licensee 8.9.2 → 9.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bd286955df8a0e4dff2cbeb964fcdfc28595250
-  data.tar.gz: fd1cac842289dd0399faf4fca39344955999d07b
+  metadata.gz: '0923f356c4362acaa8b166869c724e40b77334c6'
+  data.tar.gz: a21149dd924c42abfb7cdbc06550604bfdd9a54c
 SHA512:
-  metadata.gz: e5e506fa77c9718cad668dd3d4f5aaac281073ebe8822a33d7e30db258c1a2ad0ce4052355cdb48063729b0cfabd55097b9052ac7228d189a673b2812e184bba
-  data.tar.gz: 192310645fd0a2fe87ee0c530d795e568490e19bd7ac973a9f3d1d1553413e8e3980c14dd12e38725456e18a04f2f45600a4dd9e2b358bc4910e4a8243d3a32e
+  metadata.gz: 14c7dfea1fc4e9f44015b2c52034f6030239690a2976ed01410b02980ba3b2f202f5bce36bc8f2d8c549d5af67b7d33e8a6985609c82124d979154c21827cc8b
+  data.tar.gz: beb248f3754149ff4063afcf0e151d112a54369a0cc227c8854ef687c8c9e66e6682be043824e727064a55fb78f0c26578065a8932a8d331fcb36f1110c2f804

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2016 Ben Balter
+Copyright (c) 2014-2017 Ben Balter
 
 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

@@ -4,47 +4,61 @@ require_relative '../lib/licensee'
 
 path = ARGV[0] || Dir.pwd
 
-def format_percent(float)
-  "#{format('%.2f', float)}%"
+# Given a string or object, prepares it for output and human consumption
+def humanize(value, type = nil)
+  case type
+  when :license
+    value.name
+  when :matcher
+    value.class
+  when :confidence
+    Licensee::ContentHelper.format_percent(value)
+  when :method
+    value.to_s.tr('_', ' ').capitalize
+  else
+    value
+  end
 end
 
-project = Licensee.project(path, detect_packages: true, detect_readme: true)
-license_file = project.license_file
-matched_file = project.matched_file
+# Methods to call when displaying information about ProjectFiles
+MATCHED_FILE_METHODS = %i[
+  content_hash attribution confidence matcher license
+].freeze
 
-if license_file
-  puts "License file: #{license_file.filename}"
-  puts "License hash: #{license_file.hash}"
-  puts "Attribution: #{license_file.attribution}" if license_file.attribution
-end
+project = Licensee.project(path, detect_packages: true, detect_readme: true)
 
-unless matched_file
+if project.license
+  puts "License: #{project.license.name}"
+elsif project.licenses
+  puts "Licenses: #{project.licenses.map(&:name)}"
+else
   puts 'License: Not detected'
-  exit 1
 end
 
-if matched_file.license
-  puts "License: #{matched_file.license.meta['title']}"
+puts "Matched files: #{project.matched_files.map(&:filename)}"
+
+project.matched_files.each do |matched_file|
+  puts "#{matched_file.filename}:"
 
-  if matched_file.confidence
-    puts "Confidence: #{format_percent(matched_file.confidence)}"
+  MATCHED_FILE_METHODS.each do |method|
+    next unless matched_file.respond_to? method
+    value = matched_file.public_send method
+    next if value.nil?
+    puts "  #{humanize(method, :method)}: #{humanize(value, method)}"
   end
 
-  puts "Method: #{matched_file.matcher.class}" if matched_file.matcher
-  exit 0
-end
+  next unless matched_file.is_a? Licensee::ProjectFiles::LicenseFile
+  next unless matched_file.confidence != 100
 
-if matched_file.is_a?(Licensee::Project::LicenseFile)
   matcher = Licensee::Matchers::Dice.new(matched_file)
   licenses = matcher.licenses_by_similiarity
-  unless licenses.empty?
-    puts
-    puts "Here's the closest licenses:"
-    licenses[0...3].each do |license, similarity|
-      spdx_id = license.meta['spdx-id']
-      puts "* #{spdx_id} similarity: #{format_percent(similarity)}"
-    end
+  next if licenses.empty?
+  puts '  Closest licenses:'
+  licenses[0...3].each do |license, similarity|
+    spdx_id = license.meta['spdx-id']
+    percent = Licensee::ContentHelper.format_percent(similarity)
+    puts "    * #{spdx_id} similarity: #{percent}"
   end
 end
 
-exit 1
+exit !project.licenses.empty?

data/lib/licensee.rb

@@ -1,32 +1,18 @@
 require_relative 'licensee/version'
-require_relative 'licensee/content_helper'
-require_relative 'licensee/license'
-require_relative 'licensee/rule'
-
-# Projects
-require_relative 'licensee/project'
-require_relative 'licensee/projects/git_project'
-require_relative 'licensee/projects/fs_project'
-
-# Project files
-require_relative 'licensee/project_file'
-require_relative 'licensee/project_files/license_file'
-require_relative 'licensee/project_files/package_info'
-require_relative 'licensee/project_files/readme'
-
-# Matchers
-require_relative 'licensee/matchers/exact_matcher'
-require_relative 'licensee/matchers/copyright_matcher'
-require_relative 'licensee/matchers/dice_matcher'
-require_relative 'licensee/matchers/package_matcher'
-require_relative 'licensee/matchers/gemspec_matcher'
-require_relative 'licensee/matchers/npm_bower_matcher'
-require_relative 'licensee/matchers/cran_matcher'
-require_relative 'licensee/matchers/dist_zilla_matcher'
+require 'forwardable'
+require 'pathname'
+require 'rugged'
 
 module Licensee
+  autoload :ContentHelper, 'licensee/content_helper'
+  autoload :License, 'licensee/license'
+  autoload :Rule, 'licensee/rule'
+  autoload :Matchers, 'licensee/matchers'
+  autoload :Projects, 'licensee/projects'
+  autoload :ProjectFiles, 'licensee/project_files'
+
   # Over which percent is a match considered a match by default
-  CONFIDENCE_THRESHOLD = 95
+  CONFIDENCE_THRESHOLD = 98
 
   # Base domain from which to build license URLs
   DOMAIN = 'http://choosealicense.com'.freeze
@@ -45,9 +31,9 @@ module Licensee
     end
 
     def project(path, **args)
-      Licensee::GitProject.new(path, args)
-    rescue Licensee::GitProject::InvalidRepository
-      Licensee::FSProject.new(path, args)
+      Licensee::Projects::GitProject.new(path, args)
+    rescue Licensee::Projects::GitProject::InvalidRepository
+      Licensee::Projects::FSProject.new(path, args)
     end
 
     def confidence_threshold

data/lib/licensee/content_helper.rb

@@ -5,13 +5,12 @@ module Licensee
   module ContentHelper
     DIGEST = Digest::SHA1
     END_OF_TERMS_REGEX = /^\s*end of terms and conditions\s*$/i
-    HR_REGEX = /^\s*[=-]{4,}/
+    HR_REGEX = /[=\-\*][=\-\*\s]{3,}/
     ALT_TITLE_REGEX = {
       'bsd-2-clause'       => /bsd 2-clause( \"simplified\")? license/i,
       'bsd-3-clause'       => /bsd 3-clause( \"new\" or \"revised\")? license/i,
       'bsd-3-clause-clear' => /bsd 3-clause( clear)? license/i
     }.freeze
-    MAX_SCALED_DELTA = 150
 
     # A set of each word in the license, without duplicates
     def wordset
@@ -29,7 +28,7 @@ module Licensee
     # Number of characters that could be added/removed to still be
     # considered a potential match
     def max_delta
-      scaled_delta < MAX_SCALED_DELTA ? scaled_delta : MAX_SCALED_DELTA
+      @max_delta ||= (length * Licensee.inverse_confidence_threshold).to_i
     end
 
     # Given another license or project file, calculates the difference in length
@@ -46,8 +45,8 @@ module Licensee
     end
 
     # SHA1 of the normalized content
-    def hash
-      @hash ||= DIGEST.hexdigest content_normalized
+    def content_hash
+      @content_hash ||= DIGEST.hexdigest content_normalized
     end
 
     # Content with the title and version removed
@@ -65,7 +64,11 @@ module Licensee
     end
 
     # Content without title, version, copyright, whitespace, or insturctions
-    def content_normalized
+    #
+    # wrap - Optional width to wrap the content
+    #
+    # Returns a string
+    def content_normalized(wrap: nil)
       return unless content
       @content_normalized ||= begin
         string = content_without_title_and_version.downcase
@@ -75,6 +78,33 @@ module Licensee
         string, _partition, _instructions = string.partition(END_OF_TERMS_REGEX)
         strip_whitespace(string)
       end
+
+      if wrap.nil?
+        @content_normalized
+      else
+        Licensee::ContentHelper.wrap(@content_normalized, wrap)
+      end
+    end
+
+    # Wrap text to the given line length
+    def self.wrap(text, line_width = 80)
+      return if text.nil?
+      text = text.clone
+      text.gsub!(/([^\n])\n([^\n])/, '\1 \2')
+
+      text = text.split("\n").collect do |line|
+        if line.length > line_width
+          line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
+        else
+          line
+        end
+      end * "\n"
+
+      text.strip
+    end
+
+    def self.format_percent(float)
+      "#{format('%.2f', float)}%"
     end
 
     private
@@ -104,7 +134,7 @@ module Licensee
 
     # Strip HRs from MPL
     def strip_hrs(string)
-      string.gsub HR_REGEX, ''
+      string.gsub HR_REGEX, ' '
     end
 
     # Strip leading #s from the document
@@ -113,11 +143,7 @@ module Licensee
     end
 
     def strip_whitespace(string)
-      string.tr("\n", ' ').squeeze(' ').strip
-    end
-
-    def scaled_delta
-      @scaled_delta ||= (length * Licensee.inverse_confidence_threshold).to_i
+      string.gsub(/\s+/, ' ').squeeze(' ').strip
     end
   end
 end

data/lib/licensee/license.rb

@@ -4,6 +4,9 @@ require 'yaml'
 module Licensee
   class InvalidLicense < ArgumentError; end
   class License
+    @all = {}
+    @keys_licenses = {}
+
     class << self
       # All license objects defined via Licensee (via choosealicense.com)
       #
@@ -13,29 +16,31 @@ module Licensee
       #
       # Returns an Array of License objects.
       def all(options = {})
-        options = { hidden: false, featured: nil }.merge(options)
-        output = licenses.dup
-        output.reject!(&:hidden?) unless options[:hidden]
-        return output if options[:featured].nil?
-        output.select { |l| l.featured? == options[:featured] }
+        @all[options] ||= begin
+          options = { hidden: false, featured: nil }.merge(options)
+          output = licenses.dup
+          output.reject!(&:hidden?) unless options[:hidden]
+          return output if options[:featured].nil?
+          output.select { |l| l.featured? == options[:featured] }
+        end
       end
 
       def keys
         @keys ||= license_files.map do |license_file|
-          File.basename(license_file, '.txt').downcase
+          ::File.basename(license_file, '.txt').downcase
         end + PSEUDO_LICENSES
       end
 
       def find(key, options = {})
         options = { hidden: true }.merge(options)
-        all(options).find { |license| key.casecmp(license.key).zero? }
+        keys_licenses(options)[key.downcase]
       end
       alias [] find
       alias find_by_key find
 
       def license_dir
-        dir = File.dirname(__FILE__)
-        File.expand_path '../../vendor/choosealicense.com/_licenses', dir
+        dir = ::File.dirname(__FILE__)
+        ::File.expand_path '../../vendor/choosealicense.com/_licenses', dir
       end
 
       def license_files
@@ -47,6 +52,10 @@ module Licensee
       def licenses
         @licenses ||= keys.map { |key| new(key) }
       end
+
+      def keys_licenses(options = {})
+        @keys_licenses[options] ||= all(options).map { |l| [l.key, l] }.to_h
+      end
     end
 
     attr_reader :key
@@ -111,6 +120,10 @@ module Licensee
       key == 'gpl-2.0' || key == 'gpl-3.0'
     end
 
+    def lgpl?
+      key == 'lgpl-2.1' || key == 'lgpl-3.0'
+    end
+
     # Is this license a Creative Commons license?
     def creative_commons?
       key.start_with?('cc-')

data/lib/licensee/matchers.rb

@@ -0,0 +1,14 @@
+module Licensee
+  module Matchers
+    autoload :Matcher, 'licensee/matchers/matcher'
+    autoload :Cabal, 'licensee/matchers/cabal'
+    autoload :Copyright, 'licensee/matchers/copyright'
+    autoload :Cran, 'licensee/matchers/cran'
+    autoload :Dice, 'licensee/matchers/dice'
+    autoload :DistZilla, 'licensee/matchers/dist_zilla'
+    autoload :Exact, 'licensee/matchers/exact'
+    autoload :Gemspec, 'licensee/matchers/gemspec'
+    autoload :NpmBower, 'licensee/matchers/npm_bower'
+    autoload :Package, 'licensee/matchers/package'
+  end
+end

data/lib/licensee/matchers/cabal.rb

@@ -0,0 +1,16 @@
+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
+
+      private
+
+      def license_property
+        match = @file.content.match LICENSE_REGEX
+        match[1].downcase if match && match[1]
+      end
+    end
+  end
+end

data/lib/licensee/matchers/{copyright_matcher.rb → copyright.rb}

@@ -2,7 +2,7 @@
 
 module Licensee
   module Matchers
-    class Copyright
+    class Copyright < Licensee::Matchers::Matcher
       attr_reader :file
 
       # rubocop:disable Metrics/LineLength
@@ -10,10 +10,6 @@ module Licensee
       REGEX = /\A\s*#{COPYRIGHT_SYMBOLS}.*$/i
       # rubocop:enable Metrics/LineLength
 
-      def initialize(file)
-        @file = file
-      end
-
       def match
         # Note: must use content, and not content_normalized here
         if @file.content.strip =~ /\A#{REGEX}\z/i

data/lib/licensee/matchers/{cran_matcher.rb → cran.rb}

@@ -1,6 +1,6 @@
 module Licensee
   module Matchers
-    class Cran < Package
+    class Cran < Licensee::Matchers::Package
       attr_reader :file
 
       # While we could parse the DESCRIPTION file, prefer

data/lib/licensee/matchers/{dice_matcher.rb → dice.rb}

@@ -1,12 +1,6 @@
 module Licensee
   module Matchers
-    class Dice
-      attr_reader :file
-
-      def initialize(file)
-        @file = file
-      end
-
+    class Dice < Licensee::Matchers::Matcher
       # Return the first potential license that is more similar
       # than the confidence threshold
       def match

data/lib/licensee/matchers/{dist_zilla_matcher.rb → dist_zilla.rb}

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

data/lib/licensee/matchers/{exact_matcher.rb → exact.rb}

@@ -8,7 +8,8 @@ module Licensee
       end
 
       def match
-        Licensee.licenses(hidden: true).find do |license|
+        return @match if defined? @match
+        @match = Licensee.licenses(hidden: true).find do |license|
           license.length == @file.length && license.wordset == @file.wordset
         end
       end

data/lib/licensee/matchers/gemspec.rb

@@ -0,0 +1,24 @@
+module Licensee
+  module Matchers
+    class Gemspec < Licensee::Matchers::Package
+      DECLARATION_REGEX = /
+        ^\s*[a-z0-9_]+\.([a-z0-9_]+)\s*\=\s*[\'\"]([a-z\-0-9\.]+)[\'\"]\s*$
+        /ix
+
+      LICENSE_REGEX = /
+           ^\s*[a-z0-9_]+\.license\s*\=\s*[\'\"]([a-z\-0-9\.]+)[\'\"]\s*$
+           /ix
+
+      private
+
+      def license_property
+        match = @file.content.match LICENSE_REGEX
+        match[1].downcase if match && match[1]
+      end
+
+      def declarations
+        @declarations ||= @file.content.match DECLARATION_REGEX
+      end
+    end
+  end
+end