licensee 9.10.0 → 9.13.1

data/lib/licensee/hash_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module HashHelper
     def to_h
@@ -6,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module Licensee
@@ -16,11 +18,16 @@ module Licensee
       # Returns an Array of License objects.
       def all(options = {})
         @all[options] ||= begin
+          # TODO: Remove in next major version to avoid breaking change
+          options[:pseudo] ||= options[:psuedo] unless options[:psuedo].nil?
+
           options = DEFAULT_OPTIONS.merge(options)
           output = licenses.dup
           output.reject!(&:hidden?) unless options[:hidden]
-          output.reject!(&:pseudo_license?) unless options[:psuedo]
+          output.reject!(&:pseudo_license?) unless options[:pseudo]
+          output.sort_by!(&:key)
           return output if options[:featured].nil?
+
           output.select { |l| l.featured? == options[:featured] }
         end
       end
@@ -40,7 +47,7 @@ module Licensee
 
       # Given a license title or nickname, fuzzy match the license
       def find_by_title(title)
-        License.all(hidden: true, psuedo: false).find do |license|
+        License.all(hidden: true, pseudo: false).find do |license|
           title =~ /\A(the )?#{license.title_regex}( license)?\z/i
         end
       end
@@ -82,17 +89,11 @@ module Licensee
     DEFAULT_OPTIONS = {
       hidden:   false,
       featured: nil,
-      psuedo:   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
+      pseudo:   true
     }.freeze
 
-    SOURCE_PREFIX = %r{https?://(?:www\.)?}i
-    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|\/)(?:\?[^\s]*)?}i
+    SOURCE_PREFIX = %r{https?://(?:www\.)?}i.freeze
+    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|\/)(?:\?[^\s]*)?}i.freeze
 
     HASH_METHODS = %i[
       key spdx_id meta url rules fields other? gpl? lgpl? cc?
@@ -125,6 +126,8 @@ module Licensee
 
     # Returns the human-readable license name
     def name
+      return key.tr('-', ' ').capitalize if pseudo_license?
+
       title || spdx_id
     end
 
@@ -135,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!(/ license\z/i, '')
-        string.sub!(/,? version /, ' ')
-        string.sub!(/v(\d+\.\d+)/, '\1')
-        string = Regexp.escape(string)
-        string = string.sub(/ (\d+\\.\d+)/, ',?\ (?: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
@@ -242,11 +247,13 @@ module Licensee
       unless File.exist?(path)
         raise Licensee::InvalidLicense, "'#{key}' is not a valid license key"
       end
+
       @raw_content ||= File.read(path, encoding: 'utf-8')
     end
 
     def parts
       return unless raw_content
+
       @parts ||= raw_content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a
     end
 

data/lib/licensee/license_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   class LicenseField < Struct.new(:name, :description)
     class << self
@@ -39,12 +41,13 @@ module Licensee
       # Given a license body, returns an array of included LicneseFields
       def from_content(content)
         return [] unless content
+
         LicenseField.from_array content.scan(FIELD_REGEX).flatten
       end
     end
 
     alias key name
-    FIELD_REGEX = /\[(#{Regexp.union(LicenseField.keys)})\]/
+    FIELD_REGEX = /\[(#{Regexp.union(LicenseField.keys)})\]/.freeze
 
     # The human-readable field name
     def label

data/lib/licensee/license_meta.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   class LicenseMeta < Struct.new(
     :title, :spdx_id, :source, :description, :how, :conditions, :permissions,
@@ -23,6 +25,7 @@ module Licensee
       # returns a LicenseMeta with defaults set
       def from_yaml(yaml)
         return from_hash({}) if yaml.nil? || yaml.to_s.empty?
+
         from_hash YAML.safe_load(yaml)
       end
 

data/lib/licensee/license_rules.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   # Exposes #conditions, #permissions, and #limitation arrays of LicenseRules
   class LicenseRules < Struct.new(:conditions, :permissions, :limitations)

data/lib/licensee/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     autoload :Matcher,   'licensee/matchers/matcher'

data/lib/licensee/matchers/cabal.rb

@@ -1,15 +1,29 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     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
+      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',
+        'LGPL-3' => 'LGPL-3.0',
+        'AGPL-3' => 'AGPL-3.0',
+        'BSD2'   => 'BSD-2-Clause',
+        'BSD3'   => 'BSD-3-Clause'
+      }.freeze
 
       private
 
       def license_property
         match = @file.content.match LICENSE_REGEX
-        match[1].downcase if match && match[1]
+        spdx_name(match[1]).downcase if match && match[1]
+      end
+
+      def spdx_name(cabal_name)
+        LICENSE_CONVERSIONS[cabal_name] || cabal_name
       end
     end
   end

data/lib/licensee/matchers/cargo.rb

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

data/lib/licensee/matchers/copyright.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class Copyright < Licensee::Matchers::Matcher
       attr_reader :file
 
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       COPYRIGHT_SYMBOLS = Regexp.union([/copyright/i, /\(c\)/i, "\u00A9", "\xC2\xA9"])
-      REGEX = /\A(\s*#{COPYRIGHT_SYMBOLS}.*$)+/i
-      # rubocop:enable Metrics/LineLength
+      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 =~ /\A#{REGEX}\z/i
+        if file.content.strip =~ /#{REGEX}+\z/i
           Licensee::License.find('no-license')
         end
       rescue Encoding::CompatibilityError

data/lib/licensee/matchers/cran.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class Cran < Licensee::Matchers::Package
@@ -5,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
-      PLUS_FILE_LICENSE_REGEX = /\s*\+\s*file\s+LICENSE$/i
-      GPL_VERSION_REGEX = /^GPL(?:-([23])|\s*\(\s*>=\s*([23])\s*\))$/i
+      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
 
       private
 
@@ -15,6 +17,7 @@ module Licensee
       # or `nil` if no license field is found
       def license_field
         return @license_field if defined? @license_field
+
         match = @file.content.match LICENSE_FIELD_REGEX
         @license_field = match ? match[1].downcase : nil
       end
@@ -30,6 +33,7 @@ module Licensee
       # Rerurns `nil` if no license is found
       def license_property
         return unless license_field
+
         # Remove The common + file LICENSE text
         license_key = license_field.sub(PLUS_FILE_LICENSE_REGEX, '')
         gpl_version(license_key) || license_key

data/lib/licensee/matchers/dice.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class Dice < Licensee::Matchers::Matcher
@@ -5,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
 
@@ -49,7 +51,7 @@ module Licensee
 
       # Confidence that the matched license is a match
       def confidence
-        @confidence ||= match ? file.similarity(match) : 0
+        @confidence ||= match ? match.similarity(file) : 0
       end
 
       private

data/lib/licensee/matchers/dist_zilla.rb

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

data/lib/licensee/matchers/exact.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class Exact < Licensee::Matchers::Matcher
       def match
         return @match if defined? @match
+
         @match = potential_matches.find do |potential_match|
           potential_match.wordset == file.wordset
         end

data/lib/licensee/matchers/gemspec.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     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
+      VALUE_REGEX = /\s*[\'\"]([a-z\-0-9\.]+)[\'\"](?:\.freeze)?\s*/i.freeze
 
       # 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
+      ARRAY_REGEX = /\s*\[#{VALUE_REGEX}(?:,#{VALUE_REGEX})*\]\s*/i.freeze
 
       DECLARATION_REGEX = /
         ^\s*[a-z0-9_]+\.([a-z0-9_]+)\s*\=#{VALUE_REGEX}$
-      /ix
+      /ix.freeze
 
       LICENSE_REGEX = /
         ^\s*[a-z0-9_]+\.license\s*\=#{VALUE_REGEX}$
-      /ix
+      /ix.freeze
 
       LICENSE_ARRAY_REGEX = /
         ^\s*[a-z0-9_]+\.licenses\s*\=#{ARRAY_REGEX}$
-      /ix
+      /ix.freeze
 
       private
 
@@ -34,6 +36,7 @@ module Licensee
 
         # use 'other' if array contains multiple licenses
         return 'other' unless licenses.size == 1
+
         licenses[0]
       end
 

data/lib/licensee/matchers/matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class Matcher
@@ -25,7 +27,7 @@ module Licensee
       private
 
       def potential_matches
-        @potential_matches ||= Licensee.licenses(hidden: true)
+        @potential_matches ||= Licensee.licenses(hidden: true, psuedo: false)
       end
     end
   end

data/lib/licensee/matchers/npm_bower.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class NpmBower < Licensee::Matchers::Package
@@ -5,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
+      /ix.freeze
 
       private
 

data/lib/licensee/matchers/package.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     class Package < Licensee::Matchers::Matcher
       def match
         return @match if defined? @match
         return if license_property.nil? || license_property.to_s.empty?
+
         @match = Licensee.licenses(hidden: true).find do |license|
           license.key == license_property
         end

data/lib/licensee/matchers/reference.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     # Matches README files that include a license by reference
     class Reference < Licensee::Matchers::Matcher
       def match
-        License.all(hidden: true, psuedo: false).find do |license|
+        potential_matches.find do |license|
           title_or_source = [license.title_regex, license.source_regex].compact
           /\b#{Regexp.union(title_or_source)}\b/ =~ file.content
         end

data/lib/licensee/matchers/spdx.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Licensee
   module Matchers
     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
+      LICENSE_REGEX = /PackageLicenseDeclared:\s*([a-z\-0-9\. +()]+)\s*/i.freeze
 
       private