licensee 9.13.1 → 9.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd74e74f07c0dc4111b3cbbebf62ae3ab140a788ed511491b5995d45f2371de0
-  data.tar.gz: 90561b8b85ded55614a88e38b0469e80d110bd113e3a6ddfee9bdd840dec237a
+  metadata.gz: dff748195c8e0488eee7b7a9d15b90c1683059c0d52a30721f36250cdeac8935
+  data.tar.gz: 30f85a2b7d664c4b1345a8a76d98e8c059ef550b5b4ce878484f47f296d70a33
 SHA512:
-  metadata.gz: bc64456f4f05411ab8152ce3ade984aa52851f39399d0bffe1e6c51fa4f9de6b00fcd84008bed0d0b71b0569a9799ba0b539ce6323fee55b4436c583ae4ce92c
-  data.tar.gz: d797f174a17e2f91eb8f4e7c9eff9b3d4631f58531d4d57cc9da98e75e062345a52354a9ca3a8e1f991cb70a92b91e7b600814dddca345c3528742011e92c8ed
+  metadata.gz: 3dfa1f6ece5593ef76abf731cf3787b4e616803735f4c241c462f7081c333cee0d88da6854dcbe4bb43a6aefcd35414340f45a2cb3057ddb7d434a27acc0b461
+  data.tar.gz: 2444b1b8e714a4385baaeb8863bd8af26fb62b9bf31dd810e62b189158459cc0fcd23056adbdcc670df1c690f916e2f8cc3f62953704eae8b7651a624ea14613

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2017 Ben Balter
+Copyright (c) 2014-2021 Ben Balter and Licensee contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/bin/licensee

@@ -19,7 +19,7 @@ class LicenseeCLI < Thor
                 args.first || Dir.pwd
               else
                 "https://github.com/#{args.first}"
-    end
+              end
   end
 
   def project

data/lib/licensee.rb

@@ -37,13 +37,13 @@ module Licensee
     end
 
     def project(path, **args)
-      if path =~ %r{\Ahttps://github.com}
-        Licensee::Projects::GitHubProject.new(path, args)
+      if %r{\Ahttps://github.com}.match?(path)
+        Licensee::Projects::GitHubProject.new(path, **args)
       else
-        Licensee::Projects::GitProject.new(path, args)
+        Licensee::Projects::GitProject.new(path, **args)
       end
     rescue Licensee::Projects::GitProject::InvalidRepository
-      Licensee::Projects::FSProject.new(path, args)
+      Licensee::Projects::FSProject.new(path, **args)
     end
 
     def confidence_threshold

data/lib/licensee/commands/detect.rb

@@ -28,11 +28,9 @@ class LicenseeCLI < Thor
               ['Licenses:', project.licenses.map(&:spdx_id)]
             else
               ['License:', set_color('None', :red)]
-    end
+            end
 
-    unless project.matched_files.empty?
-      rows << ['Matched files:', project.matched_files.map(&:filename).join(', ')]
-    end
+    rows << ['Matched files:', project.matched_files.map(&:filename).join(', ')] unless project.matched_files.empty?
 
     print_table rows
 
@@ -88,7 +86,7 @@ class LicenseeCLI < Thor
     when :confidence
       Licensee::ContentHelper.format_percent(value)
     when :method
-      value.to_s.tr('_', ' ').capitalize + ':'
+      "#{value.to_s.tr('_', ' ').capitalize}:"
     else
       value
     end

data/lib/licensee/commands/diff.rb

@@ -41,17 +41,15 @@ class LicenseeCLI < Thor
 
   def license_to_diff
     return options[:license_to_diff] if options[:license_to_diff]
-    return project.license_file if remote? || STDIN.tty? && project.license_file
+    return project.license_file if remote? || $stdin.tty? && project.license_file
 
     @license_to_diff ||= begin
-      Licensee::ProjectFiles::LicenseFile.new(STDIN.read, 'LICENSE')
+      Licensee::ProjectFiles::LicenseFile.new($stdin.read, 'LICENSE')
     end
   end
 
   def expected_license
-    if options[:license]
-      @expected_license ||= Licensee::License.find options[:license]
-    end
+    @expected_license ||= Licensee::License.find options[:license] if options[:license]
     return @expected_license if @expected_license
 
     if options[:license]

data/lib/licensee/content_helper.rb

@@ -7,23 +7,24 @@ module Licensee
   module ContentHelper
     DIGEST = Digest::SHA1
     START_REGEX = /\A\s*/.freeze
-    END_OF_TERMS_REGEX = /^[\s#*_]*end of terms and conditions\s*$/i.freeze
+    END_OF_TERMS_REGEX = /^[\s#*_]*end of terms and conditions[\s#*_]*$/i.freeze
     REGEXES = {
-      hrs:                 /^\s*[=\-\*]{3,}\s*$/,
+      bom:                 /#{START_REGEX}\xEF\xBB\xBF/,
+      hrs:                 /^\s*[=\-*]{3,}\s*$/,
       all_rights_reserved: /#{START_REGEX}all rights reserved\.?$/i,
       whitespace:          /\s+/,
-      markdown_headings:   /#{START_REGEX}#+/,
+      markdown_headings:   /^\s*#+/,
       version:             /#{START_REGEX}version.*$/i,
       span_markup:         /[_*~]+(.*?)[_*~]+/,
       link_markup:         /\[(.+?)\]\(.+?\)/,
       block_markup:        /^\s*>/,
-      border_markup:       /^[\*-](.*?)[\*-]$/,
-      comment_markup:      %r{^\s*?[/\*]{1,2}},
+      border_markup:       /^[*-](.*?)[*-]$/,
+      comment_markup:      %r{^\s*?[/*]{1,2}},
       url:                 %r{#{START_REGEX}https?://[^ ]+\n},
-      bullet:              /\n\n\s*(?:[*-]|\(?[\da-z]{1,2}[)\.])\s+/i,
+      bullet:              /\n\n\s*(?:[*-]|\(?[\da-z]{1,2}[).])\s+/i,
       developed_by:        /#{START_REGEX}developed by:.*?\n\n/im,
-      quote_begin:         /[`'"‘“]/,
-      quote_end:           /[`'"’”]/,
+      cc_dedication:       /The\s+text\s+of\s+the\s+Creative\s+Commons.*?Public\s+Domain\s+Dedication./im,
+      cc_wiki:             /wiki.creativecommons.org/i,
       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,
@@ -35,10 +36,7 @@ module Licensee
       https:      { from: /http:/, to: 'https:' },
       ampersands: { from: '&', to: 'and' },
       dashes:     { from: /(?<!^)([—–-]+)(?!$)/, to: '-' },
-      quotes:     {
-        from: /#{REGEXES[:quote_begin]}+([\w -]*?\w)#{REGEXES[:quote_end]}+/,
-        to:   '"\1"'
-      }
+      quote:      { from: /[`'"‘“’”]/, to: "'" }
     }.freeze
 
     # Legally equivalent words that schould be ignored for comparison
@@ -88,10 +86,10 @@ module Licensee
       'owner'           => 'holder'
     }.freeze
     STRIP_METHODS = %i[
+      bom
+      cc_optional
       cc0_optional
       unlicense_optional
-      hrs
-      markdown_headings
       borders
       title
       version
@@ -99,8 +97,6 @@ module Licensee
       copyright
       title
       block_markup
-      span_markup
-      link_markup
       developed_by
       end_of_terms
       whitespace
@@ -109,35 +105,30 @@ module Licensee
 
     # A set of each word in the license, without duplicates
     def wordset
-      @wordset ||= content_normalized&.scan(%r{(?:[\w\/](?:'s|(?<=s)')?)+})&.to_set
+      @wordset ||= content_normalized&.scan(%r{(?:[\w/-](?:'s|(?<=s)')?)+})&.to_set
     end
 
-    # Number of characteres in the normalized content
+    # Number of characters in the normalized content
     def length
       return 0 unless content_normalized
 
       content_normalized.length
     end
 
-    # Number of characters that could be added/removed to still be
-    # considered a potential match
-    def max_delta
-      @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
     def length_delta(other)
       (length - other.length).abs
     end
 
     # Given another license or project file, calculates the similarity
-    # as a percentage of words in common
+    # as a percentage of words in common, minus a tiny penalty that
+    # increases with size difference between licenses so that false
+    # positives for long licnses are ruled out by this score alone.
     def similarity(other)
       overlap = (wordset_fieldless & other.wordset).size
       total = wordset_fieldless.size + other.wordset.size -
               fields_normalized_set.size
-      100.0 * (overlap * 2.0 / total)
+      (overlap * 200.0) / (total + variation_adjusted_length_delta(other) / 4)
     end
 
     # SHA1 of the normalized content
@@ -152,7 +143,7 @@ module Licensee
     def content_without_title_and_version
       @content_without_title_and_version ||= begin
         @_content = nil
-        ops = %i[html hrs comments markdown_headings title version]
+        ops = %i[html hrs comments markdown_headings link_markup title version]
         ops.each { |op| strip(op) }
         _content
       end
@@ -162,7 +153,7 @@ module Licensee
       @content_normalized ||= begin
         @_content = content_without_title_and_version.downcase
 
-        (NORMALIZATIONS.keys + %i[spelling bullets]).each { |op| normalize(op) }
+        (NORMALIZATIONS.keys + %i[spelling span_markup bullets]).each { |op| normalize(op) }
         STRIP_METHODS.each { |op| strip(op) }
 
         _content
@@ -190,12 +181,10 @@ module Licensee
       text.gsub!(/([^\n])\n([^\n])/, '\1 \2')
 
       text = text.split("\n").collect do |line|
-        if line =~ REGEXES[:hrs]
+        if line =~ REGEXES[:hrs] || line.length <= line_width
           line
-        elsif line.length > line_width
-          line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
         else
-          line
+          line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
         end
       end * "\n"
 
@@ -237,9 +226,7 @@ module Licensee
         meth = "strip_#{regex_or_sym}"
         return send(meth) if respond_to?(meth, true)
 
-        unless REGEXES[regex_or_sym]
-          raise ArgumentError, "#{regex_or_sym} is an invalid regex reference"
-        end
+        raise ArgumentError, "#{regex_or_sym} is an invalid regex reference" unless REGEXES[regex_or_sym]
 
         regex_or_sym = REGEXES[regex_or_sym]
       end
@@ -248,9 +235,7 @@ module Licensee
     end
 
     def strip_title
-      while _content =~ ContentHelper.title_regex
-        strip(ContentHelper.title_regex)
-      end
+      strip(ContentHelper.title_regex) while _content =~ ContentHelper.title_regex
     end
 
     def strip_borders
@@ -278,6 +263,13 @@ module Licensee
       strip(REGEXES[:cc0_disclaimer])
     end
 
+    def strip_cc_optional
+      return unless _content.include? 'creative commons'
+
+      strip(REGEXES[:cc_dedication])
+      strip(REGEXES[:cc_wiki])
+    end
+
     def strip_unlicense_optional
       return unless _content.include? 'unlicense'
 
@@ -289,7 +281,7 @@ module Licensee
       @_content = body
     end
 
-    def strip_span_markup
+    def normalize_span_markup
       normalize(REGEXES[:span_markup], '\1')
     end
 
@@ -299,7 +291,7 @@ module Licensee
 
     def strip_html
       return unless respond_to?(:filename) && filename
-      return unless File.extname(filename) =~ /\.html?/i
+      return unless /\.html?/i.match?(File.extname(filename))
 
       require 'reverse_markdown'
       @_content = ReverseMarkdown.convert(_content, unknown_tags: :bypass)
@@ -323,7 +315,7 @@ module Licensee
     end
 
     def normalize_bullets
-      normalize(REGEXES[:bullet], "\n\n* ")
+      normalize(REGEXES[:bullet], "\n\n- ")
       normalize(/\)\s+\(/, ')(')
     end
 
@@ -340,5 +332,17 @@ module Licensee
     def fields_normalized_set
       @fields_normalized_set ||= fields_normalized.to_set
     end
+
+    def variation_adjusted_length_delta(other)
+      delta = length_delta(other)
+
+      # The content helper mixin is used in different objects
+      # Licenses have a more advanced SPDX alt. segement-based delta.
+      # 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.positive? ? adjusted_delta : 0
+    end
   end
 end

data/lib/licensee/hash_helper.rb

@@ -13,7 +13,7 @@ module Licensee
                       value.to_h
                     else
                       value
-        end
+                    end
       end
 
       hash

data/lib/licensee/license.rb

@@ -4,6 +4,7 @@ require 'uri'
 
 module Licensee
   class InvalidLicense < ArgumentError; end
+
   class License
     @all = {}
     @keys_licenses = {}
@@ -26,9 +27,11 @@ module Licensee
           output.reject!(&:hidden?) unless options[:hidden]
           output.reject!(&:pseudo_license?) unless options[:pseudo]
           output.sort_by!(&:key)
-          return output if options[:featured].nil?
-
-          output.select { |l| l.featured? == options[:featured] }
+          if options[:featured].nil?
+            output
+          else
+            output.select { |l| l.featured? == options[:featured] }
+          end
         end
       end
 
@@ -53,14 +56,17 @@ module Licensee
       end
 
       def license_dir
-        dir = ::File.dirname(__FILE__)
-        ::File.expand_path '../../vendor/choosealicense.com/_licenses', dir
+        ::File.expand_path '../../vendor/choosealicense.com/_licenses', __dir__
       end
 
       def license_files
         @license_files ||= Dir.glob("#{license_dir}/*.txt")
       end
 
+      def spdx_dir
+        ::File.expand_path '../../vendor/license-list-XML/src', __dir__
+      end
+
       private
 
       def licenses
@@ -82,7 +88,7 @@ module Licensee
     # `other` - The project had a license, but we were not able to detect it
     # `no-license` - The project is not licensed (e.g., all rights reserved)
     #
-    # Note: A lack of detected license will be a nil license
+    # NOTE: A lack of detected license will be a nil license
     PSEUDO_LICENSES = %w[other no-license].freeze
 
     # Default options to use when retrieving licenses via #all
@@ -93,7 +99,7 @@ module Licensee
     }.freeze
 
     SOURCE_PREFIX = %r{https?://(?:www\.)?}i.freeze
-    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|\/)(?:\?[^\s]*)?}i.freeze
+    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|/)(?:\?[^\s]*)?}i.freeze
 
     HASH_METHODS = %i[
       key spdx_id meta url rules fields other? gpl? lgpl? cc?
@@ -154,9 +160,7 @@ module Licensee
       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
+      parts.push Regexp.new meta.nickname.sub(/\bGNU /i, '(?:GNU )?') if meta.nickname
 
       @title_regex = Regexp.union parts
     end
@@ -173,8 +177,8 @@ module Licensee
       return @source_regex if defined? @source_regex
       return unless meta.source
 
-      source = meta.source.dup.sub(/\A#{SOURCE_PREFIX}/, '')
-      source = source.sub(/#{SOURCE_SUFFIX}\z/, '')
+      source = meta.source.dup.sub(/\A#{SOURCE_PREFIX}/o, '')
+      source = source.sub(/#{SOURCE_SUFFIX}\z/o, '')
 
       escaped_source = Regexp.escape(source)
       @source_regex = /#{SOURCE_PREFIX}#{escaped_source}(?:#{SOURCE_SUFFIX})?/i
@@ -244,9 +248,7 @@ module Licensee
     # Raw content of license file, including YAML front matter
     def raw_content
       return if pseudo_license?
-      unless File.exist?(path)
-        raise Licensee::InvalidLicense, "'#{key}' is not a valid license key"
-      end
+      raise Licensee::InvalidLicense, "'#{key}' is not a valid license key" unless File.exist?(path)
 
       @raw_content ||= File.read(path, encoding: 'utf-8')
     end
@@ -260,5 +262,17 @@ module Licensee
     def yaml
       @yaml ||= parts[1] if parts
     end
+
+    def spdx_alt_segments
+      @spdx_alt_segments ||= begin
+        path = File.expand_path "#{spdx_id}.xml", Licensee::License.spdx_dir
+        raw_xml = File.read(path, encoding: 'utf-8')
+        text = raw_xml.match(%r{<text>(.*)</text>}m)[1]
+        text.gsub!(%r{<copyrightText>.*?</copyrightText>}m, '')
+        text.gsub!(%r{<titleText>.*?</titleText>}m, '')
+        text.gsub!(%r{<optional.*?>.*?</optional>}m, '')
+        text.scan(/<alt .*?>/m).size
+      end
+    end
   end
 end

data/lib/licensee/matchers.rb

@@ -12,6 +12,7 @@ module Licensee
     autoload :Exact,     'licensee/matchers/exact'
     autoload :Gemspec,   'licensee/matchers/gemspec'
     autoload :NpmBower,  'licensee/matchers/npm_bower'
+    autoload :NuGet,     'licensee/matchers/nuget'
     autoload :Package,   'licensee/matchers/package'
     autoload :Reference, 'licensee/matchers/reference'
     autoload :Spdx,      'licensee/matchers/spdx'

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.freeze
       LICENSE_CONVERSIONS = {
         'GPL-2'  => 'GPL-2.0',
         'GPL-3'  => 'GPL-3.0',