licensee 9.14.1 → 9.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cdac44039e6185c028d41ab8112b43d7e1ba66f2c8bd02be490255d14dfac38
-  data.tar.gz: 895ffc0aa9296fef49193b6282edb6286a9115ba4b3207be4c15df5755ca3bf7
+  metadata.gz: 63f3f7938e9e0c58907e71bcf9de72e69d2d494d2dbbba6c71e150b44190eda3
+  data.tar.gz: 51583db05dee9239fb50e373f3dc4c79dfa4515a5461facc2722dabe5ee0fb9a
 SHA512:
-  metadata.gz: eb7c6c9d1b2a8c8258b8d499efa96ab7b25b83108bb47ed163eabd5d78e83a2443a0bbf6f43eb1abda0b441e8696a17f79066ec4356c80a1b88d3c40338c726b
-  data.tar.gz: e1bfeb5c75d28b334d880351acf7977c71e5efa9b61c407c204921475070c3ede8b2331b82cc64446fa81577ede499cf8d2d5b6d70ae1fc507cc238ee4a52a08
+  metadata.gz: 87b8a85992cec7c2e7c30fab5b96e33a0fdd4271df34a99ca2b99584f1f94cdcb70c5663d9a584ccf1164fd10eca2b1e7b26f09bb7b43a81a8c3705dc6341666
+  data.tar.gz: b261c2cf6a2b40fd5b4b10bd4644d179dda3e35686b6f6361af4177dcda852eb45c22bf0dafc43291824a2c48b30f1297c2f933a7786f12dbefbb0bde6dfb83b

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2020 Ben Balter and Licensee contributors
+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,7 +37,7 @@ module Licensee
     end
 
     def project(path, **args)
-      if path =~ %r{\Ahttps://github.com}
+      if %r{\Ahttps://github.com}.match?(path)
         Licensee::Projects::GitHubProject.new(path, **args)
       else
         Licensee::Projects::GitProject.new(path, **args)

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
 

data/lib/licensee/commands/diff.rb

@@ -49,9 +49,7 @@ class LicenseeCLI < Thor
   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

@@ -23,8 +23,8 @@ module Licensee
       url:                 %r{#{START_REGEX}https?://[^ ]+\n},
       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,
@@ -36,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
@@ -90,10 +87,9 @@ module Licensee
     }.freeze
     STRIP_METHODS = %i[
       bom
+      cc_optional
       cc0_optional
       unlicense_optional
-      hrs
-      markdown_headings
       borders
       title
       version
@@ -101,7 +97,6 @@ module Licensee
       copyright
       title
       block_markup
-      link_markup
       developed_by
       end_of_terms
       whitespace
@@ -110,7 +105,7 @@ 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 characters in the normalized content
@@ -133,7 +128,7 @@ module Licensee
       overlap = (wordset_fieldless & other.wordset).size
       total = wordset_fieldless.size + other.wordset.size -
               fields_normalized_set.size
-      (overlap * 200.0) / (total + fields_adjusted_length_delta(other) / 10)
+      (overlap * 200.0) / (total + variation_adjusted_length_delta(other) / 4)
     end
 
     # SHA1 of the normalized content
@@ -148,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
@@ -186,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"
 
@@ -233,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
@@ -244,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
@@ -274,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'
 
@@ -295,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)
@@ -319,7 +315,7 @@ module Licensee
     end
 
     def normalize_bullets
-      normalize(REGEXES[:bullet], "\n\n* ")
+      normalize(REGEXES[:bullet], "\n\n- ")
       normalize(/\)\s+\(/, ')(')
     end
 
@@ -337,10 +333,10 @@ module Licensee
       @fields_normalized_set ||= fields_normalized.to_set
     end
 
-    def fields_adjusted_length_delta(other)
+    def variation_adjusted_length_delta(other)
       delta = length_delta(other)
-      adjusted_delta = delta - fields_normalized.size * 2
-      adjusted_delta.positive? ? adjusted_delta : delta
+      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
@@ -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/copyright.rb

@@ -5,16 +5,11 @@ module Licensee
     class Copyright < Licensee::Matchers::Matcher
       attr_reader :file
 
-      # rubocop:disable Layout/LineLength
       COPYRIGHT_SYMBOLS = Regexp.union([/copyright/i, /\(c\)/i, "\u00A9", "\xC2\xA9"])
       REGEX = /#{ContentHelper::START_REGEX}(?:portions )?([_*\-\s]*#{COPYRIGHT_SYMBOLS}.*$)+$/i.freeze
-      # rubocop:enable Layout/LineLength
-
       def match
-        # Note: must use content, and not content_normalized here
-        if file.content.strip =~ /#{REGEX}+\z/i
-          Licensee::License.find('no-license')
-        end
+        # NOTE: must use content, and not content_normalized here
+        Licensee::License.find('no-license') if /#{REGEX}+\z/io.match?(file.content.strip)
       rescue Encoding::CompatibilityError
         nil
       end

data/lib/licensee/matchers/cran.rb

@@ -26,7 +26,7 @@ module Licensee
       # Otherwise, returns `nil`
       def gpl_version(license_key)
         match = license_key.match GPL_VERSION_REGEX
-        match ? "gpl-#{(match[1] || match[2])}.0" : nil
+        match ? "gpl-#{match[1] || match[2]}.0" : nil
       end
 
       # Normalizes the license field value to an SPDX ID

data/lib/licensee/matchers/dice.rb

@@ -10,7 +10,7 @@ module Licensee
                      nil
                    else
                      matches.first[0]
-        end
+                   end
       end
 
       # Licenses that may be a match for this file.

data/lib/licensee/project_files/license_file.rb

@@ -10,7 +10,14 @@ module Licensee
       PREFERRED_EXT_REGEX = /\.#{Regexp.union(PREFERRED_EXT)}\z/.freeze
 
       # Regex to match any extension except .spdx or .header
-      OTHER_EXT_REGEX = %r{\.(?!spdx|header|gemspec)[^./]+\z}i.freeze
+      LICENSE_EXT_REGEX = %r{\.(?!spdx|header)[^./]+\z}i.freeze
+
+      # 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
+
+      # Regex to match any extension
+      ANY_EXT_REGEX = %r{\.[^./]+\z}i.freeze
 
       # Regex to match, LICENSE, LICENCE, unlicense, etc.
       LICENSE_REGEX = /(un)?licen[sc]e/i.freeze
@@ -26,22 +33,22 @@ module Licensee
 
       # Hash of Regex => score with which to score potential license files
       FILENAME_REGEXES = {
-        /\A#{LICENSE_REGEX}\z/                       => 1.00,  # LICENSE
-        /\A#{LICENSE_REGEX}#{PREFERRED_EXT_REGEX}\z/ => 0.95,  # LICENSE.md
-        /\A#{COPYING_REGEX}\z/                       => 0.90,  # COPYING
-        /\A#{COPYING_REGEX}#{PREFERRED_EXT_REGEX}\z/ => 0.85,  # COPYING.md
-        /\A#{LICENSE_REGEX}#{OTHER_EXT_REGEX}\z/     => 0.80,  # LICENSE.textile
-        /\A#{COPYING_REGEX}#{OTHER_EXT_REGEX}\z/     => 0.75,  # COPYING.textile
-        /\A#{LICENSE_REGEX}[-_]/                     => 0.70,  # LICENSE-MIT
-        /\A#{COPYING_REGEX}[-_]/                     => 0.65,  # COPYING-MIT
-        /\A\w+[-_]#{LICENSE_REGEX}/                  => 0.60,  # MIT-LICENSE-MIT
-        /\A\w+[-_]#{COPYING_REGEX}/                  => 0.55,  # MIT-COPYING
-        /\A#{OFL_REGEX}#{PREFERRED_EXT_REGEX}/       => 0.50,  # OFL.md
-        /\A#{OFL_REGEX}#{OTHER_EXT_REGEX}/           => 0.45,  # OFL.textile
-        /\A#{OFL_REGEX}\z/                           => 0.40,  # OFL
-        /\A#{PATENTS_REGEX}\z/                       => 0.35,  # PATENTS
-        /\A#{PATENTS_REGEX}#{OTHER_EXT_REGEX}\z/     => 0.30,  # PATENTS.txt
-        //                                           => 0.00   # Catch all
+        /\A#{LICENSE_REGEX}\z/                                => 1.00,  # LICENSE
+        /\A#{LICENSE_REGEX}#{PREFERRED_EXT_REGEX}\z/          => 0.95,  # LICENSE.md
+        /\A#{COPYING_REGEX}\z/                                => 0.90,  # COPYING
+        /\A#{COPYING_REGEX}#{PREFERRED_EXT_REGEX}\z/          => 0.85,  # COPYING.md
+        /\A#{LICENSE_REGEX}#{LICENSE_EXT_REGEX}\z/            => 0.80,  # LICENSE.textile
+        /\A#{COPYING_REGEX}#{ANY_EXT_REGEX}\z/                => 0.75,  # COPYING.textile
+        /\A#{LICENSE_REGEX}[-_][^.]*#{OTHER_EXT_REGEX}?\z/    => 0.70,  # LICENSE-MIT
+        /\A#{COPYING_REGEX}[-_][^.]*#{OTHER_EXT_REGEX}?\z/    => 0.65,  # COPYING-MIT
+        /\A\w+[-_]#{LICENSE_REGEX}[^.]*#{OTHER_EXT_REGEX}?\z/ => 0.60,  # MIT-LICENSE-MIT
+        /\A\w+[-_]#{COPYING_REGEX}[^.]*#{OTHER_EXT_REGEX}?\z/ => 0.55,  # MIT-COPYING
+        /\A#{OFL_REGEX}#{PREFERRED_EXT_REGEX}/                => 0.50,  # OFL.md
+        /\A#{OFL_REGEX}#{OTHER_EXT_REGEX}/                    => 0.45,  # OFL.textile
+        /\A#{OFL_REGEX}\z/                                    => 0.40,  # OFL
+        /\A#{PATENTS_REGEX}\z/                                => 0.35,  # PATENTS
+        /\A#{PATENTS_REGEX}#{OTHER_EXT_REGEX}\z/              => 0.30,  # PATENTS.txt
+        //                                                    => 0.00   # Catch all
       }.freeze
 
       # CC-NC and CC-ND are not open source licenses and should not be
@@ -56,11 +63,11 @@ module Licensee
 
       def attribution
         @attribution ||= begin
-          return unless copyright? || license.content&.include?('[fullname]')
-
-          matches = Matchers::Copyright::REGEX
-                    .match(content_without_title_and_version)
-          matches[0] if matches
+          if copyright? || license.content&.include?('[fullname]')
+            matches = Matchers::Copyright::REGEX
+                      .match(content_without_title_and_version)
+            matches[0] if matches
+          end
         end
       end
 

data/lib/licensee/project_files/project_file.rb

@@ -37,9 +37,7 @@ module Licensee
       def initialize(content, metadata = {})
         @content = content.dup
         @content.force_encoding(ENCODING)
-        unless @content.valid_encoding?
-          @content.encode!(ENCODING, **ENCODING_OPTIONS)
-        end
+        @content.encode!(ENCODING, **ENCODING_OPTIONS) unless @content.valid_encoding?
         @content.encode!(ENCODING, universal_newline: true)
 
         metadata = { name: metadata } if metadata.is_a? String
@@ -93,7 +91,7 @@ module Licensee
         return false unless is_a?(LicenseFile)
         return false unless matcher.is_a?(Matchers::Copyright)
 
-        filename =~ /\Acopyright(?:#{LicenseFile::OTHER_EXT_REGEX})?\z/i
+        filename =~ /\Acopyright(?:#{LicenseFile::OTHER_EXT_REGEX})?\z/io
       end
 
       def content_hash