licensee 9.10.1 → 9.11.0

data/lib/licensee/matchers/gemspec.rb

@@ -3,24 +3,24 @@ module Licensee
     class Gemspec < Licensee::Matchers::Package
       # a value is a string surrounded by any amount of whitespace
       # optionally ended with (non-captured) ".freeze"
-      VALUE_REGEX = /\s*[\'\"]([a-z\-0-9\.]+)[\'\"](?:\.freeze)?\s*/i
+      VALUE_REGEX = /\s*[\'\"]([a-z\-0-9\.]+)[\'\"](?:\.freeze)?\s*/i.freeze
 
       # an array contains one or more values. all values, or array itself,
       # can be surrounded by any amount of whitespace.  do not capture
       # non-value groups
-      ARRAY_REGEX = /\s*\[#{VALUE_REGEX}(?:,#{VALUE_REGEX})*\]\s*/i
+      ARRAY_REGEX = /\s*\[#{VALUE_REGEX}(?:,#{VALUE_REGEX})*\]\s*/i.freeze
 
       DECLARATION_REGEX = /
         ^\s*[a-z0-9_]+\.([a-z0-9_]+)\s*\=#{VALUE_REGEX}$
-      /ix
+      /ix.freeze
 
       LICENSE_REGEX = /
         ^\s*[a-z0-9_]+\.license\s*\=#{VALUE_REGEX}$
-      /ix
+      /ix.freeze
 
       LICENSE_ARRAY_REGEX = /
         ^\s*[a-z0-9_]+\.licenses\s*\=#{ARRAY_REGEX}$
-      /ix
+      /ix.freeze
 
       private
 

data/lib/licensee/matchers/matcher.rb

@@ -25,7 +25,7 @@ module Licensee
       private
 
       def potential_matches
-        @potential_matches ||= Licensee.licenses(hidden: true)
+        @potential_matches ||= Licensee.licenses(hidden: true, psuedo: false)
       end
     end
   end

data/lib/licensee/matchers/npm_bower.rb

@@ -5,7 +5,7 @@ module Licensee
       # a lenient regex for speed and security. Moar parsing moar problems.
       LICENSE_REGEX = /
         \s*[\"\']license[\"\']\s*\:\s*[\'\"]([a-z\-0-9\.+ ()]+)[\'\"],?\s*
-      /ix
+      /ix.freeze
 
       private
 

data/lib/licensee/matchers/reference.rb

@@ -3,7 +3,7 @@ module Licensee
     # 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|
+        potential_matches.find do |license|
           title_or_source = [license.title_regex, license.source_regex].compact
           /\b#{Regexp.union(title_or_source)}\b/ =~ file.content
         end

data/lib/licensee/matchers/spdx.rb

@@ -3,7 +3,7 @@ module Licensee
     class Spdx < Licensee::Matchers::Package
       # While we could parse the LICENSE.spdx file, prefer
       # a lenient regex for speed and security. Moar parsing moar problems.
-      LICENSE_REGEX = /PackageLicenseDeclared:\s*([a-z\-0-9\. +()]+)\s*/i
+      LICENSE_REGEX = /PackageLicenseDeclared:\s*([a-z\-0-9\. +()]+)\s*/i.freeze
 
       private
 

data/lib/licensee/project_files/license_file.rb

@@ -5,22 +5,22 @@ module Licensee
 
       # List of extensions to give preference to
       PREFERRED_EXT = %w[md markdown txt].freeze
-      PREFERRED_EXT_REGEX = /\.#{Regexp.union(PREFERRED_EXT)}\z/
+      PREFERRED_EXT_REGEX = /\.#{Regexp.union(PREFERRED_EXT)}\z/.freeze
 
       # Regex to match any extension except .spdx or .header
-      OTHER_EXT_REGEX = %r{\.(?!spdx|header|gemspec)[^./]+\z}i
+      OTHER_EXT_REGEX = %r{\.(?!spdx|header|gemspec)[^./]+\z}i.freeze
 
       # Regex to match, LICENSE, LICENCE, unlicense, etc.
-      LICENSE_REGEX = /(un)?licen[sc]e/i
+      LICENSE_REGEX = /(un)?licen[sc]e/i.freeze
 
       # Regex to match COPYING, COPYRIGHT, etc.
-      COPYING_REGEX = /copy(ing|right)/i
+      COPYING_REGEX = /copy(ing|right)/i.freeze
 
       # Regex to match OFL.
-      OFL_REGEX = /ofl/i
+      OFL_REGEX = /ofl/i.freeze
 
       # BSD + PATENTS patent file
-      PATENTS_REGEX = /patents/i
+      PATENTS_REGEX = /patents/i.freeze
 
       # Hash of Regex => score with which to score potential license files
       FILENAME_REGEXES = {
@@ -46,7 +46,7 @@ module Licensee
       # detected as CC-BY or CC-BY-SA which are 98%+ similar
       CC_FALSE_POSITIVE_REGEX = /
         ^(creative\ commons\ )?Attribution-(NonCommercial|NoDerivatives)
-      /xi
+      /xi.freeze
 
       def possible_matchers
         [Matchers::Copyright, Matchers::Exact, Matchers::Dice]

data/lib/licensee/project_files/readme_file.rb

@@ -7,8 +7,8 @@ module Licensee
         /\AREADME\.(#{Regexp.union(EXTENSIONS).source})\z/i => 0.9
       }.freeze
 
-      TITLE_REGEX = /licen[sc]e:?/i
-      UNDERLINE_REGEX = /\n[-=]+/m
+      TITLE_REGEX = /licen[sc]e:?/i.freeze
+      UNDERLINE_REGEX = /\n[-=]+/m.freeze
       CONTENT_REGEX = /^
           (?:                                # Header lookbehind
             [\#=]+\s#{TITLE_REGEX}\s*[\#=]*  # Start of hashes or rdoc header
@@ -25,7 +25,7 @@ module Licensee
           |
             \z                               # End of file
           )
-        /mix
+        /mix.freeze
 
       def possible_matchers
         super.push(Matchers::Reference)

data/lib/licensee/projects/github_project.rb

@@ -13,7 +13,7 @@ module Licensee
       # If there's any trailing data (e.g. `.git`) this pattern will ignore it:
       # we're going to use the API rather than clone the repo.
       GITHUB_REPO_PATTERN =
-        %r{https://github.com/([^\/]+\/([^\/]+(?=\.git)|[^\/]+)).*}
+        %r{https://github.com/([^\/]+\/([^\/]+(?=\.git)|[^\/]+)).*}.freeze
 
       class RepoNotFound < StandardError; end
 

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 module Licensee
-  VERSION = '9.10.1'.freeze
+  VERSION = '9.11.0'.freeze
 end

data/spec/fixtures/detect.json

@@ -88,8 +88,8 @@
     {
       "filename": "LICENSE.md",
       "content": "MIT License\n\nCopyright (c) 2014-2017 Ben Balter\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
-      "content_hash": "46cdc03462b9af57968df67b450cc4372ac41f53",
-      "content_normalized": "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.",
+      "content_hash": "d64f3bb4282a97b37454b5bb96a8a264a3363dc3",
+      "content_normalized": "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.",
       "matcher": {
         "name": "exact",
         "confidence": 100

data/spec/fixtures/license-hashes.json

@@ -0,0 +1,36 @@
+{
+  "upl-1.0": "093b8b048dec7bc685c9ee6a5afffa4a1d148c02",
+  "ofl-1.1": "1fb0563aa1250e18a6948afde286edc95761f461",
+  "lgpl-3.0": "bdb3c042bd84f914eacfbe4977c5e58352745809",
+  "agpl-3.0": "d445855a1f169b12cbee97d320c2e3522d053016",
+  "gpl-2.0": "3becd209e8ed8039656c1debe01dd17b9a79208f",
+  "cc-by-4.0": "899872bc08626e6cf154dcf9e08ff0de82c9b3db",
+  "ms-rl": "402bf344e506a8d10175c1e516b396c060ffd823",
+  "wtfpl": "f8544c074f203d86cdcb24082fedfb2cf2fe411a",
+  "osl-3.0": "ab241ef932d3ac038e8ed62c860e9eba051ae7a0",
+  "bsl-1.0": "ca8f916d00c234719956e932061f192abb2d5bf9",
+  "lgpl-2.1": "91e779a787786276618f58d6e396a5e64a981805",
+  "mpl-2.0": "b4db668fa7573bfdcae74eb51eafc961034f0a61",
+  "isc": "d168f98624be864548b2bbf4f198fdbf702d6743",
+  "cc0-1.0": "ec5027313ed11fea202060f6958ac25b086d6dcb",
+  "bsd-3-clause-clear": "251d4599b622d2a87b2c4bb21dfacd438c048466",
+  "gpl-3.0": "b22f1b1f953a38a8a11686587b98831858d6468b",
+  "unlicense": "86c75861af1b9b9e0573b190dcb2c2cdbbee7037",
+  "bsd-2-clause": "59f0099ff04225daf184db3fe55e478256133b1a",
+  "artistic-2.0": "a2ff6e7fb76e51bda9a5350c759a824f206049d1",
+  "zlib": "576139d1f785b8f3539099b9702fc68005ee2213",
+  "lppl-1.3c": "60961652297042d28bb689c17fac47eca7348d16",
+  "epl-2.0": "b57663bc9c3f41446a8cd3f0050149221a58fe66",
+  "mit": "d64f3bb4282a97b37454b5bb96a8a264a3363dc3",
+  "postgresql": "87550a6bb3409db00d8552b2ac07d373ea56a024",
+  "afl-3.0": "4702ff33018a2874510beeef5916d6e8629cdc32",
+  "ncsa": "04c052b69de47ab0641068657a14632cdf9aa48d",
+  "cc-by-sa-4.0": "d11590d97684231d5358252e0cc97373d62ec4f1",
+  "bsd-3-clause": "fa22c672927af9c7334874561198799cbf4bdf31",
+  "epl-1.0": "e306464a81ab0e6688653c6509245b451637172c",
+  "ms-pl": "c900293d66a241e54f7817367a8f32f7f94e12ff",
+  "ecl-2.0": "58e7f645bfa1c5ccca7e2c37e626b3487e4d9d1b",
+  "eupl-1.2": "f122f96b9f1a56e4806a89cb1cc6ca2bb956f3e5",
+  "apache-2.0": "ab3901051663cb8ee5dea9ebdff406ad136910e3",
+  "eupl-1.1": "873e30dbc5f75d076d7aecb6ceb84fb6bb765452"
+}

data/spec/licensee/commands/detect_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'detect command' do
   let(:stdout) { output[0] }
   let(:stderr) { output[1] }
   let(:status) { output[2] }
-  let(:hash) { '46cdc03462b9af57968df67b450cc4372ac41f53' }
+  let(:hash) { license_hashes['mit'] }
   let(:expected) do
     {
       'License'          => 'MIT',

data/spec/licensee/content_helper_spec.rb

@@ -29,6 +29,7 @@ RSpec.describe Licensee::ContentHelper do
   end
   subject { ContentHelperTestHelper.new(content) }
   let(:mit) { Licensee::License.find('mit') }
+  let(:normalized_content) { subject.content_normalized }
 
   it 'creates the wordset' do
     wordset = Set.new(
@@ -53,7 +54,7 @@ RSpec.describe Licensee::ContentHelper do
   end
 
   it 'knows the length delta' do
-    expect(subject.length_delta(mit)).to eql(884)
+    expect(subject.length_delta(mit)).to eql(885)
     expect(subject.length_delta(subject)).to eql(0)
   end
 
@@ -78,9 +79,42 @@ RSpec.describe Licensee::ContentHelper do
     expect(percent).to eql('12.35%')
   end
 
-  context 'normalizing' do
-    let(:normalized_content) { subject.content_normalized }
+  context '#strip' do
+    {
+      version:             "The MIT License\nVersion 1.0\nfoo",
+      hrs:                 "The MIT License\n=====\n-----\n*******\nfoo",
+      markdown_headings:   "# The MIT License\n\nfoo",
+      whitespace:          "The MIT License\n\n   foo  ",
+      all_rights_reserved: "Copyright 2016 Ben Balter\n\nfoo",
+      urls:                "https://example.com\nfoo",
+      developed_by:        "Developed By: Ben Balter\n\nFoo",
+      borders:             '*   Foo    *',
+      title:               "The MIT License\nfoo",
+      copyright:           "The MIT License\nCopyright 2018 Ben Balter\nFoo",
+      end_of_terms:        "Foo\nend of terms and conditions\nbar",
+      block_markup:        '> Foo',
+      link_markup:         '[Foo](http://exmaple.com)',
+      comment_markup:      "/*\n* The MIT License\n* Foo\n*/"
+    }.each do |field, fixture|
+      context "#strip_#{field}" do
+        let(:content) { fixture }
+
+        it "strips #{field}" do
+          expect(normalized_content).to eql('foo')
+        end
+      end
+    end
 
+    context 'span markup' do
+      let(:content) { '_foo_ *foo* **foo** ~foo~' }
+
+      it 'strips span markup' do
+        expect(normalized_content).to eql('foo foo foo foo')
+      end
+    end
+  end
+
+  context 'integration fixture' do
     it 'strips copyright' do
       expect(normalized_content).to_not match 'Copyright'
       expect(normalized_content).to_not match 'Ben Balter'
@@ -98,22 +132,6 @@ RSpec.describe Licensee::ContentHelper do
       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 'normalizes http: to https:' do
-      license = Licensee::License.find('mpl-2.0')
-      expect(license.content).to include('http:')
-      expect(license.content_normalized).to_not include('http:')
-    end
-
-    it 'wraps' do
-      lines = mit.content_normalized(wrap: 40).split("\n")
-      expect(lines.first.length).to be <= 40
-    end
-
     it 'squeezes whitespace' do
       expect(normalized_content).to_not match '  '
     end
@@ -148,15 +166,93 @@ RSpec.describe Licensee::ContentHelper do
       expect(normalized_content).to match('"software"')
     end
 
+    it 'strips the title' do
+      expect(normalized_content).to_not match('MIT')
+    end
+
+    it 'normalize the content' do
+      expected = 'the made up license. this license provided "as is". '
+      expected << "please respect the contributors' wishes when implementing "
+      expected << "the license's \"software\"."
+      expect(normalized_content).to eql(expected)
+    end
+  end
+
+  context 'normalizing' do
+    context 'https' do
+      let(:content) { 'http://example.com' }
+
+      it 'normalized URL protocals' do
+        expect(subject.content_normalized).to eql('https://example.com')
+      end
+    end
+
+    context 'ampersands' do
+      let(:content) { 'Foo & Bar' }
+
+      it 'normalized ampersands' do
+        expect(subject.content_normalized).to eql('foo and bar')
+      end
+    end
+
+    context 'lists' do
+      let(:content) { "1. Foo\n * Bar" }
+
+      it 'normalizes lists' do
+        expect(subject.content_normalized).to eql('- foo - bar')
+      end
+    end
+
+    context 'dashes' do
+      let(:content) { 'Foo-Bar—–baz-buzz' }
+
+      it 'normalizes dashes' do
+        expect(subject.content_normalized).to eql('foo-bar-baz-buzz')
+      end
+    end
+
+    context 'quotes' do
+      let(:content) { "`a` 'b' \"c\" ‘d’ “e”" }
+
+      it 'normalizes quotes' do
+        expect(subject.content_normalized).to eql('"a" "b" "c" "d" "e"')
+      end
+    end
+
+    it 'strips formatting from the MPL' do
+      license = Licensee::License.find('mpl-2.0')
+      expect(license.content_normalized).to_not include('* *')
+    end
+
+    it 'normalizes http: to https:' do
+      license = Licensee::License.find('mpl-2.0')
+      expect(license.content).to include('http:')
+      expect(license.content_normalized).to_not include('http:')
+    end
+
+    it 'wraps' do
+      lines = mit.content_normalized(wrap: 40).split("\n")
+      expect(lines.first.length).to be <= 40
+    end
+
+    context 'spelling' do
+      let(:content) { 'licence' }
+
+      it 'normalizes' do
+        expect(subject.content_normalized).to eql('license')
+      end
+    end
+
     Licensee::License.all(hidden: true).each do |license|
       context license.name do
         let(:stripped_content) { subject.content_without_title_and_version }
 
         it 'strips the title' do
-          regex = Licensee::ContentHelper::ALT_TITLE_REGEX[license.key]
+          skip "Doesn't strip ECL title" if license.key == 'ecl-2.0'
+          regex = Licensee::License::ALT_TITLE_REGEX[license.key]
           regex ||= /\A#{license.name_without_version}/i
-          expect(license.content_normalized).to_not match(regex)
           expect(stripped_content).to_not match(regex)
+          expect(license.content_normalized).to_not match(regex)
         end
 
         it 'strips the version' do
@@ -181,17 +277,6 @@ RSpec.describe Licensee::ContentHelper do
       end
     end
 
-    it 'strips the title' do
-      expect(normalized_content).to_not match('MIT')
-    end
-
-    it 'normalize the content' do
-      expected = 'the made up license. this license provided "as is". '
-      expected << "please respect the contributors' wishes when implementing "
-      expected << "the license's \"software\"."
-      expect(normalized_content).to eql(expected)
-    end
-
     context 'a title in parenthesis' do
       let(:content) { "(The MIT License)\n\nfoo" }
 
@@ -275,4 +360,18 @@ RSpec.describe Licensee::ContentHelper do
       end
     end
   end
+
+  context 'metaprogramming' do
+    it 'raises on invalid normalization' do
+      expect { subject.send(:normalize, :foo) }.to raise_error(ArgumentError)
+    end
+
+    it 'raises on invalid strip' do
+      expect { subject.send(:strip, :foo) }.to raise_error(ArgumentError)
+    end
+
+    it 'backwards compatibalizes regexes' do
+      expect(described_class::WHITESPACE_REGEX).to eql(/\s+/)
+    end
+  end
 end

data/spec/licensee/license_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Licensee::License do
   let(:no_license) { described_class.find('no-license') }
   let(:gpl) { described_class.find('gpl-3.0') }
   let(:lgpl) { described_class.find('lgpl-3.0') }
-  let(:content_hash) { '46cdc03462b9af57968df67b450cc4372ac41f53' }
+  let(:content_hash) { license_hashes['mit'] }
 
   let(:license_dir) do
     File.expand_path 'vendor/choosealicense.com/_licenses', project_root

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.matches_by_similarity[0]).to eql([gpl, 100.0])
-    expect(subject.matches_by_similarity[1]).to eql([agpl, 95.76581285938317])
+    expect(subject.matches_by_similarity[1]).to eql([agpl, 95.67966280295047])
   end
 
   it 'returns a list of licenses above the confidence threshold' do
     expect(subject.matches_by_similarity[0]).to eql([gpl, 100.0])
-    expect(subject.matches_by_similarity[1]).to eql([agpl, 95.76581285938317])
+    expect(subject.matches_by_similarity[1]).to eql([agpl, 95.67966280295047])
   end
 
   it 'returns the match confidence' do

data/spec/licensee/project_files/license_file_spec.rb

@@ -3,7 +3,7 @@ RSpec.describe Licensee::ProjectFiles::LicenseFile do
   let(:gpl) { Licensee::License.find('gpl-3.0') }
   let(:mit) { Licensee::License.find('mit') }
   let(:content) { sub_copyright_info(mit) }
-  let(:content_hash) { '46cdc03462b9af57968df67b450cc4372ac41f53' }
+  let(:content_hash) { license_hashes['mit'] }
 
   subject { described_class.new(content, filename) }