licensee 9.9.1 → 9.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 930a96d1bd7ed3b84fa727cf70d71740a5471500fdbdc3f5736f54eafd67e8e6
-  data.tar.gz: af48a6336b6de9b1f97d344bfcff49dedb4169e31000a3a981ffbc43aa514cc3
+  metadata.gz: cb4651c6f3bae8fae051ec33b3517ebb09191402f8e7e5d1b0fd949a85b71393
+  data.tar.gz: 6fd1952939f6c0940fb0c132092b7b025803f76cb3789450ddabd53883dd0a88
 SHA512:
-  metadata.gz: f4f2e0f847843640551f0ac5369b13880a06326cfd262c8909a176722828ad0435f9ff803aaf4223550462d36d21f9535f4cf2bc9e23f299ec6d62454788c157
-  data.tar.gz: f13add2cdd94ae3e02b0a55cb445d8c2e1b4907eea902860fee3a7508abd9f979da2dba73caddd56a468d724b36251cea7565e73b015fcb4ad5db3a629f24c90
+  metadata.gz: 36016536deeadbd74cb8078622b4e89c8b744f139661076252a62d3543d9e70c8b84df70cfe0cff340b75f17d92e174b21cbd7e2eef1c8a7ae95219fb41b33e1
+  data.tar.gz: c67c0456e2477d69e7fad5a753c789bf5cdfc426bb7eec3dfda23cf23dce311906e47cc00b2ce3b1af1772e85be3f1d147fdc19426be6e968111b497578efe51

data/lib/licensee.rb

@@ -1,7 +1,6 @@
 require_relative 'licensee/version'
 require 'forwardable'
 require 'pathname'
-require 'rugged'
 require 'yaml'
 
 module Licensee

data/lib/licensee/commands/detect.rb

@@ -21,12 +21,12 @@ class LicenseeCLI < Thor
 
     rows = []
     rows << if project.license
-              ['License:', project.license.spdx_id]
-            elsif !project.licenses.empty?
-              ['Licenses:', project.licenses.map(&:spdx_id)]
-            else
-              ['License:', set_color('None', :red)]
-            end
+      ['License:', project.license.spdx_id]
+    elsif !project.licenses.empty?
+      ['Licenses:', project.licenses.map(&:spdx_id)]
+    else
+      ['License:', set_color('None', :red)]
+    end
 
     unless project.matched_files.empty?
       rows << ['Matched files:', project.matched_files.map(&:filename).join(', ')]
@@ -51,7 +51,7 @@ class LicenseeCLI < Thor
 
       licenses = licenses_by_similiarity(matched_file)
       next if licenses.empty?
-      say '  Closest licenses:'
+      say '  Closest non-matching licenses:'
       rows = licenses[0...3].map do |license, similarity|
         spdx_id = license.meta['spdx-id']
         percent = Licensee::ContentHelper.format_percent(similarity)

data/lib/licensee/content_helper.rb

@@ -13,6 +13,8 @@ module Licensee
     VERSION_REGEX = /\Aversion.*$/i
     MARKUP_REGEX = /[#_*=~\[\]()`|>]+/
     DEVELOPED_BY_REGEX = /\Adeveloped by:.*?\n\n/im
+    QUOTE_BEGIN_REGEX = /[`'"‘“]/
+    QUOTE_END_REGEX = /['"’”]/
 
     # A set of each word in the license, without duplicates
     def wordset
@@ -80,9 +82,10 @@ module Licensee
         string = strip_all_rights_reserved(string)
         string = strip_developed_by(string)
         string, _partition, _instructions = string.partition(END_OF_TERMS_REGEX)
-        string = strip_markup(string)
+        string = normalize_lists(string)
         string = normalize_quotes(string)
         string = normalize_https(string)
+        string = strip_markup(string)
         strip_whitespace(string)
       end
 
@@ -173,15 +176,20 @@ module Licensee
       string.gsub(regex, ' ').squeeze(' ').strip
     end
 
-    # Replace all single quotes with double quotes
+    # Replace all enclosing quotes with double quotes
     # Single versus double quotes don't alter the meaning, and it's easier to
     # strip double quotes if we still want to allow possessives
     def normalize_quotes(string)
-      string.gsub(/\s'([\w -]*?\w)'/, ' "\1"')
+      string.gsub(/#{QUOTE_BEGIN_REGEX}+([\w -]*?\w)#{QUOTE_END_REGEX}+/,
+                  '"\1"')
     end
 
     def normalize_https(string)
       string.gsub(/http:/, 'https:')
     end
+
+    def normalize_lists(string)
+      string.gsub(/^\s*(\d\.|\*)/, '-')
+    end
   end
 end

data/lib/licensee/license.rb

@@ -125,7 +125,7 @@ module Licensee
 
     # Returns the human-readable license name
     def name
-      title ? title : key.capitalize
+      title || spdx_id
     end
 
     def name_without_version

data/lib/licensee/project_files/license_file.rb

@@ -8,7 +8,7 @@ module Licensee
       PREFERRED_EXT_REGEX = /\.#{Regexp.union(PREFERRED_EXT)}\z/
 
       # Regex to match any extension except .spdx or .header
-      OTHER_EXT_REGEX = %r{\.(?!spdx|header)[^./]+\z}i
+      OTHER_EXT_REGEX = %r{\.(?!spdx|header|gemspec)[^./]+\z}i
 
       # Regex to match, LICENSE, LICENCE, unlicense, etc.
       LICENSE_REGEX = /(un)?licen[sc]e/i

data/lib/licensee/projects/git_project.rb

@@ -5,6 +5,9 @@
 # Project files for this project type will contain the following keys:
 #  :name - the file's path relative to the repo root
 #  :oid  - the file's OID
+
+autoload :Rugged, 'rugged'
+
 module Licensee
   module Projects
     class GitProject < Licensee::Projects::Project

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 module Licensee
-  VERSION = '9.9.1'.freeze
+  VERSION = '9.9.2'.freeze
 end

data/spec/fixtures/bsd-3-lists/LICENSE.BULLETS

@@ -0,0 +1,27 @@
+Copyright (c) 2018, Ben Balter
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/spec/fixtures/bsd-3-lists/LICENSE.NUMBERS

@@ -0,0 +1,27 @@
+Copyright (c) 2018, Ben Balter
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/spec/fixtures/detect.json

@@ -98,7 +98,7 @@
     },
     {
       "filename": "licensee.gemspec",
-      "content": "require File.expand_path('lib/licensee/version', __dir__)\n\nGem::Specification.new do |gem|\n  gem.name    = 'licensee'\n  gem.version = Licensee::VERSION\n\n  gem.summary = 'A Ruby Gem to detect open source project licenses'\n  gem.description = <<-DESC\n    Licensee automates the process of reading LICENSE files and\n    compares their contents to known licenses using a fancy maths.\n  DESC\n\n  gem.authors  = ['Ben Balter']\n  gem.email    = 'ben.balter@github.com'\n  gem.homepage = 'https://github.com/benbalter/licensee'\n  gem.license  = 'MIT'\n\n  gem.bindir = 'bin'\n  gem.executables << 'licensee'\n\n  gem.add_dependency('dotenv', '~> 2.0')\n  gem.add_dependency('octokit', '~> 4.8.0')\n  gem.add_dependency('rugged', '~> 0.24')\n  gem.add_dependency('thor', '~> 0.19')\n\n  gem.add_development_dependency('coveralls', '~> 0.8')\n  gem.add_development_dependency('mustache', '>= 0.9', '< 2.0')\n  gem.add_development_dependency('pry', '~> 0.9')\n  gem.add_development_dependency('rake', '~> 10.3')\n  gem.add_development_dependency('rspec', '~> 3.5')\n  gem.add_development_dependency('rubocop', '~> 0.49')\n  gem.add_development_dependency('webmock', '~> 3.1')\n\n  gem.required_ruby_version = '>= 2.1'\n\n  # ensure the gem is built out of versioned files\n  gem.files = Dir[\n    'Rakefile',\n    '{bin,lib,man,test,vendor,spec}/**/*',\n    'README*', 'LICENSE*'\n  ] & `git ls-files -z`.split(\"\\0\")\nend\n",
+      "content": "require File.expand_path('lib/licensee/version', __dir__)\n\nGem::Specification.new do |gem|\n  gem.name    = 'licensee'\n  gem.version = Licensee::VERSION\n\n  gem.summary = 'A Ruby Gem to detect open source project licenses'\n  gem.description = <<-DESC\n    Licensee automates the process of reading LICENSE files and\n    compares their contents to known licenses using a fancy maths.\n  DESC\n\n  gem.authors  = ['Ben Balter']\n  gem.email    = 'ben.balter@github.com'\n  gem.homepage = 'https://github.com/benbalter/licensee'\n  gem.license  = 'MIT'\n\n  gem.bindir = 'bin'\n  gem.executables << 'licensee'\n\n  gem.add_dependency('dotenv', '~> 2.0')\n  gem.add_dependency('octokit', '~> 4.8.0')\n  gem.add_dependency('rugged', '~> 0.24')\n  gem.add_dependency('thor', '~> 0.19')\n\n  gem.add_development_dependency('coveralls', '~> 0.8')\n  gem.add_development_dependency('mustache', '>= 0.9', '< 2.0')\n  gem.add_development_dependency('pry', '~> 0.9')\n  gem.add_development_dependency('rake', '~> 10.3')\n  gem.add_development_dependency('rspec', '~> 3.5')\n  gem.add_development_dependency('rubocop', '~> 0.49')\n  gem.add_development_dependency('webmock', '~> 3.1')\n\n  gem.required_ruby_version = '> 2.2'\n\n  # ensure the gem is built out of versioned files\n  gem.files = Dir[\n    'Rakefile',\n    '{bin,lib,man,test,vendor,spec}/**/*',\n    'README*', 'LICENSE*'\n  ] & `git ls-files -z`.split(\"\\0\")\nend\n",
       "content_hash": null,
       "content_normalized": null,
       "matcher": {

data/spec/integration_spec.rb

@@ -186,6 +186,15 @@ RSpec.describe 'integration test' do
             expect(subject.license).to eql(license)
           end
         end
+
+        context 'BSD-3-Clause numbered and bulleted' do
+          let(:license) { Licensee::License.find('bsd-3-clause') }
+          let(:fixture) { 'bsd-3-lists' }
+
+          it 'determines the project is BSD-3-Clause' do
+            expect(subject.license).to eql(license)
+          end
+        end
       end
 
       context 'with the license file stubbed' do

data/spec/licensee/content_helper_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Licensee::ContentHelper do
   This license provided 'as is'. Please respect the contributors' wishes when
   implementing the license's "software".
   -----------
-LICENSE
+    LICENSE
   end
   subject { ContentHelperTestHelper.new(content) }
   let(:mit) { Licensee::License.find('mit') }

data/spec/licensee/license_spec.rb

@@ -201,7 +201,7 @@ RSpec.describe Licensee::License do
     end
 
     it 'uses the default name when none exists' do
-      expect(other.name).to eql('Other')
+      expect(other.name).to eql('NOASSERTION')
     end
 
     it 'expoeses the nickname' do

data/spec/licensee/matchers/dice_matcher_spec.rb

@@ -22,12 +22,12 @@ RSpec.describe Licensee::Matchers::Dice do
 
   it 'sorts licenses by similarity' do
     expect(subject.licenses_by_similiarity[0]).to eql([gpl, 100.0])
-    expect(subject.licenses_by_similiarity[1]).to eql([agpl, 95.73361082206036])
+    expect(subject.licenses_by_similiarity[1]).to eql([agpl, 95.76581285938317])
   end
 
   it 'returns a list of licenses above the confidence threshold' do
     expect(subject.licenses_by_similiarity[0]).to eql([gpl, 100.0])
-    expect(subject.licenses_by_similiarity[1]).to eql([agpl, 95.73361082206036])
+    expect(subject.licenses_by_similiarity[1]).to eql([agpl, 95.76581285938317])
   end
 
   it 'returns the match confidence' do

data/vendor/choosealicense.com/_licenses/agpl-3.0.txt

@@ -37,7 +37,7 @@ limitations:
                     GNU AFFERO GENERAL PUBLIC LICENSE
                        Version 3, 19 November 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -679,7 +679,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -694,4 +694,4 @@ specific requirements.
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.

data/vendor/choosealicense.com/_licenses/cc0-1.0.txt

@@ -4,7 +4,7 @@ spdx-id: CC0-1.0
 redirect_from: /licenses/cc0/
 source: https://creativecommons.org/publicdomain/zero/1.0/
 
-description: The <a href="https://creativecommons.org/publicdomain/zero/1.0/">Creative Commons CC0 Public Domain Dedication</a> waives copyright interest in any a work you've created and dedicates it to the world-wide public domain. Use CC0 to opt out of copyright entirely and ensure your work has the widest reach. As with the Unlicense and typical software licenses, CC0 disclaims warranties. CC0 is very similar to the Unlicense.
+description: The <a href="https://creativecommons.org/publicdomain/zero/1.0/">Creative Commons CC0 Public Domain Dedication</a> waives copyright interest in a work you've created and dedicates it to the world-wide public domain. Use CC0 to opt out of copyright entirely and ensure your work has the widest reach. As with the Unlicense and typical software licenses, CC0 disclaims warranties. CC0 is very similar to the Unlicense.
 
 how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the CC0 into the file.
 

data/vendor/choosealicense.com/_licenses/ecl-2.0.txt

@@ -12,7 +12,7 @@ note: The Apereo Foundation recommends taking the additional step of adding a bo
 using:
   - Sakai: https://github.com/sakaiproject/sakai/blob/master/LICENSE
   - OAE: https://github.com/oaeproject/Hilary/blob/master/LICENSE
-  - Opencast: https://bitbucket.org/opencast-community/opencast/src/905077ba5e6483f8c49869a1fc13bf9268790a79/LICENSE
+  - Opencast: https://github.com/opencast/opencast/blob/develop/LICENSE
 
 permissions:
   - commercial-use

data/vendor/choosealicense.com/_licenses/epl-1.0.txt

@@ -2,14 +2,13 @@
 title: Eclipse Public License 1.0
 spdx-id: EPL-1.0
 source: https://www.eclipse.org/legal/epl-v10.html
-hidden: true
 
 description: This commercially-friendly copyleft license provides the ability to commercially license binaries; a modern royalty-free patent license grant; and the ability for linked works to use other licenses, including commercial ones.
 
 how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file.
 
 using:
-  - Eclipse Che: https://github.com/eclipse/che/blob/master/LICENSE
+  - Eclipse hawkBit: https://github.com/eclipse/hawkbit/blob/master/LICENSE
   - JUnit: https://github.com/junit-team/junit4/blob/master/LICENSE-junit.txt
   - openHAB: https://github.com/openhab/openhab-distro/blob/master/LICENSE
 

data/vendor/choosealicense.com/_licenses/epl-2.0.txt

@@ -12,7 +12,7 @@ how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of
 using:
   - Eclipse Ditto: https://github.com/eclipse/ditto/blob/master/LICENSE
   - Eclipse SmartHome: https://github.com/eclipse/smarthome/blob/master/LICENSE
-  - SUMO: https://github.com/DLR-TS/sumo/blob/master/COPYING
+  - SUMO: https://github.com/eclipse/sumo/blob/master/LICENSE
 
 permissions:
   - commercial-use

data/vendor/choosealicense.com/_licenses/gpl-3.0.txt

@@ -40,7 +40,7 @@ limitations:
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -684,7 +684,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -703,11 +703,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

data/vendor/choosealicense.com/_licenses/lgpl-3.0.txt

@@ -36,7 +36,7 @@ limitations:
                    GNU LESSER GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 

data/vendor/choosealicense.com/_licenses/postgresql.txt

@@ -10,7 +10,7 @@ how: To use it, say that it is The PostgreSQL License, and then substitute the c
 using:
   - pgBadger: https://github.com/dalibo/pgbadger/blob/master/LICENSE
   - pgAdmin: https://github.com/postgres/pgadmin4/blob/master/LICENSE
-  - .NET Access to PostgreSQL: https://github.com/npgsql/npgsql/blob/dev/LICENSE.txt
+  - .NET Access to PostgreSQL: https://github.com/npgsql/npgsql/blob/dev/LICENSE
 
 permissions:
   - commercial-use

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.9.1
+  version: 9.9.2
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -222,6 +222,8 @@ files:
 - spec/fixtures/apache-with-readme-notice/LICENSE
 - spec/fixtures/apache-with-readme-notice/LICENSE.header
 - spec/fixtures/apache-with-readme-notice/README.md
+- spec/fixtures/bsd-3-lists/LICENSE.BULLETS
+- spec/fixtures/bsd-3-lists/LICENSE.NUMBERS
 - spec/fixtures/bsd-plus-patents/PATENTS
 - spec/fixtures/bsd-plus-patents/license.txt
 - spec/fixtures/bsl/LICENSE_1_0.txt
@@ -335,9 +337,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="