licensee 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9511aa5acc8806c546383c7c3a9768e604c303fe
-  data.tar.gz: 6ac4084aece7db23441894eaa7832d4fa9c5cb44
+  metadata.gz: ab35a217757c184a6a0b91d6536c8ab7a8b19c44
+  data.tar.gz: 9cdabe6b6e388c2ef893f8e691aa1aa5aa7e78b2
 SHA512:
-  metadata.gz: ac982657202244e0460648cca93b7877e802aae30ba6369c0fcb12d2ae6f76056473ac0c8a5eaa85f43c2101e23d691286eadaab9e1dcd39112edcff4c978064
-  data.tar.gz: 4873e3d6dcb1e6285d4b4c41177be741f3ffc4b7ae2678eedb44ca5581074a95703dc33dcfb32b0587df3e251cbf00ba59f603b46e7b3f59270a1deb14f59a99
+  metadata.gz: 41e4cff0f46f818a9cacfc83b7e0bb495b59152e29e9a95a12a9296e0a87d0b051ac009c329ef435804051076281724ece0c18612ebe7e38a53ed230830f7466
+  data.tar.gz: d69564bffdc75c6af44a36795d7cee2c5dddf8b91cb65ce92e1eb3345ecc31500c31a2a2a47b828c0476181356a39c76c00a0e6f94775a3b1e27224a7d55d9ce

data/lib/licensee/license.rb

@@ -1,5 +1,4 @@
 require 'uri'
-require 'yaml'
 
 module Licensee
   class InvalidLicense < ArgumentError; end
@@ -60,11 +59,8 @@ module Licensee
 
     attr_reader :key
 
-    # These should be in sync with choosealicense.com's collection defaults
-    YAML_DEFAULTS = {
-      'featured' => false,
-      'hidden'   => true
-    }.freeze
+    # Preserved for backwards compatability
+    YAML_DEFAULTS = Licensee::LicenseMeta.members
 
     # Pseudo-license are license placeholders with no content
     #
@@ -75,6 +71,8 @@ module Licensee
     PSEUDO_LICENSES = %w[other no-license].freeze
 
     include Licensee::ContentHelper
+    extend Forwardable
+    def_delegators :meta, *LicenseMeta.helper_methods
 
     def initialize(key)
       @key = key.downcase
@@ -87,33 +85,20 @@ module Licensee
 
     # License metadata from YAML front matter with defaults merged in
     def meta
-      @meta ||= begin
-        return YAML_DEFAULTS unless parts && parts[1]
-        meta = YAML.safe_load(parts[1])
-        YAML_DEFAULTS.merge(meta)
-      end
+      @meta ||= LicenseMeta.from_yaml(yaml)
     end
 
     # Returns the human-readable license name
     def name
-      meta['title'] ? meta['title'] : key.capitalize
-    end
-
-    def nickname
-      meta['nickname']
+      title ? title : key.capitalize
     end
 
     def name_without_version
       /(.+?)(( v?\d\.\d)|$)/.match(name)[1]
     end
 
-    def featured?
-      meta['featured']
-    end
-    alias featured featured?
-
-    def hidden?
-      meta['hidden']
+    def other?
+      key == 'other'
     end
 
     def gpl?
@@ -183,5 +168,9 @@ module Licensee
       return unless raw_content
       @parts ||= raw_content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a
     end
+
+    def yaml
+      @yaml ||= parts[1] if parts
+    end
   end
 end

data/lib/licensee/license_meta.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+
+module Licensee
+  class LicenseMeta < Struct.new(
+    :title, :spdx_id, :source, :description, :how, :conditions, :permissions,
+    :limitations, :using, :featured, :hidden, :nickname, :note
+  )
+
+    # These should be in sync with choosealicense.com's collection defaults
+    DEFAULTS = {
+      'featured' => false,
+      'hidden'   => true
+    }.freeze
+
+    PREDICATE_FIELDS = %i[featured hidden].freeze
+
+    class << self
+      # Create a new LicenseMeta from YAML
+      #
+      # yaml - the raw YAML string
+      #
+      # returns a LicenseMeta with defaults set
+      def from_yaml(yaml)
+        return from_hash({}) if yaml.nil? || yaml.to_s.empty?
+        from_hash YAML.safe_load(yaml)
+      end
+
+      # Create a new LicenseMeta from a hash
+      #
+      # hash - the hash of key/value meta pairs
+      #
+      # returns a LicenseMeta with defaults set
+      def from_hash(hash)
+        hash = DEFAULTS.merge(hash)
+        hash['spdx_id'] = hash.delete('spdx-id')
+        ordered_array = hash.values_at(*members.map(&:to_s))
+        new(*ordered_array)
+      end
+
+      # Array of symbolized helper methods to expose on the License class
+      def helper_methods
+        members - PREDICATE_FIELDS + PREDICATE_FIELDS.map { |f| "#{f}?".to_sym }
+      end
+    end
+
+    PREDICATE_FIELDS.each do |field|
+      alias_method "#{field}?".to_sym, field
+    end
+
+    # Backward compatibalize `#["spdx-id"]` calls to avoid a breaking change
+    def [](key)
+      key = 'spdx_id' if key == 'spdx-id'
+      super(key)
+    end
+  end
+end

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 module Licensee
-  VERSION = '9.0.0'.freeze
+  VERSION = '9.1.0'.freeze
 end

data/lib/licensee.rb

@@ -6,6 +6,7 @@ require 'rugged'
 module Licensee
   autoload :ContentHelper, 'licensee/content_helper'
   autoload :License, 'licensee/license'
+  autoload :LicenseMeta, 'licensee/license_meta'
   autoload :Rule, 'licensee/rule'
   autoload :Matchers, 'licensee/matchers'
   autoload :Projects, 'licensee/projects'

data/spec/licensee/license_meta_spec.rb

@@ -0,0 +1,110 @@
+RSpec.describe Licensee::LicenseMeta do
+  subject { Licensee::License.find('mit').meta }
+
+  meta_fields.each do |field|
+    next if field['name'] == 'redirect_from'
+
+    context "the #{field['name']} field" do
+      let(:name) { field['name'].tr('-', '_') }
+      let(:method) { name.to_sym }
+
+      it 'responds to the field as a method' do
+        expect(subject).to respond_to(method)
+      end
+
+      it 'responds to the field as a hash key' do
+        if field['required']
+          expect(subject[name]).to_not be_nil
+        else
+          expect { subject[name] }.not_to raise_error
+        end
+      end
+    end
+  end
+
+  context 'predicate methods' do
+    described_class::PREDICATE_FIELDS.each do |field|
+      context "the #{field}? method" do
+        it 'responds' do
+          expect(subject).to respond_to("#{field}?".to_sym)
+        end
+
+        it 'is boolean' do
+          expect(subject.send("#{field}?".to_sym)).to be(true).or be(false)
+        end
+      end
+    end
+  end
+
+  context '#from_hash' do
+    let(:hash) do
+      { 'title' => 'Test license', 'description' => 'A test license' }
+    end
+    subject { described_class.from_hash(hash) }
+
+    it 'sets values' do
+      expect(subject.title).to eql('Test license')
+      expect(subject.description).to eql('A test license')
+    end
+
+    context 'setting defaults' do
+      let(:hash) { {} }
+
+      described_class::DEFAULTS.each do |key, value|
+        it "sets the #{key} field to #{value}" do
+          expect(subject[key]).to eql(value)
+        end
+      end
+    end
+
+    context 'spdx-id' do
+      let(:hash) { { 'spdx-id' => 'foo' } }
+
+      it 'renames spdx-id to spdx_id' do
+        expect(subject['spdx_id']).to eql('foo')
+      end
+
+      it 'exposes spdx-id via #[]' do
+        expect(subject['spdx-id']).to eql('foo')
+      end
+    end
+  end
+
+  context '#from_yaml' do
+    let(:yaml) { "title: Test license\ndescription: A test license" }
+    subject { described_class.from_yaml(yaml) }
+
+    it 'parses yaml' do
+      expect(subject.title).to eql('Test license')
+      expect(subject.description).to eql('A test license')
+    end
+
+    it 'sets defaults' do
+      expect(subject.hidden).to eql(true)
+      expect(subject.featured).to eql(false)
+    end
+
+    context 'nil yaml' do
+      let(:yaml) { nil }
+
+      it 'returns defaults' do
+        expect(subject.hidden).to eql(true)
+      end
+    end
+
+    context 'empty yaml' do
+      let(:yaml) { '' }
+
+      it 'returns defaults' do
+        expect(subject.featured).to eql(false)
+      end
+    end
+  end
+
+  it 'returns the list of helper methods' do
+    expect(described_class.helper_methods.length).to eql(13)
+    expect(described_class.helper_methods).to include(:hidden?)
+    expect(described_class.helper_methods).to_not include(:hidden)
+    expect(described_class.helper_methods).to include(:title)
+  end
+end

data/spec/licensee/license_spec.rb

@@ -127,11 +127,26 @@ RSpec.describe Licensee::License do
     expect(mit.key).to eql('mit')
   end
 
+  it 'exposes the SPDX ID' do
+    expect(gpl.spdx_id).to eql('GPL-3.0')
+  end
+
+  context '#other?' do
+    it 'knows MIT is not other' do
+      expect(gpl).to_not be_other
+    end
+
+    it 'knows the other license is other?' do
+      expect(other).to be_other
+    end
+  end
+
   context 'meta' do
     it 'exposes license meta' do
       expect(mit).to respond_to(:meta)
-      expect(mit.meta).to have_key('title')
+      expect(mit.meta).to respond_to(:title)
       expect(mit.meta['title']).to eql('MIT License')
+      expect(mit.meta.title).to eql('MIT License')
     end
 
     it 'includes defaults' do

data/spec/spec_helper.rb

@@ -66,6 +66,12 @@ def format_percent(float)
   "#{format('%.2f', float)}%"
 end
 
+def meta_fields
+  path = 'vendor/choosealicense.com/_data/meta.yml'
+  path = File.expand_path(path, project_root)
+  YAML.safe_load(File.read(path))
+end
+
 RSpec::Matchers.define :be_an_existing_file do
   match { |path| File.exist?(path) }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -108,6 +108,7 @@ files:
 - lib/licensee.rb
 - lib/licensee/content_helper.rb
 - lib/licensee/license.rb
+- lib/licensee/license_meta.rb
 - lib/licensee/matchers.rb
 - lib/licensee/matchers/cabal.rb
 - lib/licensee/matchers/copyright.rb
@@ -156,6 +157,7 @@ files:
 - spec/fixtures/wrk-modified-apache/LICENSE
 - spec/integration_spec.rb
 - spec/licensee/content_helper_spec.rb
+- spec/licensee/license_meta_spec.rb
 - spec/licensee/license_spec.rb
 - spec/licensee/matchers/cabal_matcher_spec.rb
 - spec/licensee/matchers/copyright_matcher_spec.rb