licensee 9.11.0 → 9.12.0

data/lib/licensee/projects/git_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Git-based project
 #
 # Analyze a given (bare) Git repository for license information
@@ -11,25 +13,31 @@ autoload :Rugged, 'rugged'
 module Licensee
   module Projects
     class GitProject < Licensee::Projects::Project
-      attr_reader :repository, :revision
+      attr_reader :revision
 
       class InvalidRepository < ArgumentError; end
 
       def initialize(repo, revision: nil, **args)
-        @repository = if repo.is_a? Rugged::Repository
-          repo
-        else
-          Rugged::Repository.new(repo)
-        end
-
+        @raw_repo = repo
         @revision = revision
+
+        raise InvalidRepository if repository.head_unborn?
+
         super(**args)
+      end
+
+      def repository
+        @repository ||= begin
+          return @raw_repo if @raw_repo.is_a? Rugged::Repository
+
+          Rugged::Repository.new(@raw_repo)
+        end
       rescue Rugged::OSError, Rugged::RepositoryError
         raise InvalidRepository
       end
 
       def close
-        @repository.close
+        repository.close
       end
 
       private

data/lib/licensee/projects/github_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # GitHub project
 #
 # Analyses a remote GitHub repository for license information

data/lib/licensee/projects/project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Licensee::Project represents an open source project on disk
 # It is not used directly, but rather is extended by FSProject and GitProject
 # depending on the type of file system access available
@@ -113,7 +115,7 @@ module Licensee
         return [] if files.empty? || files.nil?
 
         found = files.map { |file| file.merge(score: yield(file[:name])) }
-        found.select! { |file| file[:score] > 0 }
+        found.select! { |file| file[:score].positive? }
         found.sort { |a, b| b[:score] <=> a[:score] }
       end
 
@@ -137,7 +139,7 @@ module Licensee
       # Returns an array of LicenseFiles with LPGL first
       def prioritize_lgpl(files)
         return files if files.empty?
-        return files unless files.first.license && files.first.license.gpl?
+        return files unless files.first.license&.gpl?
 
         lesser = files.find_index(&:lgpl?)
         files.unshift(files.delete_at(lesser)) if lesser

data/lib/licensee/rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   class Rule
     attr_reader :tag, :label, :description, :group

data/lib/licensee/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
-  VERSION = '9.11.0'.freeze
+  VERSION = '9.12.0'
 end

data/spec/bin_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe 'command line invocation' do
   let(:command) { ['bundle', 'exec', 'bin/licensee', 'help'] }
   let(:arguments) { [] }

data/spec/fixture_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+RSpec.describe 'fixture test' do
+  fixtures.each do |fixture|
+    let(:options) { { detect_packages: true, detect_readme: true } }
+
+    context "the #{fixture} fixture" do
+      let(:path) { fixture_path(fixture) }
+      let(:other) { Licensee::License.find('other') }
+      let(:none) { Licensee::License.find('none') }
+      let(:expectations) { fixture_licenses[fixture] || {} }
+      let(:license_file) { subject.license_file }
+      let(:matcher) { license_file&.matcher }
+
+      subject { Licensee.project(path, options) }
+
+      it 'has an expected license in fixtures-licenses.yml' do
+        msg = 'Expected an entry in `'.dup
+        msg << fixture_path('fixtures-licenses.yml')
+        msg << "` for the `#{fixture}` fixture. Please run "
+        msg << 'script/dump-fixture-licenses and confirm the output.'
+        expect(fixture_licenses).to have_key(fixture), msg
+      end
+
+      it 'detects the license' do
+        expected = if expectations['key']
+          Licensee::License.find(expectations['key'])
+        else
+          none
+        end
+
+        expect(subject.license).to eql(expected)
+      end
+
+      it 'returns the expected hash' do
+        hash = license_file ? license_file.content_hash : nil
+        expect(hash).to eql(expectations['hash'])
+      end
+
+      it 'uses the expected matcher' do
+        expected = matcher ? matcher.name.to_s : nil
+        expect(expected).to eql(expectations['matcher'])
+      end
+    end
+  end
+end

data/spec/fixtures/detect.json

@@ -94,18 +94,20 @@
         "name": "exact",
         "confidence": 100
       },
-      "matched_license": "MIT"
+      "matched_license": "MIT",
+      "attribution": "Copyright (c) 2014-2017 Ben Balter"
     },
     {
       "filename": "licensee.gemspec",
-      "content": "require File.expand_path('lib/licensee/version', __dir__)\n\nGem::Specification.new do |gem|\n  gem.name    = 'licensee'\n  gem.version = Licensee::VERSION\n\n  gem.summary = 'A Ruby Gem to detect open source project licenses'\n  gem.description = <<-DESC\n    Licensee automates the process of reading LICENSE files and\n    compares their contents to known licenses using a fancy maths.\n  DESC\n\n  gem.authors  = ['Ben Balter']\n  gem.email    = 'ben.balter@github.com'\n  gem.homepage = 'https://github.com/benbalter/licensee'\n  gem.license  = 'MIT'\n\n  gem.bindir = 'bin'\n  gem.executables << 'licensee'\n\n  gem.add_dependency('dotenv', '~> 2.0')\n  gem.add_dependency('octokit', '~> 4.8.0')\n  gem.add_dependency('rugged', '~> 0.24')\n  gem.add_dependency('thor', '~> 0.19')\n\n  gem.add_development_dependency('coveralls', '~> 0.8')\n  gem.add_development_dependency('mustache', '>= 0.9', '< 2.0')\n  gem.add_development_dependency('pry', '~> 0.9')\n  gem.add_development_dependency('rake', '~> 10.3')\n  gem.add_development_dependency('rspec', '~> 3.5')\n  gem.add_development_dependency('rubocop', '~> 0.49')\n  gem.add_development_dependency('webmock', '~> 3.1')\n\n  gem.required_ruby_version = '> 2.2'\n\n  # ensure the gem is built out of versioned files\n  gem.files = Dir[\n    'Rakefile',\n    '{bin,lib,man,test,vendor,spec}/**/*',\n    'README*', 'LICENSE*'\n  ] & `git ls-files -z`.split(\"\\0\")\nend\n",
+      "content": "# frozen_string_literal: true\n\nrequire File.expand_path('lib/licensee/version', __dir__)\n\nGem::Specification.new do |gem|\n  gem.name    = 'licensee'\n  gem.version = Licensee::VERSION\n\n  gem.summary = 'A Ruby Gem to detect open source project licenses'\n  gem.description = <<-DESC\n    Licensee automates the process of reading LICENSE files and\n    compares their contents to known licenses using a fancy maths.\n  DESC\n\n  gem.authors  = ['Ben Balter']\n  gem.email    = 'ben.balter@github.com'\n  gem.homepage = 'https://github.com/benbalter/licensee'\n  gem.license  = 'MIT'\n\n  gem.bindir = 'bin'\n  gem.executables << 'licensee'\n\n  gem.add_dependency('dotenv', '~> 2.0')\n  gem.add_dependency('octokit', '~> 4.8')\n  gem.add_dependency('reverse_markdown', '~> 1.0')\n  gem.add_dependency('rugged', '~> 0.24')\n  gem.add_dependency('thor', '~> 0.19')\n\n  gem.add_development_dependency('mustache', '>= 0.9', '< 2.0')\n  gem.add_development_dependency('pry', '~> 0.9')\n  gem.add_development_dependency('rake', '~> 10.3')\n  gem.add_development_dependency('rspec', '~> 3.5')\n  gem.add_development_dependency('rubocop', '~> 0.69')\n  gem.add_development_dependency('simplecov', '~> 0.16')\n  gem.add_development_dependency('webmock', '~> 3.1')\n\n  gem.required_ruby_version = '> 2.3'\n\n  # ensure the gem is built out of versioned files\n  gem.files = Dir[\n    'Rakefile',\n    '{bin,lib,man,test,vendor,spec}/**/*',\n    'README*', 'LICENSE*'\n  ] & `git ls-files -z`.split(\"\\0\")\nend\n",
       "content_hash": null,
       "content_normalized": null,
       "matcher": {
         "name": "gemspec",
         "confidence": 90
       },
-      "matched_license": "MIT"
+      "matched_license": "MIT",
+      "attribution": null
     }
   ]
-}
+}

data/spec/fixtures/fixtures.yml

@@ -0,0 +1,110 @@
+# Map of fixtures to expectation as an added integration test
+---
+apache-with-readme-notice:
+  key: apache-2.0
+  matcher: exact
+  hash: ab3901051663cb8ee5dea9ebdff406ad136910e3
+bsd-3-lists:
+  key: bsd-3-clause
+  matcher: 
+  hash: 
+bsd-plus-patents:
+  key: other
+  matcher: 
+  hash: 
+bsl:
+  key: bsl-1.0
+  matcher: exact
+  hash: ca8f916d00c234719956e932061f192abb2d5bf9
+case-sensitive:
+  key: other
+  matcher: 
+  hash: da39a3ee5e6b4b0d3255bfef95601890afd80709
+cc-by-nc-sa:
+  key: other
+  matcher: 
+  hash: 5327932ea9cfee2d8d1ab7d5e088e868413eadea
+cc-by-nd:
+  key: other
+  matcher: 
+  hash: a75ef554ca6941d195bbc1197f934d43a75b312d
+copyright-encoding:
+  key: no-license
+  matcher: copyright
+  hash: da39a3ee5e6b4b0d3255bfef95601890afd80709
+crlf-license:
+  key: gpl-3.0
+  matcher: exact
+  hash: b22f1b1f953a38a8a11686587b98831858d6468b
+description-license:
+  key: other
+  matcher: 
+  hash: ab0fb718684bbc67c7dfc2e9ab2175dab4fcb819
+fcpl-modified-mpl:
+  key: other
+  matcher: 
+  hash: '06942321efd22b697fc4600bf68c0b6b3399cb12'
+gemspec:
+  key: 
+  matcher: 
+  hash: 
+gpl3-without-instructions:
+  key: gpl-3.0
+  matcher: exact
+  hash: b22f1b1f953a38a8a11686587b98831858d6468b
+html:
+  key: epl-1.0
+  matcher: dice
+  hash: 5265922b5943810a3ad23c66c50a0828ba342bfd
+lgpl:
+  key: lgpl-3.0
+  matcher: exact
+  hash: bdb3c042bd84f914eacfbe4977c5e58352745809
+license-folder:
+  key: 
+  matcher: 
+  hash: 
+license-in-parent-folder:
+  key: mit
+  matcher: exact
+  hash: d64f3bb4282a97b37454b5bb96a8a264a3363dc3
+license-with-readme-reference:
+  key: mit
+  matcher: exact
+  hash: d64f3bb4282a97b37454b5bb96a8a264a3363dc3
+markdown-gpl:
+  key: gpl-2.0
+  matcher: dice
+  hash: a0de4ee2a7e6ef2c2f6283b09cc755af5de5a5cb
+mit:
+  key: mit
+  matcher: exact
+  hash: d64f3bb4282a97b37454b5bb96a8a264a3363dc3
+mit-optional:
+  key: mit
+  matcher: exact
+  hash: d64f3bb4282a97b37454b5bb96a8a264a3363dc3
+mit-with-copyright:
+  key: mit
+  matcher: 
+  hash: 
+mpl-without-hrs:
+  key: mpl-2.0
+  matcher: exact
+  hash: b4db668fa7573bfdcae74eb51eafc961034f0a61
+multiple-license-files:
+  key: other
+  matcher: 
+  hash: 
+readme:
+  key: mit
+  matcher: 
+  hash: 
+webmock:
+  key: 
+  matcher: 
+  hash: 
+wrk-modified-apache:
+  key: other
+  matcher: 
+  hash: e733ea59fcc053841df5a1a3574a298d9ee3635e

data/spec/fixtures/html/license.html

@@ -0,0 +1,262 @@
+
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+<title>Eclipse Public License - Version 1.0</title>
+<style type="text/css">
+  body {
+    size: 8.5in 11.0in;
+    margin: 0.25in 0.5in 0.25in 0.5in;
+    tab-interval: 0.5in;
+    }
+  p {
+    margin-left: auto;
+    margin-top:  0.5em;
+    margin-bottom: 0.5em;
+    }
+  p.list {
+  	margin-left: 0.5in;
+    margin-top:  0.05em;
+    margin-bottom: 0.05em;
+    }
+  </style>
+
+</head>
+
+<body lang="EN-US">
+
+<h2>Eclipse Public License - v 1.0</h2>
+
+<p>THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+PUBLIC LICENSE (&quot;AGREEMENT&quot;). ANY USE, REPRODUCTION OR
+DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS
+AGREEMENT.</p>
+
+<p><b>1. DEFINITIONS</b></p>
+
+<p>&quot;Contribution&quot; means:</p>
+
+<p class="list">a) in the case of the initial Contributor, the initial
+code and documentation distributed under this Agreement, and</p>
+<p class="list">b) in the case of each subsequent Contributor:</p>
+<p class="list">i) changes to the Program, and</p>
+<p class="list">ii) additions to the Program;</p>
+<p class="list">where such changes and/or additions to the Program
+originate from and are distributed by that particular Contributor. A
+Contribution 'originates' from a Contributor if it was added to the
+Program by such Contributor itself or anyone acting on such
+Contributor's behalf. Contributions do not include additions to the
+Program which: (i) are separate modules of software distributed in
+conjunction with the Program under their own license agreement, and (ii)
+are not derivative works of the Program.</p>
+
+<p>&quot;Contributor&quot; means any person or entity that distributes
+the Program.</p>
+
+<p>&quot;Licensed Patents&quot; mean patent claims licensable by a
+Contributor which are necessarily infringed by the use or sale of its
+Contribution alone or when combined with the Program.</p>
+
+<p>&quot;Program&quot; means the Contributions distributed in accordance
+with this Agreement.</p>
+
+<p>&quot;Recipient&quot; means anyone who receives the Program under
+this Agreement, including all Contributors.</p>
+
+<p><b>2. GRANT OF RIGHTS</b></p>
+
+<p class="list">a) Subject to the terms of this Agreement, each
+Contributor hereby grants Recipient a non-exclusive, worldwide,
+royalty-free copyright license to reproduce, prepare derivative works
+of, publicly display, publicly perform, distribute and sublicense the
+Contribution of such Contributor, if any, and such derivative works, in
+source code and object code form.</p>
+
+<p class="list">b) Subject to the terms of this Agreement, each
+Contributor hereby grants Recipient a non-exclusive, worldwide,
+royalty-free patent license under Licensed Patents to make, use, sell,
+offer to sell, import and otherwise transfer the Contribution of such
+Contributor, if any, in source code and object code form. This patent
+license shall apply to the combination of the Contribution and the
+Program if, at the time the Contribution is added by the Contributor,
+such addition of the Contribution causes such combination to be covered
+by the Licensed Patents. The patent license shall not apply to any other
+combinations which include the Contribution. No hardware per se is
+licensed hereunder.</p>
+
+<p class="list">c) Recipient understands that although each Contributor
+grants the licenses to its Contributions set forth herein, no assurances
+are provided by any Contributor that the Program does not infringe the
+patent or other intellectual property rights of any other entity. Each
+Contributor disclaims any liability to Recipient for claims brought by
+any other entity based on infringement of intellectual property rights
+or otherwise. As a condition to exercising the rights and licenses
+granted hereunder, each Recipient hereby assumes sole responsibility to
+secure any other intellectual property rights needed, if any. For
+example, if a third party patent license is required to allow Recipient
+to distribute the Program, it is Recipient's responsibility to acquire
+that license before distributing the Program.</p>
+
+<p class="list">d) Each Contributor represents that to its knowledge it
+has sufficient copyright rights in its Contribution, if any, to grant
+the copyright license set forth in this Agreement.</p>
+
+<p><b>3. REQUIREMENTS</b></p>
+
+<p>A Contributor may choose to distribute the Program in object code
+form under its own license agreement, provided that:</p>
+
+<p class="list">a) it complies with the terms and conditions of this
+Agreement; and</p>
+
+<p class="list">b) its license agreement:</p>
+
+<p class="list">i) effectively disclaims on behalf of all Contributors
+all warranties and conditions, express and implied, including warranties
+or conditions of title and non-infringement, and implied warranties or
+conditions of merchantability and fitness for a particular purpose;</p>
+
+<p class="list">ii) effectively excludes on behalf of all Contributors
+all liability for damages, including direct, indirect, special,
+incidental and consequential damages, such as lost profits;</p>
+
+<p class="list">iii) states that any provisions which differ from this
+Agreement are offered by that Contributor alone and not by any other
+party; and</p>
+
+<p class="list">iv) states that source code for the Program is available
+from such Contributor, and informs licensees how to obtain it in a
+reasonable manner on or through a medium customarily used for software
+exchange.</p>
+
+<p>When the Program is made available in source code form:</p>
+
+<p class="list">a) it must be made available under this Agreement; and</p>
+
+<p class="list">b) a copy of this Agreement must be included with each
+copy of the Program.</p>
+
+<p>Contributors may not remove or alter any copyright notices contained
+within the Program.</p>
+
+<p>Each Contributor must identify itself as the originator of its
+Contribution, if any, in a manner that reasonably allows subsequent
+Recipients to identify the originator of the Contribution.</p>
+
+<p><b>4. COMMERCIAL DISTRIBUTION</b></p>
+
+<p>Commercial distributors of software may accept certain
+responsibilities with respect to end users, business partners and the
+like. While this license is intended to facilitate the commercial use of
+the Program, the Contributor who includes the Program in a commercial
+product offering should do so in a manner which does not create
+potential liability for other Contributors. Therefore, if a Contributor
+includes the Program in a commercial product offering, such Contributor
+(&quot;Commercial Contributor&quot;) hereby agrees to defend and
+indemnify every other Contributor (&quot;Indemnified Contributor&quot;)
+against any losses, damages and costs (collectively &quot;Losses&quot;)
+arising from claims, lawsuits and other legal actions brought by a third
+party against the Indemnified Contributor to the extent caused by the
+acts or omissions of such Commercial Contributor in connection with its
+distribution of the Program in a commercial product offering. The
+obligations in this section do not apply to any claims or Losses
+relating to any actual or alleged intellectual property infringement. In
+order to qualify, an Indemnified Contributor must: a) promptly notify
+the Commercial Contributor in writing of such claim, and b) allow the
+Commercial Contributor to control, and cooperate with the Commercial
+Contributor in, the defense and any related settlement negotiations. The
+Indemnified Contributor may participate in any such claim at its own
+expense.</p>
+
+<p>For example, a Contributor might include the Program in a commercial
+product offering, Product X. That Contributor is then a Commercial
+Contributor. If that Commercial Contributor then makes performance
+claims, or offers warranties related to Product X, those performance
+claims and warranties are such Commercial Contributor's responsibility
+alone. Under this section, the Commercial Contributor would have to
+defend claims against the other Contributors related to those
+performance claims and warranties, and if a court requires any other
+Contributor to pay any damages as a result, the Commercial Contributor
+must pay those damages.</p>
+
+<p><b>5. NO WARRANTY</b></p>
+
+<p>EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
+PROVIDED ON AN &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS
+OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION,
+ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY
+OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
+responsible for determining the appropriateness of using and
+distributing the Program and assumes all risks associated with its
+exercise of rights under this Agreement , including but not limited to
+the risks and costs of program errors, compliance with applicable laws,
+damage to or loss of data, programs or equipment, and unavailability or
+interruption of operations.</p>
+
+<p><b>6. DISCLAIMER OF LIABILITY</b></p>
+
+<p>EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT
+NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING
+WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR
+DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
+HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
+
+<p><b>7. GENERAL</b></p>
+
+<p>If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this Agreement, and without further action
+by the parties hereto, such provision shall be reformed to the minimum
+extent necessary to make such provision valid and enforceable.</p>
+
+<p>If Recipient institutes patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that the
+Program itself (excluding combinations of the Program with other
+software or hardware) infringes such Recipient's patent(s), then such
+Recipient's rights granted under Section 2(b) shall terminate as of the
+date such litigation is filed.</p>
+
+<p>All Recipient's rights under this Agreement shall terminate if it
+fails to comply with any of the material terms or conditions of this
+Agreement and does not cure such failure in a reasonable period of time
+after becoming aware of such noncompliance. If all Recipient's rights
+under this Agreement terminate, Recipient agrees to cease use and
+distribution of the Program as soon as reasonably practicable. However,
+Recipient's obligations under this Agreement and any licenses granted by
+Recipient relating to the Program shall continue and survive.</p>
+
+<p>Everyone is permitted to copy and distribute copies of this
+Agreement, but in order to avoid inconsistency the Agreement is
+copyrighted and may only be modified in the following manner. The
+Agreement Steward reserves the right to publish new versions (including
+revisions) of this Agreement from time to time. No one other than the
+Agreement Steward has the right to modify this Agreement. The Eclipse
+Foundation is the initial Agreement Steward. The Eclipse Foundation may
+assign the responsibility to serve as the Agreement Steward to a
+suitable separate entity. Each new version of the Agreement will be
+given a distinguishing version number. The Program (including
+Contributions) may always be distributed subject to the version of the
+Agreement under which it was received. In addition, after a new version
+of the Agreement is published, Contributor may elect to distribute the
+Program (including its Contributions) under the new version. Except as
+expressly stated in Sections 2(a) and 2(b) above, Recipient receives no
+rights or licenses to the intellectual property of any Contributor under
+this Agreement, whether expressly, by implication, estoppel or
+otherwise. All rights in the Program not expressly granted under this
+Agreement are reserved.</p>
+
+<p>This Agreement is governed by the laws of the State of New York and
+the intellectual property laws of the United States of America. No party
+to this Agreement will bring a legal action under this Agreement more
+than one year after the cause of action arose. Each party waives its
+rights to a jury trial in any resulting litigation.</p>
+
+</body>
+
+</html>