licensee 9.5.0 → 9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba8051e36fee570aacfe7594c0ba6b293f6ec091
-  data.tar.gz: 6c24e69c2f219d3fb32e4a86e240a04a28e547ae
+  metadata.gz: 6dc03da7b85af43160fabdd877969b47865f7a3a
+  data.tar.gz: 590c50612c7d602a375d81c7d26cde0f85f94ac3
 SHA512:
-  metadata.gz: cdfe0a0195cbdaeaae793156af0aebde1faf319ce812ebe999386c8d35f30b4f20332be41ab97679af82a0f30046fd5de4654b13a3e125c377900d346266ec5d
-  data.tar.gz: 2a9562f47b7ac5667b38e3871bda75b88856695682b77cd8c7830352f64336d5e4d056da65b93037baa3807c8ac556bb226be54794a3bc8d51bffc7f6c9a8d11
+  metadata.gz: 793e8eff41106beca118b3223270ad67de8573570d3e169f009cb2d250c92e660818e07e35105fa1beedc0fc07f145608ef90886297829524201c74bfde86f09
+  data.tar.gz: 200981a147b856337ee7ed1425e6dd38ccd03e7558e56bb79b87ded8f67b673df679fdaec5c95ff6a2d2c169a61695811c104c5b4ccf753946a7d497ce9731ed

data/lib/licensee/license.rb

@@ -91,6 +91,9 @@ module Licensee
       'bsd-3-clause-clear' => /(?:clear bsd|bsd 3-clause(?: clear)?)/i
     }.freeze
 
+    SOURCE_PREFIX = %r{https?://(?:www\.)?}i
+    SOURCE_SUFFIX = %r{(?:\.html?|\.txt|\/)}i
+
     include Licensee::ContentHelper
     extend Forwardable
     def_delegators :meta, *LicenseMeta.helper_methods
@@ -119,14 +122,17 @@ module Licensee
     end
 
     def title_regex
-      return @regex if defined? @regex
+      return @title_regex if defined? @title_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.sub!(/,? version /, ' ')
+        string.sub!(/v(\d+\.\d+)/, '\1')
         string = Regexp.escape(string)
+        string = string.sub(/ (\d+\\.\d+)/, ',?\ (?:version\ |v)?\1')
         string = string.sub(/\bgnu\\ /, '(?:GNU )?')
         Regexp.new string, 'i'
       end
@@ -136,7 +142,26 @@ module Licensee
         parts.push Regexp.new meta.nickname.sub(/\bGNU /i, '(?:GNU )?')
       end
 
-      @regex = Regexp.union parts
+      @title_regex = Regexp.union parts
+    end
+
+    # Returns a regex that will match the license source
+    #
+    # The following variations are supported (as presumed identical):
+    # 1. HTTP or HTTPS
+    # 2. www or non-www
+    # 3. .txt, .html, .htm, or / suffix
+    #
+    # Returns the regex, or nil if no source exists
+    def source_regex
+      return @source_regex if defined? @source_regex
+      return unless meta.source
+
+      source = meta.source.dup.sub(/\A#{SOURCE_PREFIX}/, '')
+      source = source.sub(/#{SOURCE_SUFFIX}\z/, '')
+
+      escaped_source = Regexp.escape(source)
+      @source_regex = /#{SOURCE_PREFIX}#{escaped_source}(?:#{SOURCE_SUFFIX})?/i
     end
 
     def other?

data/lib/licensee/matchers/reference.rb

@@ -4,7 +4,8 @@ module Licensee
     class Reference < Licensee::Matchers::Matcher
       def match
         License.all(hidden: true, psuedo: false).find do |license|
-          /\b#{license.title_regex}\b/ =~ file.content
+          title_or_source = [license.title_regex, license.source_regex].compact
+          /\b#{Regexp.union(title_or_source)}\b/ =~ file.content
         end
       end
 

data/lib/licensee/project_files/license_file.rb

@@ -30,10 +30,10 @@ module Licensee
         /\A#{COPYING_REGEX}#{PREFERRED_EXT_REGEX}\z/ => 0.85,  # COPYING.md
         /\A#{LICENSE_REGEX}#{ANY_EXT_REGEX}\z/       => 0.80,  # LICENSE.textile
         /\A#{COPYING_REGEX}#{ANY_EXT_REGEX}\z/       => 0.75,  # COPYING.textile
-        /#{LICENSE_REGEX}-/                          => 0.70,  # LICENSE-MIT
-        /#{COPYING_REGEX}-/                          => 0.65,  # COPYING-MIT
-        /-#{LICENSE_REGEX}/                          => 0.60,  # MIT-LICENSE-MIT
-        /-#{COPYING_REGEX}/                          => 0.55,  # MIT-COPYING
+        /\A#{LICENSE_REGEX}[-_]/                     => 0.70,  # LICENSE-MIT
+        /\A#{COPYING_REGEX}[-_]/                     => 0.65,  # COPYING-MIT
+        /[-_]#{LICENSE_REGEX}/                       => 0.60,  # MIT-LICENSE-MIT
+        /[-_]#{COPYING_REGEX}/                       => 0.55,  # MIT-COPYING
         /\A#{OFL_REGEX}#{PREFERRED_EXT_REGEX}/       => 0.50,  # OFL.md
         /\A#{OFL_REGEX}#{ANY_EXT_REGEX}/             => 0.45,  # OFL.textile
         /\A#{OFL_REGEX}\z/                           => 0.40,  # OFL

data/lib/licensee/version.rb

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

data/spec/fixtures/apache-with-readme-notice/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/spec/fixtures/apache-with-readme-notice/README.md

@@ -0,0 +1,19 @@
+# Project Name
+
+Project is a project.
+
+## License
+
+Copyright 2017 Project Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this material except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/spec/fixtures/bsl/LICENSE_1_0.txt

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN 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

@@ -149,6 +149,15 @@ RSpec.describe 'integration test' do
           end
         end
 
+        context 'BSL' do
+          let(:license) { Licensee::License.find('bsl-1.0') }
+          let(:fixture) { 'bsl' }
+
+          it 'returns bsl-1.0' 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' }
@@ -158,6 +167,16 @@ RSpec.describe 'integration test' do
             expect(subject.license).to eql(license)
           end
         end
+
+        context 'apache license + README notice' do
+          let(:license) { Licensee::License.find('apache-2.0') }
+          let(:fixture) { 'apache-with-readme-notice' }
+          let(:arguments) { { detect_readme: true } }
+
+          it 'determines the project is Apache-2.0' do
+            expect(subject.license).to eql(license)
+          end
+        end
       end
 
       context 'with the license file stubbed' do

data/spec/licensee/license_spec.rb

@@ -369,6 +369,40 @@ RSpec.describe Licensee::License do
                 expect(text).to match(license.title_regex)
               end
             end
+
+            if variation == :title
+              context 'version notation variations' do
+                context "with 'version x.x'" do
+                  let(:text) do
+                    license_variation.sub(/v?(\d+\.\d+)/i, 'version \1')
+                  end
+
+                  it 'matches' do
+                    expect(text).to match(license.title_regex)
+                  end
+                end
+
+                context "with ', version x.x'" do
+                  let(:text) do
+                    license_variation.sub(/ v?(\d+\.\d+)/i, ', version \1')
+                  end
+
+                  it 'matches' do
+                    expect(text).to match(license.title_regex)
+                  end
+                end
+
+                context "with 'vx.x'" do
+                  let(:text) do
+                    license_variation.sub(/(?:version)? (\d+\.\d+)/i, ' v\1')
+                  end
+
+                  it 'matches' do
+                    expect(text).to match(license.title_regex)
+                  end
+                end
+              end
+            end
           end
         end
       end
@@ -387,4 +421,41 @@ RSpec.describe Licensee::License do
       end
     end
   end
+
+  context 'source regex' do
+    Licensee::License.all(hidden: true, psuedo: false).each do |license|
+      context "the #{license.title} license" do
+        let(:source) { URI.parse(license.source) }
+
+        %w[http https].each do |scheme|
+          context "with a #{scheme}:// scheme" do
+            before { source.scheme = scheme }
+
+            ['www.', ''].each do |prefix|
+              context "with '#{prefix}' before the host" do
+                before do
+                  source.host = "#{prefix}#{source.host.sub(/\Awww\./, '')}"
+                end
+
+                ['.html', '.htm', '.txt', ''].each do |suffix|
+                  context "with '#{suffix}' after the path" do
+                    before do
+                      next if license.key == 'wtfpl'
+                      regex = /#{Licensee::License::SOURCE_SUFFIX}\z/
+                      source.path = source.path.sub(regex, '')
+                      source.path = "#{source.path}#{suffix}"
+                    end
+
+                    it 'matches' do
+                      expect(source.to_s).to match(license.source_regex)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
 end

data/spec/licensee/matchers/reference_matcher_spec.rb

@@ -39,4 +39,13 @@ RSpec.describe Licensee::Matchers::Reference do
       expect(subject.match).to eql(license)
     end
   end
+
+  context 'with a license source' do
+    let(:license) { Licensee::License.find('mpl-2.0') }
+    let(:content) { "The [license](#{license.source})" }
+
+    it 'matches' do
+      expect(subject.match).to eql(license)
+    end
+  end
 end

data/spec/licensee/project_files/license_file_spec.rb

@@ -53,10 +53,11 @@ RSpec.describe Licensee::ProjectFiles::LicenseFile do
       'copying.image'      => 0.75,
       'COPYRIGHT.go'       => 0.75,
       'LICENSE-MIT'        => 0.70,
-      'MIT-LICENSE.txt'    => 0.60,
-      'mit-license-foo.md' => 0.70,
+      'LICENSE_1_0.txt'    => 0.70,
       'COPYING-GPL'        => 0.65,
       'COPYRIGHT-BSD'      => 0.65,
+      'MIT-LICENSE.txt'    => 0.60,
+      'mit-license-foo.md' => 0.60,
       'OFL.md'             => 0.50,
       'ofl.textile'        => 0.45,
       'ofl'                => 0.40,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.5.0
+  version: 9.6.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -155,8 +155,11 @@ files:
 - lib/licensee/rule.rb
 - lib/licensee/version.rb
 - spec/bin_spec.rb
+- spec/fixtures/apache-with-readme-notice/LICENSE
+- spec/fixtures/apache-with-readme-notice/README.md
 - spec/fixtures/bsd-plus-patents/PATENTS
 - spec/fixtures/bsd-plus-patents/license.txt
+- spec/fixtures/bsl/LICENSE_1_0.txt
 - spec/fixtures/case-sensitive/LiCeNsE.TxT
 - spec/fixtures/cc-by-nc-sa/LICENSE
 - spec/fixtures/cc-by-nd/LICENSE