licensee 9.10.0 → 9.13.1

data/spec/licensee/project_files/package_info_spec.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 RSpec.describe Licensee::ProjectFiles::PackageManagerFile do
+  subject { described_class.new(content, filename) }
+
   let(:content) { '' }
   let(:filename) { '' }
-  subject { described_class.new(content, filename) }
 
   context 'name scoring' do
     {
@@ -17,6 +20,7 @@ RSpec.describe Licensee::ProjectFiles::PackageManagerFile do
     }.each do |filename, expected_score|
       context "a file named #{filename}" do
         let(:score) { described_class.name_score(filename) }
+
         it 'scores the file' do
           expect(score).to eql(expected_score)
         end

data/spec/licensee/project_files/project_file_spec.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 RSpec.describe Licensee::ProjectFiles::ProjectFile do
+  subject { Licensee::ProjectFiles::LicenseFile.new(content, filename) }
+
   let(:filename) { 'LICENSE.txt' }
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { mit.content }
   let(:possible_matchers) { [Licensee::Matchers::Exact] }
 
-  subject { Licensee::ProjectFiles::LicenseFile.new(content, filename) }
   before do
     allow(subject).to receive(:possible_matchers).and_return(possible_matchers)
   end
+
   before { allow(subject).to receive(:length).and_return(mit.length) }
+
   before { allow(subject).to receive(:wordset).and_return(mit.wordset) }
 
   it 'stores the content' do
@@ -24,7 +29,7 @@ RSpec.describe Licensee::ProjectFiles::ProjectFile do
   end
 
   it 'returns the confidence' do
-    expect(subject.confidence).to eql(100)
+    expect(subject.confidence).to be(100)
   end
 
   it 'returns the license' do
@@ -48,6 +53,7 @@ RSpec.describe Licensee::ProjectFiles::ProjectFile do
     let(:hash) { subject.to_h }
     let(:expected) do
       {
+        attribution:        'Copyright (c) [year] [fullname]',
         filename:           'LICENSE.txt',
         content:            mit.content.to_s,
         content_hash:       subject.content_hash,

data/spec/licensee/project_files/readme_file_spec.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 RSpec.describe Licensee::ProjectFiles::ReadmeFile do
+  subject { described_class.new(content, filename) }
+
   let(:filename) { 'README.md' }
   let(:content) { '' }
-  subject { described_class.new(content, filename) }
 
   context 'scoring names' do
     {

data/spec/licensee/project_spec.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 [
   Licensee::Projects::FSProject,
   Licensee::Projects::GitProject,
   Licensee::Projects::GitHubProject
 ].each do |project_type|
   RSpec.describe project_type do
+    subject { described_class.new(path) }
+
     let(:stubbed_org) { '_licensee_test_fixture' }
     let(:mit) { Licensee::License.find('mit') }
     let(:other) { Licensee::License.find('other') }
     let(:fixture) { 'mit' }
     let(:path) { fixture_path(fixture) }
     let(:api_base) { 'https://api.github.com/repos' }
-    subject { described_class.new(path) }
 
     if described_class == Licensee::Projects::GitProject
       before do
@@ -44,14 +47,16 @@
             .to_return(status: 200, body: File.read(file))
         end
       end
+
       let(:path) { "https://github.com/#{stubbed_org}/#{fixture}" }
     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) }
 
+        let(:repo) { Rugged::Repository.new(path) }
+
         it 'returns the repository' do
           expect(subject.repository).to be_a(Rugged::Repository)
         end
@@ -59,6 +64,7 @@
 
       context 'when initialized with a revision' do
         let(:revision) { subject.repository.last_commit.oid }
+
         before do
           subject.instance_variable_set('@revision', revision)
         end
@@ -96,9 +102,9 @@
       let(:files) { subject.send(:files) }
 
       it 'returns the file list' do
-        expect(files.count).to eql(2)
+        expect(files.count).to be(2)
         license = files.find { |f| f[:name] == 'LICENSE.txt' }
-        expect(license).to_not be_nil
+        expect(license).not_to be_nil
 
         if described_class == Licensee::Projects::GitProject
           expect(files.first).to have_key(:oid)
@@ -121,7 +127,7 @@
 
           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.count).to be(1)
             expect(files.first[:name]).to eql('LICENSE.txt')
           end
         end
@@ -130,7 +136,7 @@
           let(:fixture) { 'license-in-parent-folder/license-folder/package' }
 
           it 'looks for licenses in current directory only' do
-            expect(files.count).to eql(0)
+            expect(files.count).to be(0)
           end
         end
       end
@@ -147,9 +153,10 @@
     end
 
     context 'readme detection' do
-      let(:fixture) { 'readme' }
       subject { described_class.new(path, detect_readme: true) }
 
+      let(:fixture) { 'readme' }
+
       it 'returns the readme' do
         expect(subject.readme_file).to be_a(Licensee::ProjectFiles::ReadmeFile)
         expect(subject.readme_file.filename).to eql('README.md')
@@ -162,6 +169,8 @@
     end
 
     context 'package manager detection' do
+      subject { described_class.new(path, detect_packages: true) }
+
       let(:fixture) { 'gemspec' }
 
       # Using a `.gemspec` extension in the fixture breaks `gem release`
@@ -200,8 +209,6 @@
         FileUtils.rm("#{fixture_path(fixture)}/project.gemspec")
       end
 
-      subject { described_class.new(path, detect_packages: true) }
-
       it 'returns the package file' do
         expected = Licensee::ProjectFiles::PackageManagerFile
         expect(subject.package_file).to be_a(expected)
@@ -230,19 +237,19 @@
       end
 
       it 'returns both licenses' do
-        expect(subject.licenses.count).to eql(2)
+        expect(subject.licenses.count).to be(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.count).to be(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.count).to be(2)
         expect(subject.license_files.first.filename).to eql('LICENSE')
         expect(subject.license_files.last.filename).to eql('LICENSE.txt')
       end
@@ -258,29 +265,29 @@
       end
 
       it 'matched_file returns copying.lesser' do
-        expect(subject.matched_file).to_not be_nil
+        expect(subject.matched_file).not_to 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).not_to 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.count).to be(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.count).to be(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.count).to be(2)
         expect(subject.license_files.first.filename).to eql('COPYING.lesser')
         expect(subject.license_files.last.filename).to eql('LICENSE')
       end

data/spec/licensee/projects/git_project_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.describe Licensee::Projects::GitProject do
+  let(:fixture) { 'mit' }
+
+  context 'new git repo handled as file system project' do
+    let(:path) { fixture_path(fixture) }
+
+    before do
+      Dir.chdir path do
+        `git init`
+      end
+    end
+
+    after do
+      FileUtils.rm_rf File.expand_path '.git', path
+    end
+
+    it 'raises InvalidRepository error' do
+      expect { described_class.new(path) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/licensee/projects/github_project_spec.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 RSpec.describe Licensee::Projects::GitHubProject do
+  subject(:instance) { described_class.new(github_url) }
+
   let(:repo) { 'benbalter/licensee' }
   let(:github_url) { "https://github.com/#{repo}" }
   let(:mit) { Licensee::License.find('mit') }
   let(:readme_file) { File.read(fixture_path('mit/README.md')) }
   let(:license_file) { File.read(fixture_path('mit/LICENSE.txt')) }
-  subject(:instance) { described_class.new(github_url) }
 
   describe '#initialize' do
     context 'with a GitHub URI' do
-      it 'should set @repo' do
+      it 'sets @repo' do
         expect(instance.repo).to eq(repo)
       end
     end
@@ -16,7 +19,7 @@ RSpec.describe Licensee::Projects::GitHubProject do
     context 'with a GitHub git URI' do
       let(:github_url) { "https://github.com/#{repo}.git" }
 
-      it 'should set @repo, stripping the trailing extension' do
+      it 'sets @repo, stripping the trailing extension' do
         expect(instance.repo).to eq(repo)
       end
     end
@@ -24,7 +27,7 @@ RSpec.describe Licensee::Projects::GitHubProject do
     context 'with a non-GitHub URI' do
       let(:github_url) { "https://gitlab.com/#{repo}" }
 
-      it 'should raise an ArgumentError' do
+      it 'raises an ArgumentError' do
         expect { instance }.to raise_error(ArgumentError)
       end
     end
@@ -32,7 +35,7 @@ RSpec.describe Licensee::Projects::GitHubProject do
     context 'with a local folder' do
       let(:github_url) { fixture_path('mit') }
 
-      it 'should raise an ArgumentError' do
+      it 'raises an ArgumentError' do
         expect { instance }.to raise_error(ArgumentError)
       end
     end

data/spec/licensee/rule_spec.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 RSpec.describe Licensee::Rule do
-  let(:groups) { %w[permissions conditions limitations] }
   subject do
     described_class.new(
       description: 'description',
@@ -9,6 +10,8 @@ RSpec.describe Licensee::Rule do
     )
   end
 
+  let(:groups) { %w[permissions conditions limitations] }
+
   it 'stores properties' do
     expect(subject.tag).to eql('tag')
     expect(subject.label).to eql('label')
@@ -28,7 +31,7 @@ RSpec.describe Licensee::Rule do
 
   it 'determines the file path' do
     path = described_class.file_path
-    expect(File.exist?(path)).to eql(true)
+    expect(File.exist?(path)).to be(true)
   end
 
   it 'loads a rule by tag' do
@@ -50,7 +53,7 @@ RSpec.describe Licensee::Rule do
   end
 
   it 'loads all rules' do
-    expect(described_class.all.count).to eql(16)
+    expect(described_class.all.count).to be(17)
     rule = described_class.all.first
     expect(rule).to be_a(described_class)
     expect(rule.tag).to eql('commercial-use')

data/spec/licensee_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 RSpec.describe Licensee do
   let(:project_path) { fixture_path('mit') }
   let(:license_path) { fixture_path('mit/LICENSE.txt') }
   let(:mit_license) { Licensee::License.find('mit') }
-  let(:hidden_license_count) { 36 }
+  let(:hidden_license_count) { 41 }
 
   it 'exposes licenses' do
     expect(described_class.licenses).to be_an(Array)
@@ -12,15 +14,15 @@ RSpec.describe Licensee do
   end
 
   it "detects a project's license" do
-    expect(Licensee.license(project_path)).to eql(mit_license)
+    expect(described_class.license(project_path)).to eql(mit_license)
   end
 
   it "detect a file's license" do
-    expect(Licensee.license(license_path)).to eql(mit_license)
+    expect(described_class.license(license_path)).to eql(mit_license)
   end
 
   describe '.project' do
-    subject { Licensee.project(project_path) }
+    subject { described_class.project(project_path) }
 
     it 'inits a project' do
       expect(subject).to be_a(Licensee::Projects::Project)
@@ -37,19 +39,20 @@ RSpec.describe Licensee do
 
   context 'confidence threshold' do
     it 'exposes the confidence threshold' do
-      expect(described_class.confidence_threshold).to eql(98)
+      expect(described_class.confidence_threshold).to be(98)
     end
 
     it 'exposes the inverse of the confidence threshold' do
-      expect(described_class.inverse_confidence_threshold).to eql(0.02)
+      expect(described_class.inverse_confidence_threshold).to be(0.02)
     end
 
     context 'user overridden' do
-      before { Licensee.confidence_threshold = 50 }
-      after { Licensee.confidence_threshold = nil }
+      before { described_class.confidence_threshold = 50 }
+
+      after { described_class.confidence_threshold = nil }
 
       it 'lets the user override the confidence threshold' do
-        expect(described_class.confidence_threshold).to eql(50)
+        expect(described_class.confidence_threshold).to be(50)
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-require 'coveralls'
-Coveralls.wear!
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
 
 require 'licensee'
 require 'open3'
@@ -27,6 +29,13 @@ def fixtures_base
   File.expand_path 'spec/fixtures', project_root
 end
 
+def fixtures
+  @fixtures ||= begin
+    dirs = Dir["#{fixtures_base}/*"].select { |e| File.directory?(e) }
+    dirs.map { |path| File.basename(path) }.sort_by { |k, _v| k }
+  end
+end
+
 def fixture_path(fixture)
   File.expand_path fixture, fixtures_base
 end
@@ -49,6 +58,10 @@ def fixture_root_contents_from_api(fixture)
   end.to_json
 end
 
+def fixture_licenses
+  @fixture_licenses ||= YAML.load_file(fixture_path('fixtures.yml'))
+end
+
 def field_values
   {
     fullname:    'Ben Balter',
@@ -90,7 +103,7 @@ def git_init(path)
 end
 
 def format_percent(float)
-  "#{format('%.2f', float)}%"
+  "#{format('%<float>.2f', float: float)}%"
 end
 
 def meta_fields
@@ -106,17 +119,19 @@ end
 RSpec::Matchers.define :be_detected_as do |expected|
   match do |actual|
     @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
+    @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::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"
+    content = @license_file.content
+    msg = +"Expected '#{content}' to match the #{license_name} license"
     msg << " (#{format_percent(similarity)} similarity"
     msg << "using the #{license_file.matcher} matcher)"
   end
@@ -126,9 +141,13 @@ RSpec::Matchers.define :be_detected_as do |expected|
     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 = +"Expected the content to *not* match the #{license_name} license"
     msg << " (#{format_percent(similarity)} similarity)"
   end
 
   diffable
 end
+
+def license_hashes
+  @license_hashes ||= JSON.parse(fixture_contents('license-hashes.json'))
+end