licensee 9.1.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab35a217757c184a6a0b91d6536c8ab7a8b19c44
-  data.tar.gz: 9cdabe6b6e388c2ef893f8e691aa1aa5aa7e78b2
+  metadata.gz: 78870e247e0c6151853578986d20c1c751367d5d
+  data.tar.gz: 44bb59c524289c3797c408ddd727fca8e808893d
 SHA512:
-  metadata.gz: 41e4cff0f46f818a9cacfc83b7e0bb495b59152e29e9a95a12a9296e0a87d0b051ac009c329ef435804051076281724ece0c18612ebe7e38a53ed230830f7466
-  data.tar.gz: d69564bffdc75c6af44a36795d7cee2c5dddf8b91cb65ce92e1eb3345ecc31500c31a2a2a47b828c0476181356a39c76c00a0e6f94775a3b1e27224a7d55d9ce
+  metadata.gz: beda36d600d5771bf870f627547800aa561641f2755c2f9a6662b7e7b14dfdb743075ecfd45145bfe6050c8f3aedcf9c3b65f70b10d5f0edab22b1c4a10bf7cb
+  data.tar.gz: d66f22ef8340ccfb6c9ca11fdbd1c5e403ba26c5f8a21776cd5f88dfa2fc8bf71322b5fc0895412091cd78ccbf39fba099953a5bec51c62e129c99c95c308cf7

data/lib/licensee.rb

@@ -2,11 +2,13 @@ require_relative 'licensee/version'
 require 'forwardable'
 require 'pathname'
 require 'rugged'
+require 'yaml'
 
 module Licensee
   autoload :ContentHelper, 'licensee/content_helper'
   autoload :License, 'licensee/license'
   autoload :LicenseMeta, 'licensee/license_meta'
+  autoload :LicenseRules, 'licensee/license_rules'
   autoload :Rule, 'licensee/rule'
   autoload :Matchers, 'licensee/matchers'
   autoload :Projects, 'licensee/projects'

data/lib/licensee/license.rb

@@ -134,19 +134,8 @@ module Licensee
       PSEUDO_LICENSES.include?(key)
     end
 
-    # Returns a hash in the form of rule_group => rules describing
-    # what you legally can and can't do with the given license
     def rules
-      return @rules if defined? @rules
-      @rules = {}
-
-      Rule.groups.each do |group|
-        @rules[group] = meta[group].map do |tag|
-          Rule.find_by_tag_and_group(tag, group)
-        end
-      end
-
-      @rules
+      @rules ||= LicenseRules.from_meta(meta)
     end
 
     def inspect

data/lib/licensee/license_meta.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Licensee
   class LicenseMeta < Struct.new(
     :title, :spdx_id, :source, :description, :how, :conditions, :permissions,

data/lib/licensee/license_rules.rb

@@ -0,0 +1,34 @@
+module Licensee
+  # Exposes #conditions, #permissions, and #limitation arrays of LicenseRules
+  class LicenseRules < Struct.new(:conditions, :permissions, :limitations)
+    class << self
+      def from_license(license)
+        from_meta(license.meta)
+      end
+
+      def from_meta(meta)
+        rules = {}
+        Rule.groups.each do |group|
+          rules[group] = meta[group].map do |tag|
+            Rule.find_by_tag_and_group(tag, group)
+          end
+        end
+        from_hash(rules)
+      end
+
+      def from_hash(hash)
+        ordered_array = hash.values_at(*members.map(&:to_s))
+        new(*ordered_array)
+      end
+    end
+
+    def flatten
+      members.map { |m| public_send(m) }.flatten
+    end
+
+    def key?(key)
+      members.include?(key.to_sym)
+    end
+    alias has_key? key?
+  end
+end

data/lib/licensee/version.rb

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

data/spec/licensee/license_rules_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe Licensee::LicenseRules do
+  let(:mit) { Licensee::License.find('mit') }
+  subject { mit.rules }
+
+  Licensee::Rule.groups.each do |group|
+    context "the #{group} rule group" do
+      it 'responds as a hash key string' do
+        expect(subject[group]).to be_a(Array)
+      end
+
+      it 'responds as a hash key symbol' do
+        expect(subject[group.to_sym]).to be_a(Array)
+      end
+
+      it 'responds as a method' do
+        expect(subject.public_send(group.to_sym)).to be_a(Array)
+      end
+    end
+  end
+
+  context 'created from a license' do
+    subject { described_class.from_license(mit) }
+
+    it 'exposes the rules' do
+      expect(subject.permissions.first.label).to eql('Commercial use')
+    end
+  end
+
+  context 'created from a meta' do
+    subject { described_class.from_meta(mit.meta) }
+
+    it 'exposes the rules' do
+      expect(subject.permissions.first.label).to eql('Commercial use')
+    end
+  end
+
+  context 'created from a hash' do
+    let(:hash) { { 'permissions' => Licensee::Rule.all } }
+    subject { described_class.from_hash(hash) }
+
+    it 'exposes the rules' do
+      expect(subject.permissions.first.label).to eql('Commercial use')
+    end
+  end
+end

data/spec/licensee/license_spec.rb

@@ -250,9 +250,10 @@ RSpec.describe Licensee::License do
   end
 
   it 'returns the rules' do
+    expect(mit.rules).to be_a(Licensee::LicenseRules)
     expect(mit.rules).to have_key('permissions')
     expect(mit.rules['permissions'].first).to be_a(Licensee::Rule)
-    expect(mit.rules.flatten.count).to eql(6)
+    expect(mit.rules.flatten.count).to eql(7)
   end
 
   it 'returns rules by tag and group' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -109,6 +109,7 @@ files:
 - lib/licensee/content_helper.rb
 - lib/licensee/license.rb
 - lib/licensee/license_meta.rb
+- lib/licensee/license_rules.rb
 - lib/licensee/matchers.rb
 - lib/licensee/matchers/cabal.rb
 - lib/licensee/matchers/copyright.rb
@@ -158,6 +159,7 @@ files:
 - spec/integration_spec.rb
 - spec/licensee/content_helper_spec.rb
 - spec/licensee/license_meta_spec.rb
+- spec/licensee/license_rules_spec.rb
 - spec/licensee/license_spec.rb
 - spec/licensee/matchers/cabal_matcher_spec.rb
 - spec/licensee/matchers/copyright_matcher_spec.rb