licensee 5.0.0b4 → 5.0.0b5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ddb84b445d32f602815a66e09512dd9fd917bbb
-  data.tar.gz: 44813cf43899909185a60b9bd3ae10fc5a5fa594
+  metadata.gz: 3141e0f1cc301cf2aebb6f835212533eafe27316
+  data.tar.gz: 3fac37012f662fd0520b99106793d3b43bafce61
 SHA512:
-  metadata.gz: dd4d1ee0285d9425546a5dfa41d746b9db3a00903dcf9a5ea34ddea9d4eed4c979783bf9920d3db9756822a6d4caff44ec1a316ae12b606c6788ecb712552c12
-  data.tar.gz: c3acb3e8ed77664b816ef5523d2cea79c236edd6b6b25bef1a4cc1100af077418c10b5ff792a5ab7041ab03275e91fa4348546710380576a3b204ef72deeab45
+  metadata.gz: bc48939cb0de92f1305b7e341b01da174c298b262ec58a1f6a7ed66298a1d4f68ecfbb1dc870e64cab51bb75298b643a66770c3590b666d2c3cdf7a8881049d3
+  data.tar.gz: 8f8350d224fa1cb4f18661a3a42c876e2dd450670de6f3888b8cbeef6a9a8ffdbe7ab635b8702b27b179b92115cf7defe32436b51bb7ee25a74ea7d8b440f474

data/bin/licensee

@@ -7,8 +7,12 @@ Licensee.package_manager_files = true
 project = Licensee::Project.new(path)
 license = project.matched_file
 
+if project.license_file
+  puts "License file: #{project.license_file.path}"
+  puts "Attribution: #{project.license_file.attribution}" if project.license_file.attribution
+end
+
 if license
-  puts "Matched file: #{license.path}"
   puts "License: #{license.match ? license.match.meta['title'] : 'no license'}"
   puts "Confidence: #{license.confidence}%"
   puts "Method: #{license.matcher.class}"

data/lib/licensee.rb

@@ -4,6 +4,7 @@ require 'rugged'
 require 'levenshtein'
 
 require_relative "licensee/version"
+require_relative "licensee/content_helper"
 require_relative "licensee/license"
 require_relative "licensee/project"
 require_relative "licensee/project_file"
@@ -39,11 +40,6 @@ class Licensee
       Licensee::Project.new(path).license
     end
 
-    # Diffs the project license and the known license
-    def diff(path)
-      Licensee::Project.new(path).license_file.diff
-    end
-
     # Array of matchers to use, in order of preference
     # The order should be decending order of anticipated speed to match
     def matchers

data/lib/licensee/content_helper.rb

@@ -0,0 +1,13 @@
+class Licensee
+  module ContentHelper
+    def normalize_content(content)
+      return unless content
+      content = content.downcase
+      content = content.gsub(/\A[[:space:]]+/, '')
+      content = content.gsub(/[[:space:]]+\z/, '')
+      content = content.gsub(/^#{CopyrightMatcher::REGEX}$/i, '')
+      content = content.gsub(/[[:space:]]+/, ' ')
+      content.squeeze(' ').strip
+    end
+  end
+end

data/lib/licensee/license.rb

@@ -39,6 +39,8 @@ class Licensee
 
     HIDDEN_LICENSES = %w[other no-license]
 
+    include Licensee::ContentHelper
+
     def initialize(key)
       @key=key.downcase
     end
@@ -76,6 +78,14 @@ class Licensee
       meta.nil? ? key.capitalize : meta["title"]
     end
 
+    def nickname
+      meta["nickname"] if meta
+    end
+
+    def name_without_version
+      /(.+?)(( v?\d\.\d)|$)/.match(name)[1]
+    end
+
     def featured?
       !!(meta["featured"] if meta)
     end
@@ -95,7 +105,7 @@ class Licensee
 
     # License body with all whitespace replaced with a single space
     def body_normalized
-      @content_normalized ||= body.to_s.downcase.gsub(/\s+/, " ").strip
+      @body_normalized ||= normalize_content(body)
     end
 
     # Git-computed hash signature for the license file
@@ -118,6 +128,14 @@ class Licensee
       other != nil && key == other.key
     end
 
+    def body_includes_name?
+      @body_includes_name ||= body_normalized.include?(name_without_version.downcase)
+    end
+
+    def body_includes_nickname?
+      @body_includes_nickname ||= !!(nickname && body_normalized.include?(nickname.downcase))
+    end
+
     private
 
     def parts

data/lib/licensee/matchers/copyright_matcher.rb

@@ -2,10 +2,11 @@
 class Licensee
   class CopyrightMatcher < Matcher
 
-    REGEX = /\ACopyright (©|\(c\)|\xC2\xA9)? ?\d{4}.*?\n?\z/i
+    REGEX = /\s*Copyright (©|\(c\)|\xC2\xA9)? ?(\d{4}|\[year\])(.*)?\s*/i
 
     def match
-      no_license if file.content.strip =~ REGEX
+      # Note: must use content, and not content_normalized here
+      no_license if file.content.strip =~ /\A#{REGEX}\z/i
     rescue
       nil
     end

data/lib/licensee/matchers/git_matcher.rb

@@ -2,7 +2,7 @@ class Licensee
   class GitMatcher < Matcher
 
     def match
-      match_info[0] unless match_info.nil?
+      match_info[0] if match_info && match_info[1] >= Licensee.confidence_threshold
     end
 
     def confidence
@@ -19,7 +19,7 @@ class Licensee
     def match_info
       @match_info ||= begin
         match = matches.max_by { |license, similarity| similarity }
-        match if match && match[1] > Licensee.confidence_threshold
+        match if match
       end
     end
   end

data/lib/licensee/matchers/levenshtein_matcher.rb

@@ -4,6 +4,13 @@ class Licensee
     # Return the first potential license that is more similar than the confidence threshold
     def match
       @match ||= potential_licenses.find do |license|
+
+        # If we know the license text contains the license name or nickname,
+        # bail early unless the file we're checking contains it.
+        # Guards against OSL & AFL confusion. See https://github.com/benbalter/licensee/issues/50
+        next if license.body_includes_name? && !includes_license_name?(license)
+        next if license.body_includes_nickname? && !includes_license_nickname?(license)
+
         similarity(license) >= Licensee.confidence_threshold
       end
     end
@@ -12,7 +19,11 @@ class Licensee
     # Difference in lengths cannot exceed the file's length * the confidence threshold / 100
     def potential_licenses
       @potential_licenses ||= begin
-        Licensee.licenses(:hidden => true).select { |license| length_delta(license) <= max_delta }.sort_by { |l| length_delta(l) }
+        licenses = Licensee.licenses(:hidden => true)
+        licenses = licenses.select do |license|
+          license.body_normalized && length_delta(license) <= max_delta
+        end
+        licenses.sort_by { |l| length_delta(l) }
       end
     end
 
@@ -51,5 +62,13 @@ class Licensee
     def distance(license)
       Levenshtein.distance(license.body_normalized, file.content_normalized).to_f
     end
+
+    def includes_license_name?(license)
+      file.content_normalized.include?(license.name_without_version.downcase)
+    end
+
+    def includes_license_nickname?(license)
+      license.nickname && file.content_normalized.include?(license.nickname.downcase)
+    end
   end
 end

data/lib/licensee/project_file.rb

@@ -7,6 +7,8 @@ class Licensee
     attr_reader :blob, :path
     alias_method :filename, :path
 
+    include Licensee::ContentHelper
+
     def initialize(blob, path)
       @blob = blob
       @path = path
@@ -21,7 +23,7 @@ class Licensee
 
     # File content with all whitespace replaced with a single space
     def content_normalized
-      @content_normalized ||= content.downcase.gsub(/\s+/, " ").strip
+      @content_normalized ||= normalize_content(content)
     end
 
     # Determines which matching strategy to use, returns an instane of that matcher
@@ -46,12 +48,6 @@ class Licensee
       0
     end
 
-    # Comptutes a diff between known license and project license
-    def diff(options={})
-      options = options.merge(:reverse => true)
-      blob.diff(match.body, options).to_s if match
-    end
-
     def license_score
       self.class.license_score(filename)
     end
@@ -60,6 +56,12 @@ class Licensee
       license_score != 0.0
     end
 
+    def attribution
+      return nil unless license?
+      matches = /^#{CopyrightMatcher::REGEX}$/i.match(content)
+      matches[0].strip if matches
+    end
+
     def package_score
       return 1.0  if filename =~ /[a-zA-Z0-9\-_]+\.gemspec/
       return 1.0  if filename =~ /package\.json/

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 class Licensee
-  VERSION = "5.0.0b4"
+  VERSION = "5.0.0b5"
 end

data/test/fixtures/mit-without-title/mit.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Ben Balter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/test/functions.rb

@@ -22,8 +22,8 @@ end
 FakeBlob = Licensee::FilesystemRepository::Blob
 
 def chaos_monkey(string)
-  Random.rand(5).times do
-    string[Random.rand(string.length)] = SecureRandom.base64(Random.rand(5))
+  Random.rand(3).times do
+    string[Random.rand(string.length)] = SecureRandom.base64(Random.rand(3))
   end
   string
 end
@@ -39,15 +39,28 @@ def verify_license_file(license, chaos = false, wrap=false)
   license_file = Licensee::ProjectFile.new(blob, "LICENSE")
 
   actual = license_file.match
-  assert actual, "No match for #{expected}. Here's the test text:\n#{text}"
+  msg = "No match for #{expected}."
+
+  unless actual
+    Licensee.matchers.each do |matcher|
+      matcher = matcher.new(license_file)
+      msg << "#{matcher.class}: #{matcher.confidence}% #{matcher.match.inspect}\n"
+    end
+    msg << "Here's the test text:\n#{text}"
+  end
+
+  assert actual, msg
   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)
   text = text.clone
+  copyright = /^#{Licensee::CopyrightMatcher::REGEX}$/i.match(text)
+  text.gsub! /^#{Licensee::CopyrightMatcher::REGEX}$/i, '[COPYRIGHT]' if copyright
   text.gsub! /([^\n])\n([^\n])/, '\1 \2'
   text = text.split("\n").collect do |line|
     line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
   end * "\n"
+  text.gsub! "[COPYRIGHT]", "\n#{copyright}\n" if copyright
   text.strip
 end

data/test/test_licensee.rb

@@ -12,10 +12,6 @@ class TestLicensee < Minitest::Test
     assert_equal "mit", Licensee.license(fixture_path("licenses.git")).key
   end
 
-  should "diff a license" do
-    Licensee.diff(fixture_path("licenses.git"))
-  end
-
   context "confidence threshold" do
     should "return the confidence threshold" do
       assert_equal 90, Licensee.confidence_threshold

data/test/test_licensee_bin.rb

@@ -6,7 +6,7 @@ class TestLicenseeBin < Minitest::Test
     Dir.chdir root
     stdout,stderr,status = Open3.capture3("#{root}/bin/licensee")
     assert stdout.include?("License: MIT"), "expected #{stdout} to include `License: MIT`"
-    assert stdout.include?("Matched file: LICENSE.md"), "expected #{stdout} to include `Matched file: LICENSE.md`"
+    assert stdout.include?("License file: LICENSE.md"), "expected #{stdout} to include `Matched file: LICENSE.md`"
     assert_equal 0, status
   end
 end

data/test/test_licensee_content_helper.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestHelper
+  include Licensee::ContentHelper
+end
+
+class TestLicenseeContentHelper < Minitest::Test
+
+  def setup
+    @helper = TestHelper.new
+  end
+
+  def normalize(content)
+    @helper.normalize_content(content)
+  end
+
+  should "downcase content" do
+    assert_equal "foo", normalize("Foo")
+  end
+
+  should "strip leading whitespace" do
+    assert_equal "foo", normalize("\n Foo")
+  end
+
+  should "strip trailing whitespace" do
+    assert_equal "foo", normalize("Foo \n ")
+  end
+
+  should "strip double spaces" do
+    assert_equal "foo bar", normalize("Foo  bar")
+  end
+
+  should "strip copyrights" do
+    assert_equal "foo", normalize("Copyright (c) 2015 Ben Balter\nFoo")
+  end
+end

data/test/test_licensee_git_matcher.rb

@@ -15,4 +15,5 @@ class TestLicenseeGitMatcher < Minitest::Test
   should "know the match confidence" do
     assert_equal 94, Licensee::GitMatcher.new(@mit).confidence
   end
+
 end

data/test/test_licensee_levenshtein_matcher.rb

@@ -18,13 +18,13 @@ class TestLicenseeLevenshteinMatcher < Minitest::Test
   end
 
   should "calculate max delta" do
-    assert_equal 964.8000000000001, Licensee::LevenshteinMatcher.new(@mit).max_delta
+    assert_equal 937.8000000000001, Licensee::LevenshteinMatcher.new(@mit).max_delta
   end
 
   should "calculate length delta" do
     isc = Licensee::License.find("isc")
-    assert_equal 2, Licensee::LevenshteinMatcher.new(@mit).length_delta(Licensee::License.find("mit"))
-    assert_equal 334, Licensee::LevenshteinMatcher.new(@mit).length_delta(isc)
+    assert_equal 0.0, Licensee::LevenshteinMatcher.new(@mit).length_delta(Licensee::License.find("mit"))
+    assert_equal 347.0, Licensee::LevenshteinMatcher.new(@mit).length_delta(isc)
   end
 
   should "round up potential licenses" do

data/test/test_licensee_license.rb

@@ -30,6 +30,11 @@ class TestLicenseeLicense < Minitest::Test
     assert_equal "MIT License", @license.name
   end
 
+  should "know the license nickname" do
+    expected = "GNU Affero GPL v3.0"
+    assert_equal expected, Licensee::License.find("agpl-3.0").nickname
+  end
+
   should "know the license ID" do
     assert_equal "mit", @license.key
   end
@@ -98,6 +103,32 @@ class TestLicenseeLicense < Minitest::Test
     refute license.featured?
   end
 
+  describe "name without version" do
+    should "strip the version from the license name" do
+      expected = "GNU Affero General Public License"
+      assert_equal expected, Licensee::License.find("agpl-3.0").name_without_version
+      expected = "GNU General Public License"
+      assert_equal expected,  Licensee::License.find("gpl-2.0").name_without_version
+      assert_equal expected,  Licensee::License.find("gpl-3.0").name_without_version
+    end
+
+    should "know if the license contains the name without version" do
+      refute Licensee::License.find("cc0-1.0").body_includes_name?
+      assert Licensee::License.find("agpl-3.0").body_includes_name?
+    end
+
+    should "know if the license contains the nickname" do
+      refute Licensee::License.find("mit").body_includes_nickname?
+      assert Licensee::License.find("apache-2.0").body_includes_nickname?
+    end
+
+    Licensee.licenses.each do |license|
+      should "strip the version number from the #{license.name} license" do
+        assert license.name_without_version
+      end
+    end
+  end
+
   describe "class methods" do
     should "know license names" do
       assert_equal Array, Licensee::License.keys.class

data/test/test_licensee_project.rb

@@ -68,6 +68,10 @@ class TestLicenseeProject < Minitest::Test
     end
   end
 
+  should "detect the MIT license even with the title removed" do
+    verify_license_file fixture_path("mit-without-title/mit.txt")
+  end
+
   describe "packages" do
 
     def setup

data/test/test_licensee_project_file.rb

@@ -22,13 +22,12 @@ class TestLicenseeProjectFile < Minitest::Test
     assert_equal "LICENSE", @file.path
   end
 
-  should "diff the file" do
-    expected = "-Copyright (c) [year] [fullname]\n+Copyright (c) 2014 Ben Balter"
-    assert @file.diff.include?(expected)
+  should "calculate confidence" do
+    assert_equal 100, @file.confidence
   end
 
-  should "calculate confidence" do
-    assert_equal 94, @file.confidence
+  should "parse the attribution" do
+    assert_equal "Copyright (c) 2014 Ben Balter", @file.attribution
   end
 
   context "license filename scoring" do

data/test/test_licensee_vendor.rb

@@ -1,15 +1,17 @@
 require 'helper'
 
 class TestLicenseeVendor < Minitest::Test
-  Licensee::License.send(:license_files).shuffle.each do |license|
 
+  SKIP = %[wtfpl no-license]
+
+  Licensee::License.send(:license_files).shuffle.each do |license|
     should "detect the #{license} license" do
       verify_license_file(license)
     end
 
     context "when modified" do
       should "detect the #{license} license" do
-        verify_license_file(license, true) unless license =~ /no-license\.txt$/
+        verify_license_file(license, true) unless SKIP.include?(File.basename(license, ".txt"))
       end
     end
 
@@ -20,7 +22,7 @@ class TestLicenseeVendor < Minitest::Test
 
       context "when modified" do
         should "detect the #{license} license" do
-          verify_license_file(license, true, 50) unless license =~ /no-license\.txt$/
+          verify_license_file(license, true, 50) unless SKIP.include?(File.basename(license, ".txt"))
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 5.0.0b4
+  version: 5.0.0b5
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -107,6 +107,7 @@ files:
 - Rakefile
 - bin/licensee
 - lib/licensee.rb
+- lib/licensee/content_helper.rb
 - lib/licensee/filesystem_repository.rb
 - lib/licensee/license.rb
 - lib/licensee/matcher.rb
@@ -151,6 +152,7 @@ files:
 - test/fixtures/licenses.git/objects/pack/pack-4a7088171ae3ca900f010a4be6f1c2c96490c338.pack
 - test/fixtures/licenses.git/packed-refs
 - test/fixtures/licenses.git/refs/heads/master
+- test/fixtures/mit-without-title/mit.txt
 - test/fixtures/named-license-file-prefix.git/HEAD
 - test/fixtures/named-license-file-prefix.git/config
 - test/fixtures/named-license-file-prefix.git/objects/64/3983d3f82ecc2a7d8e4227946220ebffd477d2
@@ -177,6 +179,7 @@ files:
 - test/helper.rb
 - test/test_licensee.rb
 - test/test_licensee_bin.rb
+- test/test_licensee_content_helper.rb
 - test/test_licensee_copyright_matcher.rb
 - test/test_licensee_exact_matcher.rb
 - test/test_licensee_gemspec_matcher.rb