licensee 6.1.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0e6140bf397fcff609ea09c93a2021374d9d541
-  data.tar.gz: ab2638dcef843f3e1588e70a8e8647c2f5fc1b95
+  metadata.gz: 635a65cf8bd046b4f88528088de2dc0863648ed3
+  data.tar.gz: d3ddf6c216c07d29e868ce5772d70935a45cf75e
 SHA512:
-  metadata.gz: 7b7466fe1eb5be7a997ede72847a02244e21cfbf9a2724a51c53a383d312b291acd7d99c3fb2a46419272be1c925538ed8137b6baa34cee5c569004e47856c61
-  data.tar.gz: 111ae00501bc4bcd36155643cc742db0f34c86330127bfde0622891ef3d00fe8aedc294fd6df7f1728649e5d71617c0d51058159fb55fcfada2e8be8245aa3b6
+  metadata.gz: a4ea781352b1a409c3cf0652637a8f270b226770d8a27f93e8a590eaa3b9a320ed9a347e1c488bcd7f336b7c736e4e1262ba65420780ff569c2990fe1c8b0b88
+  data.tar.gz: 01c989238c40de7102e5558f3f4086c93cf65003ec451a8aa9d5ac6123cda560861d4b1486ac64923fbb5fbfed922b395d921a2215d859df6b1f4284649dd4ae

data/Rakefile

@@ -6,7 +6,7 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_licensee*.rb'
 end
 
-desc "Open console with Licensee loaded"
+desc 'Open console with Licensee loaded'
 task :console do
-  exec "pry -r ./lib/licensee.rb"
+  exec 'pry -r ./lib/licensee.rb'
 end

data/bin/licensee

@@ -1,14 +1,17 @@
 #!/usr/bin/env ruby
-require_relative "../lib/licensee"
+require_relative '../lib/licensee'
 
 path = ARGV[0] || Dir.pwd
 
-project = Licensee::GitProject.new(path, detect_packages: true)
+options = { detect_packages: true, detect_readme: true }
+project = Licensee::GitProject.new(path, options)
 file = project.matched_file
 
 if project.license_file
   puts "License file: #{project.license_file.filename}"
-  puts "Attribution: #{project.license_file.attribution}" if project.license_file.attribution
+  if project.license_file.attribution
+    puts "Attribution: #{project.license_file.attribution}"
+  end
 end
 
 if file
@@ -16,5 +19,5 @@ if file
   puts "Confidence: #{file.confidence}%"
   puts "Method: #{file.matcher.class}"
 else
-  puts "Unknown"
+  puts 'Unknown'
 end

data/lib/licensee.rb

@@ -1,33 +1,38 @@
-require_relative "licensee/version"
-require_relative "licensee/content_helper"
-require_relative "licensee/license"
-require_relative "licensee/project"
+require_relative 'licensee/version'
+require_relative 'licensee/content_helper'
+require_relative 'licensee/license'
+
+# 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.rb"
-require_relative "licensee/project_files/package_info.rb"
+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"
-
-class Licensee
+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'
+
+module Licensee
   # Over which percent is a match considered a match by default
   CONFIDENCE_THRESHOLD = 90
 
   # Base domain from which to build license URLs
-  DOMAIN = "http://choosealicense.com"
+  DOMAIN = 'http://choosealicense.com'.freeze
 
   class << self
     attr_writer :confidence_threshold
 
     # Returns an array of Licensee::License instances
-    def licenses(options={})
+    def licenses(options = {})
       Licensee::License.all(options)
     end
 
@@ -37,11 +42,9 @@ class Licensee
     end
 
     def project(path)
-      begin
-        Licensee::GitProject.new(path)
-      rescue Licensee::GitProject::InvalidRepository
-        Licensee::FSProject.new(path)
-      end
+      Licensee::GitProject.new(path)
+    rescue Licensee::GitProject::InvalidRepository
+      Licensee::FSProject.new(path)
     end
 
     def confidence_threshold

data/lib/licensee/content_helper.rb

@@ -1,13 +1,14 @@
 require 'set'
 require 'digest'
 
-class Licensee
+module Licensee
   module ContentHelper
-
     DIGEST = Digest::SHA1
 
     def wordset
-      @wordset ||= content_normalized.scan(/[\w']+/).to_set if content_normalized
+      @wordset ||= if content_normalized
+        content_normalized.scan(/[\w']+/).to_set
+      end
     end
 
     def hash
@@ -19,7 +20,7 @@ class Licensee
       @content_normalized ||= begin
         content_normalized = content.downcase.strip
         content_normalized.gsub!(/^#{Matchers::Copyright::REGEX}$/i, '')
-        content_normalized.gsub("\n", " ").squeeze(" ")
+        content_normalized.tr("\n", ' ').squeeze(' ')
       end
     end
   end

data/lib/licensee/license.rb

@@ -1,39 +1,41 @@
 require 'uri'
 require 'yaml'
 
-class Licensee
+module Licensee
   class InvalidLicense < ArgumentError; end
   class License
-
     class << self
-
       # All license objects defined via Licensee (via choosealicense.com)
       #
-      # Options - :hidden - boolean, whether to return hidden licenses, defaults to false
-      # Options - :featured - boolean, whether to return only (non)featured licenses, defaults to all
+      # Options:
+      # - :hidden - boolean, return hidden licenses (default: false)
+      # - :featured - boolean, return only (non)featured licenses (default: all)
       #
       # Returns an Array of License objects.
-      def all(options={})
+      def all(options = {})
+        options = { hidden: false, featured: nil }.merge(options)
         output = licenses.dup
-        output.reject! { |l| l.hidden? } unless options[:hidden]
-        output.select! { |l| l.featured? == options[:featured] } unless options[:featured].nil?
-        output
+        output.reject!(&:hidden?) unless options[:hidden]
+        return output if options[:featured].nil?
+        output.select { |l| l.featured? == options[:featured] }
       end
 
       def keys
-        @keys ||= license_files.map { |l| File.basename(l, ".txt").downcase } + ["other"]
+        @keys ||= license_files.map do |license_file|
+          File.basename(license_file, '.txt').downcase
+        end + PSEUDO_LICENSES
       end
 
-      def find(key, options={})
-        options = {:hidden => true}.merge(options)
-        key = key.downcase
-        all(options).find { |license| license.key == key }
+      def find(key, options = {})
+        options = { hidden: true }.merge(options)
+        all(options).find { |license| key.casecmp(license.key).zero? }
       end
-      alias_method :[], :find
-      alias_method :find_by_key, :find
+      alias [] find
+      alias find_by_key find
 
       def license_dir
-        File.expand_path "../../vendor/choosealicense.com/_licenses", File.dirname(__FILE__)
+        dir = File.dirname(__FILE__)
+        File.expand_path '../../vendor/choosealicense.com/_licenses', dir
       end
 
       def license_files
@@ -43,19 +45,26 @@ class Licensee
       private
 
       def licenses
-        @licenses ||= keys.map { |key| self.new(key) }
+        @licenses ||= keys.map { |key| new(key) }
       end
     end
 
     attr_reader :key
 
+    # These should be in sync with choosealicense.com's collection defaults
     YAML_DEFAULTS = {
-      "featured" => false,
-      "hidden"   => false,
-      "variant"  => false
-    }
-
-    HIDDEN_LICENSES = %w[other no-license]
+      'featured' => false,
+      'hidden'   => true,
+      'variant'  => false
+    }.freeze
+
+    # Pseudo-license are license placeholders with no content
+    #
+    # `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
+    PSEUDO_LICENSES = %w(other no-license).freeze
 
     include Licensee::ContentHelper
 
@@ -71,10 +80,10 @@ class Licensee
     # License metadata from YAML front matter
     def meta
       @meta ||= if parts && parts[1]
-        if YAML.respond_to? :safe_load
-          meta = YAML.safe_load(parts[1])
+        meta = if YAML.respond_to? :safe_load
+          YAML.safe_load(parts[1])
         else
-          meta = YAML.load(parts[1])
+          YAML.load(parts[1])
         end
         YAML_DEFAULTS.merge(meta)
       end
@@ -82,11 +91,11 @@ class Licensee
 
     # Returns the human-readable license name
     def name
-      meta.nil? ? key.capitalize : meta["title"]
+      meta.nil? ? key.capitalize : meta['title']
     end
 
     def nickname
-      meta["nickname"] if meta
+      meta['nickname'] if meta
     end
 
     def name_without_version
@@ -94,50 +103,52 @@ class Licensee
     end
 
     def featured?
-      !!(meta["featured"] if meta)
+      return YAML_DEFAULTS['featured'] unless meta
+      meta['featured']
     end
-    alias_method :featured, :featured?
+    alias featured featured?
 
     def hidden?
-      return true if HIDDEN_LICENSES.include?(key)
-      !!(meta["hidden"] if meta)
+      return true if PSEUDO_LICENSES.include?(key)
+      return YAML_DEFAULTS['hidden'] unless meta
+      meta['hidden']
     end
 
     # The license body (e.g., contents - frontmatter)
     def content
       @content ||= parts[2] if parts && parts[2]
     end
-    alias_method :to_s, :content
-    alias_method :text, :content
-    alias_method :body, :content
-
-    def inspect
-      "#<Licensee::License key=\"#{key}\" name=\"#{name}\">"
-    end
+    alias to_s content
+    alias text content
+    alias body content
 
     def url
       URI.join(Licensee::DOMAIN, "/licenses/#{key}/").to_s
     end
 
     def ==(other)
-      other != nil && key == other.key
+      !other.nil? && key == other.key
     end
 
     private
 
+    def pseudo_license?
+      PSEUDO_LICENSES.include?(key)
+    end
+
     # Raw content of license file, including YAML front matter
     def raw_content
-      @raw_content ||= if File.exists?(path)
+      return if pseudo_license?
+      @raw_content ||= if File.exist?(path)
         File.open(path).read
-      elsif key == "other" # A pseudo-license with no content
-        nil
       else
         raise Licensee::InvalidLicense, "'#{key}' is not a valid license key"
       end
     end
 
     def parts
-      @parts ||= raw_content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a if raw_content
+      return unless raw_content
+      @parts ||= raw_content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a
     end
   end
 end

data/lib/licensee/matchers/copyright_matcher.rb

@@ -1,5 +1,5 @@
 # encoding=utf-8
-class Licensee
+module Licensee
   module Matchers
     class Copyright
       REGEX = /\s*Copyright (©|\(c\)|\xC2\xA9)? ?(\d{4}|\[year\])(.*)?\s*/i
@@ -11,7 +11,7 @@ class Licensee
       def match
         # Note: must use content, and not content_normalized here
         if @file.content.strip =~ /\A#{REGEX}\z/i
-          Licensee::License.find("no-license") 
+          Licensee::License.find('no-license')
         end
       rescue
         nil

data/lib/licensee/matchers/dice_matcher.rb

@@ -1,4 +1,4 @@
-class Licensee
+module Licensee
   module Matchers
     class Dice
       def initialize(file)
@@ -18,7 +18,7 @@ class Licensee
         @match = if matches.empty?
           nil
         else
-          matches.max_by { |l, sim| sim }.first
+          matches.max_by { |_l, sim| sim }.first
         end
       end
 
@@ -28,7 +28,7 @@ class Licensee
       # the confidence threshold / 100
       def potential_licenses
         @potential_licenses ||= begin
-          licenses = Licensee.licenses(:hidden => true)
+          licenses = Licensee.licenses(hidden: true)
           licenses = licenses.select do |license|
             license.wordset && length_delta(license) <= max_delta
           end
@@ -45,7 +45,9 @@ class Licensee
       # Maximum possible difference between file length and license length
       # for a license to be a potential license to be matched
       def max_delta
-        @max_delta ||= (@file.wordset.size * (Licensee.confidence_threshold/100.0))
+        @max_delta ||= (
+          @file.wordset.size * (Licensee.confidence_threshold / 100.0)
+        )
       end
 
       # Confidence that the matched license is a match
@@ -54,6 +56,7 @@ class Licensee
       end
 
       private
+
       # Calculate percent changed between file and potential license
       def similarity(license)
         overlap = (@file.wordset & license.wordset).size

data/lib/licensee/matchers/exact_matcher.rb

@@ -1,4 +1,4 @@
-class Licensee
+module Licensee
   module Matchers
     class Exact
       def initialize(file)
@@ -6,7 +6,7 @@ class Licensee
       end
 
       def match
-        Licensee.licenses(:hidden => true).find { |l| l.wordset == @file.wordset }
+        Licensee.licenses(hidden: true).find { |l| l.wordset == @file.wordset }
       end
 
       def confidence

data/lib/licensee/matchers/gemspec_matcher.rb

@@ -1,12 +1,15 @@
-class Licensee
+module Licensee
   module Matchers
     class Gemspec < Package
       # We definitely don't want to be evaling arbitrary Gemspec files
       # While not 100% accurate, use some lenient regex to try to grep the
       # license declaration from the Gemspec as a string, if any
-      LICENSE_REGEX = /^\s*[a-z0-9_]+\.license\s*\=\s*[\'\"]([a-z\-0-9\.]+)[\'\"]\s*$/i
+      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]

data/lib/licensee/matchers/npm_bower_matcher.rb

@@ -1,11 +1,14 @@
-class Licensee
+module Licensee
   module Matchers
     class NpmBower < Package
       # While we could parse the package.json or bower.json file, prefer
       # a lenient regex for speed and security. Moar parsing moar problems.
-      LICENSE_REGEX = /\s*[\"\']license[\"\']\s*\:\s*[\'\"]([a-z\-0-9\.]+)[\'\"],?\s*/i
+      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]