licensee 8.9.2 → 9.0.0.beta.1

data/spec/licensee/project_files/package_info_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe Licensee::Project::PackageInfo do
+RSpec.describe Licensee::ProjectFiles::PackageManagerFile do
   let(:content) { '' }
   let(:filename) { '' }
   subject { described_class.new(content, filename) }
@@ -6,6 +6,7 @@ RSpec.describe Licensee::Project::PackageInfo do
   context 'name scoring' do
     {
       'licensee.gemspec' => 1.0,
+      'test.cabal'       => 1.0,
       'package.json'     => 1.0,
       'DESCRIPTION'      => 0.9,
       'dist.ini'         => 0.8,
@@ -32,6 +33,14 @@ RSpec.describe Licensee::Project::PackageInfo do
       end
     end
 
+    context 'with cabal file ' do
+      let(:filename) { 'test.cabal' }
+
+      it 'returns the cabal matcher' do
+        expect(possible_matchers).to eql([Licensee::Matchers::Cabal])
+      end
+    end
+
     context 'with package.json' do
       let(:filename) { 'package.json' }
 

data/spec/{project_file_spec.rb → licensee/project_files/project_file_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Licensee::Project::File do
+RSpec.describe Licensee::ProjectFiles::ProjectFile do
   let(:filename) { 'LICENSE.txt' }
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { mit.content }
@@ -30,4 +30,17 @@ RSpec.describe Licensee::Project::File do
   it 'returns the license' do
     expect(subject.license).to eql(mit)
   end
+
+  context 'with additional metadata' do
+    subject { described_class.new(content, name: filename, dir: Dir.pwd) }
+
+    it 'stores the filename' do
+      expect(subject.filename).to eql(filename)
+      expect(subject[:name]).to eql(filename)
+    end
+
+    it 'stores additional metadata' do
+      expect(subject[:dir]).to eql(Dir.pwd)
+    end
+  end
 end

data/spec/licensee/project_files/readme_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe Licensee::Project::Readme do
+RSpec.describe Licensee::ProjectFiles::ReadmeFile do
   let(:filename) { 'README.md' }
   let(:content) { '' }
   subject { described_class.new(content, filename) }

data/spec/licensee/project_spec.rb

@@ -1,11 +1,13 @@
-[Licensee::FSProject, Licensee::GitProject].each do |project_type|
+[Licensee::Projects::FSProject,
+ Licensee::Projects::GitProject].each do |project_type|
   RSpec.describe project_type do
     let(:mit) { Licensee::License.find('mit') }
+    let(:other) { Licensee::License.find('other') }
     let(:fixture) { 'mit' }
     let(:path) { fixture_path(fixture) }
     subject { described_class.new(path) }
 
-    if described_class == Licensee::GitProject
+    if described_class == Licensee::Projects::GitProject
       before do
         Dir.chdir path do
           `git init`
@@ -14,7 +16,32 @@
         end
       end
 
-      after { FileUtils.rm_rf File.expand_path '.git', path }
+      after do
+        subject.close
+        FileUtils.rm_rf File.expand_path '.git', path
+      end
+    end
+
+    if described_class == Licensee::Projects::GitProject
+      context 'when initialized with a repo' do
+        let(:repo) { Rugged::Repository.new(path) }
+        subject { described_class.new(repo) }
+
+        it 'returns the repository' do
+          expect(subject.repository).to be_a(Rugged::Repository)
+        end
+      end
+
+      context 'when initialized with a revision' do
+        let(:revision) { subject.repository.last_commit.oid }
+        before do
+          subject.instance_variable_set('@revision', revision)
+        end
+
+        it 'returns the commit' do
+          expect(subject.send(:commit).oid).to eql(revision)
+        end
+      end
     end
 
     it 'returns the license' do
@@ -23,12 +50,12 @@
     end
 
     it 'returns the matched file' do
-      expect(subject.matched_file).to be_a(Licensee::Project::LicenseFile)
+      expect(subject.matched_file).to be_a(Licensee::ProjectFiles::LicenseFile)
       expect(subject.matched_file.filename).to eql('LICENSE.txt')
     end
 
     it 'returns the license file' do
-      expect(subject.license_file).to be_a(Licensee::Project::LicenseFile)
+      expect(subject.license_file).to be_a(Licensee::ProjectFiles::LicenseFile)
       expect(subject.license_file.filename).to eql('LICENSE.txt')
     end
 
@@ -47,7 +74,7 @@
         expect(files.count).to eql(2)
         expect(files.first[:name]).to eql('LICENSE.txt')
 
-        if described_class == Licensee::GitProject
+        if described_class == Licensee::Projects::GitProject
           expect(files.first).to have_key(:oid)
         end
       end
@@ -56,6 +83,31 @@
         content = subject.send(:load_file, files.first)
         expect(content).to match('Permission is hereby granted')
       end
+
+      if described_class == Licensee::Projects::FSProject
+        context 'with search root argument' do
+          let(:fixture) { 'license-in-parent-folder/license-folder/package' }
+          let(:path) { fixture_path(fixture) }
+          let(:license_folder) { 'license-in-parent-folder/license-folder' }
+          let(:search_root) { fixture_path(license_folder) }
+          let(:subject) { described_class.new(path, search_root: search_root) }
+          let(:files) { subject.send(:files) }
+
+          it 'looks for licenses in parent directories up to the search root' do
+            # should not include the license in 'license-in-parent-folder' dir
+            expect(files.count).to eql(1)
+            expect(files.first[:name]).to eql('LICENSE.txt')
+          end
+        end
+
+        context 'without search root argument' do
+          let(:fixture) { 'license-in-parent-folder/license-folder/package' }
+
+          it 'looks for licenses in current directory only' do
+            expect(files.count).to eql(0)
+          end
+        end
+      end
     end
 
     context 'encoding correctness' do
@@ -73,7 +125,7 @@
       subject { described_class.new(path, detect_readme: true) }
 
       it 'returns the readme' do
-        expect(subject.readme_file).to be_a(Licensee::Project::Readme)
+        expect(subject.readme_file).to be_a(Licensee::ProjectFiles::ReadmeFile)
         expect(subject.readme_file.filename).to eql('README.md')
       end
 
@@ -89,7 +141,7 @@
       # Using a `.gemspec` extension in the fixture breaks `gem release`
       before do
         FileUtils.cp("#{path}/project._gemspec", "#{path}/project.gemspec")
-        if described_class == Licensee::GitProject
+        if described_class == Licensee::Projects::GitProject
           Dir.chdir path do
             `git add project.gemspec`
             `git commit -m 'add real gemspec'`
@@ -104,7 +156,8 @@
       subject { described_class.new(path, detect_packages: true) }
 
       it 'returns the package file' do
-        expect(subject.package_file).to be_a(Licensee::Project::PackageInfo)
+        expected = Licensee::ProjectFiles::PackageManagerFile
+        expect(subject.package_file).to be_a(expected)
         expect(subject.package_file.filename).to eql('project.gemspec')
       end
 
@@ -113,5 +166,77 @@
         expect(subject.license).to eql(mit)
       end
     end
+
+    context 'multiple licenses' do
+      let(:fixture) { 'multiple-license-files' }
+
+      it 'returns other for license' do
+        expect(subject.license).to eql(other)
+      end
+
+      it 'returns nil for matched_file' do
+        expect(subject.matched_file).to be_nil
+      end
+
+      it 'returns nil for license_file' do
+        expect(subject.license_file).to be_nil
+      end
+
+      it 'returns both licenses' do
+        expect(subject.licenses.count).to eql(2)
+        expect(subject.licenses.first).to eql(Licensee::License.find('mpl-2.0'))
+        expect(subject.licenses.last).to eql(mit)
+      end
+
+      it 'returns both matched_files' do
+        expect(subject.matched_files.count).to eql(2)
+        expect(subject.matched_files.first.filename).to eql('LICENSE')
+        expect(subject.matched_files.last.filename).to eql('LICENSE.txt')
+      end
+
+      it 'returns both license_files' do
+        expect(subject.license_files.count).to eql(2)
+        expect(subject.license_files.first.filename).to eql('LICENSE')
+        expect(subject.license_files.last.filename).to eql('LICENSE.txt')
+      end
+    end
+
+    context 'lgpl' do
+      let(:gpl) { Licensee::License.find('gpl-3.0') }
+      let(:lgpl) { Licensee::License.find('lgpl-3.0') }
+      let(:fixture) { 'lgpl' }
+
+      it 'license returns lgpl' do
+        expect(subject.license).to eql(lgpl)
+      end
+
+      it 'matched_file returns copying.lesser' do
+        expect(subject.matched_file).to_not be_nil
+        expect(subject.matched_file.filename).to eql('COPYING.lesser')
+      end
+
+      it 'license_file returns copying.lesser' do
+        expect(subject.license_file).to_not be_nil
+        expect(subject.license_file.filename).to eql('COPYING.lesser')
+      end
+
+      it 'returns both licenses' do
+        expect(subject.licenses.count).to eql(2)
+        expect(subject.licenses.first).to eql(lgpl)
+        expect(subject.licenses.last).to eql(gpl)
+      end
+
+      it 'returns both matched_files' do
+        expect(subject.matched_files.count).to eql(2)
+        expect(subject.matched_files.first.filename).to eql('COPYING.lesser')
+        expect(subject.matched_files.last.filename).to eql('LICENSE')
+      end
+
+      it 'returns both license_files' do
+        expect(subject.license_files.count).to eql(2)
+        expect(subject.license_files.first.filename).to eql('COPYING.lesser')
+        expect(subject.license_files.last.filename).to eql('LICENSE')
+      end
+    end
   end
 end

data/spec/licensee_spec.rb

@@ -18,20 +18,21 @@ RSpec.describe Licensee do
   end
 
   it 'inits a project' do
-    expect(Licensee.project(project_path)).to be_a(Licensee::Project)
+    expect(Licensee.project(project_path)).to be_a(Licensee::Projects::Project)
   end
 
   context 'confidence threshold' do
     it 'exposes the confidence threshold' do
-      expect(described_class.confidence_threshold).to eql(95)
+      expect(described_class.confidence_threshold).to eql(98)
     end
 
     it 'exposes the inverse of the confidence threshold' do
-      expect(described_class.inverse_confidence_threshold).to eql(0.05)
+      expect(described_class.inverse_confidence_threshold).to eql(0.02)
     end
 
     context 'user overridden' do
       before { Licensee.confidence_threshold = 50 }
+      after { Licensee.confidence_threshold = nil }
 
       it 'lets the user override the confidence threshold' do
         expect(described_class.confidence_threshold).to eql(50)

data/spec/spec_helper.rb

@@ -36,29 +36,16 @@ def sub_copyright_info(text)
   text
 end
 
-def wrap(text, line_width = 80)
-  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
-
 # Add random words to the end of a license to test similarity tollerances
 def add_random_words(string, count = 5)
-  string = string.dup
-  ipsum = %w[lorem ipsum dolor sit amet consectetur adipiscing elit]
+  words = string.dup.split(' ')
+  ipsum = File.read(fixture_path('ipsum.txt')).split(' ')
   count.times do
-    string << " #{ipsum[Random.rand(ipsum.length)]}"
+    word = ipsum[Random.rand(ipsum.length)]
+    index = Random.rand(words.length)
+    words.insert(index, word)
   end
-  string
+  words.join(' ')
 end
 
 # Init git dir
@@ -85,14 +72,15 @@ end
 
 RSpec::Matchers.define :be_detected_as do |expected|
   match do |actual|
-    @expected_as_array = [expected.content]
-    license_file = Licensee::Project::LicenseFile.new(actual, 'LICENSE')
+    @expected_as_array = [expected.content_normalized(wrap: 80)]
+    license_file = Licensee::ProjectFiles::LicenseFile.new(actual, 'LICENSE')
+    @actual = license_file.content_normalized(wrap: 80)
     return false unless license_file.license
     values_match? expected, license_file.license
   end
 
   failure_message do |actual|
-    license_file = Licensee::Project::LicenseFile.new(actual, 'LICENSE')
+    license_file = Licensee::ProjectFiles::LicenseFile.new(actual, 'LICENSE')
     license_name = expected.meta['spdx-id'] || expected.key
     similarity = expected.similarity(license_file)
     msg = "Expected the content to match the #{license_name} license"
@@ -101,9 +89,10 @@ RSpec::Matchers.define :be_detected_as do |expected|
   end
 
   failure_message_when_negated do |actual|
-    license_file = Licensee::Project::LicenseFile.new(actual, 'LICENSE')
+    license_file = Licensee::ProjectFiles::LicenseFile.new(actual, 'LICENSE')
     license_name = expected.meta['spdx-id'] || expected.key
     similarity = expected.similarity(license_file)
+
     msg = "Expected the content to *not* match the #{license_name} license"
     msg << " (#{format_percent(similarity)} similarity)"
   end

data/spec/vendored_license_spec.rb

@@ -1,13 +1,15 @@
-RSpec.describe 'vendored licenes' do
+RSpec.describe 'vendored licenses' do
   let(:filename) { 'LICENSE.txt' }
-  let(:license_file) { Licensee::Project::LicenseFile.new(content, filename) }
+  let(:license_file) do
+    Licensee::ProjectFiles::LicenseFile.new(content, filename)
+  end
   let(:detected_license) { license_file.license if license_file }
   let(:wtfpl) { Licensee::License.find('wtfpl') }
 
   Licensee.licenses(hidden: true).each do |license|
     next if license.pseudo_license?
 
-    context "the #{license.meta['spdx-id'] || license.key} license" do
+    context "the #{license.name} license" do
       let(:content_with_copyright) { sub_copyright_info(license.content) }
       let(:content) { content_with_copyright }
 
@@ -17,8 +19,10 @@ RSpec.describe 'vendored licenes' do
 
       context 'when modified' do
         let(:line_length) { 60 }
-        let(:random_words) { 3 }
-        let(:content_rewrapped) { wrap(content_with_copyright, line_length) }
+        let(:random_words) { 75 }
+        let(:content_rewrapped) do
+          Licensee::ContentHelper.wrap(content_with_copyright, line_length)
+        end
         let(:content_with_random_words) do
           add_random_words(content_with_copyright, random_words)
         end
@@ -27,7 +31,6 @@ RSpec.describe 'vendored licenes' do
           let(:content) { wtfpl.send :strip_title, content_with_copyright }
 
           it 'detects the license' do
-            skip 'The WTFPL is too short to be modified' if license == wtfpl
             expect(content).to be_detected_as(license)
           end
         end
@@ -53,18 +56,18 @@ RSpec.describe 'vendored licenes' do
         context 'with random words added' do
           let(:content) { content_with_random_words }
 
-          it 'detects the license' do
-            skip 'The WTFPL is too short to be modified' if license == wtfpl
-            expect(content).to be_detected_as(license)
+          it 'does not match the license' do
+            expect(content).to_not be_detected_as(license)
           end
         end
 
         context 'when rewrapped with random words added' do
-          let(:content) { wrap(content_with_random_words, line_length) }
+          let(:content) do
+            Licensee::ContentHelper.wrap(content_with_random_words, line_length)
+          end
 
-          it 'detects the license' do
-            skip 'The WTFPL is too short to be modified' if license == wtfpl
-            expect(content).to be_detected_as(license)
+          it 'does not match the license' do
+            expect(content).to_not be_detected_as(license)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 8.9.2
+  version: 9.0.0.beta.1
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -108,21 +108,26 @@ files:
 - lib/licensee.rb
 - lib/licensee/content_helper.rb
 - lib/licensee/license.rb
-- lib/licensee/matchers/copyright_matcher.rb
-- lib/licensee/matchers/cran_matcher.rb
-- lib/licensee/matchers/dice_matcher.rb
-- lib/licensee/matchers/dist_zilla_matcher.rb
-- lib/licensee/matchers/exact_matcher.rb
-- lib/licensee/matchers/gemspec_matcher.rb
-- lib/licensee/matchers/npm_bower_matcher.rb
-- lib/licensee/matchers/package_matcher.rb
-- lib/licensee/project.rb
-- lib/licensee/project_file.rb
+- lib/licensee/matchers.rb
+- lib/licensee/matchers/cabal.rb
+- lib/licensee/matchers/copyright.rb
+- lib/licensee/matchers/cran.rb
+- lib/licensee/matchers/dice.rb
+- lib/licensee/matchers/dist_zilla.rb
+- lib/licensee/matchers/exact.rb
+- lib/licensee/matchers/gemspec.rb
+- lib/licensee/matchers/matcher.rb
+- lib/licensee/matchers/npm_bower.rb
+- lib/licensee/matchers/package.rb
+- lib/licensee/project_files.rb
 - lib/licensee/project_files/license_file.rb
-- lib/licensee/project_files/package_info.rb
-- lib/licensee/project_files/readme.rb
+- lib/licensee/project_files/package_manager_file.rb
+- lib/licensee/project_files/project_file.rb
+- lib/licensee/project_files/readme_file.rb
+- lib/licensee/projects.rb
 - lib/licensee/projects/fs_project.rb
 - lib/licensee/projects/git_project.rb
+- lib/licensee/projects/project.rb
 - lib/licensee/rule.rb
 - lib/licensee/version.rb
 - spec/bin_spec.rb
@@ -130,22 +135,29 @@ files:
 - spec/fixtures/cc-by-nc-sa/LICENSE
 - spec/fixtures/cc-by-nd/LICENSE
 - spec/fixtures/copyright-encoding/COPYING
+- spec/fixtures/crlf-license/LICENSE
 - spec/fixtures/description-license/DESCRIPTION
 - spec/fixtures/description-license/LICENSE
 - spec/fixtures/fcpl-modified-mpl/LICENSE
 - spec/fixtures/gemspec/project._gemspec
 - spec/fixtures/gpl3-without-instructions/LICENSE
+- spec/fixtures/ipsum.txt
 - spec/fixtures/lgpl/COPYING.lesser
 - spec/fixtures/lgpl/LICENSE
 - spec/fixtures/license-folder/README.md
+- spec/fixtures/license-in-parent-folder/LICENSE.txt
+- spec/fixtures/license-in-parent-folder/license-folder/LICENSE.txt
 - spec/fixtures/mit/LICENSE.txt
 - spec/fixtures/mit/README.md
 - spec/fixtures/mpl-without-hrs/LICENSE
+- spec/fixtures/multiple-license-files/LICENSE
+- spec/fixtures/multiple-license-files/LICENSE.txt
 - spec/fixtures/readme/README.md
 - spec/fixtures/wrk-modified-apache/LICENSE
 - spec/integration_spec.rb
 - spec/licensee/content_helper_spec.rb
 - spec/licensee/license_spec.rb
+- spec/licensee/matchers/cabal_matcher_spec.rb
 - spec/licensee/matchers/copyright_matcher_spec.rb
 - spec/licensee/matchers/cran_matcher_spec.rb
 - spec/licensee/matchers/dice_matcher_spec.rb
@@ -156,11 +168,11 @@ files:
 - spec/licensee/matchers/package_matcher_spec.rb
 - spec/licensee/project_files/license_file_spec.rb
 - spec/licensee/project_files/package_info_spec.rb
+- spec/licensee/project_files/project_file_spec.rb
 - spec/licensee/project_files/readme_spec.rb
 - spec/licensee/project_spec.rb
 - spec/licensee/rule_spec.rb
 - spec/licensee_spec.rb
-- spec/project_file_spec.rb
 - spec/spec_helper.rb
 - spec/vendored_license_spec.rb
 - vendor/choosealicense.com/_data/fields.yml
@@ -211,9 +223,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11