licensee 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 046dcbf68cab0fbba5bd8624102a73c11fbe2c4e
-  data.tar.gz: 2b569387243ebeed517c5b873b8f4529149ba62d
+  metadata.gz: de46f921456858704f9f2260d3d699d9ddc61501
+  data.tar.gz: 043ec663c844f2c845a33aab4df9bd9e70d277a3
 SHA512:
-  metadata.gz: 0fe55bf7698ecc52aaa2de8dd77f85cb8ad9357e29abeeb8a3237a1b258fcb1ca172d7329027d0a6f045e2c869029af20fe342ac91011199e9ccdf5423c05af5
-  data.tar.gz: a4f92f1e13d453c7819c52dc591243edde132ec41c9f743c397b06902be2a40019776558ce03b935a3998682962e63af6f902bd4496032d8f79b740fb002d8fd
+  metadata.gz: 497beceba2f3b24cf06bafcf3042e9a202d3aaa8668431c09736cd3bc11267a937d90a522f5ade5ff67e45cdb585d07d1bcc5584034ff84284fc62146d681f94
+  data.tar.gz: 9e41896143cb6c2bc55f9ac5d6953f506f2d2b8223499bdbdf2f904f4feea9dbf7684a9cbe2a81deb85dc7264a8e006eea02c3cb91d4b6e2a38ff262ea4c8c98

data/lib/licensee/license.rb

@@ -1,4 +1,5 @@
 class Licensee
+  class InvalidLicense < ArgumentError; end
   class License
 
     def self.all
@@ -18,20 +19,23 @@ class Licensee
 
     # Raw content of license file, including YAML front matter
     def content
-      @content ||= File.open(path).read
-    rescue
-      ""
+      @content ||= if File.exists?(path)
+        File.open(path).read
+      elsif key == "other" # A pseudo-license with no content
+        nil
+      else
+        raise Licensee::InvalidLicense, "'#{key}' is not a valid license key"
+      end
     end
 
     # License metadata from YAML front matter
     def meta
-      @meta ||= YAML.load(parts[1]) if parts[1]
-    rescue
-      nil
+      @meta ||= YAML.load(parts[1]) if parts && parts[1]
     end
 
+    # Returns the human-readable license name
     def name
-      meta["title"] if meta
+      meta.nil? ? key.capitalize : meta["title"]
     end
 
     def featured?
@@ -41,7 +45,7 @@ class Licensee
 
     # The license body (e.g., contents - frontmatter)
     def body
-      @body ||= parts[2] if parts[2]
+      @body ||= parts[2] if parts && parts[2]
     end
     alias_method :to_s, :body
     alias_method :text, :body
@@ -70,7 +74,7 @@ class Licensee
     private
 
     def parts
-      @parts ||= content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a
+      @parts ||= content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a if content
     end
   end
 end

data/lib/licensee/project.rb

@@ -2,17 +2,6 @@ class Licensee
   class Project
     attr_reader :repository
 
-    # Array of file names to look for potential license files, in order
-    # Filenames should be lower case as candidates are downcased before comparison
-    LICENSE_FILENAMES = %w[
-      license
-      license.txt
-      license.md
-      unlicense
-      copying
-      copyright
-    ]
-
     # Initializes a new project
     #
     # path_or_repo path to git repo or Rugged::Repository instance
@@ -45,6 +34,19 @@ class Licensee
       @license ||= license_file.match if license_file
     end
 
+    # Scores a given file as a potential license
+    #
+    # filename - (string) the name of the file to score
+    #
+    # Returns 1 if the file is definately a license file
+    # Return 0.5 if the file is likely a license file
+    # Returns 0 if the file is definately not a license file
+    def self.match_license_file(filename)
+      return 1   if self.license_file?(filename)
+      return 0.5 if self.maybe_license_file?(filename)
+      return 0
+    end
+
     private
 
     def commit
@@ -58,11 +60,8 @@ class Licensee
     # Detects the license file, if any
     # Returns the blob hash as detected in the tree
     def license_hash
-      # Prefer an exact match to one of our known file names
-      license_hash = tree.find { |blob| LICENSE_FILENAMES.include? blob[:name].downcase }
-
-      # Fall back to the first file in the project root that has the word license in it
-      license_hash || tree.find { |blob| blob[:name] =~ /licen(s|c)e/i }
+      license_hash = tree.find { |blob| self.class.license_file?(blob[:name]) }
+      license_hash ||= tree.find { |blob| self.class.maybe_license_file?(blob[:name]) }
     end
 
     def license_blob
@@ -72,5 +71,26 @@ class Licensee
     def license_path
       license_hash[:name] if license_hash
     end
+
+    # Regex to detect license files
+    #
+    # Examples it should match:
+    # - LICENSE.md
+    # - licence.txt
+    # - unlicense
+    # - copying
+    # - copyright
+    def self.license_file?(filename)
+      !!(filename =~ /\A(un)?licen[sc]e|copy(ing|right)(\.[^.]+)?\z/i)
+    end
+
+    # Regex to detect things that look like license files
+    #
+    # Examples it should match:
+    # - license-MIT.txt
+    # - MIT-LICENSE
+    def self.maybe_license_file?(filename)
+      !!(filename =~ /licen[sc]e/i)
+    end
   end
 end

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 class Licensee
-  VERSION = "4.6.0"
+  VERSION = "4.7.0"
 end

data/test/test_licensee_license.rb

@@ -30,8 +30,8 @@ class TestLicenseeLicense < Minitest::Test
   should "know if the license is featured" do
     assert @license.featured?
     assert_equal TrueClass, @license.featured?.class
-    refute Licensee::License.new("cc0").featured?
-    assert_equal FalseClass, Licensee::License.new("cc0").featured?.class
+    refute Licensee::License.new("cc0-1.0").featured?
+    assert_equal FalseClass, Licensee::License.new("cc0-1.0").featured?.class
   end
 
   should "parse the license parts" do
@@ -50,4 +50,15 @@ class TestLicenseeLicense < Minitest::Test
   should "strip leading newlines from the license" do
     assert_equal "T", @license.body[0]
   end
+
+  should "fail loudly for invalid licenses" do
+    assert_raises(Licensee::InvalidLicense) { Licensee::License.new("foo").name }
+  end
+
+  should "support 'other' licenses" do
+    license = Licensee::License.new("other")
+    assert_equal nil, license.content
+    assert_equal "Other", license.name
+    refute license.featured?
+  end
 end

data/test/test_licensee_project.rb

@@ -79,4 +79,42 @@ class TestLicenseeProject < Minitest::Test
     end
   end
 
+  context "license filename matching" do
+    # Standard license names
+    ["license",
+      "LICENSE",
+      "LICENCE",
+      "license.md",
+      "unlicense",
+      "unlicence",
+      "copying",
+      "copyRIGHT",
+      "license.txt"
+    ].each do |license|
+      should "match #{license}" do
+        assert Licensee::Project.license_file?(license)
+      end
+    end
+
+    should "not match MIT-LICENSE" do
+      refute Licensee::Project.license_file?("MIT-LICENSE")
+    end
+
+    # Abnormal license names
+    [
+      "LICENSE-MIT",
+      "MIT-LICENSE.txt",
+      "mit-license-foo.md"
+    ].each do |license|
+      should "match #{license}" do
+        assert Licensee::Project.maybe_license_file?(license)
+      end
+    end
+
+    should "return the proper license files scores" do
+      assert_equal 1,   Licensee::Project.match_license_file("LICENSE.md")
+      assert_equal 0.5, Licensee::Project.match_license_file("MIT-LICENSE")
+      assert_equal 0,   Licensee::Project.match_license_file("README.txt")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-27 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem to detect under what license a project is distributed