licensee 9.12.0 → 9.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7dc009b0467cfb305e8dac051ed4e78d2f35d0454f2e14cef0952338540f8ae
-  data.tar.gz: 3c27bb3dd3cea6d62fab826b81fab93d9152893851b541c91d69406cdf9fcbd8
+  metadata.gz: 7aeb33320898c7e64f31f6ea15708f4e4c23a6856e10c54e004054ee6997200a
+  data.tar.gz: dcbac4f8b08ff1d55e0ac7de2b603c67ce4f9a2b7d9486fbfccae3fa0dc6d304
 SHA512:
-  metadata.gz: 07f19b33f70b0b73611d34e474f2aa4e4d7f62c7451cdf70f76774beceac2c75ab3d1cc5048061a848b979a54032aad6dd1ba278c79cd798029efd6873d54425
-  data.tar.gz: 96c5e66f65307e7feb2c00b3f06661b093c60995d049f7fd19cc27b76881965a1d33768a16b0a3a3b085e9392ef828dce9cf692ee04255dd9ea2c6d22da38da6
+  metadata.gz: d92bb1d7662b504e92ad6a2fa3f0c8fa23716fa3825715333f8483085a8662d94d61032ec2e4155ae93b9bc0e71627f9e841268e1c7b2229078f13da216d0394
+  data.tar.gz: 364fe3f78e38f703a1e7c9317453b598e4a4bc0b8db773efd4e6e701e7f3a730426698c3a4561e34ba09e839a35a24d4526d87595de31f687a7e83c932bf4ae2

data/bin/licensee

@@ -16,9 +16,9 @@ class LicenseeCLI < Thor
 
   def path
     @path ||= if !options[:remote] || args.first =~ %r{^https://}
-      args.first || Dir.pwd
-    else
-      "https://github.com/#{args.first}"
+                args.first || Dir.pwd
+              else
+                "https://github.com/#{args.first}"
     end
   end
 

data/lib/licensee/commands/detect.rb

@@ -23,11 +23,11 @@ class LicenseeCLI < Thor
 
     rows = []
     rows << if project.license
-      ['License:', project.license.spdx_id]
-    elsif !project.licenses.empty?
-      ['Licenses:', project.licenses.map(&:spdx_id)]
-    else
-      ['License:', set_color('None', :red)]
+              ['License:', project.license.spdx_id]
+            elsif !project.licenses.empty?
+              ['Licenses:', project.licenses.map(&:spdx_id)]
+            else
+              ['License:', set_color('None', :red)]
     end
 
     unless project.matched_files.empty?

data/lib/licensee/content_helper.rb

@@ -8,7 +8,6 @@ module Licensee
     DIGEST = Digest::SHA1
     START_REGEX = /\A\s*/.freeze
     END_OF_TERMS_REGEX = /^[\s#*_]*end of terms and conditions\s*$/i.freeze
-    ALT_TITLE_REGEX = License::ALT_TITLE_REGEX
     REGEXES = {
       hrs:                 /^\s*[=\-\*]{3,}\s*$/,
       all_rights_reserved: /#{START_REGEX}all rights reserved\.?$/i,
@@ -25,6 +24,10 @@ module Licensee
       developed_by:        /#{START_REGEX}developed by:.*?\n\n/im,
       quote_begin:         /[`'"‘“]/,
       quote_end:           /[`'"’”]/,
+      cc_legal_code:       /^\s*Creative Commons Legal Code\s*$/i,
+      cc0_info:            /For more information, please see\s*\S+zero\S+/im,
+      cc0_disclaimer:      /CREATIVE COMMONS CORPORATION.*?\n\n/im,
+      unlicense_info:      /For more information, please.*\S+unlicense\S+/im,
       mit_optional:        /\(including the next paragraph\)/i
     }.freeze
     NORMALIZATIONS = {
@@ -85,9 +88,23 @@ module Licensee
       'owner'           => 'holder'
     }.freeze
     STRIP_METHODS = %i[
-      hrs markdown_headings borders title version url copyright
-      block_markup span_markup link_markup
-      all_rights_reserved developed_by end_of_terms whitespace
+      cc0_optional
+      unlicense_optional
+      hrs
+      markdown_headings
+      borders
+      title
+      version
+      url
+      copyright
+      title
+      block_markup
+      span_markup
+      link_markup
+      all_rights_reserved
+      developed_by
+      end_of_terms
+      whitespace
       mit_optional
     ].freeze
 
@@ -106,7 +123,8 @@ module Licensee
     # Number of characters that could be added/removed to still be
     # considered a potential match
     def max_delta
-      @max_delta ||= (length * Licensee.inverse_confidence_threshold).to_i
+      @max_delta ||= fields_normalized.size * 10 +
+                     (length * Licensee.inverse_confidence_threshold).to_i
     end
 
     # Given another license or project file, calculates the difference in length
@@ -117,10 +135,9 @@ module Licensee
     # Given another license or project file, calculates the similarity
     # as a percentage of words in common
     def similarity(other)
-      wordset_fieldless = wordset - LicenseField.keys
-      fields_removed = wordset.size - wordset_fieldless.size
       overlap = (wordset_fieldless & other.wordset).size
-      total = wordset_fieldless.size + other.wordset.size - fields_removed
+      total = wordset_fieldless.size + other.wordset.size -
+              fields_normalized_set.size
       100.0 * (overlap * 2.0 / total)
     end
 
@@ -254,6 +271,20 @@ module Licensee
       strip(regex) while _content =~ regex
     end
 
+    def strip_cc0_optional
+      return unless _content.include? 'associating cc0'
+
+      strip(REGEXES[:cc_legal_code])
+      strip(REGEXES[:cc0_info])
+      strip(REGEXES[:cc0_disclaimer])
+    end
+
+    def strip_unlicense_optional
+      return unless _content.include? 'unlicense'
+
+      strip(REGEXES[:unlicense_info])
+    end
+
     def strip_end_of_terms
       body, _partition, _instructions = _content.partition(END_OF_TERMS_REGEX)
       @_content = body
@@ -296,5 +327,19 @@ module Licensee
       normalize(REGEXES[:bullet], "\n\n* ")
       normalize(/\)\s+\(/, ')(')
     end
+
+    def wordset_fieldless
+      @wordset_fieldless ||= wordset - fields_normalized_set
+    end
+
+    # Returns an array of strings of substitutable fields in normalized content
+    def fields_normalized
+      @fields_normalized ||=
+        content_normalized.scan(LicenseField::FIELD_REGEX).flatten
+    end
+
+    def fields_normalized_set
+      @fields_normalized_set ||= fields_normalized.to_set
+    end
   end
 end

data/lib/licensee/hash_helper.rb

@@ -8,11 +8,11 @@ module Licensee
         key = method.to_s.delete('?').to_sym
         value = public_send(method)
         hash[key] = if value.is_a?(Array)
-          value.map { |v| v.respond_to?(:to_h) ? v.to_h : v }
-        elsif value.respond_to?(:to_h) && !value.nil?
-          value.to_h
-        else
-          value
+                      value.map { |v| v.respond_to?(:to_h) ? v.to_h : v }
+                    elsif value.respond_to?(:to_h) && !value.nil?
+                      value.to_h
+                    else
+                      value
         end
       end
 

data/lib/licensee/license.rb

@@ -92,12 +92,6 @@ module Licensee
       pseudo:   true
     }.freeze
 
-    ALT_TITLE_REGEX = {
-      'bsd-2-clause'       => /bsd 2-clause(?: \"simplified\")?/i,
-      'bsd-3-clause'       => /bsd 3-clause(?: \"new\" or \"revised\")?/i,
-      'bsd-3-clause-clear' => /(?:clear bsd|bsd 3-clause(?: clear)?)/i
-    }.freeze
-
     SOURCE_PREFIX = %r{https?://(?:www\.)?}i.freeze
     SOURCE_SUFFIX = %r{(?:\.html?|\.txt|\/)(?:\?[^\s]*)?}i.freeze
 
@@ -144,20 +138,22 @@ module Licensee
     def title_regex
       return @title_regex if defined? @title_regex
 
-      title_regex = ALT_TITLE_REGEX[key]
-      title_regex ||= begin
-        string = name.downcase.sub('*', 'u')
-        string.sub!(/\Athe /i, '')
-        string.sub!(/,? version /, ' ')
-        string.sub!(/v(\d+\.\d+)/, '\1')
-        string = Regexp.escape(string)
-        string = string.sub(/\\ licen[sc]e/i, '(?:\ licen[sc]e)?')
-        string = string.sub(/\\ (\d+\\.\d+)/, ',?\s+(?:version\ |v(?:\. )?)?\1')
-        string = string.sub(/\bgnu\\ /, '(?:GNU )?')
-        Regexp.new string, 'i'
-      end
-
-      parts = [title_regex, key]
+      string = name.downcase.sub('*', 'u')
+      string.sub!(/\Athe /i, '')
+      string.sub!(/,? version /, ' ')
+      string.sub!(/v(\d+\.\d+)/, '\1')
+      string = Regexp.escape(string)
+      string = string.sub(/\\ licen[sc]e/i, '(?:\ licen[sc]e)?')
+      string = string.sub(/\\ (\d+\\.\d+)/, ',?\s+(?:version\ |v(?:\. )?)?\1')
+      string = string.sub(/\bgnu\\ /, '(?:GNU )?')
+      title_regex = Regexp.new string, 'i'
+
+      string = key.sub('-', '[- ]')
+      string.sub!('.', '\.')
+      string << '(?:\ licen[sc]e)?'
+      key_regex = Regexp.new string, 'i'
+
+      parts = [title_regex, key_regex]
       if meta.nickname
         parts.push Regexp.new meta.nickname.sub(/\bGNU /i, '(?:GNU )?')
       end

data/lib/licensee/matchers/dice.rb

@@ -7,9 +7,9 @@ module Licensee
       # than the confidence threshold
       def match
         @match ||= if matches.empty?
-          nil
-        else
-          matches.first[0]
+                     nil
+                   else
+                     matches.first[0]
         end
       end
 

data/lib/licensee/projects/git_project.rb

@@ -44,9 +44,9 @@ module Licensee
 
       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/project.rb

@@ -25,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
 

data/lib/licensee/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Licensee
-  VERSION = '9.12.0'
+  VERSION = '9.13.0'
 end

data/licensee.gemspec

@@ -0,0 +1,47 @@
+# 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.8')
+  gem.add_dependency('reverse_markdown', '~> 1.0')
+  gem.add_dependency('rugged', '~> 0.24')
+  gem.add_dependency('thor', '~> 0.19')
+
+  gem.add_development_dependency('mustache', '>= 0.9', '< 2.0')
+  gem.add_development_dependency('pry', '~> 0.9')
+  gem.add_development_dependency('rake', '~> 10.3')
+  gem.add_development_dependency('rspec', '~> 3.5')
+  gem.add_development_dependency('rubocop', '~> 0.76')
+  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[
+    'Rakefile',
+    '{bin,lib,man,test,vendor,spec}/**/*',
+    'README*', 'LICENSE*'
+  ] & `git ls-files -z`.split("\0")
+end

data/spec/bin_spec.rb

@@ -14,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

@@ -5,6 +5,8 @@ RSpec.describe 'fixture test' do
     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') }
@@ -12,8 +14,6 @@ RSpec.describe 'fixture test' do
       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')
@@ -24,9 +24,9 @@ RSpec.describe 'fixture test' do
 
       it 'detects the license' do
         expected = if expectations['key']
-          Licensee::License.find(expectations['key'])
-        else
-          none
+                     Licensee::License.find(expectations['key'])
+                   else
+                     none
         end
 
         expect(subject.license).to eql(expected)

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/>