licensee 8.9.2 → 9.0.0.beta.1

data/spec/licensee/content_helper_spec.rb

@@ -11,11 +11,13 @@ RSpec.describe Licensee::ContentHelper do
   let(:content) do
     <<-EOS.freeze.gsub(/^\s*/, '')
   # The MIT License
-  =================
+	=================
 
-  Copyright 2016 Ben Balter
+	Copyright 2016 Ben Balter
+	*************************
 
   The made
+  * * * *
   up  license.
   -----------
 EOS
@@ -31,15 +33,11 @@ EOS
     expect(subject.length).to eql(20)
   end
 
-  it 'knows the max delta' do
-    expect(subject.max_delta).to eql(1)
-  end
-
   context 'a very long license' do
     let(:content) { 'license' * 1000 }
 
-    it 'does not return a max delta larger than 150' do
-      expect(subject.max_delta).to eql(150)
+    it 'returns the max delta' do
+      expect(subject.max_delta).to eql(140)
     end
   end
 
@@ -54,7 +52,19 @@ EOS
   end
 
   it 'calculates the hash' do
-    expect(subject.hash).to eql('3c59634b9fae4396a76a978f3f6aa718ed790a9a')
+    content_hash = '3c59634b9fae4396a76a978f3f6aa718ed790a9a'
+    expect(subject.content_hash).to eql(content_hash)
+  end
+
+  it 'wraps' do
+    content = Licensee::ContentHelper.wrap(mit.content, 40)
+    lines = content.split("\n")
+    expect(lines.first.length).to be <= 40
+  end
+
+  it 'formats percents' do
+    percent = Licensee::ContentHelper.format_percent(12.3456789)
+    expect(percent).to eql('12.35%')
   end
 
   context 'normalizing' do
@@ -72,6 +82,19 @@ EOS
 
     it 'strips HRs' do
       expect(normalized_content).to_not match '---'
+      expect(normalized_content).to_not match '==='
+      expect(normalized_content).to_not include '***'
+      expect(normalized_content).to_not include '* *'
+    end
+
+    it 'strips formatting from the MPL' do
+      license = Licensee::License.find('mpl-2.0')
+      expect(license.content_normalized).to_not include('* *')
+    end
+
+    it 'wraps' do
+      lines = mit.content_normalized(wrap: 40).split("\n")
+      expect(lines.first.length).to be <= 40
     end
 
     it 'squeezes whitespace' do
@@ -80,6 +103,7 @@ EOS
 
     it 'strips whitespace' do
       expect(normalized_content).to_not match(/\n/)
+      expect(normalized_content).to_not match(/\t/)
     end
 
     it 'strips markdown headings' do

data/spec/licensee/license_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe Licensee::License do
   let(:unlicense) { described_class.find('unlicense') }
   let(:other) { described_class.find('other') }
   let(:gpl) { described_class.find('gpl-3.0') }
+  let(:lgpl) { described_class.find('lgpl-3.0') }
 
   let(:license_dir) do
     File.expand_path 'vendor/choosealicense.com/_licenses', project_root
@@ -169,6 +170,11 @@ RSpec.describe Licensee::License do
       expect(gpl).to be_gpl
     end
 
+    it 'knows a license is lgpl' do
+      expect(mit).to_not be_gpl
+      expect(lgpl).to be_lgpl
+    end
+
     it 'knows if a license is CC' do
       expect(gpl).to_not be_creative_commons
       expect(cc_by).to be_creative_commons
@@ -185,7 +191,8 @@ RSpec.describe Licensee::License do
     end
 
     it 'computes the hash' do
-      expect(mit.hash).to eql('d64f3bb4282a97b37454b5bb96a8a264a3363dc3')
+      content_hash = 'd64f3bb4282a97b37454b5bb96a8a264a3363dc3'
+      expect(mit.content_hash).to eql(content_hash)
     end
 
     context 'with content stubbed' do

data/spec/licensee/matchers/cabal_matcher_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe Licensee::Matchers::Cabal do
+  let(:content) { 'license: mit' }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.txt') }
+  let(:mit) { Licensee::License.find('mit') }
+  let(:no_license) { Licensee::License.find('no-license') }
+  subject { described_class.new(file) }
+
+  it 'matches' do
+    expect(subject.match).to eql(mit)
+  end
+
+  it 'has a confidence' do
+    expect(subject.confidence).to eql(90)
+  end
+
+  {
+    'whitespace'         => 'license : mit',
+    'no whitespace'      => 'license:mit',
+    'leading whitespace' => ' license:mit'
+  }.each do |description, license_declaration|
+    context "with a #{description} declaration" do
+      let(:content) { license_declaration }
+
+      it 'matches' do
+        expect(subject.match).to eql(mit)
+      end
+    end
+  end
+
+  context 'no license field' do
+    let(:content) { 'foo: bar' }
+
+    it 'returns nil' do
+      expect(subject.match).to be_nil
+    end
+  end
+
+  context 'an unknown license' do
+    let(:content) { 'license: foo' }
+
+    it 'returns other' do
+      expect(subject.match).to eql(Licensee::License.find('other'))
+    end
+  end
+end

data/spec/licensee/matchers/copyright_matcher_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe Licensee::Matchers::Copyright do
   let(:content) { 'Copyright 2015 Ben Balter' }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'LICENSE.txt') }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.txt') }
   let(:mit) { Licensee::License.find('mit') }
   let(:no_license) { Licensee::License.find('no-license') }
 

data/spec/licensee/matchers/cran_matcher_spec.rb

@@ -3,7 +3,7 @@ RSpec.describe Licensee::Matchers::Cran do
   let(:gpl2) { Licensee::License.find('gpl-2.0') }
   let(:gpl3) { Licensee::License.find('gpl-3.0') }
   let(:content) { "License: MIT + file LICENSE\nPackage: test" }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'DESCRIPTION') }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'DESCRIPTION') }
   subject { described_class.new(file) }
 
   it 'stores the file' do
@@ -26,7 +26,8 @@ RSpec.describe Licensee::Matchers::Cran do
     'GPL (>=2) + file LICENSE' => Licensee::License.find('gpl-2.0'),
     'GPL (>=3)'                => Licensee::License.find('gpl-3.0'),
     'GPL-2'                    => Licensee::License.find('gpl-2.0'),
-    'GPL-3'                    => Licensee::License.find('gpl-3.0')
+    'GPL-3'                    => Licensee::License.find('gpl-3.0'),
+    'Foo'                      => Licensee::License.find('other')
   }.each do |license_declaration, license|
     context "with '#{license_declaration}' declaration" do
       let(:content) { "Package: test\nLicense: #{license_declaration}" }
@@ -36,4 +37,12 @@ RSpec.describe Licensee::Matchers::Cran do
       end
     end
   end
+
+  context 'with no license field' do
+    let(:content) { 'Package: test' }
+
+    it 'returns nil' do
+      expect(subject.match).to be_nil
+    end
+  end
 end

data/spec/licensee/matchers/dice_matcher_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Licensee::Matchers::Dice do
   let(:cc_by) { Licensee::License.find('cc-by-4.0') }
   let(:cc_by_sa) { Licensee::License.find('cc-by-sa-4.0') }
   let(:content) { sub_copyright_info(gpl.content) }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'LICENSE.txt') }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.txt') }
   subject { described_class.new(file) }
 
   it 'stores the file' do
@@ -50,7 +50,6 @@ RSpec.describe Licensee::Matchers::Dice do
     end
 
     it "doesn't match" do
-      skip 'Stacked MIT + GPL not properly detected'
       expect(content).to_not be_detected_as(gpl)
       expect(subject.match).to eql(nil)
       expect(subject.matches).to be_empty

data/spec/licensee/matchers/dist_zilla_matcher_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Licensee::Matchers::DistZilla do
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { 'license = MIT' }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'dist.ini') }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'dist.ini') }
   subject { described_class.new(file) }
 
   it 'stores the file' do
@@ -18,7 +18,8 @@ RSpec.describe Licensee::Matchers::DistZilla do
 
   {
     'spdx name'     => ['license = MIT', 'mit'],
-    'non spdx name' => ['license = Mozilla_2_0', 'mpl-2.0']
+    'non spdx name' => ['license = Mozilla_2_0', 'mpl-2.0'],
+    'other license' => ['license = Foo', 'other']
   }.each do |description, license_declaration_and_key|
     context "with a #{description}" do
       let(:content) { license_declaration_and_key[0] }
@@ -29,4 +30,12 @@ RSpec.describe Licensee::Matchers::DistZilla do
       end
     end
   end
+
+  context 'no license field' do
+    let(:content) { 'foo = bar' }
+
+    it 'returns nil' do
+      expect(subject.match).to be_nil
+    end
+  end
 end

data/spec/licensee/matchers/exact_matcher_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Licensee::Matchers::Exact do
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { sub_copyright_info(mit.content) }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'LICENSE.txt') }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.txt') }
   subject { described_class.new(file) }
 
   it 'stores the file' do

data/spec/licensee/matchers/gemspec_matcher_spec.rb

@@ -1,7 +1,9 @@
 RSpec.describe Licensee::Matchers::Gemspec do
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { "s.license = 'mit'" }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'project.gemspec') }
+  let(:file) do
+    Licensee::ProjectFiles::LicenseFile.new(content, 'project.gemspec')
+  end
   subject { described_class.new(file) }
 
   it 'matches' do
@@ -26,4 +28,20 @@ RSpec.describe Licensee::Matchers::Gemspec do
       end
     end
   end
+
+  context 'no license field' do
+    let(:content) { "s.foo = 'bar'" }
+
+    it 'returns nil' do
+      expect(subject.match).to be_nil
+    end
+  end
+
+  context 'an unknown license' do
+    let(:content) { "s.license = 'foo'" }
+
+    it 'returns other' do
+      expect(subject.match).to eql(Licensee::License.find('other'))
+    end
+  end
 end

data/spec/licensee/matchers/npm_bower_matcher_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe Licensee::Matchers::NpmBower do
   let(:content) { '"license": "mit"' }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'LICENSE.txt') }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.txt') }
   let(:mit) { Licensee::License.find('mit') }
   let(:no_license) { Licensee::License.find('no-license') }
   subject { described_class.new(file) }
@@ -14,11 +14,12 @@ RSpec.describe Licensee::Matchers::NpmBower do
   end
 
   {
-    'double quotes' => '"license": "mit"',
-    'single quotes' => "'license': 'mit'",
-    'mixed quotes'  => "'license': \"mit\"",
-    'whitespace'    => "'license' : 'mit'",
-    'no whitespace' => "'license':'mit'"
+    'double quotes'      => '"license": "mit"',
+    'single quotes'      => "'license': 'mit'",
+    'mixed quotes'       => "'license': \"mit\"",
+    'whitespace'         => "'license' : 'mit'",
+    'no whitespace'      => "'license':'mit'",
+    'leading whitespace' => " 'license':'mit'"
   }.each do |description, license_declaration|
     context "with a #{description} declaration" do
       let(:content) { license_declaration }
@@ -28,4 +29,20 @@ RSpec.describe Licensee::Matchers::NpmBower do
       end
     end
   end
+
+  context 'no license field' do
+    let(:content) { 'foo: bar' }
+
+    it 'returns nil' do
+      expect(subject.match).to be_nil
+    end
+  end
+
+  context 'an unknown license' do
+    let(:content) { "'license': 'foo'" }
+
+    it 'returns other' do
+      expect(subject.match).to eql(Licensee::License.find('other'))
+    end
+  end
 end

data/spec/licensee/matchers/package_matcher_spec.rb

@@ -1,9 +1,14 @@
 RSpec.describe Licensee::Matchers::Package do
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { '' }
-  let(:file) { Licensee::Project::LicenseFile.new(content, 'project.gemspec') }
+  let(:file) do
+    Licensee::ProjectFiles::LicenseFile.new(content, 'project.gemspec')
+  end
+  let(:license_property) { 'mit' }
   subject { described_class.new(file) }
-  before { allow(subject).to receive(:license_property).and_return('mit') }
+  before do
+    allow(subject).to receive(:license_property).and_return(license_property)
+  end
 
   it 'matches' do
     expect(subject.match).to eql(mit)
@@ -12,4 +17,28 @@ RSpec.describe Licensee::Matchers::Package do
   it 'has confidence' do
     expect(subject.confidence).to eql(90)
   end
+
+  context 'with a nil license property' do
+    let(:license_property) { nil }
+
+    it 'matches to nil' do
+      expect(subject.match).to be_nil
+    end
+  end
+
+  context 'with an empty license property' do
+    let(:license_property) { '' }
+
+    it 'matches to nil' do
+      expect(subject.match).to be_nil
+    end
+  end
+
+  context 'with an unmatched license proprerty' do
+    let(:license_property) { 'foo' }
+
+    it 'matches to other' do
+      expect(subject.match).to eql(Licensee::License.find('other'))
+    end
+  end
 end

data/spec/licensee/project_files/license_file_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe Licensee::Project::LicenseFile do
+RSpec.describe Licensee::ProjectFiles::LicenseFile do
   let(:filename) { 'LICENSE.txt' }
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { sub_copyright_info(mit.content) }
@@ -31,7 +31,8 @@ RSpec.describe Licensee::Project::LicenseFile do
   end
 
   it 'creates the hash' do
-    expect(subject.hash).to eql('d64f3bb4282a97b37454b5bb96a8a264a3363dc3')
+    content_hash = 'd64f3bb4282a97b37454b5bb96a8a264a3363dc3'
+    expect(subject.content_hash).to eql(content_hash)
   end
 
   context 'filename scoring' do
@@ -52,10 +53,10 @@ RSpec.describe Licensee::Project::LicenseFile do
       'copying.image'      => 0.5,
       'COPYRIGHT.go'       => 0.5,
       'LICENSE-MIT'        => 0.4,
-      'MIT-LICENSE.txt'    => 0.4,
+      'MIT-LICENSE.txt'    => 0.3,
       'mit-license-foo.md' => 0.4,
-      'COPYING-GPL'        => 0.3,
-      'COPYRIGHT-BSD'      => 0.3,
+      'COPYING-GPL'        => 0.35,
+      'COPYRIGHT-BSD'      => 0.35,
       'OFL.md'             => 0.2,
       'ofl.textile'        => 0.1,
       'ofl'                => 0.05,
@@ -133,7 +134,7 @@ RSpec.describe Licensee::Project::LicenseFile do
   end
 
   context 'CC false positives' do
-    let(:regex) { Licensee::Project::LicenseFile::CC_FALSE_POSITIVE_REGEX }
+    let(:regex) { Licensee::ProjectFiles::LicenseFile::CC_FALSE_POSITIVE_REGEX }
 
     it "knows MIT isn't a potential false positive" do
       expect(subject.content).to_not match(regex)
@@ -182,4 +183,59 @@ Creative Commons Attribution-NonCommercial 4.0
       end
     end
   end
+
+  context 'LGPL' do
+    let(:lgpl) { Licensee::License.find('lgpl-3.0') }
+    let(:content) { sub_copyright_info(lgpl.content) }
+
+    context 'with a COPYING.lesser file' do
+      let(:filename) { 'COPYING.lesser' }
+
+      it 'knows when a license file is LGPL' do
+        expect(subject).to be_lgpl
+      end
+
+      context 'with non-lgpl content' do
+        let(:content) { sub_copyright_info(mit.content) }
+
+        it 'is not lgpl' do
+          expect(subject).to_not be_lgpl
+        end
+      end
+    end
+
+    context 'with a different file name' do
+      let(:filename) { 'COPYING' }
+
+      it 'is not lgpl' do
+        expect(subject).to_not be_lgpl
+      end
+    end
+  end
+
+  context 'GPL' do
+    let(:gpl) { Licensee::License.find('gpl-3.0') }
+    let(:content) { sub_copyright_info(gpl.content) }
+
+    it 'knows its GPL' do
+      expect(subject).to be_gpl
+    end
+
+    context 'another license' do
+      let(:content) { sub_copyright_info(mit.content) }
+
+      it 'is not GPL' do
+        expect(subject).to_not be_gpl
+      end
+    end
+  end
+
+  context 'an unknown license' do
+    let(:content) { 'foo' }
+    let(:other) { Licensee::License.find('other') }
+
+    it 'matches to other' do
+      expect(subject.license).to eql(other)
+    end
+  end
 end