licensee 9.10.1 → 9.13.2

data/lib/licensee/project_files/readme_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module ProjectFiles
     class ReadmeFile < Licensee::ProjectFiles::LicenseFile
@@ -7,8 +9,8 @@ module Licensee
         /\AREADME\.(#{Regexp.union(EXTENSIONS).source})\z/i => 0.9
       }.freeze
 
-      TITLE_REGEX = /licen[sc]e:?/i
-      UNDERLINE_REGEX = /\n[-=]+/m
+      TITLE_REGEX = /licen[sc]e:?/i.freeze
+      UNDERLINE_REGEX = /\n[-=]+/m.freeze
       CONTENT_REGEX = /^
           (?:                                # Header lookbehind
             [\#=]+\s#{TITLE_REGEX}\s*[\#=]*  # Start of hashes or rdoc header
@@ -25,7 +27,7 @@ module Licensee
           |
             \z                               # End of file
           )
-        /mix
+        /mix.freeze
 
       def possible_matchers
         super.push(Matchers::Reference)

data/lib/licensee/projects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module Projects
     autoload :Project, 'licensee/projects/project'

data/lib/licensee/projects/fs_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Filesystem-based project
 #
 # Analyze a folder on the filesystem for license information
@@ -42,13 +44,18 @@ module Licensee
         end
       end
 
-      # Retrieve a file's content from disk
+      # Retrieve a file's content from disk, enforcing encoding
       #
       # file - the file hash, with the :name key as the file's relative path
       #
       # Returns the file contents as a string
       def load_file(file)
-        File.read dir_path.join(file[:dir], file[:name])
+        content = File.read dir_path.join(file[:dir], file[:name])
+        content.force_encoding(ProjectFiles::ProjectFile::ENCODING)
+
+        return content if content.valid_encoding?
+
+        content.encode(ProjectFiles::ProjectFile::ENCODING, **ProjectFiles::ProjectFile::ENCODING_OPTIONS)
       end
 
       # Returns true if @dir is @root or it's descendant

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,34 +13,40 @@ 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
 
       def commit
         @commit ||= if revision
-          repository.lookup(revision)
-        else
-          repository.last_commit
+                      repository.lookup(revision)
+                    else
+                      repository.last_commit
         end
       end
 

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
@@ -13,7 +15,7 @@ module Licensee
       # If there's any trailing data (e.g. `.git`) this pattern will ignore it:
       # we're going to use the API rather than clone the repo.
       GITHUB_REPO_PATTERN =
-        %r{https://github.com/([^\/]+\/([^\/]+(?=\.git)|[^\/]+)).*}
+        %r{https://github.com/([^\/]+\/([^\/]+(?=\.git)|[^\/]+)).*}.freeze
 
       class RepoNotFound < StandardError; end
 

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
@@ -23,9 +25,9 @@ module Licensee
         return @license if defined? @license
 
         @license = if licenses_without_copyright.count == 1 || lgpl?
-          licenses_without_copyright.first
-        elsif licenses_without_copyright.count > 1
-          Licensee::License.find('other')
+                     licenses_without_copyright.first
+                   elsif licenses_without_copyright.count > 1
+                     Licensee::License.find('other')
         end
       end
 
@@ -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.10.1'.freeze
+  VERSION = '9.13.2'
 end

data/licensee.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/licensee/version', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name    = 'licensee'
+  gem.version = Licensee::VERSION
+
+  gem.summary = 'A Ruby Gem to detect open source project licenses'
+  gem.description = <<-DESC
+    Licensee automates the process of reading LICENSE files and
+    compares their contents to known licenses using a fancy maths.
+  DESC
+
+  gem.authors  = ['Ben Balter']
+  gem.email    = 'ben.balter@github.com'
+  gem.homepage = 'https://github.com/benbalter/licensee'
+  gem.license  = 'MIT'
+
+  gem.bindir = 'bin'
+  gem.executables << 'licensee'
+
+  gem.add_dependency('dotenv', '~> 2.0')
+  gem.add_dependency('octokit', '~> 4.17')
+  gem.add_dependency('reverse_markdown', '~> 1.0')
+  gem.add_dependency('rugged', '~> 0.24')
+  gem.add_dependency('thor', '>= 0.19', '< 2.0')
+
+  gem.add_development_dependency('mustache', '>= 0.9', '< 2.0')
+  gem.add_development_dependency('pry', '~> 0.9')
+  gem.add_development_dependency('rspec', '~> 3.5')
+  gem.add_development_dependency('rubocop', '~> 0.80')
+  gem.add_development_dependency('rubocop-performance', '~> 1.5')
+  gem.add_development_dependency('rubocop-rspec', '~> 1.36')
+  gem.add_development_dependency('simplecov', '~> 0.16')
+  gem.add_development_dependency('webmock', '~> 3.1')
+
+  gem.required_ruby_version = '> 2.3'
+
+  # ensure the gem is built out of versioned files
+  gem.files = Dir[
+    '{bin,lib,man,test,vendor,spec}/**/*',
+    'README*', 'LICENSE*'
+  ] & `git ls-files -z`.split("\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) { [] }
@@ -12,7 +14,7 @@ RSpec.describe 'command line invocation' do
   let(:status) { output[2] }
 
   it 'Returns a zero exit code' do
-    expect(status.exitstatus).to eql(0)
+    expect(status.exitstatus).to be(0)
   end
 
   it 'returns the help text' do

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
+      subject { Licensee.project(path, **options) }
+
+      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 }
+
+      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/bsd-3-noendorseslash/LICENSE

@@ -0,0 +1,30 @@
+Copyright © 2019, Person Person and contributors
+
+All rights reserved.
+
+* * *
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of someorg/foo-bar-baz-quux nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 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
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/spec/fixtures/cc0-cal2013/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/spec/fixtures/cc0-cc/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.