licensee 6.1.1 → 7.0.0

data/test/test_licensee_npm_bower_matcher.rb

@@ -1,27 +1,27 @@
 require 'helper'
 
 class TestLicenseeNpmBowerMatchers < Minitest::Test
-  should "detect NPM files" do
-    pkg = File.read fixture_path("npm/package.json")
+  should 'detect NPM files' do
+    pkg = File.read fixture_path('npm/package.json')
     pkgfile = Licensee::Project::PackageInfo.new(pkg)
     matcher = Licensee::Matchers::NpmBower.new(pkgfile)
-    assert_equal "mit", matcher.send(:license_property)
-    assert_equal "mit", matcher.match.key
+    assert_equal 'mit', matcher.send(:license_property)
+    assert_equal 'mit', matcher.match.key
   end
 
-  should "detect Bower files" do
-    pkg = File.read fixture_path("bower/bower.json")
+  should 'detect Bower files' do
+    pkg = File.read fixture_path('bower/bower.json')
     pkgfile = Licensee::Project::PackageInfo.new(pkg)
     matcher = Licensee::Matchers::NpmBower.new(pkgfile)
-    assert_equal "mit", matcher.send(:license_property)
-    assert_equal "mit", matcher.match.key
+    assert_equal 'mit', matcher.send(:license_property)
+    assert_equal 'mit', matcher.match.key
   end
 
-  should "not err on non-spdx licenses" do
-    pkg = File.read fixture_path("npm-non-spdx/package.json")
+  should 'not err on non-spdx licenses' do
+    pkg = File.read fixture_path('npm-non-spdx/package.json')
     pkgfile = Licensee::Project::PackageInfo.new(pkg)
     matcher = Licensee::Matchers::NpmBower.new(pkgfile)
-    assert_equal "mit-1.0", matcher.send(:license_property)
+    assert_equal 'mit-1.0', matcher.send(:license_property)
     assert_equal nil, matcher.match
   end
 end

data/test/test_licensee_package_info.rb

@@ -1,17 +1,18 @@
 require 'helper'
 
 class TestLicenseePackageInfo < Minitest::Test
-  context "license filename scoring" do
+  context 'license filename scoring' do
     EXPECTATIONS = {
-      "licensee.gemspec" => 1.0,
-      "package.json"     => 1.0,
-      "bower.json"       => 0.75,
-      "README.md"        => 0.0
-    }
+      'licensee.gemspec' => 1.0,
+      'package.json'     => 1.0,
+      'bower.json'       => 0.75,
+      'README.md'        => 0.0
+    }.freeze
 
     EXPECTATIONS.each do |filename, expected|
       should "score a license named `#{filename}` as `#{expected}`" do
-        assert_equal expected, Licensee::Project::PackageInfo.name_score(filename)
+        score = Licensee::Project::PackageInfo.name_score(filename)
+        assert_equal expected, score
       end
     end
   end

data/test/test_licensee_project.rb

@@ -2,86 +2,94 @@ require 'helper'
 require 'fileutils'
 
 class TestLicenseeProject < Minitest::Test
-
-  ["git", "filesystem"].each do |project_type|
+  %w(git filesystem).each do |project_type|
     describe("#{project_type} repository project") do
-      if project_type == "git"
+      if project_type == 'git'
         def make_project(fixture_name)
           fixture = fixture_path fixture_name
           Licensee::GitProject.new(fixture)
         end
       else
         def make_project(fixture_name)
-          dest = File.join("tmp", "fixtures", fixture_name)
+          dest = File.join('tmp', 'fixtures', fixture_name)
           FileUtils.mkdir_p File.dirname(dest)
-          system "git", "clone", "-q", fixture_path(fixture_name), dest
-          FileUtils.rm_r File.join(dest, ".git")
+          system 'git', 'clone', '-q', fixture_path(fixture_name), dest
+          FileUtils.rm_r File.join(dest, '.git')
 
           Licensee::FSProject.new(dest)
         end
 
         def teardown
-          FileUtils.rm_rf "tmp/fixtures" 
+          FileUtils.rm_rf 'tmp/fixtures'
         end
       end
 
-      should "detect the license file" do
-        project = make_project "licenses.git"
+      should 'detect the license file' do
+        project = make_project 'licenses.git'
         assert_instance_of Licensee::Project::LicenseFile, project.license_file
       end
 
-      should "detect the license" do
-        project = make_project "licenses.git"
-        assert_equal "mit", project.license.key
+      should 'detect the license' do
+        project = make_project 'licenses.git'
+        assert_equal 'mit', project.license.key
       end
 
-      should "detect an atypically cased license file" do
-        project = make_project "case-sensitive.git"
+      should 'detect an atypically cased license file' do
+        project = make_project 'case-sensitive.git'
         assert_instance_of Licensee::Project::LicenseFile, project.license_file
       end
 
-      should "detect MIT-LICENSE licensed projects" do
-        project = make_project "named-license-file-prefix.git"
-        assert_equal "mit", project.license.key
+      should 'detect MIT-LICENSE licensed projects' do
+        project = make_project 'named-license-file-prefix.git'
+        assert_equal 'mit', project.license.key
       end
 
-      should "detect LICENSE-MIT licensed projects" do
-        project = make_project "named-license-file-suffix.git"
-        assert_equal "mit", project.license.key
+      should 'detect LICENSE-MIT licensed projects' do
+        project = make_project 'named-license-file-suffix.git'
+        assert_equal 'mit', project.license.key
       end
 
-      should "not error out on repos with folders names license" do
-        project = make_project "license-folder.git"
+      should 'not error out on repos with folders names license' do
+        project = make_project 'license-folder.git'
         assert_equal nil, project.license
       end
 
-      should "detect licence files" do
-        project = make_project "licence.git"
-        assert_equal "mit", project.license.key
+      should 'detect licence files' do
+        project = make_project 'licence.git'
+        assert_equal 'mit', project.license.key
       end
 
-      should "detect an unlicensed project" do
-        project = make_project "no-license.git"
+      should 'detect an unlicensed project' do
+        project = make_project 'no-license.git'
         assert_equal nil, project.license
       end
     end
   end
 
-  describe "mit license with title removed" do
-    should "detect the MIT license" do
-      verify_license_file fixture_path("mit-without-title/mit.txt")
+  describe 'mit license with title removed' do
+    should 'detect the MIT license' do
+      verify_license_file fixture_path('mit-without-title/mit.txt')
     end
 
-    should "should detect the MIT license when rewrapped" do
-      verify_license_file fixture_path("mit-without-title-rewrapped/mit.txt")
+    should 'should detect the MIT license when rewrapped' do
+      verify_license_file fixture_path('mit-without-title-rewrapped/mit.txt')
     end
   end
 
-  describe "packages" do
-    should "detect a package file" do
-      project = Licensee::GitProject.new(fixture_path("npm.git"), detect_packages: true)
-      assert_equal "package.json", project.package_file.filename
-      assert_equal "mit", project.license.key
+  describe 'packages' do
+    should 'detect a package file' do
+      path = fixture_path('npm.git')
+      options = { detect_packages: true }
+      project = Licensee::GitProject.new(path, options)
+      assert_equal 'package.json', project.package_file.filename
+      assert_equal 'mit', project.license.key
+    end
+
+    should 'skip readme if no license content' do
+      path = fixture_path('bower-with-readme')
+      options = { detect_packages: true, detect_readme: true }
+      project = Licensee::FSProject.new(path, options)
+      assert_equal 'mit', project.license.key
     end
   end
 end

data/test/test_licensee_project_file.rb

@@ -1,24 +1,24 @@
 require 'helper'
 
 class TestLicenseeProjectFile < Minitest::Test
-
   def setup
-    @repo = Rugged::Repository.new(fixture_path("licenses.git"))
-    blob, _ = Rugged::Blob.to_buffer(@repo, 'bcb552d06d9cf1cd4c048a6d3bf716849c2216cc')
+    @repo = Rugged::Repository.new(fixture_path('licenses.git'))
+    ref = 'bcb552d06d9cf1cd4c048a6d3bf716849c2216cc'
+    blob, = Rugged::Blob.to_buffer(@repo, ref)
     @file = Licensee::Project::LicenseFile.new(blob)
-    @gpl = Licensee::License.find "GPL-3.0"
-    @mit = Licensee::License.find "MIT"
+    @gpl = Licensee::License.find 'GPL-3.0'
+    @mit = Licensee::License.find 'MIT'
   end
 
-  should "read the file" do
+  should 'read the file' do
     assert @file.content =~ /MIT/
   end
 
-  should "match the license" do
-    assert_equal "mit", @file.license.key
+  should 'match the license' do
+    assert_equal 'mit', @file.license.key
   end
 
-  should "calculate confidence" do
+  should 'calculate confidence' do
     assert_equal 100, @file.confidence
   end
 end

data/test/test_licensee_readme.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class TestLicenseeReadme < Minitest::Test
+  context 'readme filename scoring' do
+    EXPECTATIONS = {
+      'readme'     => 1.0,
+      'README'     => 1.0,
+      'readme.md'  => 0.9,
+      'README.md'  => 0.9,
+      'readme.txt' => 0.9,
+      'LICENSE'    => 0.0
+    }.freeze
+
+    EXPECTATIONS.each do |filename, expected|
+      should "score a readme named `#{filename}` as `#{expected}`" do
+        assert_equal expected, Licensee::Project::Readme.name_score(filename)
+      end
+    end
+  end
+
+  context 'readme content' do
+    should 'be blank if not license text' do
+      assert_license_content nil, 'There is no License in this README'
+    end
+
+    should 'get content after h1' do
+      assert_license_content 'hello world', "# License\n\nhello world"
+    end
+
+    should 'get content after h2' do
+      assert_license_content 'hello world', "## License\n\nhello world"
+    end
+
+    should 'be case-insensitive' do
+      assert_license_content 'hello world', "## LICENSE\n\nhello world"
+    end
+
+    should 'be british' do
+      assert_license_content 'hello world', "## Licence\n\nhello world"
+    end
+
+    should 'not include trailing content' do
+      readme = "## License\n\nhello world\n\n# Contributing"
+      assert_license_content 'hello world', readme
+    end
+  end
+end

data/test/test_licensee_vendor.rb

@@ -1,28 +1,31 @@
 require 'helper'
 
 class TestLicenseeVendor < Minitest::Test
-
-  SKIP = %[wtfpl no-license]
+  SKIP = %(wtfpl no-license).freeze
 
   Licensee::License.send(:license_files).shuffle.each do |license|
     should "detect the #{license} license" do
       verify_license_file(license)
     end
 
-    context "when modified" do
+    context 'when modified' do
       should "detect the #{license} license" do
-        verify_license_file(license, true) unless SKIP.include?(File.basename(license, ".txt"))
+        unless SKIP.include?(File.basename(license, '.txt'))
+          verify_license_file(license, true)
+        end
       end
     end
 
-    context "different line lengths" do
+    context 'different line lengths' do
       should "detect the #{license} license" do
         verify_license_file(license, false, 50)
       end
 
-      context "when modified" do
+      context 'when modified' do
         should "detect the #{license} license" do
-          verify_license_file(license, true, 50) unless SKIP.include?(File.basename(license, ".txt"))
+          unless SKIP.include?(File.basename(license, '.txt'))
+            verify_license_file(license, true, 50)
+          end
         end
       end
     end

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

@@ -4,8 +4,6 @@ source: http://opensource.org/licenses/afl-3.0
 
 description: The Academic Free License is a variant of the Open Source License that does not require that the source code of derivative works be disclosed. It contains explicit copyright and patent grants and reserves trademark rights in the author.
 
-hidden: true
-
 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. Files licensed under OSL 3.0 must also include the notice "Licensed under the Academic Free License version 3.0" adjacent to the copyright notice.
 
 required:
@@ -15,7 +13,6 @@ permitted:
   - commercial-use
   - modifications
   - distribution
-  - sublicense
   - private-use
   - patent-use
 

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

@@ -1,13 +1,12 @@
 ---
 title: GNU Affero General Public License v3.0
-nickname: GNU Affero GPL v3.0
-tab-slug: agpl-v3
+nickname: GNU AGPLv3
 redirect_from: /licenses/agpl/
-family: GPL
+family: GNU GPL
 variant: true
 source: http://www.gnu.org/licenses/agpl-3.0.txt
 
-description: "The GPL family of licenses is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. The AGPL family of licenses is distinguished from GPLv2 and GPLv3 in that hosted services using the code are considered distribution and trigger the copyleft requirements."
+description: "The GNU GPL family of licenses is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. GNU AGPLv3 is distinguished from GNU GPLv3 in that hosted services using the code are considered distribution and trigger the copyleft requirements."
 
 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.
 
@@ -18,6 +17,7 @@ required:
   - document-changes
   - disclose-source
   - network-use-disclose
+  - same-license
 
 permitted:
   - commercial-use
@@ -28,8 +28,8 @@ permitted:
 
 forbidden:
   - no-liability
-  - no-sublicense
 
+hidden: false
 ---
 
                     GNU AFFERO GENERAL PUBLIC LICENSE

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

@@ -1,6 +1,5 @@
 ---
 title: Apache License 2.0
-nickname: Apache
 redirect_from: /licenses/apache/
 featured: true
 source: http://www.apache.org/licenses/LICENSE-2.0.html
@@ -19,7 +18,6 @@ permitted:
   - commercial-use
   - modifications
   - distribution
-  - sublicense
   - patent-use
   - private-use
 
@@ -27,6 +25,7 @@ forbidden:
   - trademark-use
   - no-liability
 
+hidden: false
 ---
 
                                  Apache License

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

@@ -15,18 +15,19 @@ permitted:
   - commercial-use
   - modifications
   - distribution
-  - sublicense
+  - patent-use
   - private-use
 
 forbidden:
   - no-liability
   - trademark-use
 
+hidden: false
 ---
 
-               The Artistic License 2.0
+		       The Artistic License 2.0
 
-           Copyright (c) [year] [fullname]
+	    Copyright (c) 2000-2006, The Perl Foundation.
 
      Everyone is permitted to copy and distribute verbatim copies
       of this license document, but changing it is not allowed.
@@ -134,16 +135,16 @@ you do at least ONE of the following:
     (c)  allow anyone who receives a copy of the Modified Version to
     make the Source form of the Modified Version available to others
     under
-
-    (i)  the Original License or
-
-    (ii)  a license that permits the licensee to freely copy,
-    modify and redistribute the Modified Version using the same
-    licensing terms that apply to the copy that the licensee
-    received, and requires that the Source form of the Modified
-    Version, and of any works derived from it, be made freely
-    available in that license fees are prohibited but Distributor
-    Fees are allowed.
+		
+	(i)  the Original License or
+
+	(ii)  a license that permits the licensee to freely copy,
+	modify and redistribute the Modified Version using the same
+	licensing terms that apply to the copy that the licensee
+	received, and requires that the Source form of the Modified
+	Version, and of any works derived from it, be made freely
+	available in that license fees are prohibited but Distributor
+	Fees are allowed.
 
 
 Distribution of Compiled Forms of the Standard Version