diff options
| author | mokha <mokha@cisco.com> | 2018-02-13 19:03:31 -0700 |
|---|---|---|
| committer | mokha <mokha@cisco.com> | 2018-02-13 19:03:31 -0700 |
| commit | 5401de49dcd25e6b6fcd7d9fef9fd847608cfab4 (patch) | |
| tree | b516df24f94d9cc0361cff40c3127cf58da49486 | |
initial commit.
| -rw-r--r-- | .gitignore | 11 | ||||
| -rw-r--r-- | .rspec | 3 | ||||
| -rw-r--r-- | .travis.yml | 5 | ||||
| -rw-r--r-- | Gemfile | 6 | ||||
| -rw-r--r-- | LICENSE.txt | 21 | ||||
| -rw-r--r-- | README.md | 39 | ||||
| -rw-r--r-- | Rakefile | 6 | ||||
| -rwxr-xr-x | bin/console | 14 | ||||
| -rwxr-xr-x | bin/setup | 8 | ||||
| -rw-r--r-- | exe/xsay | 3 | ||||
| -rw-r--r-- | lib/xsay.rb | 5 | ||||
| -rw-r--r-- | lib/xsay/version.rb | 3 | ||||
| -rw-r--r-- | spec/spec_helper.rb | 14 | ||||
| -rw-r--r-- | spec/xsay_spec.rb | 9 | ||||
| -rw-r--r-- | xsay.gemspec | 36 |
15 files changed, 183 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b04a8c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +# rspec failure tracking +.rspec_status @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..6a8e36f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +sudo: false +language: ruby +rvm: + - 2.5.0 +before_install: gem install bundler -v 1.16.1 @@ -0,0 +1,6 @@ +source "https://rubygems.org" + +git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } + +# Specify your gem's dependencies in xsay.gemspec +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..6e639d5 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 mokha + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..94a24b1 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Xsay + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xsay`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'xsay' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install xsay + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xsay. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..b7e9ed5 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +require "bundler/gem_tasks" +require "rspec/core/rake_task" + +RSpec::Core::RakeTask.new(:spec) + +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..0753066 --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "xsay" + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +# (If you use this, don't forget to add pry to your Gemfile!) +# require "pry" +# Pry.start + +require "irb" +IRB.start(__FILE__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/exe/xsay b/exe/xsay new file mode 100644 index 0000000..5e81230 --- /dev/null +++ b/exe/xsay @@ -0,0 +1,3 @@ +#!/usr/bin/env ruby + +require "xsay" diff --git a/lib/xsay.rb b/lib/xsay.rb new file mode 100644 index 0000000..f243c0c --- /dev/null +++ b/lib/xsay.rb @@ -0,0 +1,5 @@ +require "xsay/version" + +module Xsay + # Your code goes here... +end diff --git a/lib/xsay/version.rb b/lib/xsay/version.rb new file mode 100644 index 0000000..fcdb0c1 --- /dev/null +++ b/lib/xsay/version.rb @@ -0,0 +1,3 @@ +module Xsay + VERSION = "0.1.0" +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..108f5c7 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,14 @@ +require "bundler/setup" +require "xsay" + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = ".rspec_status" + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end diff --git a/spec/xsay_spec.rb b/spec/xsay_spec.rb new file mode 100644 index 0000000..5126638 --- /dev/null +++ b/spec/xsay_spec.rb @@ -0,0 +1,9 @@ +RSpec.describe Xsay do + it "has a version number" do + expect(Xsay::VERSION).not_to be nil + end + + it "does something useful" do + expect(false).to eq(true) + end +end diff --git a/xsay.gemspec b/xsay.gemspec new file mode 100644 index 0000000..5d1d629 --- /dev/null +++ b/xsay.gemspec @@ -0,0 +1,36 @@ + +lib = File.expand_path("../lib", __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require "xsay/version" + +Gem::Specification.new do |spec| + spec.name = "xsay" + spec.version = Xsay::VERSION + spec.authors = ["mokha"] + spec.email = ["mokha@cisco.com"] + + spec.summary = %q{TODO: Write a short summary, because RubyGems requires one.} + spec.description = %q{TODO: Write a longer description or delete this line.} + spec.homepage = "TODO: Put your gem's website or public repo URL here." + spec.license = "MIT" + + # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' + # to allow pushing to a single host or delete this section to allow pushing to any host. + if spec.respond_to?(:metadata) + spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" + else + raise "RubyGems 2.0 or newer is required to protect against " \ + "public gem pushes." + end + + spec.files = `git ls-files -z`.split("\x0").reject do |f| + f.match(%r{^(test|spec|features)/}) + end + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_development_dependency "bundler", "~> 1.16" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rspec", "~> 3.0" +end |
