licensee 6.1.1 → 7.0.0

data/lib/licensee/matchers/package_matcher.rb

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

data/lib/licensee/project.rb

@@ -1,32 +1,40 @@
 require 'rugged'
 
-class Licensee
-  private
+module Licensee
   class Project
-    def initialize(detect_packages)
-      @detect_packages = detect_packages
-    end
+    attr_reader :detect_readme, :detect_packages
+    alias detect_readme? detect_readme
+    alias detect_packages? detect_packages
 
-    def detect_packages?
-      @detect_packages
+    def initialize(detect_packages: false, detect_readme: false)
+      @detect_packages = detect_packages
+      @detect_readme = detect_readme
     end
 
-    # Returns the matching Licensee::License instance if a license can be detected
+    # Returns the matching License instance if a license can be detected
     def license
       @license ||= matched_file && matched_file.license
     end
 
     def matched_file
-      @matched_file ||= (license_file || package_file)
+      @matched_file ||= (license_file || readme || package_file)
     end
 
     def license_file
       return @license_file if defined? @license_file
       @license_file = begin
         content, name = find_file { |name| LicenseFile.name_score(name) }
-        if content && name
-          LicenseFile.new(content, name)
-        end
+        LicenseFile.new(content, name) if content && name
+      end
+    end
+
+    def readme
+      return unless detect_readme?
+      return @readme if defined? @readme
+      @readme = begin
+        content, name = find_file { |name| Readme.name_score(name) }
+        content = Readme.license_content(content)
+        Readme.new(content, name) if content && name
       end
     end
 
@@ -35,91 +43,8 @@ class Licensee
       return @package_file if defined? @package_file
       @package_file = begin
         content, name = find_file { |name| PackageInfo.name_score(name) }
-        if content && name 
-          PackageInfo.new(content, name)
-        end
+        PackageInfo.new(content, name) if content && name
       end
     end
   end
-
-  public
-
-  # Git-based project
-  # 
-  # analyze a given git repository for license information
-  class GitProject < Project
-    attr_reader :repository, :revision
-
-    class InvalidRepository < ArgumentError; end
-
-    def initialize(repo, revision: nil, detect_packages: false)
-      if repo.kind_of? Rugged::Repository
-        @repository = repo
-      else
-        @repository = Rugged::Repository.new(repo)
-      end
-
-      @revision = revision
-      super(detect_packages)
-    rescue Rugged::RepositoryError
-      raise InvalidRepository
-    end
-
-    private
-    def commit
-      @commit ||= revision ? repository.lookup(revision) : repository.last_commit
-    end
-
-    MAX_LICENSE_SIZE = 64 * 1024
-
-    def load_blob_data(oid)
-      data, _ = Rugged::Blob.to_buffer(repository, oid, MAX_LICENSE_SIZE)
-      data
-    end
-
-    def find_file
-      files = commit.tree.map do |entry|
-        next unless entry[:type] == :blob
-        if (score = yield entry[:name]) > 0
-          { :name => entry[:name], :oid => entry[:oid], :score => score }
-        end
-      end.compact
-
-      return if files.empty?
-      files.sort! { |a, b| b[:score] <=> a[:score] }
-
-      f = files.first
-      [load_blob_data(f[:oid]), f[:name]]
-    end
-  end
-
-  # Filesystem-based project
-  #
-  # Analyze a folder on the filesystem for license information
-  class FSProject < Project
-    attr_reader :path
-
-    def initialize(path, detect_packages: false)
-      @path = path
-      super(detect_packages)
-    end
-
-    private
-    def find_file
-      files = [] 
-
-      Dir.foreach(path) do |file|
-        next unless ::File.file?(::File.join(path, file))
-        if (score = yield file) > 0
-          files.push({ :name => file, :score => score })
-        end
-      end
-
-      return if files.empty?
-      files.sort! { |a, b| b[:score] <=> a[:score] }
-
-      f = files.first
-      [::File.read(::File.join(path, f[:name])), f[:name]]
-    end
-  end
 end

data/lib/licensee/project_file.rb

@@ -1,18 +1,17 @@
-class Licensee
+module Licensee
   class Project
-    private
-
     class File
       attr_reader :content, :filename
 
       def initialize(content, filename = nil)
         @content = content
-        @content.encode!(Encoding::UTF_8, :invalid => :replace, :undef => :replace, :replace => "")
+        options = { invalid: :replace, undef: :replace, replace: '' }
+        @content.encode!(Encoding::UTF_8, options)
         @filename = filename
       end
 
       def matcher
-        @matcher ||= possible_matchers.map { |m| m.new(self) }.find { |m| m.match }
+        @matcher ||= possible_matchers.map { |m| m.new(self) }.find(&:match)
       end
 
       # Returns the percent confident with the match
@@ -24,8 +23,8 @@ class Licensee
         matcher && matcher.match
       end
 
-      alias_method :match, :license
-      alias_method :path, :filename
+      alias match license
+      alias path filename
     end
   end
 end

data/lib/licensee/project_files/license_file.rb

@@ -1,4 +1,4 @@
-class Licensee
+module Licensee
   class Project
     class LicenseFile < Licensee::Project::File
       include Licensee::ContentHelper
@@ -6,7 +6,7 @@ class Licensee
       def possible_matchers
         [Matchers::Copyright, Matchers::Exact, Matchers::Dice]
       end
-      
+
       def attribution
         matches = /^#{Matchers::Copyright::REGEX}$/i.match(content)
         matches[0].strip if matches
@@ -18,7 +18,7 @@ class Licensee
         return 0.8 if filename =~ /\Acopy(ing|right)(\.[^.]+)?\z/i
         return 0.7 if filename =~ /\A(un)?licen[sc]e\.[^.]+\z/i
         return 0.5 if filename =~ /licen[sc]e/i
-        return 0.0
+        0.0
       end
     end
   end

data/lib/licensee/project_files/package_info.rb

@@ -1,11 +1,11 @@
-class Licensee
+module Licensee
   class Project
     class PackageInfo < Licensee::Project::File
       def possible_matchers
         case ::File.extname(filename)
-        when ".gemspec"
+        when '.gemspec'
           [Matchers::Gemspec]
-        when ".json"
+        when '.json'
           [Matchers::NpmBower]
         else
           []
@@ -13,10 +13,10 @@ class Licensee
       end
 
       def self.name_score(filename)
-        return 1.0  if ::File.extname(filename) == ".gemspec"
-        return 1.0  if filename == "package.json"
-        return 0.75 if filename == "bower.json"
-        return 0.0
+        return 1.0  if ::File.extname(filename) == '.gemspec'
+        return 1.0  if filename == 'package.json'
+        return 0.75 if filename == 'bower.json'
+        0.0
       end
     end
   end

data/lib/licensee/project_files/readme.rb

@@ -0,0 +1,24 @@
+module Licensee
+  class Project
+    class Readme < LicenseFile
+      SCORES = {
+        /\AREADME\z/i                    => 1.0,
+        /\AREADME\.(md|markdown|txt)\z/i => 0.9
+      }.freeze
+
+      CONTENT_REGEX = /^#+ Licen[sc]e$(.*?)(?=#+|\z)/im
+
+      def self.name_score(filename)
+        SCORES.each do |pattern, score|
+          return score if pattern =~ filename
+        end
+        0.0
+      end
+
+      def self.license_content(content)
+        match = CONTENT_REGEX.match(content)
+        match[1].strip if match
+      end
+    end
+  end
+end

data/lib/licensee/projects/fs_project.rb

@@ -0,0 +1,32 @@
+# Filesystem-based project
+#
+# Analyze a folder on the filesystem for license information
+module Licensee
+  class FSProject < Project
+    attr_reader :path
+
+    def initialize(path, **args)
+      @path = path
+      super(**args)
+    end
+
+    private
+
+    def find_file
+      files = []
+
+      Dir.foreach(path) do |file|
+        next unless ::File.file?(::File.join(path, file))
+        if (score = yield file) > 0
+          files.push(name: file, score: score)
+        end
+      end
+
+      return if files.empty?
+      files.sort! { |a, b| b[:score] <=> a[:score] }
+
+      f = files.first
+      [::File.read(::File.join(path, f[:name])), f[:name]]
+    end
+  end
+end

data/lib/licensee/projects/git_project.rb

@@ -0,0 +1,55 @@
+# Git-based project
+#
+# analyze a given git repository for license information
+module Licensee
+  class GitProject < Licensee::Project
+    attr_reader :repository, :revision
+
+    class InvalidRepository < ArgumentError; end
+
+    def initialize(repo, revision: nil, **args)
+      @repository = if repo.is_a? Rugged::Repository
+        repo
+      else
+        Rugged::Repository.new(repo)
+      end
+
+      @revision = revision
+      super(**args)
+    rescue Rugged::RepositoryError
+      raise InvalidRepository
+    end
+
+    private
+
+    def commit
+      @commit ||= if revision
+        repository.lookup(revision)
+      else
+        repository.last_commit
+      end
+    end
+
+    MAX_LICENSE_SIZE = 64 * 1024
+
+    def load_blob_data(oid)
+      data, = Rugged::Blob.to_buffer(repository, oid, MAX_LICENSE_SIZE)
+      data
+    end
+
+    def find_file
+      files = commit.tree.map do |entry|
+        next unless entry[:type] == :blob
+        if (score = yield entry[:name]) > 0
+          { name: entry[:name], oid: entry[:oid], score: score }
+        end
+      end.compact
+
+      return if files.empty?
+      files.sort! { |a, b| b[:score] <=> a[:score] }
+
+      f = files.first
+      [load_blob_data(f[:oid]), f[:name]]
+    end
+  end
+end

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
-class Licensee
-  VERSION = "6.1.1"
+module Licensee
+  VERSION = '7.0.0'.freeze
 end

data/test/fixtures/bower-with-readme/README.md

@@ -0,0 +1 @@
+This readme doesn't have a license, so detected the license from bower.

data/test/fixtures/bower-with-readme/bower.json

@@ -0,0 +1,3 @@
+{
+  "license": "mit"
+}

data/test/functions.rb

@@ -4,7 +4,7 @@ require 'securerandom'
 require_relative '../lib/licensee'
 
 def fixtures_base
-  File.expand_path "fixtures", File.dirname( __FILE__ )
+  File.expand_path 'fixtures', File.dirname(__FILE__)
 end
 
 def fixture_path(fixture)
@@ -13,9 +13,9 @@ end
 
 def license_from_path(path)
   license = File.open(path).read.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a[2]
-  license.sub! "[fullname]", "Ben Balter"
-  license.sub! "[year]", "2014"
-  license.sub! "[email]", "ben@github.invalid"
+  license.sub! '[fullname]', 'Ben Balter'
+  license.sub! '[year]', '2014'
+  license.sub! '[email]', 'ben@github.invalid'
   license
 end
 
@@ -26,8 +26,8 @@ def chaos_monkey(string)
   string
 end
 
-def verify_license_file(license, chaos = false, wrap=false)
-  expected = File.basename(license, ".txt")
+def verify_license_file(license, chaos = false, wrap = false)
+  expected = File.basename(license, '.txt')
 
   text = license_from_path(license)
   text = chaos_monkey(text) if chaos
@@ -39,17 +39,28 @@ def verify_license_file(license, chaos = false, wrap=false)
   msg = "No match for #{expected}."
 
   assert actual, msg
-  assert_equal expected, actual.key, "expeceted #{expected} but got #{actual.key} for .match. Confidence: #{license_file.confidence}. Method: #{license_file.matcher.class}"
+
+  msg = "Expeceted #{expected} but got #{actual.key} for .match. "
+  msg << "Confidence: #{license_file.confidence}. "
+  msg << "Method: #{license_file.matcher.class}"
+  assert_equal expected, actual.key, msg
 end
 
-def wrap(text, line_width=80)
+def wrap(text, line_width = 80)
   text = text.clone
   copyright = /^#{Licensee::Matchers::Copyright::REGEX}$/i.match(text)
-  text.gsub! /^#{Licensee::Matchers::Copyright::REGEX}$/i, '[COPYRIGHT]' if copyright
-  text.gsub! /([^\n])\n([^\n])/, '\1 \2'
+  if copyright
+    text.gsub!(/^#{Licensee::Matchers::Copyright::REGEX}$/i, '[COPYRIGHT]')
+  end
+  text.gsub!(/([^\n])\n([^\n])/, '\1 \2')
+
   text = text.split("\n").collect do |line|
-    line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
+    if line.length > line_width
+      line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
+    else
+      line
+    end
   end * "\n"
-  text.gsub! "[COPYRIGHT]", "\n#{copyright}\n" if copyright
+  text.gsub! '[COPYRIGHT]', "\n#{copyright}\n" if copyright
   text.strip
 end