licensee 4.4.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 838dc4899938c974a913e9097f7ea675bbbaa3e4
-  data.tar.gz: ccfd1b06f7d7e012db37caad3013f464c5cbfc1b
+  metadata.gz: d6d6862fe6acd66d17a577ac52357cb55352c355
+  data.tar.gz: 1e52b8216cd0443e86bf2f6b4bdc67d3a12c6b3c
 SHA512:
-  metadata.gz: f990aba892efb0f74986af60d73dec263af25c19a83bb374555f39e2da16e530b079ac31d521ab30f53f971da3f19b1ef9bf225bebb38fbdabad398f27bc2a0e
-  data.tar.gz: be5014602677a7947136059c65dfe6018be36a23ecfc79d931676915b8f91ca54a34ce1721323653efcb7ce4aa3ace003e6bae89e92d87469e19b8bf2b9d59d8
+  metadata.gz: 4afadc876117dca8dae492065fd0145086dafb195f50dd0314e42299f9d4345ab4fc124fce52b89812553fb2cc082037e2ce03807a9cb074c080eb6af5ba8fa6
+  data.tar.gz: f0028b11795d26f8c23664ee7e010fc7c57eeead50b29c77dd2086dd8f5ee63da05a1459c564751d704e6da7b1fd3f79b753b18bff956691e077d2c7a2c5063a

data/README.md

@@ -18,7 +18,7 @@ Licensee automates the process of reading `LICENSE` files and compares their con
 
 2. If the license is an exact match to a known license. Licenses like GPL don't have a copyright notice that needs to be changed in the license itself, so if we strip away whitespace, we might get lucky, and direct string comparison in Ruby is cheap.
 
-3. If 90% of the lines match a known license. We use Git's internal change calculation method. To calcualte diffs, Git hashes each line of both files, and compares the hashes to tell the percent changed. This method is fast, but is done on a line-by-line basis, so if the license is wrapped differently, or has extra words inserted, it's not going to match the license.
+3. If 90% of the lines match a known license. We use Git's internal change calculation method. To calculate diffs, Git hashes each line of both files, and compares the hashes to tell the percent changed. This method is fast, but is done on a line-by-line basis, so if the license is wrapped differently, or has extra words inserted, it's not going to match the license.
 
 4. If we still can't match the license, we use a fancy math thing called the [Levenshtein distance algorithm](https://en.wikipedia.org/wiki/Levenshtein_distance), which while very slow, is really good at calculating the similarity between two strings. By calculating the percent changed from the known license to the license file, you can tell, e.g., that a given license is 90% similar to the MIT license, that 10% likely representing the copyright line being properly adapted to the project.
 

data/bin/licensee

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
-
 require_relative "../lib/licensee"
-project = Licensee::Project.new(Dir.pwd)
+
+path = ARGV[0] || Dir.pwd
+
+project = Licensee::Project.new(path)
 license = project.license_file
 
 if license

data/lib/licensee.rb

@@ -8,6 +8,7 @@ require_relative "licensee/license"
 require_relative "licensee/licenses"
 require_relative "licensee/license_file"
 require_relative "licensee/project"
+require_relative "licensee/filesystem_repository"
 require_relative "licensee/matcher"
 require_relative "licensee/matchers/exact_matcher"
 require_relative "licensee/matchers/copyright_matcher"

data/lib/licensee/filesystem_repository.rb

@@ -0,0 +1,38 @@
+class Licensee
+  class FilesystemRepository
+    def initialize(path)
+      @path = path
+    end
+
+    def last_commit() self end
+
+    def tree
+      return to_enum(__method__) unless block_given?
+      Dir.entries(@path).each do |name|
+        filename = File.join @path, name
+        next if File.directory? filename
+        yield(:name => name, :type => :blob, :oid => filename)
+      end
+    end
+
+    def lookup(filename)
+      Blob.new File.read(filename)
+    end
+
+    Blob = Struct.new(:content) do
+      def size
+        content.size
+      end
+
+      def similarity(other)
+        self.hashsig ? Rugged::Blob::HashSignature.compare(self.hashsig, other) : 0
+      end
+
+      def hashsig(options = 0)
+        @hashsig ||= Rugged::Blob::HashSignature.new(content, options)
+      rescue Rugged::InvalidError
+        nil
+      end
+    end
+  end
+end

data/lib/licensee/license.rb

@@ -70,7 +70,7 @@ class Licensee
     private
 
     def parts
-      @parts ||= content.match(/^(---\n.*\n---\n+)?(.*)/m).to_a
+      @parts ||= content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a
     end
   end
 end

data/lib/licensee/project.rb

@@ -10,6 +10,7 @@ class Licensee
       license.md
       unlicense
       copying
+      copyright
     ]
 
     # Initializes a new project
@@ -20,7 +21,15 @@ class Licensee
       if path_or_repo.kind_of? Rugged::Repository
         @repository = path_or_repo
       else
-        @repository = Rugged::Repository.new(path_or_repo)
+        begin
+          @repository = Rugged::Repository.new(path_or_repo)
+        rescue Rugged::RepositoryError
+          if revision
+            raise
+          else
+            @repository = FilesystemRepository.new(path_or_repo)
+          end
+        end
       end
 
       @revision = revision

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 class Licensee
-  VERSION = "4.4.2"
+  VERSION = "4.5.0"
 end

data/test/functions.rb

@@ -1,6 +1,7 @@
 # Pulled from helper.rb because something in the test suite monkey patches benchmarking
 
 require 'securerandom'
+require 'licensee/filesystem_repository'
 
 def fixtures_base
   File.expand_path "fixtures", File.dirname( __FILE__ )
@@ -18,27 +19,7 @@ def license_from_path(path)
   license
 end
 
-class FakeBlob
-  attr_reader :content
-
-  def initialize(content)
-    @content = content
-  end
-
-  def size
-    content.size
-  end
-
-  def similarity(other)
-    self.hashsig ? Rugged::Blob::HashSignature.compare(self.hashsig, other) : 0
-  end
-
-  def hashsig(options = 0)
-    @hashsig ||= Rugged::Blob::HashSignature.new(content, options)
-  rescue Rugged::InvalidError
-    nil
-  end
-end
+FakeBlob = Licensee::FilesystemRepository::Blob
 
 def chaos_monkey(string)
   Random.rand(5).times do

data/test/test_licensee_project.rb

@@ -1,57 +1,72 @@
 require 'helper'
+require 'fileutils'
 
 class TestLicenseeProject < Minitest::Test
 
-  def setup
-    @project = Licensee::Project.new fixture_path("licenses.git")
-  end
+  [true, false].each do |as_git|
+    describe(as_git ? "git" : "non-git") do
 
-  should "detect the license file" do
-    assert_equal Licensee::LicenseFile, @project.license_file.class
-  end
+      def make_project(fixture_name, as_git)
+        fixture = fixture_path fixture_name
 
-  should "detect the license" do
-    assert_equal "mit", @project.license.key
-  end
+        unless as_git
+          dest = File.join("tmp", "fixtures", fixture_name)
+          FileUtils.mkdir_p File.dirname(dest)
+          system "git", "clone", "-q", fixture, dest
+          FileUtils.rm_r File.join(dest, ".git")
+          fixture = dest
+        end
 
-  should "know the last commit" do
-    commit = @project.send(:commit)
-    assert_equal Rugged::Commit, commit.class
-    assert_equal "b02cbad9d254c41d16d56ed9d6d2cf07c1d837fd", commit.oid
-  end
+        Licensee::Project.new fixture
+      end
 
-  should "retrieve the tree" do
-    tree = @project.send(:tree)
-    assert_equal 1, tree.count
-    assert_equal "bcb552d06d9cf1cd4c048a6d3bf716849c2216cc", tree.first[:oid]
-  end
+      unless as_git
+        def teardown
+          FileUtils.rm_rf "tmp/fixtures"
+        end
+      end
 
-  should "return the license blob" do
-    assert_equal "LICENSE", @project.send(:license_blob)[:name]
-  end
+      should "detect the license file" do
+        project = make_project "licenses.git", as_git
+        assert_instance_of Licensee::LicenseFile, project.license_file
+      end
 
-  should "detect an atypically cased license file" do
-    project = Licensee::Project.new fixture_path("case-sensitive.git")
-    assert_equal Licensee::LicenseFile, project.license_file.class
-  end
+      should "detect the license" do
+        project = make_project "licenses.git", as_git
+        assert_equal "mit", project.license.key
+      end
 
-  should "detect MIT-LICENSE licensed projects" do
-    project = Licensee::Project.new fixture_path("named-license-file-prefix.git")
-    assert_equal "mit", project.license.key
-  end
+      should "return the license blob" do
+        project = make_project "licenses.git", as_git
+        assert_equal "LICENSE", project.send(:license_blob)[:name]
+      end
 
-  should "detect LICENSE-MIT licensed projects" do
-    project = Licensee::Project.new fixture_path("named-license-file-suffix.git")
-    assert_equal "mit", project.license.key
-  end
+      should "detect an atypically cased license file" do
+        project = make_project "case-sensitive.git", as_git
+        assert_instance_of Licensee::LicenseFile, project.license_file
+      end
 
-  should "not error out on repos with folders names license" do
-    project = Licensee::Project.new fixture_path("license-folder.git")
-    assert_equal nil, project.license
-  end
+      should "detect MIT-LICENSE licensed projects" do
+        project = make_project "named-license-file-prefix.git", as_git
+        assert_equal "mit", project.license.key
+      end
+
+      should "detect LICENSE-MIT licensed projects" do
+        project = make_project "named-license-file-suffix.git", as_git
+        assert_equal "mit", project.license.key
+      end
 
-  should "detect licence files" do
-    project = Licensee::Project.new fixture_path("licence.git")
-    assert_equal "mit", project.license.key
+      should "not error out on repos with folders names license" do
+        project = make_project "license-folder.git", as_git
+        assert_equal nil, project.license
+      end
+
+      should "detect licence files" do
+        project = make_project "licence.git", as_git
+        assert_equal "mit", project.license.key
+      end
+
+    end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.5.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -107,6 +107,7 @@ files:
 - Rakefile
 - bin/licensee
 - lib/licensee.rb
+- lib/licensee/filesystem_repository.rb
 - lib/licensee/license.rb
 - lib/licensee/license_file.rb
 - lib/licensee/licenses.rb
@@ -207,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem to detect under what license a project is distributed