jekyll-spdx_licenses 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 407a1f772dd9175916ef4e22c0b39ebb03ae8a4ad5184d976f995a9db8335c8a
+  data.tar.gz: ca6e22730bb57c305e9e923aaefa2358226af6c17aedde31c083cc1de033af1c
+SHA512:
+  metadata.gz: '08162ca53d30ab6729f137b4769f56dcd6cce87b5087b8ebfaab720ace3938aec0cc31d6bd2f6a124da883f1b6c028c754fdc2ca29feba41bf1ad7c1561c6727'
+  data.tar.gz: 3421c00ff3d16d17b5d93e78001dcdce83761abd04735686e371d56e44453b9b9c7ef4d0e03cc8e23723ee46a464b9c6113a89f842e5e6e9f3a8b0a2c9bb3cfe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-spdx_licenses.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# Jekyll::SpdxLicenses
+
+Liquid Tag to be used with Jekyll, which allows you to reference [SPDX](https://spdx.org/) licenses within your posts/projects.
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-spdx_licenses'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-spdx_licenses
+
+## Usage
+
+To convert a SPDX license ID to its full name:
+
+```
+{% spdx_name Apache-2.0 %}
+=> Apache License 2.0
+```
+
+To convert the SPDX license ID to a link:
+
+```
+{% spdx_link Apache-2.0 %}
+=> <a href="https://spdx.org/licenses/Apache-2.0">Apache License 2.0</a>
+```
+
+## 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://gitlab.com/jamietanna/jekyll-spdx_licenses

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/spdx_licenses"
+
+# 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__)

data/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

data/jekyll-spdx_licenses.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/spdx_licenses/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-spdx_licenses"
+  spec.version       = Jekyll::SpdxLicenses::VERSION
+  spec.authors       = ["Jamie Tanna"]
+  spec.email         = ["rubygems@jamietanna.co.uk"]
+
+  spec.summary       = 'Liquid Tag to be used with Jekyll, which allows you to reference SPDX licenses within your posts/projects.'
+  spec.description   = 'Liquid Tag to be used with Jekyll, which allows you to reference SPDX licenses within your posts/projects.'
+  spec.homepage      = 'https://gitlab.com/jamietanna/jekyll-spdx_licenses'
+
+  # 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"] = 'https://rubygems.org/'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = 'https://gitlab.com/jamietanna/jekyll-spdx_licenses'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_dependency 'jekyll', '~> 3.8'
+  spec.add_dependency 'spdx-licenses', '~> 1.2'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jekyll/spdx_licenses.rb

@@ -0,0 +1,8 @@
+require "jekyll/spdx_licenses/version"
+
+module Jekyll
+  module SpdxLicenses
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/jekyll/spdx_licenses/spdx_link_tag.rb

@@ -0,0 +1,18 @@
+require 'liquid'
+require 'spdx-licenses'
+
+module Jekyll
+  module SpdxLicenses
+    class SpdxLinkTag < Liquid::Tag
+      def initialize(tag_name, license_id, tokens)
+        super
+        raise 'License ID not valid according to SPDX licenses' unless ::SpdxLicenses.exist?(license_id)
+        @license = ::SpdxLicenses.lookup(license_id)
+      end
+
+      def render(content)
+        "<a href=\"https://spdx.org/licenses/#{@license.id}.html\">#{@license.name}</a>"
+      end
+    end
+  end
+end

data/lib/jekyll/spdx_licenses/spdx_name_tag.rb

@@ -0,0 +1,18 @@
+require 'liquid'
+require 'spdx-licenses'
+
+module Jekyll
+  module SpdxLicenses
+    class SpdxNameTag < Liquid::Tag
+      def initialize(tag_name, license_id, tokens)
+        super
+        raise 'License ID not valid according to SPDX licenses' unless ::SpdxLicenses.exist?(license_id)
+        @license = ::SpdxLicenses.lookup(license_id)
+      end
+
+      def render(content)
+        @license.name
+      end
+    end
+  end
+end

data/lib/jekyll/spdx_licenses/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module SpdxLicenses
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-spdx_licenses
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Tanna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: spdx-licenses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Liquid Tag to be used with Jekyll, which allows you to reference SPDX
+  licenses within your posts/projects.
+email:
+- rubygems@jamietanna.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-spdx_licenses.gemspec
+- lib/jekyll/spdx_licenses.rb
+- lib/jekyll/spdx_licenses/spdx_link_tag.rb
+- lib/jekyll/spdx_licenses/spdx_name_tag.rb
+- lib/jekyll/spdx_licenses/version.rb
+homepage: https://gitlab.com/jamietanna/jekyll-spdx_licenses
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://gitlab.com/jamietanna/jekyll-spdx_licenses
+  source_code_uri: https://gitlab.com/jamietanna/jekyll-spdx_licenses
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Liquid Tag to be used with Jekyll, which allows you to reference SPDX licenses
+  within your posts/projects.
+test_files: []