diff options
| -rw-r--r-- | .gitignore | 11 | ||||
| -rw-r--r-- | .rspec | 3 | ||||
| -rw-r--r-- | .travis.yml | 7 | ||||
| -rw-r--r-- | Gemfile | 4 | ||||
| -rw-r--r-- | Gemfile.lock | 35 | ||||
| -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 | ||||
| -rwxr-xr-x | exe/spandx | 3 | ||||
| -rw-r--r-- | lib/spandx.rb | 6 | ||||
| -rw-r--r-- | lib/spandx/version.rb | 3 | ||||
| -rw-r--r-- | spandx.gemspec | 32 | ||||
| -rw-r--r-- | spec/spandx_spec.rb | 3 | ||||
| -rw-r--r-- | spec/spec_helper.rb | 14 |
16 files changed, 209 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..f8e5b17 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,7 @@ +--- +sudo: false +language: ruby +cache: bundler +rvm: + - 2.6.4 +before_install: gem install bundler -v 2.0.2 @@ -0,0 +1,4 @@ +source "https://rubygems.org" + +# Specify your gem's dependencies in spandx.gemspec +gemspec diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..354166a --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,35 @@ +PATH + remote: . + specs: + spandx (0.1.0) + +GEM + remote: https://rubygems.org/ + specs: + diff-lcs (1.3) + rake (10.5.0) + rspec (3.8.0) + rspec-core (~> 3.8.0) + rspec-expectations (~> 3.8.0) + rspec-mocks (~> 3.8.0) + rspec-core (3.8.2) + rspec-support (~> 3.8.0) + rspec-expectations (3.8.5) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.8.0) + rspec-mocks (3.8.2) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.8.0) + rspec-support (3.8.3) + +PLATFORMS + ruby + +DEPENDENCIES + bundler (~> 2.0) + rake (~> 10.0) + rspec (~> 3.0) + spandx! + +BUNDLED WITH + 2.0.2 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..cc2636e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 mo khan + +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..a4e0561 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Spandx + +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/spandx`. 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 'spandx' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install spandx + +## 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]/spandx. + +## 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..fa0b2f5 --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "spandx" + +# 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/spandx b/exe/spandx new file mode 100755 index 0000000..a574347 --- /dev/null +++ b/exe/spandx @@ -0,0 +1,3 @@ +#!/usr/bin/env ruby + +require "spandx" diff --git a/lib/spandx.rb b/lib/spandx.rb new file mode 100644 index 0000000..1bd6563 --- /dev/null +++ b/lib/spandx.rb @@ -0,0 +1,6 @@ +require "spandx/version" + +module Spandx + class Error < StandardError; end + # Your code goes here... +end diff --git a/lib/spandx/version.rb b/lib/spandx/version.rb new file mode 100644 index 0000000..b330592 --- /dev/null +++ b/lib/spandx/version.rb @@ -0,0 +1,3 @@ +module Spandx + VERSION = "0.1.0" +end diff --git a/spandx.gemspec b/spandx.gemspec new file mode 100644 index 0000000..b471f71 --- /dev/null +++ b/spandx.gemspec @@ -0,0 +1,32 @@ +lib = File.expand_path("lib", __dir__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require "spandx/version" + +Gem::Specification.new do |spec| + spec.name = "spandx" + spec.version = Spandx::VERSION + spec.authors = ["mo khan"] + spec.email = ["mo@mokhan.ca"] + + spec.summary = %q{A ruby interface to the SPDX catalogue.} + spec.description = %q{A ruby interface to the SPDX catalogue.} + spec.homepage = "https://gitlab.com/xlgmokha/spandx" + spec.license = "MIT" + + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = "https://gitlab.com/xlgmokha/spandx" + spec.metadata["changelog_uri"] = "https://gitlab.com/xlgmokha/spandx/blob/master/CHANGELOG.md" + + # Specify which files should be added to the gem when it is released. + # The `git ls-files -z` loads the files in the RubyGem that have been added into git. + spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do + `git ls-files -z`.split("\x0").reject { |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", "~> 2.0" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rspec", "~> 3.0" +end diff --git a/spec/spandx_spec.rb b/spec/spandx_spec.rb new file mode 100644 index 0000000..8a8bafb --- /dev/null +++ b/spec/spandx_spec.rb @@ -0,0 +1,3 @@ +RSpec.describe Spandx do + specify { expect(Spandx::VERSION).not_to be nil } +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..a16c619 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,14 @@ +require "bundler/setup" +require "spandx" + +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 |