licensee 9.15.3 → 9.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b54db113cb4f1c4933826886afe3ed5e4b66d757a97df74dc43dbb2f8d6bc7
-  data.tar.gz: 72fa1baf7073bfb9132823d1953977ab49618d03320694647d6947b66aee311f
+  metadata.gz: 4f5ee0aef5bea7c09d85b5fe00cde34590331108dea73bede502928d3e863809
+  data.tar.gz: 4ce51466168c4b9aaf354ffe897f6727e598cc534aadff4846f028a2a66dff7c
 SHA512:
-  metadata.gz: 461a7ed0479855f6e2c08353ee902b2b8f53661d24161ef22f6c7dbb0f9db1ee375f6fc4e196d1c266cd5830221525af471c9158b64891fa4b0b0b7b373e6eac
-  data.tar.gz: '09bfdd2cb1d12bd2b4a32bad1de90c65058d9ab1f3ed98ccb94ed9657b8965e236d4be84ce32e7801edf071de3ca7154d34455bfa749d29b1d89d9030c9a0ca4'
+  metadata.gz: 314636d52fd93d47a39b9b9835fe3b305735fc84be5767f1ab31a6bb0f933abb0e837d7bb9c4cb20ce64be0bcb0e2043adbce964b09dfc05776d955e6a089012
+  data.tar.gz: 308beab7147f0e4f5f8f16c70533e899c5106b30245544d0d27cea2727d28a929e5b328031dd1658be998da04b477e2adc6c5e3f0686cfbe8d2cd05fb93eca25

data/bin/licensee

@@ -12,6 +12,10 @@ class LicenseeCLI < Thor
   class_option :remote, type: :boolean, desc: 'Assume PATH is a GitHub owner/repo path'
   default_task :detect
 
+  def self.exit_on_failure?
+    true
+  end
+
   private
 
   def path
@@ -33,6 +37,6 @@ class LicenseeCLI < Thor
 end
 
 commands_dir = File.expand_path '../lib/licensee/commands/', __dir__
-Dir["#{commands_dir}/*.rb"].sort.each { |c| require(c) }
+Dir["#{commands_dir}/*.rb"].each { |c| require(c) }
 
 LicenseeCLI.start(ARGV)

data/lib/licensee/commands/license_path.rb

@@ -2,15 +2,15 @@
 
 class LicenseeCLI < Thor
   desc 'license-path [PATH]', "Returns the path to the given project's license file"
-  def license_path(_path)
-    if project.license_file
-      if remote?
-        say project.license_file.path
-      else
-        say File.expand_path project.license_file.path
-      end
+  def license_path(path)
+    project = Licensee.project(path)
+
+    exit 1 unless project.license_file
+
+    if remote?
+      say project.license_file.path
     else
-      exit 1
+      say File.expand_path(project.license_file.path, path)
     end
   end
 end

data/lib/licensee/content_helper.rb

@@ -6,8 +6,8 @@ require 'digest'
 module Licensee
   module ContentHelper
     DIGEST = Digest::SHA1
-    START_REGEX = /\A\s*/.freeze
-    END_OF_TERMS_REGEX = /^[\s#*_]*end of (the )?terms and conditions[\s#*_]*$/i.freeze
+    START_REGEX = /\A\s*/
+    END_OF_TERMS_REGEX = /^[\s#*_]*end of (the )?terms and conditions[\s#*_]*$/i
     REGEXES = {
       bom:                 /#{START_REGEX}\xEF\xBB\xBF/,
       hrs:                 /^\s*[=\-*]{3,}\s*$/,
@@ -32,11 +32,12 @@ module Licensee
       mit_optional:        /\(including the next paragraph\)/i
     }.freeze
     NORMALIZATIONS = {
-      lists:      { from: /^\s*(?:\d\.|\*)\s+([^\n])/, to: '- \1' },
+      lists:      { from: /^\s*(?:\d\.|[*-])(?: [*_]{0,2}\(?[\da-z]\)[*_]{0,2})?\s+([^\n])/, to: '- \1' },
       https:      { from: /http:/, to: 'https:' },
       ampersands: { from: '&', to: 'and' },
       dashes:     { from: /(?<!^)([—–-]+)(?!$)/, to: '-' },
-      quote:      { from: /[`'"‘“’”]/, to: "'" }
+      quote:      { from: /[`'"‘“’”]/, to: "'" },
+      hyphenated: { from: /(\w+)-\s*\n\s*(\w+)/, to: '\1-\2' }
     }.freeze
 
     # Legally equivalent words that schould be ignored for comparison
@@ -82,8 +83,8 @@ module Licensee
       'whilst'          => 'while',
       'wilful'          => 'wilfull',
       'non-commercial'  => 'noncommercial',
-      'cent'            => 'percent',
-      'owner'           => 'holder'
+      'per cent'        => 'percent',
+      'copyright owner' => 'copyright holder'
     }.freeze
     STRIP_METHODS = %i[
       bom
@@ -303,8 +304,8 @@ module Licensee
 
       if operation
         @_content = _content.gsub operation[:from], operation[:to]
-      elsif respond_to?("normalize_#{from_or_key}", true)
-        send("normalize_#{from_or_key}")
+      elsif respond_to?(:"normalize_#{from_or_key}", true)
+        send(:"normalize_#{from_or_key}")
       else
         raise ArgumentError, "#{from_or_key} is an invalid normalization"
       end
@@ -341,7 +342,7 @@ module Licensee
       # Use that if it's present, otherwise, just return the simple delta.
       return delta unless respond_to?(:spdx_alt_segments, true)
 
-      adjusted_delta = delta - ([fields_normalized.size, spdx_alt_segments].max * 4)
+      adjusted_delta = delta - ([fields_normalized.size, spdx_alt_segments].max * 5)
       adjusted_delta.positive? ? adjusted_delta : 0
     end
   end

data/lib/licensee/license.rb

@@ -74,7 +74,7 @@ module Licensee
       end
 
       def keys_licenses(options = {})
-        @keys_licenses[options] ||= all(options).map { |l| [l.key, l] }.to_h
+        @keys_licenses[options] ||= all(options).to_h { |l| [l.key, l] }
       end
     end
 
@@ -98,8 +98,8 @@ module Licensee
       pseudo:   true
     }.freeze
 
-    SOURCE_PREFIX = %r{https?://(?:www\.)?}i.freeze
-    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|/)(?:\?[^\s]*)?}i.freeze
+    SOURCE_PREFIX = %r{https?://(?:www\.)?}i
+    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|/)(?:\?[^\s]*)?}i
 
     HASH_METHODS = %i[
       key spdx_id meta url rules fields other? gpl? lgpl? cc?
@@ -151,7 +151,15 @@ module Licensee
       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')
+      version_match = string.match(/\d+\\.(\d+)/)
+      if version_match
+        vsub = if version_match[1] == '0'
+                 ',?\s+(?:version\ |v(?:\. )?)?\1(\2)?'
+               else
+                 ',?\s+(?:version\ |v(?:\. )?)?\1\2'
+               end
+        string = string.sub(/\\ (\d+)(\\.\d+)/, vsub)
+      end
       string = string.sub(/\bgnu\\ /, '(?:GNU )?')
       title_regex = Regexp.new string, 'i'
 

data/lib/licensee/license_field.rb

@@ -22,7 +22,7 @@ module Licensee
         @all ||= begin
           path   = '../../vendor/choosealicense.com/_data/fields.yml'
           path   = File.expand_path path, __dir__
-          fields = YAML.safe_load File.read(path)
+          fields = YAML.safe_load_file(path)
           fields.map { |field| LicenseField.from_hash(field) }
         end
       end
@@ -47,7 +47,7 @@ module Licensee
     end
 
     alias key name
-    FIELD_REGEX = /\[(#{Regexp.union(LicenseField.keys)})\]/.freeze
+    FIELD_REGEX = /\[(#{Regexp.union(LicenseField.keys)})\]/
 
     # The human-readable field name
     def label

data/lib/licensee/license_meta.rb

@@ -43,12 +43,12 @@ module Licensee
 
       # Array of symbolized helper methods to expose on the License class
       def helper_methods
-        members - PREDICATE_FIELDS + PREDICATE_FIELDS.map { |f| "#{f}?".to_sym }
+        members - PREDICATE_FIELDS + PREDICATE_FIELDS.map { |f| :"#{f}?" }
       end
     end
 
     PREDICATE_FIELDS.each do |field|
-      alias_method "#{field}?".to_sym, field
+      alias_method :"#{field}?", field
     end
 
     # Backward compatibalize `#["spdx-id"]` calls to avoid a breaking change

data/lib/licensee/matchers/cabal.rb

@@ -5,7 +5,7 @@ module Licensee
     class Cabal < Licensee::Matchers::Package
       # While we could parse the cabal file, prefer
       # a lenient regex for speed and security. Moar parsing moar problems.
-      LICENSE_REGEX = /^\s*license\s*:\s*([a-z\-0-9.]+)\s*$/ix.freeze
+      LICENSE_REGEX = /^\s*license\s*:\s*([a-z\-0-9.]+)\s*$/ix
       LICENSE_CONVERSIONS = {
         'GPL-2'  => 'GPL-2.0',
         'GPL-3'  => 'GPL-3.0',

data/lib/licensee/matchers/cargo.rb

@@ -5,7 +5,7 @@ module Licensee
     class Cargo < Licensee::Matchers::Package
       LICENSE_REGEX = %r{
         ^\s*['"]?license['"]?\s*=\s*['"]([a-z\-0-9. +()/]+)['"]\s*
-      }ix.freeze
+      }ix
 
       private
 

data/lib/licensee/matchers/copyright.rb

@@ -6,9 +6,9 @@ module Licensee
       attr_reader :file
 
       COPYRIGHT_SYMBOLS = Regexp.union([/copyright/i, /\(c\)/i, "\u00A9", "\xC2\xA9"])
-      MAIN_LINE_REGEX = /[_*\-\s]*#{COPYRIGHT_SYMBOLS}.*$/i.freeze
-      OPTIONAL_LINE_REGEX = /[_*\-\s]*with Reserved Font Name.*$/i.freeze
-      REGEX = /#{ContentHelper::START_REGEX}(#{MAIN_LINE_REGEX}#{OPTIONAL_LINE_REGEX}*)+$/i.freeze
+      MAIN_LINE_REGEX = /[_*\-\s]*#{COPYRIGHT_SYMBOLS}.*$/i
+      OPTIONAL_LINE_REGEX = /[_*\-\s]*with Reserved Font Name.*$/i
+      REGEX = /#{ContentHelper::START_REGEX}(#{MAIN_LINE_REGEX}#{OPTIONAL_LINE_REGEX}*)+$/i
       def match
         # NOTE: must use content, and not content_normalized here
         Licensee::License.find('no-license') if /#{REGEX}+\z/io.match?(file.content.strip)

data/lib/licensee/matchers/cran.rb

@@ -7,9 +7,9 @@ module Licensee
 
       # While we could parse the DESCRIPTION file, prefer
       # a lenient regex for speed and security. Moar parsing moar problems.
-      LICENSE_FIELD_REGEX = /^license:\s*(.+)/i.freeze
-      PLUS_FILE_LICENSE_REGEX = /\s*\+\s*file\s+LICENSE$/i.freeze
-      GPL_VERSION_REGEX = /^GPL(?:-([23])|\s*\(\s*>=\s*([23])\s*\))$/i.freeze
+      LICENSE_FIELD_REGEX = /^license:\s*(.+)/i
+      PLUS_FILE_LICENSE_REGEX = /\s*\+\s*file\s+LICENSE$/i
+      GPL_VERSION_REGEX = /^GPL(?:-([23])|\s*\(\s*>=\s*([23])\s*\))$/i
 
       private
 

data/lib/licensee/matchers/dist_zilla.rb

@@ -5,7 +5,7 @@ module Licensee
     class DistZilla < Licensee::Matchers::Package
       attr_reader :file
 
-      LICENSE_REGEX = /^license\s*=\s*([a-z\-0-9._]+)/i.freeze
+      LICENSE_REGEX = /^license\s*=\s*([a-z\-0-9._]+)/i
 
       private
 

data/lib/licensee/matchers/gemspec.rb

@@ -5,24 +5,24 @@ module Licensee
     class Gemspec < Licensee::Matchers::Package
       # a value is a string surrounded by any amount of whitespace
       # optionally ended with (non-captured) ".freeze"
-      VALUE_REGEX = /\s*['"]([a-z\-0-9.]+)['"](?:\.freeze)?\s*/i.freeze
+      VALUE_REGEX = /\s*['"]([a-z\-0-9.]+)['"](?:\.freeze)?\s*/i
 
       # an array contains one or more values. all values, or array itself,
       # can be surrounded by any amount of whitespace.  do not capture
       # non-value groups
-      ARRAY_REGEX = /\s*\[#{VALUE_REGEX}(?:,#{VALUE_REGEX})*\]\s*/i.freeze
+      ARRAY_REGEX = /\s*\[#{VALUE_REGEX}(?:,#{VALUE_REGEX})*\]\s*/i
 
       DECLARATION_REGEX = /
         ^\s*[a-z0-9_]+\.([a-z0-9_]+)\s*=#{VALUE_REGEX}$
-      /ix.freeze
+      /ix
 
       LICENSE_REGEX = /
         ^\s*[a-z0-9_]+\.license\s*=#{VALUE_REGEX}$
-      /ix.freeze
+      /ix
 
       LICENSE_ARRAY_REGEX = /
         ^\s*[a-z0-9_]+\.licenses\s*=#{ARRAY_REGEX}$
-      /ix.freeze
+      /ix
 
       private
 

data/lib/licensee/matchers/npm_bower.rb

@@ -7,7 +7,7 @@ module Licensee
       # a lenient regex for speed and security. Moar parsing moar problems.
       LICENSE_REGEX = /
         \s*["']license["']\s*:\s*['"]([a-z\-0-9.+ ()]+)['"],?\s*
-      /ix.freeze
+      /ix
 
       private
 

data/lib/licensee/matchers/nuget.rb

@@ -7,14 +7,14 @@ module Licensee
       # Moar parsing moar problems.
       LICENSE_REGEX = %r{
         <license\s*type\s*=\s*["']expression["']\s*>([a-z\-0-9. +()]+)</license\s*>
-      }ix.freeze
+      }ix
 
-      LICENSE_URL_REGEX = %r{<licenseUrl>\s*(.*)\s*</licenseUrl>}i.freeze
+      LICENSE_URL_REGEX = %r{<licenseUrl>\s*(.*)\s*</licenseUrl>}i
 
-      NUGET_REGEX = %r{https?://licenses.nuget.org/(.*)}i.freeze
-      OPENSOURCE_REGEX = %r{https?://(?:www\.)?opensource.org/licenses/(.*)}i.freeze
-      SPDX_REGEX = %r{https?://(?:www\.)?spdx.org/licenses/(.*?)(?:\.html|\.txt)?$}i.freeze
-      APACHE_REGEX = %r{https?://(?:www\.)?apache.org/licenses/(.*?)(?:\.html|\.txt)?$}i.freeze
+      NUGET_REGEX = %r{https?://licenses.nuget.org/(.*)}i
+      OPENSOURCE_REGEX = %r{https?://(?:www\.)?opensource.org/licenses/(.*)}i
+      SPDX_REGEX = %r{https?://(?:www\.)?spdx.org/licenses/(.*?)(?:\.html|\.txt)?$}i
+      APACHE_REGEX = %r{https?://(?:www\.)?apache.org/licenses/(.*?)(?:\.html|\.txt)?$}i
 
       private
 

data/lib/licensee/matchers/spdx.rb

@@ -5,7 +5,7 @@ module Licensee
     class Spdx < Licensee::Matchers::Package
       # While we could parse the LICENSE.spdx file, prefer
       # a lenient regex for speed and security. Moar parsing moar problems.
-      LICENSE_REGEX = /PackageLicenseDeclared:\s*([a-z\-0-9. +()]+)\s*/i.freeze
+      LICENSE_REGEX = /PackageLicenseDeclared:\s*([a-z\-0-9. +()]+)\s*/i
 
       private
 

data/lib/licensee/project_files/license_file.rb

@@ -7,29 +7,29 @@ module Licensee
 
       # List of extensions to give preference to
       PREFERRED_EXT = %w[md markdown txt html].freeze
-      PREFERRED_EXT_REGEX = /\.#{Regexp.union(PREFERRED_EXT)}\z/.freeze
+      PREFERRED_EXT_REGEX = /\.#{Regexp.union(PREFERRED_EXT)}\z/
 
       # Regex to match any extension except .spdx or .header
-      LICENSE_EXT_REGEX = %r{\.(?!spdx|header)[^./]+\z}i.freeze
+      LICENSE_EXT_REGEX = %r{\.(?!spdx|header)[^./]+\z}i
 
       # Regex to match any extension except a few unlikely as license
       # texts with complex filenames
-      OTHER_EXT_REGEX = %r{\.(?!xml|go|gemspec)[^./]+\z}i.freeze
+      OTHER_EXT_REGEX = %r{\.(?!xml|go|gemspec)[^./]+\z}i
 
       # Regex to match any extension
-      ANY_EXT_REGEX = %r{\.[^./]+\z}i.freeze
+      ANY_EXT_REGEX = %r{\.[^./]+\z}i
 
       # Regex to match, LICENSE, LICENCE, unlicense, etc.
-      LICENSE_REGEX = /(un)?licen[sc]e/i.freeze
+      LICENSE_REGEX = /(un)?licen[sc]e/i
 
       # Regex to match COPYING, COPYRIGHT, etc.
-      COPYING_REGEX = /copy(ing|right)/i.freeze
+      COPYING_REGEX = /copy(ing|right)/i
 
       # Regex to match OFL.
-      OFL_REGEX = /ofl/i.freeze
+      OFL_REGEX = /ofl/i
 
       # BSD + PATENTS patent file
-      PATENTS_REGEX = /patents/i.freeze
+      PATENTS_REGEX = /patents/i
 
       # Hash of Regex => score with which to score potential license files
       FILENAME_REGEXES = {
@@ -55,7 +55,7 @@ module Licensee
       # detected as CC-BY or CC-BY-SA which are 98%+ similar
       CC_FALSE_POSITIVE_REGEX = /
         ^(creative\ commons\ )?Attribution-(NonCommercial|NoDerivatives)
-      /xi.freeze
+      /xi
 
       def possible_matchers
         [Matchers::Copyright, Matchers::Exact, Matchers::Dice]

data/lib/licensee/project_files/readme_file.rb

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

data/lib/licensee/projects/fs_project.rb

@@ -34,11 +34,11 @@ module Licensee
       def files
         @files ||= search_directories.flat_map do |dir|
           relative_dir = Pathname.new(dir).relative_path_from(dir_path).to_s
-          Dir.glob(::File.join(dir, @pattern).tr('\\', '/')).map do |file|
+          Dir.glob(::File.join(dir, @pattern).tr('\\', '/')).filter_map do |file|
             next unless ::File.file?(file)
 
             { name: ::File.basename(file), dir: relative_dir }
-          end.compact
+          end
         end
       end
 

data/lib/licensee/projects/git_project.rb

@@ -71,9 +71,9 @@ module Licensee
       end
 
       def files_from_tree(tree, dir = '.')
-        tree.select { |e| e[:type] == :blob }.map do |entry|
+        tree.select { |e| e[:type] == :blob }.filter_map do |entry|
           entry.merge(dir: dir)
-        end.compact
+        end
       end
     end
   end

data/lib/licensee/projects/github_project.rb

@@ -15,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)|[^/]+)).*}.freeze
+        %r{https://github.com/([^/]+/([^/]+(?=\.git)|[^/]+)).*}
 
       class RepoNotFound < StandardError; end
 

data/lib/licensee/rule.rb

@@ -43,7 +43,7 @@ module Licensee
       end
 
       def raw_rules
-        YAML.safe_load File.read(Rule.file_path)
+        YAML.safe_load_file(Rule.file_path)
       end
 
       def groups

data/lib/licensee/version.rb

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

data/spec/fixture_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe 'fixture test' do
       end
 
       it 'returns the expected hash' do
-        hash = license_file ? license_file.content_hash : nil
+        hash = license_file&.content_hash
         expect(hash).to eql(expectations['hash'])
       end