licensee 9.4.0 → 9.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65fcfb5d490c6b1c20c0b28f46cb67384755d869
-  data.tar.gz: 68d6bd7a409d4fe4bcac047a02e4ae9118d76a18
+  metadata.gz: ba8051e36fee570aacfe7594c0ba6b293f6ec091
+  data.tar.gz: 6c24e69c2f219d3fb32e4a86e240a04a28e547ae
 SHA512:
-  metadata.gz: e4b5cac3a131f7a666126f6c7d0e8bd43372b07c6c9eb1e101e4248273879ae67cfccd20869e6cad30c3b7409368653d882316a4205bdd45c7a4b3edf546a131
-  data.tar.gz: 6ce3b0827cd6f725c210fea7aa8a929309ea3c2efff5bff5107fb645bcc2826443b51c964b1d0c3a6e1f227f0014f4c11610f16d3eff522d0841a4da9fbfda7b
+  metadata.gz: cdfe0a0195cbdaeaae793156af0aebde1faf319ce812ebe999386c8d35f30b4f20332be41ab97679af82a0f30046fd5de4654b13a3e125c377900d346266ec5d
+  data.tar.gz: 2a9562f47b7ac5667b38e3871bda75b88856695682b77cd8c7830352f64336d5e4d056da65b93037baa3807c8ac556bb226be54794a3bc8d51bffc7f6c9a8d11

data/lib/licensee/content_helper.rb

@@ -6,11 +6,7 @@ module Licensee
     DIGEST = Digest::SHA1
     END_OF_TERMS_REGEX = /^\s*end of terms and conditions\s*$/i
     HR_REGEX = /[=\-\*][=\-\*\s]{3,}/
-    ALT_TITLE_REGEX = {
-      'bsd-2-clause'       => /bsd 2-clause( \"simplified\")? license/i,
-      'bsd-3-clause'       => /bsd 3-clause( \"new\" or \"revised\")? license/i,
-      'bsd-3-clause-clear' => /(clear bsd|bsd 3-clause( clear)?) license/i
-    }.freeze
+    ALT_TITLE_REGEX = License::ALT_TITLE_REGEX
     ALL_RIGHTS_RESERVED_REGEX = /\Aall rights reserved\.?$/i
     WHITESPACE_REGEX = /\s+/
     MARKDOWN_HEADING_REGEX = /\A\s*#+/
@@ -62,7 +58,7 @@ module Licensee
         string = content.strip
         string = strip_markdown_headings(string)
         string = strip_hrs(string)
-        string = strip_title(string) while string =~ title_regex
+        string = strip_title(string) while string =~ ContentHelper.title_regex
         strip_version(string).strip
       end
     end
@@ -112,21 +108,25 @@ module Licensee
       "#{format('%.2f', float)}%"
     end
 
-    private
+    def self.title_regex
+      licenses = Licensee::License.all(hidden: true, psuedo: false)
+      titles = licenses.map(&:title_regex)
 
-    def license_names
-      @license_titles ||= License.all(hidden: true).map do |license|
-        regex = ALT_TITLE_REGEX[license.key]
-        regex || license.name_without_version.downcase.sub('*', 'u')
+      # Title regex must include the version to support matching within
+      # families, but for sake of normalization, we can be less strict
+      without_versions = licenses.map do |license|
+        next if license.title == license.name_without_version
+        Regexp.new Regexp.escape(license.name_without_version), 'i'
       end
-    end
+      titles.concat(without_versions.compact)
 
-    def title_regex
-      /\A\(?(the )?(#{Regexp.union(license_names).source}).*$/i
+      /\A\s*\(?(the )?#{Regexp.union titles}.*$/i
     end
 
+    private
+
     def strip_title(string)
-      strip(string, title_regex)
+      strip(string, ContentHelper.title_regex)
     end
 
     def strip_version(string)

data/lib/licensee/license.rb

@@ -16,9 +16,10 @@ module Licensee
       # Returns an Array of License objects.
       def all(options = {})
         @all[options] ||= begin
-          options = { hidden: false, featured: nil }.merge(options)
+          options = DEFAULT_OPTIONS.merge(options)
           output = licenses.dup
           output.reject!(&:hidden?) unless options[:hidden]
+          output.reject!(&:pseudo_license?) unless options[:psuedo]
           return output if options[:featured].nil?
           output.select { |l| l.featured? == options[:featured] }
         end
@@ -37,6 +38,13 @@ module Licensee
       alias [] find
       alias find_by_key find
 
+      # Given a license title or nickname, fuzzy match the license
+      def find_by_title(title)
+        License.all(hidden: true, psuedo: false).find do |license|
+          title =~ /\A(the )?#{license.title_regex}( license)?\z/i
+        end
+      end
+
       def license_dir
         dir = ::File.dirname(__FILE__)
         ::File.expand_path '../../vendor/choosealicense.com/_licenses', dir
@@ -70,6 +78,19 @@ module Licensee
     # Note: A lack of detected license will be a nil license
     PSEUDO_LICENSES = %w[other no-license].freeze
 
+    # Default options to use when retrieving licenses via #all
+    DEFAULT_OPTIONS = {
+      hidden:   false,
+      featured: nil,
+      psuedo:   true
+    }.freeze
+
+    ALT_TITLE_REGEX = {
+      'bsd-2-clause'       => /bsd 2-clause(?: \"simplified\")?/i,
+      'bsd-3-clause'       => /bsd 3-clause(?: \"new\" or \"revised\")?/i,
+      'bsd-3-clause-clear' => /(?:clear bsd|bsd 3-clause(?: clear)?)/i
+    }.freeze
+
     include Licensee::ContentHelper
     extend Forwardable
     def_delegators :meta, *LicenseMeta.helper_methods
@@ -97,6 +118,27 @@ module Licensee
       /(.+?)(( v?\d\.\d)|$)/.match(name)[1]
     end
 
+    def title_regex
+      return @regex if defined? @regex
+
+      title_regex = ALT_TITLE_REGEX[key]
+      title_regex ||= begin
+        string = name.downcase.sub('*', 'u')
+        string.sub!(/\Athe /i, '')
+        string.sub!(/ license\z/i, '')
+        string = Regexp.escape(string)
+        string = string.sub(/\bgnu\\ /, '(?:GNU )?')
+        Regexp.new string, 'i'
+      end
+
+      parts = [title_regex, key]
+      if meta.nickname
+        parts.push Regexp.new meta.nickname.sub(/\bGNU /i, '(?:GNU )?')
+      end
+
+      @regex = Regexp.union parts
+    end
+
     def other?
       key == 'other'
     end

data/lib/licensee/matchers.rb

@@ -1,14 +1,15 @@
 module Licensee
   module Matchers
-    autoload :Matcher, 'licensee/matchers/matcher'
-    autoload :Cabal, 'licensee/matchers/cabal'
+    autoload :Matcher,   'licensee/matchers/matcher'
+    autoload :Cabal,     'licensee/matchers/cabal'
     autoload :Copyright, 'licensee/matchers/copyright'
-    autoload :Cran, 'licensee/matchers/cran'
-    autoload :Dice, 'licensee/matchers/dice'
+    autoload :Cran,      'licensee/matchers/cran'
+    autoload :Dice,      'licensee/matchers/dice'
     autoload :DistZilla, 'licensee/matchers/dist_zilla'
-    autoload :Exact, 'licensee/matchers/exact'
-    autoload :Gemspec, 'licensee/matchers/gemspec'
-    autoload :NpmBower, 'licensee/matchers/npm_bower'
-    autoload :Package, 'licensee/matchers/package'
+    autoload :Exact,     'licensee/matchers/exact'
+    autoload :Gemspec,   'licensee/matchers/gemspec'
+    autoload :NpmBower,  'licensee/matchers/npm_bower'
+    autoload :Package,   'licensee/matchers/package'
+    autoload :Reference, 'licensee/matchers/reference'
   end
 end

data/lib/licensee/matchers/reference.rb

@@ -0,0 +1,16 @@
+module Licensee
+  module Matchers
+    # Matches README files that include a license by reference
+    class Reference < Licensee::Matchers::Matcher
+      def match
+        License.all(hidden: true, psuedo: false).find do |license|
+          /\b#{license.title_regex}\b/ =~ file.content
+        end
+      end
+
+      def confidence
+        90
+      end
+    end
+  end
+end

data/lib/licensee/project_files/project_file.rb

@@ -60,6 +60,14 @@ module Licensee
 
       alias match license
       alias path filename
+
+      # Is this file a COPYRIGHT file with only a copyright statement?
+      # If so, it can be excluded from determining if a project has >1 license
+      def copyright?
+        return false unless is_a?(LicenseFile)
+        return false unless matcher.is_a?(Matchers::Copyright)
+        filename =~ /\Acopyright(?:#{LicenseFile::ANY_EXT_REGEX})?\z/i
+      end
     end
   end
 end

data/lib/licensee/project_files/readme_file.rb

@@ -18,6 +18,10 @@ module Licensee
              \z)                 # End of file
         /mix
 
+      def possible_matchers
+        super.push(Matchers::Reference)
+      end
+
       def self.name_score(filename)
         SCORES.each do |pattern, score|
           return score if pattern =~ filename

data/lib/licensee/projects/project.rb

@@ -18,9 +18,9 @@ module Licensee
       # Returns the matching License instance if a license can be detected
       def license
         return @license if defined? @license
-        @license = if licenses.count == 1 || lgpl?
-          licenses.first
-        elsif licenses.count > 1
+        @license = if licenses_without_copyright.count == 1 || lgpl?
+          licenses_without_copyright.first
+        elsif licenses_without_copyright.count > 1
           Licensee::License.find('other')
         end
       end
@@ -136,6 +136,14 @@ module Licensee
       def project_files
         @project_files ||= [license_files, readme, package_file].flatten.compact
       end
+
+      # Returns an array of matches licenses, excluding the COPYRIGHT file
+      # which can often be ignored for purposes of determing dual licensing
+      def licenses_without_copyright
+        @licenses_without_copyright ||= begin
+          matched_files.reject(&:copyright?).map(&:license).uniq
+        end
+      end
     end
 
     def files

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 module Licensee
-  VERSION = '9.4.0'.freeze
+  VERSION = '9.5.0'.freeze
 end

data/spec/fixtures/license-with-readme-reference/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Ben Balter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/spec/fixtures/license-with-readme-reference/README

@@ -0,0 +1,5 @@
+# Readme fixture
+
+## License
+
+[The MIT License](http://example.invalid)

data/spec/fixtures/mit-with-copyright/COPYRIGHT.md

@@ -0,0 +1 @@
+Copyright (c) 2017 Ben Balter

data/spec/fixtures/mit-with-copyright/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ben Balter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/spec/integration_spec.rb

@@ -148,6 +148,16 @@ RSpec.describe 'integration test' do
             expect(subject.license).to eql(license)
           end
         end
+
+        context 'license + README reference' do
+          let(:license) { Licensee::License.find('mit') }
+          let(:fixture) { 'license-with-readme-reference' }
+          let(:arguments) { { detect_readme: true } }
+
+          it 'determines the project is MIT' do
+            expect(subject.license).to eql(license)
+          end
+        end
       end
 
       context 'with the license file stubbed' do

data/spec/licensee/content_helper_spec.rb

@@ -175,4 +175,69 @@ LICENSE
       end
     end
   end
+
+  context 'title regex' do
+    let(:license) { Licensee::License.find('gpl-3.0') }
+
+    %i[key title nickname name_without_version].each do |variation|
+      context "a license #{variation}" do
+        let(:license_variation) { license.send(variation) }
+        let(:text) { license_variation }
+
+        it 'matches' do
+          expect(text).to match(described_class.title_regex)
+        end
+
+        context 'preceded by the' do
+          let(:text) { "The #{license_variation} license" }
+
+          it 'matches' do
+            expect(text).to match(described_class.title_regex)
+          end
+        end
+
+        context 'with parens' do
+          let(:text) { "(#{license_variation})" }
+
+          it 'matches' do
+            expect(text).to match(described_class.title_regex)
+          end
+        end
+
+        context 'with parens and a preceding the' do
+          let(:text) { "(the #{license_variation} license)" }
+
+          it 'matches' do
+            expect(text).to match(described_class.title_regex)
+          end
+        end
+
+        context 'with whitespace' do
+          let(:text) { "     the #{license_variation} license" }
+
+          it 'matches' do
+            expect(text).to match(described_class.title_regex)
+          end
+        end
+
+        context 'escaping' do
+          let(:text) { 'gpl-3 0' }
+
+          it 'escapes' do
+            expect(text).to_not match(described_class.title_regex)
+          end
+        end
+
+        context 'in the middle of a string' do
+          let(:text) do
+            "The project is not licensed under the #{license_variation} license"
+          end
+
+          it 'matches' do
+            expect(text).to_not match(described_class.title_regex)
+          end
+        end
+      end
+    end
+  end
 end

data/spec/licensee/license_spec.rb

@@ -85,6 +85,42 @@ RSpec.describe Licensee::License do
         end
       end
     end
+
+    context 'psudo licenses' do
+      let(:other) { Licensee::License.find('other') }
+
+      context 'by default' do
+        let(:arguments) { {} }
+
+        it "doesn't include psudo licenses" do
+          expect(licenses).to_not include(other)
+        end
+      end
+
+      context 'with hidden licenses' do
+        let(:arguments) { { hidden: true } }
+
+        it 'includes psudo licenses' do
+          expect(licenses).to include(other)
+        end
+      end
+
+      context 'when explicitly asked' do
+        let(:arguments) { { hidden: true, psuedo: true } }
+
+        it 'includes psudo licenses' do
+          expect(licenses).to include(other)
+        end
+      end
+
+      context 'when explicitly excluded' do
+        let(:arguments) { { hidden: true, psuedo: false } }
+
+        it "doesn'tincludes psudo licenses" do
+          expect(licenses).to_not include(other)
+        end
+      end
+    end
   end
 
   context 'finding' do
@@ -297,4 +333,58 @@ RSpec.describe Licensee::License do
       end
     end
   end
+
+  context 'License.title_regex' do
+    Licensee::License.all(hidden: true, psuedo: false).each do |license|
+      context "the #{license.title} license" do
+        %i[title nickname key].each do |variation|
+          next if license.send(variation).nil?
+
+          context "the license #{variation}" do
+            let(:license_variation) { license.send(variation).sub('*', 'u') }
+            let(:text) { license_variation }
+
+            it 'matches' do
+              expect(text).to match(license.title_regex)
+            end
+
+            it 'finds by title' do
+              expect(described_class.find_by_title(text)).to eql(license)
+            end
+
+            if license.title =~ /\bGNU\b/
+              context "without 'GNU'" do
+                let(:text) { license_variation.sub(/GNU /i, '') }
+
+                it 'still matches' do
+                  expect(text).to match(license.title_regex)
+                end
+              end
+            end
+
+            context "with 'the' and 'license'" do
+              let(:text) { "The #{license_variation} license" }
+
+              it 'matches' do
+                expect(text).to match(license.title_regex)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    context 'a license with an alt title' do
+      let(:text) { 'The Clear BSD license' }
+      let(:license) { Licensee::License.find('bsd-3-clause-clear') }
+
+      it 'matches' do
+        expect(text).to match(license.title_regex)
+      end
+
+      it 'finds by title' do
+        expect(described_class.find_by_title(text)).to eql(license)
+      end
+    end
+  end
 end

data/spec/licensee/matchers/reference_matcher_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe Licensee::Matchers::Reference do
+  let(:content) { 'Copyright 2015 Ben Balter' }
+  let(:file) { Licensee::ProjectFiles::LicenseFile.new(content, 'LICENSE.txt') }
+  let(:license) { Licensee::License.find('gpl-3.0') }
+
+  subject { described_class.new(file) }
+
+  %i[title key nickname].each do |variation|
+    context "with a license #{variation}" do
+      let(:content) { "Licensed under the #{license.send(variation)} license" }
+
+      it 'matches' do
+        expect(subject.match).to eql(license)
+      end
+
+      context 'as a markdown link' do
+        let(:content) { "[#{license.send(variation)}](https://example.com)" }
+
+        it 'matches' do
+          expect(subject.match).to eql(license)
+        end
+      end
+    end
+  end
+
+  context 'a license key in a word' do
+    let(:content) { 'My name is MITch!' }
+
+    it "doesn't match" do
+      expect(subject.match).to be_nil
+    end
+  end
+
+  context 'a license with alt regex' do
+    let(:content) { 'Clear BSD' }
+    let(:license) { Licensee::License.find('bsd-3-clause-clear') }
+
+    it 'matches' do
+      expect(subject.match).to eql(license)
+    end
+  end
+end

data/spec/licensee/project_files/license_file_spec.rb

@@ -238,4 +238,31 @@ Creative Commons Attribution-NonCommercial 4.0
       expect(subject.license).to eql(other)
     end
   end
+
+  context 'copyright?' do
+    context 'a copyright file' do
+      let(:content) { 'Copyright 2017 Ben Balter' }
+      let(:filename) { 'COPYRIGHT.txt' }
+
+      it "knows it's a copyright file" do
+        expect(subject.send(:copyright?)).to be_truthy
+      end
+    end
+
+    context 'A copyright file with license text' do
+      let(:filename) { 'COPYRIGHT.txt' }
+
+      it "knows it's not a copyright file" do
+        expect(subject.send(:copyright?)).to be_falsy
+      end
+    end
+
+    context 'a license file with copyright text' do
+      let(:content) { 'Copyright 2017 Ben Balter' }
+
+      it "knows it's not a copyright file" do
+        expect(subject.send(:copyright?)).to be_falsy
+      end
+    end
+  end
 end

data/spec/licensee/project_files/readme_spec.rb

@@ -98,4 +98,13 @@ RSpec.describe Licensee::ProjectFiles::ReadmeFile do
       end
     end
   end
+
+  context 'a license reference' do
+    let(:content) { 'The MIT License' }
+    let(:mit) { Licensee::License.find('mit') }
+
+    it 'matches' do
+      expect(subject.match).to eql(mit)
+    end
+  end
 end

data/spec/licensee/project_spec.rb

@@ -240,5 +240,13 @@
         expect(subject.license_files.last.filename).to eql('LICENSE')
       end
     end
+
+    context 'with a copyright file' do
+      let(:fixture) { 'mit-with-copyright' }
+
+      it 'returns MIT' do
+        expect(subject.license).to eql(mit)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.4.0
+  version: 9.5.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -142,6 +142,7 @@ files:
 - lib/licensee/matchers/matcher.rb
 - lib/licensee/matchers/npm_bower.rb
 - lib/licensee/matchers/package.rb
+- lib/licensee/matchers/reference.rb
 - lib/licensee/project_files.rb
 - lib/licensee/project_files/license_file.rb
 - lib/licensee/project_files/package_manager_file.rb
@@ -172,6 +173,10 @@ files:
 - 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/license-with-readme-reference/LICENSE
+- spec/fixtures/license-with-readme-reference/README
+- spec/fixtures/mit-with-copyright/COPYRIGHT.md
+- spec/fixtures/mit-with-copyright/LICENSE.txt
 - spec/fixtures/mit/LICENSE.txt
 - spec/fixtures/mit/README.md
 - spec/fixtures/mpl-without-hrs/LICENSE
@@ -194,6 +199,7 @@ files:
 - spec/licensee/matchers/gemspec_matcher_spec.rb
 - spec/licensee/matchers/npm_bower_matcher_spec.rb
 - spec/licensee/matchers/package_matcher_spec.rb
+- spec/licensee/matchers/reference_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