licensee 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 839782ad5361d8938500dd5938eb33e38a821d9a
-  data.tar.gz: a688eb2acdf6a1da457cdcf4037a346e4b20691c
+  metadata.gz: 6d766a47dd9215350c16975d59ac9053d2e1b2e7
+  data.tar.gz: df2aed7e4d51620490bc20737beddf11c3f4ffca
 SHA512:
-  metadata.gz: 61151787e52a75c131b53b6ffdc38e8e8c7140546837e39bc3586bf87928d43b12505ee5f983b853520c6f65d1c742c0b3c381200df95b824a8a957bb031576a
-  data.tar.gz: 9bfe7533e62e998eb1406c663ba93bf2db81f85a92d274f1efb5f2d389f6e6e029e88b64ba94955d4dc322545254506287734d767b37ae70b40840238083cf7d
+  metadata.gz: ea10fa6deca9df416c8977d1577be155ed13a12d8750c593ed9da4d034ac052f4043800a8c06d7fc86bed1c3bb153850fad1abd4cebefede831754f1534feb03
+  data.tar.gz: 5dd629e1f02dba2d815eb052d3ae99be780196fbecd53c512002afdf28703ad4a8ad9cbfeac52fa39fd3b7dd1032b72f8f6fb314c26589b72c5c23349323ca19

data/README.md

@@ -34,7 +34,10 @@ Licensee will even diff the distributed license with the original, so you can se
 license = Licensee.license "/path/to/a/project"
 => #<Licensee::License name="MIT" match=0.9842154131847726>
 
-license.meta["title"]
+license.key
+=> "mit"
+
+license.name
 => "MIT License"
 
 license.meta["source"]

data/lib/licensee/license.rb

@@ -1,14 +1,14 @@
 class Licensee
   class License
-    attr_reader :name
+    attr_reader :key
 
-    def initialize(name)
-      @name=name.downcase
+    def initialize(key)
+      @key=key.downcase
     end
 
     # Path to vendored license file on disk
     def path
-      @path ||= File.expand_path "#{@name}.txt", Licensee::Licenses.base
+      @path ||= File.expand_path "#{@key}.txt", Licensee::Licenses.base
     end
 
     # Raw content of license file, including YAML front matter
@@ -18,11 +18,20 @@ class Licensee
 
     # License metadata from YAML front matter
     def meta
-      @meta ||= front_matter = YAML.load(parts[1]) if parts[1]
+      @meta ||= YAML.load(parts[1]) if parts[1]
     rescue
       nil
     end
 
+    def name
+      meta["title"] if meta
+    end
+
+    def featured?
+      meta["featured"] if meta
+    end
+    alias_method :featured, :featured?
+
     # The license body (e.g., contents - frontmatter)
     def body
       @body ||= parts[2]
@@ -42,7 +51,7 @@ class Licensee
     end
 
     def inspect
-      "#<Licensee::License name=\"#{name}\">"
+      "#<Licensee::License key= \"#{key}\" name=\"#{name}\">"
     end
 
     private

data/lib/licensee/licenses.rb

@@ -6,14 +6,14 @@ class Licensee
       def list
         @licenses ||= begin
           licenses = []
-          names.each { |name| licenses.push License.new(name) }
+          keys.each { |key| licenses.push License.new(key) }
           licenses
         end
       end
 
-      # Given a license name, attempt to return a matching Licensee::License instance
-      def find(name)
-        list.find { |l| l.name.downcase == name.downcase }
+      # Given a license key, attempt to return a matching Licensee::License instance
+      def find(key)
+        list.find { |l| l.key.downcase == key.downcase }
       end
 
       # Path to vendored licenses
@@ -23,13 +23,13 @@ class Licensee
 
       private
 
-      # Returns a list of potential license names, as vendored
-      def names
-        @names ||= begin
-          names = Dir.entries(base)
-          names.map! { |l| File.basename(l, ".txt").downcase }
-          names.reject! { |l| l =~ /^\./ || l.nil? }
-          names
+      # Returns a list of potential license keys, as vendored
+      def keys
+        @keys ||= begin
+          keyes = Dir.entries(base)
+          keyes.map! { |l| File.basename(l, ".txt").downcase }
+          keyes.reject! { |l| l =~ /^\./ || l.nil? }
+          keyes
         end
       end
 

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 class Licensee
-  VERSION = "3.0.0"
+  VERSION = "4.0.0"
 end

data/test/functions.rb

@@ -57,7 +57,7 @@ def verify_license_file(license, chaos = false, wrap=false)
 
   actual = license_file.match
   assert actual, "No match for #{expected}."
-  assert_equal expected, actual.name, "expeceted #{expected} but got #{actual.name} for .match. Confidence: #{license_file.confidence}. Method: #{license_file.matcher.class}"
+  assert_equal expected, actual.key, "expeceted #{expected} but got #{actual.key} for .match. Confidence: #{license_file.confidence}. Method: #{license_file.matcher.class}"
 end
 
 def wrap(text, line_width=80)

data/test/test_licensee.rb

@@ -8,7 +8,7 @@ class TestLicensee < Minitest::Test
   end
 
   should "detect a project's license" do
-    assert_equal "mit", Licensee.license(fixture_path("licenses.git")).name
+    assert_equal "mit", Licensee.license(fixture_path("licenses.git")).key
   end
 
   should "diff a license" do

data/test/test_licensee_exact_matcher.rb

@@ -9,7 +9,7 @@ class TestLicenseeExactMatcher < Minitest::Test
   end
 
   should "match the license" do
-    assert_equal "mit", Licensee::ExactMatcher.match(@mit).name
+    assert_equal "mit", Licensee::ExactMatcher.match(@mit).key
   end
 
   should "know the match confidence" do

data/test/test_licensee_git_matcher.rb

@@ -9,7 +9,7 @@ class TestLicenseeGitMatcher < Minitest::Test
   end
 
   should "match the license" do
-    assert_equal "mit", Licensee::GitMatcher.match(@mit).name
+    assert_equal "mit", Licensee::GitMatcher.match(@mit).key
   end
 
   should "know the match confidence" do

data/test/test_licensee_levenshtein_matcher.rb

@@ -9,7 +9,7 @@ class TestLicenseeLevenshteinMatcher < Minitest::Test
   end
 
   should "match the license" do
-    assert_equal "mit", Licensee::LevenshteinMatcher.match(@mit).name
+    assert_equal "mit", Licensee::LevenshteinMatcher.match(@mit).key
   end
 
   should "know the match confidence" do

data/test/test_licensee_license.rb

@@ -15,4 +15,24 @@ class TestLicenseeLicense < Minitest::Test
     assert_equal "MIT License", @license.meta["title"]
   end
 
+  should "know the license path" do
+    assert_equal File.expand_path("./vendor/choosealicense.com/_licenses/mit.txt"), @license.path
+  end
+
+  should "know the license name" do
+    assert_equal "MIT License", @license.name
+  end
+
+  should "know the license ID" do
+    assert_equal "mit", @license.key
+  end
+
+  should "know if the license is featured" do
+    assert @license.featured?
+    refute Licensee::License.new("cc0").featured?
+  end
+
+  should "parse the license parts" do
+    assert_equal 3, @license.send(:parts).size
+  end
 end

data/test/test_licensee_license_file.rb

@@ -15,7 +15,7 @@ class TestLicenseeLicenseFile < Minitest::Test
   end
 
   should "match the license" do
-    assert_equal "mit", @file.match.name
+    assert_equal "mit", @file.match.key
   end
 
   should "diff the file" do

data/test/test_licensee_licenses.rb

@@ -3,8 +3,8 @@ require 'helper'
 class TestLicenseeLicenses < Minitest::Test
 
   should "know license names" do
-    assert_equal Array, Licensee::Licenses.send(:names).class
-    assert_equal 15, Licensee::Licenses.send(:names).size
+    assert_equal Array, Licensee::Licenses.send(:keys).class
+    assert_equal 15, Licensee::Licenses.send(:keys).size
   end
 
   should "load the licenses" do
@@ -14,8 +14,8 @@ class TestLicenseeLicenses < Minitest::Test
   end
 
   should "find a license" do
-    assert_equal "mit", Licensee::Licenses.find("mit").name
-    assert_equal "mit", Licensee::Licenses.find("MIT").name
+    assert_equal "mit", Licensee::Licenses.find("mit").key
+    assert_equal "mit", Licensee::Licenses.find("MIT").key
   end
 
 end

data/test/test_licensee_project.rb

@@ -11,6 +11,6 @@ class TestLicenseeProject < Minitest::Test
   end
 
   should "detect the license" do
-    assert_equal "mit", @project.license.name
+    assert_equal "mit", @project.license.key
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged