licensee 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6d6862fe6acd66d17a577ac52357cb55352c355
-  data.tar.gz: 1e52b8216cd0443e86bf2f6b4bdc67d3a12c6b3c
+  metadata.gz: 046dcbf68cab0fbba5bd8624102a73c11fbe2c4e
+  data.tar.gz: 2b569387243ebeed517c5b873b8f4529149ba62d
 SHA512:
-  metadata.gz: 4afadc876117dca8dae492065fd0145086dafb195f50dd0314e42299f9d4345ab4fc124fce52b89812553fb2cc082037e2ce03807a9cb074c080eb6af5ba8fa6
-  data.tar.gz: f0028b11795d26f8c23664ee7e010fc7c57eeead50b29c77dd2086dd8f5ee63da05a1459c564751d704e6da7b1fd3f79b753b18bff956691e077d2c7a2c5063a
+  metadata.gz: 0fe55bf7698ecc52aaa2de8dd77f85cb8ad9357e29abeeb8a3237a1b258fcb1ca172d7329027d0a6f045e2c869029af20fe342ac91011199e9ccdf5423c05af5
+  data.tar.gz: a4f92f1e13d453c7819c52dc591243edde132ec41c9f743c397b06902be2a40019776558ce03b935a3998682962e63af6f902bd4496032d8f79b740fb002d8fd

data/bin/licensee

@@ -7,7 +7,7 @@ project = Licensee::Project.new(path)
 license = project.license_file
 
 if license
-  puts "License file: #{project.send(:license_blob)[:name]}"
+  puts "License 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/license_file.rb

@@ -1,9 +1,10 @@
 class Licensee
   class LicenseFile
-    attr_reader :blob
+    attr_reader :blob, :path
 
-    def initialize(blob)
+    def initialize(blob, options={})
       @blob = blob
+      @path = options[:path]
     end
 
     def similarity(other)

data/lib/licensee/project.rb

@@ -37,7 +37,7 @@ class Licensee
 
     # Returns an instance of Licensee::LicenseFile if there's a license file detected
     def license_file
-      @license_file ||= LicenseFile.new(@repository.lookup(license_blob[:oid])) if license_blob
+      @license_file ||= LicenseFile.new(license_blob, :path => license_path) if license_blob
     end
 
     # Returns the matching Licensee::License instance if a license can be detected
@@ -57,12 +57,20 @@ class Licensee
 
     # Detects the license file, if any
     # Returns the blob hash as detected in the tree
-    def license_blob
+    def license_hash
       # Prefer an exact match to one of our known file names
-      license_blob = tree.find { |blob| LICENSE_FILENAMES.include? blob[:name].downcase }
+      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_blob || tree.find { |blob| blob[:name] =~ /licen(s|c)e/i }
+      license_hash || tree.find { |blob| blob[:name] =~ /licen(s|c)e/i }
+    end
+
+    def license_blob
+      @repository.lookup(license_hash[:oid]) if license_hash
+    end
+
+    def license_path
+      license_hash[:name] if license_hash
     end
   end
 end

data/lib/licensee/version.rb

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

data/test/test_licensee_bin.rb

@@ -6,6 +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?("License file: LICENSE.md"), "expected #{stdout} to include `License file: LICENSE.md`"
     assert_equal 0, status
   end
 end

data/test/test_licensee_copyright_matcher.rb

@@ -36,4 +36,11 @@ class TestLicenseeCopyrightMatcher < Minitest::Test
     file = Licensee::LicenseFile.new(blob)
     assert_equal nil, Licensee::CopyrightMatcher.match(file)
   end
+
+  should "handle UTF-8 encoded copyright notices" do
+    text = "Copyright (c) 2010-2014 Simon Hürlimann"
+    blob = FakeBlob.new(text)
+    file = Licensee::LicenseFile.new(blob)
+    assert_equal "no-license", Licensee::CopyrightMatcher.match(file).key
+  end
 end

data/test/test_licensee_license_file.rb

@@ -5,7 +5,7 @@ class TestLicenseeLicenseFile < Minitest::Test
   def setup
     @repo = Rugged::Repository.new(fixture_path("licenses.git"))
     blob = 'bcb552d06d9cf1cd4c048a6d3bf716849c2216cc'
-    @file = Licensee::LicenseFile.new(@repo.lookup(blob))
+    @file = Licensee::LicenseFile.new(@repo.lookup(blob), :path => "LICENSE")
     @gpl = Licensee::Licenses.find "GPL-3.0"
     @mit = Licensee::Licenses.find "MIT"
   end
@@ -18,6 +18,10 @@ class TestLicenseeLicenseFile < Minitest::Test
     assert_equal "mit", @file.match.key
   end
 
+  should "know the path" do
+    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)

data/test/test_licensee_project.rb

@@ -36,9 +36,19 @@ class TestLicenseeProject < Minitest::Test
         assert_equal "mit", project.license.key
       end
 
+      should "return the license hash" do
+        project = make_project "licenses.git", as_git
+        assert_equal "LICENSE", project.send(:license_hash)[:name]
+      end
+
       should "return the license blob" do
         project = make_project "licenses.git", as_git
-        assert_equal "LICENSE", project.send(:license_blob)[:name]
+        assert_equal 1077, project.send(:license_blob).size
+      end
+
+      should "return the license path" do
+        project = make_project "licenses.git", as_git
+        assert_equal "LICENSE", project.send(:license_path)
       end
 
       should "detect an atypically cased license file" do

data/vendor/choosealicense.com/_licenses/agpl-3.0.txt

@@ -1,5 +1,6 @@
 ---
 title: GNU Affero General Public License v3.0
+nickname: GNU Affero GPL v3.0
 category: GPL
 tab-slug: agpl-v3
 hide-from-license-list: true

data/vendor/choosealicense.com/_licenses/bsd-2-clause.txt

@@ -1,6 +1,7 @@
 ---
 layout: license
 title: BSD 2-clause "Simplified" License
+nickname: Simplified BSD
 category: BSD
 tab-slug: bsd
 hide-from-license-list: true

data/vendor/choosealicense.com/_licenses/bsd-3-clause.txt

@@ -1,6 +1,7 @@
 ---
 layout: license
 title: BSD 3-clause "New" or "Revised" License
+nickname: New BSD
 category: BSD
 tab-slug: bsd-3
 hide-from-license-list: true
@@ -8,7 +9,7 @@ permalink: /licenses/bsd-3-clause/
 
 description: A permissive license that comes in two variants, the <a href="/licenses/bsd">BSD 2-Clause</a> and <a href="/licenses/bsd-3-clause">BSD 3-Clause</a>. Both have very minute differences to the MIT license. The three clause variant prohibits others from using the name of the project or its contributors to promote derivative works without written consent.
 
-how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. Replace {organization} with the organization, if any, that sponsors this work.
+how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. Replace [project] with the project organization, if any, that sponsors this work.
 
 source: http://opensource.org/licenses/BSD-3-Clause
 

data/vendor/choosealicense.com/_licenses/cc0-1.0.txt

@@ -1,6 +1,7 @@
 ---
 layout: license
 title: Creative Commons Zero v1.0 Universal
+nickname: CC0 1.0 Universal
 category: Public Domain Dedication
 tab-slug: cc0
 permalink: /licenses/cc0/

data/vendor/choosealicense.com/_licenses/gpl-2.0.txt

@@ -1,5 +1,6 @@
 ---
 title: GNU General Public License v2.0
+nickname: GNU GPL v2.0
 category: GPL
 tab-slug: gpl-v2
 hide-from-license-list: false

data/vendor/choosealicense.com/_licenses/gpl-3.0.txt

@@ -1,5 +1,6 @@
 ---
 title: GNU General Public License v3.0
+nickname: GNU GPL v3.0
 category: GPL
 tab-slug: gpl-v3
 hide-from-license-list: true

data/vendor/choosealicense.com/_licenses/lgpl-2.1.txt

@@ -1,6 +1,7 @@
 ---
 layout: license
 title: GNU Lesser General Public License v2.1
+nickname: GNU LGPL v2.1
 category: LGPL
 tab-slug: lgpl-v2_1
 redirect_from: /licenses/lgpl-v2.1/

data/vendor/choosealicense.com/_licenses/lgpl-3.0.txt

@@ -1,6 +1,7 @@
 ---
 layout: license
 title: GNU Lesser General Public License v3.0
+nickname: GNU LGPL v3.0
 category: LGPL
 tab-slug: lgpl-v3
 hide-from-license-list: true
@@ -10,9 +11,9 @@ permalink: /licenses/lgpl-3.0/
 
 description: Version 3 of the LGPL is an additional set of permissions to the <a href="/licenses/GPL-3.0">GPL v3 license</a> that requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction.
 
-how: This license is an additional set of permissions to the <a href="/licenses/gpl-3.0">GPL v3</a> license. Follow the instructions to apply the GPL v3 license. Then either paste this text to the bottom of that file OR add a separate file (typically named COPYING.lesser or LICENSE.lesser) in the root of your source code and copy the text.
+how: This license is an additional set of permissions to the <a href="/licenses/gpl-3.0">GPL v3</a> license. Follow the instructions to apply the GPL v3. Then either paste this text to the bottom of the created file OR add a separate file (typically named COPYING.lesser or LICENSE.lesser) in the root of your source code and copy the text.
 
-note: The Free Software Foundation recommends taking the additional step of adding a boilerplate notice to the top of each file. The boilerplate can be found at the end of the license.
+note: The Free Software Foundation recommends taking the additional step of adding a boilerplate notice to the top of each file. The boilerplate can be found at the end of the <a href="/licenses/gpl-3.0">GPL v3 license</a>. Insert the word “Lesser” before “General” in all three places in the boilerplate notice to make sure that you refer to the LGPL v3 and not the GPL v3.
 
 required:
   - include-copyright

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged