licensee 9.6.0 → 9.7.0

data/spec/fixtures/webmock/licensee.json

@@ -0,0 +1,26 @@
+[
+  {
+   "name":         "LICENSE.txt",
+   "path":         "LICENSE.txt",
+   "sha":          "sha1",
+   "size":         1072,
+   "url":          "https://api.github.com/repos/benbalter/licensee/contents/LICENSE.txt?ref=master",
+   "html_url":     "https://github.com/benbalter/licensee/blob/master/LICENSE.txt",
+   "git_url":      "https://api.github.com/repos/benbalter/licensee/git/blobs/sha1",
+   "download_url": "https://raw.githubusercontent.com/benbalter/licensee/master/LICENSE.txt",
+   "type":         "file",
+   "_links":       {}
+  },
+  {
+   "name":         "README.md",
+   "path":         "README.md",
+   "sha":          "sha2",
+   "size":         13420,
+   "url":          "https://api.github.com/repos/benbalter/licensee/contents/README.md?ref=master",
+   "html_url":     "https://github.com/benbalter/licensee/blob/master/README.md",
+   "git_url":      "https://api.github.com/repos/benbalter/licensee/git/blobs/sha2",
+   "download_url": "https://raw.githubusercontent.com/benbalter/licensee/master/README.md",
+   "type":         "file",
+   "_links":       {}
+  }
+]

data/spec/integration_spec.rb

@@ -177,6 +177,15 @@ RSpec.describe 'integration test' do
             expect(subject.license).to eql(license)
           end
         end
+
+        context 'GPL2 with Markdown formatting' do
+          let(:license) { Licensee::License.find('gpl-2.0') }
+          let(:fixture) { 'markdown-gpl' }
+
+          it 'matches to GPL2' do
+            expect(subject.license).to eql(license)
+          end
+        end
       end
 
       context 'with the license file stubbed' do

data/spec/licensee/content_helper_spec.rb

@@ -44,7 +44,7 @@ LICENSE
   end
 
   it 'knows the length delta' do
-    expect(subject.length_delta(mit)).to eql(1000)
+    expect(subject.length_delta(mit)).to eql(999)
     expect(subject.length_delta(subject)).to eql(0)
   end
 
@@ -116,6 +116,10 @@ LICENSE
       expect(normalized_content).to_not match(/all rights reserved/i)
     end
 
+    it 'strips markup' do
+      expect(normalized_content).to_not match(/[*=_-]+/)
+    end
+
     Licensee::License.all(hidden: true).each do |license|
       context license.name do
         let(:stripped_content) { subject.content_without_title_and_version }

data/spec/licensee/license_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe Licensee::License do
-  let(:license_count) { 33 }
-  let(:hidden_license_count) { 21 }
+  let(:license_count) { 34 }
+  let(:hidden_license_count) { 22 }
   let(:featured_license_count) { 3 }
   let(:pseudo_license_count) { 2 }
   let(:non_featured_license_count) do
@@ -13,6 +13,7 @@ RSpec.describe Licensee::License do
   let(:other) { described_class.find('other') }
   let(:gpl) { described_class.find('gpl-3.0') }
   let(:lgpl) { described_class.find('lgpl-3.0') }
+  let(:content_hash) { '46cdc03462b9af57968df67b450cc4372ac41f53' }
 
   let(:license_dir) do
     File.expand_path 'vendor/choosealicense.com/_licenses', project_root
@@ -242,7 +243,6 @@ RSpec.describe Licensee::License do
     end
 
     it 'computes the hash' do
-      content_hash = 'd64f3bb4282a97b37454b5bb96a8a264a3363dc3'
       expect(mit.content_hash).to eql(content_hash)
     end
 

data/spec/licensee/matchers/gemspec_matcher_spec.rb

@@ -18,7 +18,9 @@ RSpec.describe Licensee::Matchers::Gemspec do
     'as spec.'      => "spec.license = 'mit'",
     'double quotes' => 's.license = "mit"',
     'no whitespace' => "s.license='mit'",
-    'uppercase'     => "s.license = 'MIT'"
+    'uppercase'     => "s.license = 'MIT'",
+    'array'         => "s.licenses = ['mit']",
+    'frozen'        => "s.license = 'mit'.freeze"
   }.each do |description, license_declaration|
     context "with a #{description} declaration" do
       let(:content) { license_declaration }
@@ -44,4 +46,12 @@ RSpec.describe Licensee::Matchers::Gemspec do
       expect(subject.match).to eql(Licensee::License.find('other'))
     end
   end
+
+  context 'a licenses property with multiple licenses' do
+    let(:content) { "s.licenses = ['mit', 'bsd-3-clause']" }
+
+    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

@@ -2,7 +2,8 @@ RSpec.describe Licensee::Matchers::NpmBower 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') }
+  let(:other) { Licensee::License.find('other') }
+
   subject { described_class.new(file) }
 
   it 'matches' do
@@ -42,7 +43,15 @@ RSpec.describe Licensee::Matchers::NpmBower do
     let(:content) { "'license': 'foo'" }
 
     it 'returns other' do
-      expect(subject.match).to eql(Licensee::License.find('other'))
+      expect(subject.match).to eql(other)
+    end
+  end
+
+  context 'a license expression' do
+    let(:content) { "'license': '(MIT OR Apache-2.0 OR AGPL-3.0+)'" }
+
+    it 'returns other' do
+      expect(subject.match).to eql(other)
     end
   end
 end

data/spec/licensee/matchers/spdx_matcher_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Licensee::Matchers::Spdx do
+  let(:content) { 'PackageLicenseDeclared: MIT' }
+  let(:file) do
+    Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.spdx')
+  end
+  let(:mit) { Licensee::License.find('mit') }
+  let(:other) { Licensee::License.find('other') }
+  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
+
+  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) { 'PackageLicenseDeclared: xyz' }
+
+    it 'returns other' do
+      expect(subject.match).to eql(other)
+    end
+  end
+
+  context 'a license expression' do
+    let(:content) { 'PackageLicenseDeclared: (MIT OR Apache-2.0)' }
+
+    it 'returns other' do
+      expect(subject.match).to eql(other)
+    end
+  end
+end

data/spec/licensee/project_files/license_file_spec.rb

@@ -2,6 +2,7 @@ RSpec.describe Licensee::ProjectFiles::LicenseFile do
   let(:filename) { 'LICENSE.txt' }
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { sub_copyright_info(mit) }
+  let(:content_hash) { '46cdc03462b9af57968df67b450cc4372ac41f53' }
 
   subject { described_class.new(content, filename) }
 
@@ -31,7 +32,6 @@ RSpec.describe Licensee::ProjectFiles::LicenseFile do
   end
 
   it 'creates the hash' do
-    content_hash = 'd64f3bb4282a97b37454b5bb96a8a264a3363dc3'
     expect(subject.content_hash).to eql(content_hash)
   end
 
@@ -109,11 +109,11 @@ RSpec.describe Licensee::ProjectFiles::LicenseFile do
 
     context 'any extension regex' do
       it 'matches .foo' do
-        expect(described_class::ANY_EXT_REGEX).to match('.foo')
+        expect(described_class::OTHER_EXT_REGEX).to match('.foo')
       end
 
       it 'does not match .md/foo' do
-        expect(described_class::ANY_EXT_REGEX).to_not match('.md/foo')
+        expect(described_class::OTHER_EXT_REGEX).to_not match('.md/foo')
       end
     end
 

data/spec/licensee/project_spec.rb

@@ -1,10 +1,15 @@
-[Licensee::Projects::FSProject,
- Licensee::Projects::GitProject].each do |project_type|
+[
+  Licensee::Projects::FSProject,
+  Licensee::Projects::GitProject,
+  Licensee::Projects::GitHubProject
+].each do |project_type|
   RSpec.describe project_type do
+    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
@@ -21,6 +26,26 @@
         subject.close
         FileUtils.rm_rf File.expand_path '.git', path
       end
+    elsif described_class == Licensee::Projects::GitHubProject
+      let(:path) do
+        stub_request(
+          :get, "#{api_base}/#{stubbed_org}/#{fixture}/contents/"
+        ).to_return(
+          status:  200,
+          body:    fixture_root_contents_from_api(fixture),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+
+        fixture_root_files(fixture).each do |file|
+          relative_path = File.basename(file)
+          parts = [api_base, stubbed_org, fixture, 'contents', relative_path]
+          stub_request(:get, parts.join('/'))
+            .with(headers: { 'accept' => 'application/vnd.github.v3.raw' })
+            .to_return(status: 200, body: File.read(file))
+        end
+
+        "https://github.com/#{stubbed_org}/#{fixture}"
+      end
     end
 
     if described_class == Licensee::Projects::GitProject
@@ -142,9 +167,11 @@
 
       # Using a `.gemspec` extension in the fixture breaks `gem release`
       before do
-        FileUtils.cp("#{path}/project._gemspec", "#{path}/project.gemspec")
+        from = "#{fixture_path(fixture)}/project._gemspec"
+        to   = "#{fixture_path(fixture)}/project.gemspec"
+        FileUtils.cp(from, to)
         if described_class == Licensee::Projects::GitProject
-          Dir.chdir path do
+          Dir.chdir fixture_path(fixture) do
             `git add project.gemspec`
             `git commit -m 'add real gemspec'`
           end
@@ -152,7 +179,7 @@
       end
 
       after do
-        FileUtils.rm("#{path}/project.gemspec")
+        FileUtils.rm("#{fixture_path(fixture)}/project.gemspec")
       end
 
       subject { described_class.new(path, detect_packages: true) }

data/spec/licensee/projects/github_project_spec.rb

@@ -0,0 +1,109 @@
+RSpec.describe Licensee::Projects::GitHubProject do
+  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
+        expect(instance.repo).to eq(repo)
+      end
+    end
+
+    context 'with a GitHub git URI' do
+      let(:github_url) { "https://github.com/#{repo}.git" }
+
+      it 'should set @repo, stripping the trailing extension' do
+        expect(instance.repo).to eq(repo)
+      end
+    end
+
+    context 'with a non-GitHub URI' do
+      let(:github_url) { "https://gitlab.com/#{repo}" }
+
+      it 'should raise an ArgumentError' do
+        expect { instance }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with a local folder' do
+      let(:github_url) { fixture_path('mit') }
+
+      it 'should raise an ArgumentError' do
+        expect { instance }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  context 'when the repo exists' do
+    before do
+      stub_request(:get, 'https://api.github.com/repos/benbalter/licensee/contents/')
+        .to_return(
+          status:  200,
+          body:    fixture_contents('webmock/licensee.json'),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+
+      stub_request(:get, 'https://api.github.com/repos/benbalter/licensee/contents/LICENSE.txt')
+        .with(headers: { 'accept' => 'application/vnd.github.v3.raw' })
+        .to_return(status: 200, body: license_file)
+
+      stub_request(:get, 'https://api.github.com/repos/benbalter/licensee/contents/README.md')
+        .with(headers: { 'accept' => 'application/vnd.github.v3.raw' })
+        .to_return(status: 200, body: readme_file)
+    end
+
+    it 'returns the license' do
+      expect(subject.license).to be_a(Licensee::License)
+      expect(subject.license).to eql(mit)
+    end
+
+    it 'returns the matched file' do
+      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::ProjectFiles::LicenseFile)
+      expect(subject.license_file.filename).to eql('LICENSE.txt')
+    end
+
+    it "doesn't return the readme" do
+      expect(subject.readme_file).to be_nil
+    end
+
+    it "doesn't return the package file" do
+      expect(subject.package_file).to be_nil
+    end
+
+    context 'readme detection' do
+      subject { described_class.new(github_url, detect_readme: true) }
+
+      it 'returns the readme' do
+        expect(subject.readme_file).to be_a(Licensee::ProjectFiles::ReadmeFile)
+        expect(subject.readme_file.filename).to eql('README.md')
+      end
+
+      it 'returns the license' do
+        expect(subject.license).to be_a(Licensee::License)
+        expect(subject.license).to eql(mit)
+      end
+    end
+  end
+
+  context 'when the repo cannot be found' do
+    let(:repo) { 'benbalter/not-foundsss' }
+
+    before do
+      stub_request(:get, 'https://api.github.com/repos/benbalter/not-foundsss/contents/')
+        .to_return(status: 404)
+    end
+
+    it 'raises a RepoNotFound error' do
+      expect { subject.license }.to raise_error(described_class::RepoNotFound)
+    end
+  end
+end

data/spec/licensee_spec.rb

@@ -2,7 +2,7 @@ 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) { 33 }
+  let(:hidden_license_count) { 34 }
 
   it 'exposes licenses' do
     expect(described_class.licenses).to be_an(Array)
@@ -19,8 +19,20 @@ RSpec.describe Licensee do
     expect(Licensee.license(license_path)).to eql(mit_license)
   end
 
-  it 'inits a project' do
-    expect(Licensee.project(project_path)).to be_a(Licensee::Projects::Project)
+  describe '.project' do
+    subject { Licensee.project(project_path) }
+
+    it 'inits a project' do
+      expect(subject).to be_a(Licensee::Projects::Project)
+    end
+
+    context 'given a GitHub repository' do
+      let(:project_path) { 'https://github.com/benbalter/licensee' }
+
+      it 'creates a GitHubProject' do
+        expect(subject).to be_a(Licensee::Projects::GitHubProject)
+      end
+    end
   end
 
   context 'confidence threshold' do

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ require 'open3'
 require 'tmpdir'
 require 'mustache'
 
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
 RSpec.configure do |config|
   config.shared_context_metadata_behavior = :apply_to_host_groups
   config.example_status_persistence_file_path = 'spec/examples.txt'
@@ -30,6 +33,23 @@ def fixture_path(fixture)
   File.expand_path fixture, fixtures_base
 end
 
+def fixture_contents(fixture)
+  File.read fixture_path(fixture)
+end
+
+def fixture_root_files(fixture)
+  Dir["#{fixture_path(fixture)}/*"]
+end
+
+def fixture_root_contents_from_api(fixture)
+  fixture_root_files(fixture).map do |file|
+    {
+      name: File.basename(file),
+      type: 'file'
+    }
+  end.to_json
+end
+
 def sub_copyright_info(license)
   Mustache.render license.content_for_mustache, fullname: 'Ben Balter',
                                                 year:     '2016',