licensee 4.3.3 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c206be5aef5cd0e5f18171be03fd48608bb3182
-  data.tar.gz: 8811ceacf71df25aaf9bf939163fadd707652a6a
+  metadata.gz: e696930375e6996477c17001e3ce366ee37159fe
+  data.tar.gz: 55aef0447384d6af3763ecfbab6ffa9c961fe08a
 SHA512:
-  metadata.gz: f8daa173e64e12f4f4c8ea3e0d3a2f770e7c1dc8be8bd07755fb2bce19e6c9fea78df10f82813c9b631b131697449086c6fb234a97ca873ef8e4146e255c8fd1
-  data.tar.gz: 25fdf9d6e490077596a12c2d8e2be9c6dcae5933d8902977c160c4a0121c442daa4ce9dec4aaf434c2e3dacb106d43ed1a421426bdf46f22668ece9e5467de75
+  metadata.gz: e4a0c18e5a8edbccf0e3eaf4137d8664cb6ccf179f0a1a2944cca00f1a8b48aa37e66276a1b357e8c4358179b258079e37aab893bdb53c9101d8a8a28922a552
+  data.tar.gz: d4a51dcc5f97b286c9920f4295acdb9b973259a396b1b6dedfca09e9700890019935b5dd9cfbbb1a0a2feae13755159a7d723eeecf923cd22d0c311d431c7d8a

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Ben Balter
+Copyright (c) 2014-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

data/README.md

@@ -12,13 +12,15 @@
 
 ## The solution
 
-Licensee automates the process of reading `LICENSE` files and compares their contents to known licenses using a several strategies (which we call "Matchers"):
+Licensee automates the process of reading `LICENSE` files and compares their contents to known licenses using a several strategies (which we call "Matchers"). It attempts to determine a project's license in the following order:
 
-First, we look to see if the license is an exact match. Licenses like GPL don't have a copyright notice that needs to be changed in the license itself, so if we strip away whitespace, we might get lucky, and direct string comparison is cheap.
+1. If the license file has an explicit copyright notice, and nothing more (e.g., `Copyright (c) 2015 Ben Balter`), we'll assume the author intends to retain all rights, and thus the project isn't licensed.
 
-Next, we look to Git's internal change calculation method, which is fast, but is done on a line-by-line basis, so if the license is wrapped differently, or has extra words inserted, it's not going to match the license.
+2. If the license is an exact match to a known license. Licenses like GPL don't have a copyright notice that needs to be changed in the license itself, so if we strip away whitespace, we might get lucky, and direct string comparison in Ruby is cheap.
 
-Finally, if we still can't match the license, we use a fancy math thing called the [Levenshtein distance algorithm](https://en.wikipedia.org/wiki/Levenshtein_distance), which while slow, is really good at calculating the similarity between a known license and an unknown license. By calculating the percent changed from the known license, you can tell, e.g., that a given license is 98% similar to the MIT license, that 2% likely representing the copyright line being properly adapted to the project.
+3. If 90% of the lines match a known license. We use Git's internal change calculation method. To calcualte diffs, Git hashes each line of both files, and compares the hashes to tell the percent changed. This method is fast, but is done on a line-by-line basis, so if the license is wrapped differently, or has extra words inserted, it's not going to match the license.
+
+4. If we still can't match the license, we use a fancy math thing called the [Levenshtein distance algorithm](https://en.wikipedia.org/wiki/Levenshtein_distance), which while very slow, is really good at calculating the similarity between two strings. By calculating the percent changed from the known license to the license file, you can tell, e.g., that a given license is 90% similar to the MIT license, that 10% likely representing the copyright line being properly adapted to the project.
 
 Licensee will even diff the distributed license with the original, so you can see exactly what, if anything's been changed.
 

data/lib/licensee.rb

@@ -10,6 +10,7 @@ require_relative "licensee/license_file"
 require_relative "licensee/project"
 require_relative "licensee/matcher"
 require_relative "licensee/matchers/exact_matcher"
+require_relative "licensee/matchers/copyright_matcher"
 require_relative "licensee/matchers/git_matcher"
 require_relative "licensee/matchers/levenshtein_matcher"
 
@@ -41,7 +42,7 @@ class Licensee
     # Array of matchers to use, in order of preference
     # The order should be decending order of anticipated speed to match
     def matchers
-      [Licensee::ExactMatcher, Licensee::GitMatcher, Licensee::LevenshteinMatcher]
+      [Licensee::CopyrightMatcher, Licensee::ExactMatcher, Licensee::GitMatcher, Licensee::LevenshteinMatcher]
     end
   end
 end

data/lib/licensee/license.rb

@@ -55,6 +55,8 @@ class Licensee
     def hashsig
       @hashsig ||= Rugged::Blob::HashSignature.new(
         body, Rugged::Blob::HashSignature::WHITESPACE_SMART)
+    rescue Rugged::InvalidError
+      nil
     end
 
     def inspect

data/lib/licensee/license_file.rb

@@ -4,7 +4,13 @@ class Licensee
 
     def initialize(blob)
       @blob = blob
+    end
+
+    def similarity(other)
       blob.hashsig(Rugged::Blob::HashSignature::WHITESPACE_SMART)
+      other.hashsig ? blob.similarity(other.hashsig) : 0
+    rescue Rugged::InvalidError
+      0
     end
 
     # Raw file contents

data/lib/licensee/matchers/copyright_matcher.rb

@@ -0,0 +1,20 @@
+class Licensee
+  class CopyrightMatcher < Matcher
+
+    REGEX = /\A(Copyright|Copyright ©|Copyright \(c\)) \d{4}.*?\n?\z/i
+
+    def match
+      no_license if file.content.strip =~ REGEX
+    end
+
+    def confidence
+      100
+    end
+
+    private
+
+    def no_license
+      @no_license ||= Licensee::Licenses.find("no-license")
+    end
+  end
+end

data/lib/licensee/matchers/git_matcher.rb

@@ -12,11 +12,7 @@ class Licensee
     private
 
     def matches
-      @matches ||= Licensee.licenses.map { |l| [l, similarity(l)] }.select { |l,sim| sim > 0 }
-    end
-
-    def similarity(other)
-      file.blob.similarity(other.hashsig)
+      @matches ||= Licensee.licenses.map { |l| [l, file.similarity(l)] }.select { |l,sim| sim > 0 }
     end
 
     # Pulled out for easier testing

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 class Licensee
-  VERSION = "4.3.3"
+  VERSION = "4.4.0"
 end

data/test/functions.rb

@@ -30,16 +30,18 @@ class FakeBlob
   end
 
   def similarity(other)
-    Rugged::Blob::HashSignature.compare(self.hashsig, other)
+    self.hashsig ? Rugged::Blob::HashSignature.compare(self.hashsig, other) : 0
   end
 
   def hashsig(options = 0)
     @hashsig ||= Rugged::Blob::HashSignature.new(content, options)
+  rescue Rugged::InvalidError
+    nil
   end
 end
 
 def chaos_monkey(string)
-  Random.rand(7).times do
+  Random.rand(5).times do
     string[Random.rand(string.length)] = SecureRandom.base64(Random.rand(10))
   end
   string

data/test/test_licensee.rb

@@ -3,7 +3,7 @@ require 'helper'
 class TestLicensee < Minitest::Test
   should "know the licenses" do
     assert_equal Array, Licensee.licenses.class
-    assert_equal 15, Licensee.licenses.size
+    assert_equal 16, Licensee.licenses.size
     assert_equal Licensee::License, Licensee.licenses.first.class
   end
 

data/test/test_licensee_copyright_matcher.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestLicenseeCopyrightMatcher < Minitest::Test
+
+  def setup
+    text = "Copyright 2015 Ben Balter"
+    blob = FakeBlob.new(text)
+    @file = Licensee::LicenseFile.new(blob)
+  end
+
+  should "match the license" do
+    assert_equal "no-license", Licensee::CopyrightMatcher.match(@file).key
+  end
+
+  should "know the match confidence" do
+    assert_equal 100, Licensee::CopyrightMatcher.new(@file).confidence
+  end
+
+  should "match Copyright (C) copyright notices" do
+    text = "Copyright (C) 2015 Ben Balter"
+    blob = FakeBlob.new(text)
+    file = Licensee::LicenseFile.new(blob)
+    assert_equal "no-license", Licensee::CopyrightMatcher.match(file).key
+  end
+
+  should "match Copyright © copyright notices" do
+    text = "copyright © 2015 Ben Balter"
+    blob = FakeBlob.new(text)
+    file = Licensee::LicenseFile.new(blob)
+    assert_equal "no-license", Licensee::CopyrightMatcher.match(file).key
+  end
+
+  should "not false positive" do
+    text = File.open(Licensee::Licenses.find("mit").path).read.split("---").last
+    blob = FakeBlob.new(text)
+    file = Licensee::LicenseFile.new(blob)
+    assert_equal nil, Licensee::CopyrightMatcher.match(file)
+  end
+end

data/test/test_licensee_licenses.rb

@@ -4,12 +4,12 @@ class TestLicenseeLicenses < Minitest::Test
 
   should "know license names" do
     assert_equal Array, Licensee::Licenses.keys.class
-    assert_equal 15, Licensee::Licenses.keys.size
+    assert_equal 16, Licensee::Licenses.keys.size
   end
 
   should "load the licenses" do
     assert_equal Array, Licensee::Licenses.list.class
-    assert_equal 15, Licensee::Licenses.list.size
+    assert_equal 16, Licensee::Licenses.list.size
     assert_equal Licensee::License, Licensee::Licenses.list.first.class
   end
 

data/test/test_licensee_vendor.rb

@@ -11,7 +11,7 @@ class TestLicenseeVendor < Minitest::Test
   should "detect each vendored license when modified" do
     licenses = Dir["#{Licensee::Licenses.base}/*"].shuffle
     licenses.each do |license|
-      verify_license_file(license, true)
+      verify_license_file(license, true) unless license =~ /no-license\.txt$/
     end
   end
 
@@ -25,7 +25,7 @@ class TestLicenseeVendor < Minitest::Test
   should "detect each vendored license with different line lengths when modified" do
     licenses = Dir["#{Licensee::Licenses.base}/*"].shuffle
     licenses.each do |license|
-      verify_license_file(license, true, 50)
+      verify_license_file(license, true, 50) unless license =~ /no-license\.txt$/
     end
   end
 end

data/vendor/choosealicense.com/_licenses/no-license.txt

@@ -0,0 +1,28 @@
+---
+layout: license
+permalink: /licenses/no-license/
+category: No License
+class: license-types
+title: No License
+
+description: You retain all rights and do not permit distribution, reproduction, or derivative works. You may grant some rights in cases where you publish your source code to a site that requires accepting terms of service. For example, publishing code in a public repository on GitHub requires that you allow others to view and fork your code.
+
+note: This option may be subject to the Terms Of Use of the site where you publish your source code.
+
+how: Simply do nothing, though including a copyright notice is recommended.
+
+required:
+  - include-copyright
+
+permitted:
+  - commercial-use
+  - private-use
+
+forbidden:
+  - modifications
+  - distribution
+  - sublicense
+
+---
+
+Copyright [year] [fullname]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 4.3.3
+  version: 4.4.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -111,6 +111,7 @@ files:
 - lib/licensee/license_file.rb
 - lib/licensee/licenses.rb
 - lib/licensee/matcher.rb
+- lib/licensee/matchers/copyright_matcher.rb
 - lib/licensee/matchers/exact_matcher.rb
 - lib/licensee/matchers/git_matcher.rb
 - lib/licensee/matchers/levenshtein_matcher.rb
@@ -160,6 +161,7 @@ files:
 - test/helper.rb
 - test/test_licensee.rb
 - test/test_licensee_bin.rb
+- test/test_licensee_copyright_matcher.rb
 - test/test_licensee_exact_matcher.rb
 - test/test_licensee_git_matcher.rb
 - test/test_licensee_levenshtein_matcher.rb
@@ -183,6 +185,7 @@ files:
 - vendor/choosealicense.com/_licenses/lgpl-3.0.txt
 - vendor/choosealicense.com/_licenses/mit.txt
 - vendor/choosealicense.com/_licenses/mpl-2.0.txt
+- vendor/choosealicense.com/_licenses/no-license.txt
 - vendor/choosealicense.com/_licenses/unlicense.txt
 homepage: http://github.com/benbalter/licensee
 licenses: