licensee 9.10.0 → 9.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa1cf2d146414880f019c339c2803443db7d63eb2568f7807079aac27a7aec98
-  data.tar.gz: a6243b9cc4b9068090023c70c89a5ea0253580575b534da0c00deaa799441bb5
+  metadata.gz: 354a3c318aa962a9c184c71850ba04574618b17f28582f92660a69e5405218ee
+  data.tar.gz: 1a96874eaaff65c949ca73261aced972cf20ab53d67da7b42d887ac360810eaf
 SHA512:
-  metadata.gz: cff2872a3d87b3c708ac2585dc41b64dd665008064303ec66a3501ec5160dbc87b5e78a4128921d5a95e3e7eb160ecc625d3d12f0fad36b05b59fa577088581b
-  data.tar.gz: 96466e4da40eb17a01625110f236c40cc90cb99b2e39c7057f2867721c77c565ba16cf08d4c4b02c799d1675a11c765e0dd313c761e273354b19fa8cb0fa1528
+  metadata.gz: 227b37abb076fd1d76d9fb296056bdf16b5a24b00ef2e95a0c8a883c7be6dee011bbea1df834b20d6ffe331815cc22f4726c94c1894400d04ae32944f01622dd
+  data.tar.gz: 41582f813fd9e57fa3c497c7edfd11fc447a131e7414ba7a1c3c25266239ec2efb6b867b84adffac704a5ba96e992b72d3f87215222e0aca32f40305e285cc2d

data/lib/licensee/commands/detect.rb

@@ -40,8 +40,10 @@ class LicenseeCLI < Thor
 
       MATCHED_FILE_METHODS.each do |method|
         next unless matched_file.respond_to? method
+
         value = matched_file.public_send method
         next if value.nil?
+
         rows << [humanize(method, :method), humanize(value, method)]
       end
       print_table rows, indent: 2
@@ -51,6 +53,7 @@ class LicenseeCLI < Thor
 
       licenses = licenses_by_similarity(matched_file)
       next if licenses.empty?
+
       say '  Closest non-matching licenses:'
       rows = licenses[0...3].map do |license, similarity|
         spdx_id = license.meta['spdx-id']

data/lib/licensee/content_helper.rb

@@ -26,6 +26,7 @@ module Licensee
     # Number of characteres in the normalized content
     def length
       return 0 unless content_normalized
+
       content_normalized.length
     end
 
@@ -74,6 +75,7 @@ module Licensee
     # Returns a string
     def content_normalized(wrap: nil)
       return unless content
+
       @content_normalized ||= begin
         string = content_without_title_and_version.downcase
         while string =~ Matchers::Copyright::REGEX
@@ -99,6 +101,7 @@ module Licensee
     # Wrap text to the given line length
     def self.wrap(text, line_width = 80)
       return if text.nil?
+
       text = text.clone
       text.gsub!(/([^\n])\n([^\n])/, '\1 \2')
 
@@ -125,6 +128,7 @@ module Licensee
       # 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
       titles.concat(without_versions.compact)

data/lib/licensee/license.rb

@@ -16,11 +16,15 @@ module Licensee
       # Returns an Array of License objects.
       def all(options = {})
         @all[options] ||= begin
+          # TODO: Remove in next major version to avoid breaking change
+          options[:pseudo] ||= options[:psuedo] unless options[:psuedo].nil?
+
           options = DEFAULT_OPTIONS.merge(options)
           output = licenses.dup
           output.reject!(&:hidden?) unless options[:hidden]
-          output.reject!(&:pseudo_license?) unless options[:psuedo]
+          output.reject!(&:pseudo_license?) unless options[:pseudo]
           return output if options[:featured].nil?
+
           output.select { |l| l.featured? == options[:featured] }
         end
       end
@@ -40,7 +44,7 @@ module Licensee
 
       # Given a license title or nickname, fuzzy match the license
       def find_by_title(title)
-        License.all(hidden: true, psuedo: false).find do |license|
+        License.all(hidden: true, pseudo: false).find do |license|
           title =~ /\A(the )?#{license.title_regex}( license)?\z/i
         end
       end
@@ -82,7 +86,7 @@ module Licensee
     DEFAULT_OPTIONS = {
       hidden:   false,
       featured: nil,
-      psuedo:   true
+      pseudo:   true
     }.freeze
 
     ALT_TITLE_REGEX = {
@@ -125,6 +129,8 @@ module Licensee
 
     # Returns the human-readable license name
     def name
+      return key.tr('-', ' ').capitalize if pseudo_license?
+
       title || spdx_id
     end
 
@@ -242,11 +248,13 @@ module Licensee
       unless File.exist?(path)
         raise Licensee::InvalidLicense, "'#{key}' is not a valid license key"
       end
+
       @raw_content ||= File.read(path, encoding: 'utf-8')
     end
 
     def parts
       return unless raw_content
+
       @parts ||= raw_content.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a
     end
 

data/lib/licensee/license_field.rb

@@ -39,6 +39,7 @@ module Licensee
       # Given a license body, returns an array of included LicneseFields
       def from_content(content)
         return [] unless content
+
         LicenseField.from_array content.scan(FIELD_REGEX).flatten
       end
     end

data/lib/licensee/license_meta.rb

@@ -23,6 +23,7 @@ module Licensee
       # returns a LicenseMeta with defaults set
       def from_yaml(yaml)
         return from_hash({}) if yaml.nil? || yaml.to_s.empty?
+
         from_hash YAML.safe_load(yaml)
       end
 

data/lib/licensee/matchers/cran.rb

@@ -15,6 +15,7 @@ module Licensee
       # or `nil` if no license field is found
       def license_field
         return @license_field if defined? @license_field
+
         match = @file.content.match LICENSE_FIELD_REGEX
         @license_field = match ? match[1].downcase : nil
       end
@@ -30,6 +31,7 @@ module Licensee
       # Rerurns `nil` if no license is found
       def license_property
         return unless license_field
+
         # Remove The common + file LICENSE text
         license_key = license_field.sub(PLUS_FILE_LICENSE_REGEX, '')
         gpl_version(license_key) || license_key

data/lib/licensee/matchers/exact.rb

@@ -3,6 +3,7 @@ module Licensee
     class Exact < Licensee::Matchers::Matcher
       def match
         return @match if defined? @match
+
         @match = potential_matches.find do |potential_match|
           potential_match.wordset == file.wordset
         end

data/lib/licensee/matchers/gemspec.rb

@@ -34,6 +34,7 @@ module Licensee
 
         # use 'other' if array contains multiple licenses
         return 'other' unless licenses.size == 1
+
         licenses[0]
       end
 

data/lib/licensee/matchers/package.rb

@@ -4,6 +4,7 @@ module Licensee
       def match
         return @match if defined? @match
         return if license_property.nil? || license_property.to_s.empty?
+
         @match = Licensee.licenses(hidden: true).find do |license|
           license.key == license_property
         end

data/lib/licensee/project_files/license_file.rb

@@ -55,6 +55,7 @@ module Licensee
       def attribution
         @attribution ||= begin
           return unless copyright? || license.content =~ /\[fullname\]/
+
           matches = Matchers::Copyright::REGEX
                     .match(content_without_title_and_version)
           matches[0] if matches

data/lib/licensee/project_files/package_manager_file.rb

@@ -32,6 +32,7 @@ module Licensee
 
       def self.name_score(filename)
         return 1.0 if ['.gemspec', '.cabal'].include?(File.extname(filename))
+
         FILENAMES_SCORES[filename] || 0.0
       end
 

data/lib/licensee/project_files/project_file.rb

@@ -88,6 +88,7 @@ module Licensee
       def copyright?
         return false unless is_a?(LicenseFile)
         return false unless matcher.is_a?(Matchers::Copyright)
+
         filename =~ /\Acopyright(?:#{LicenseFile::OTHER_EXT_REGEX})?\z/i
       end
 

data/lib/licensee/projects/fs_project.rb

@@ -36,6 +36,7 @@ module Licensee
           relative_dir = Pathname.new(dir).relative_path_from(dir_path).to_s
           Dir.glob(::File.join(dir, @pattern).tr('\\', '/')).map do |file|
             next unless ::File.file?(file)
+
             { name: ::File.basename(file), dir: relative_dir }
           end.compact
         end

data/lib/licensee/projects/github_project.rb

@@ -20,6 +20,7 @@ module Licensee
       def initialize(github_url, **args)
         @repo = github_url[GITHUB_REPO_PATTERN, 1]
         raise ArgumentError, "Not a github URL: #{github_url}" unless @repo
+
         super(**args)
       end
 
@@ -29,8 +30,10 @@ module Licensee
 
       def files
         return @files if defined? @files_from_tree
+
         @files = dir_files
         return @files unless @files.empty?
+
         msg = "Could not load GitHub repo #{repo}, it may be private or deleted"
         raise RepoNotFound, msg
       end

data/lib/licensee/projects/project.rb

@@ -21,6 +21,7 @@ module Licensee
       # Returns the matching License instance if a license can be detected
       def license
         return @license if defined? @license
+
         @license = if licenses_without_copyright.count == 1 || lgpl?
           licenses_without_copyright.first
         elsif licenses_without_copyright.count > 1
@@ -53,6 +54,7 @@ module Licensee
       def license_files
         @license_files ||= begin
           return [] if files.empty? || files.nil?
+
           files = find_files do |n|
             Licensee::ProjectFiles::LicenseFile.name_score(n)
           end
@@ -67,6 +69,7 @@ module Licensee
       def readme_file
         return unless detect_readme?
         return @readme if defined? @readme
+
         @readme = begin
           content, file = find_file do |n|
             Licensee::ProjectFiles::ReadmeFile.name_score(n)
@@ -74,6 +77,7 @@ module Licensee
           content = Licensee::ProjectFiles::ReadmeFile.license_content(content)
 
           return unless content && file
+
           Licensee::ProjectFiles::ReadmeFile.new(content, file)
         end
       end
@@ -82,12 +86,14 @@ module Licensee
       def package_file
         return unless detect_packages?
         return @package_file if defined? @package_file
+
         @package_file = begin
           content, file = find_file do |n|
             Licensee::ProjectFiles::PackageManagerFile.name_score(n)
           end
 
           return unless content && file
+
           Licensee::ProjectFiles::PackageManagerFile.new(content, file)
         end
       end
@@ -96,6 +102,7 @@ module Licensee
 
       def lgpl?
         return false unless licenses.count == 2 && license_files.count == 2
+
         license_files[0].lgpl? && license_files[1].gpl?
       end
 
@@ -104,6 +111,7 @@ module Licensee
       # sorted by file score descending
       def find_files
         return [] if files.empty? || files.nil?
+
         found = files.map { |file| file.merge(score: yield(file[:name])) }
         found.select! { |file| file[:score] > 0 }
         found.sort { |a, b| b[:score] <=> a[:score] }
@@ -114,6 +122,7 @@ module Licensee
       # or nil, if no file scored > 0
       def find_file(&block)
         return if files.empty? || files.nil?
+
         file = find_files(&block).first
         [load_file(file), file] if file
       end

data/lib/licensee/version.rb

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

data/spec/licensee/license_spec.rb

@@ -44,6 +44,7 @@ RSpec.describe Licensee::License do
       it 'includes featured licenses' do
         expect(licenses).to include(mit)
         expect(licenses).to_not include(cc_by)
+        expect(licenses).to_not include(other)
       end
     end
 
@@ -63,6 +64,7 @@ RSpec.describe Licensee::License do
       it 'includes only featured licenses' do
         expect(licenses).to include(mit)
         expect(licenses).to_not include(cc_by)
+        expect(licenses).to_not include(other)
         expect(licenses.count).to eql(featured_license_count)
       end
     end
@@ -73,6 +75,7 @@ RSpec.describe Licensee::License do
       it 'includes only non-featured licenses' do
         expect(licenses).to include(unlicense)
         expect(licenses).to_not include(mit)
+        expect(licenses).to_not include(other)
         expect(licenses.count).to eql(non_featured_license_count)
       end
 
@@ -88,13 +91,13 @@ RSpec.describe Licensee::License do
       end
     end
 
-    context 'psudo licenses' do
+    context 'pseudo licenses' do
       let(:other) { Licensee::License.find('other') }
 
       context 'by default' do
         let(:arguments) { {} }
 
-        it "doesn't include psudo licenses" do
+        it "doesn't include pseudo licenses" do
           expect(licenses).to_not include(other)
         end
       end
@@ -102,13 +105,13 @@ RSpec.describe Licensee::License do
       context 'with hidden licenses' do
         let(:arguments) { { hidden: true } }
 
-        it 'includes psudo licenses' do
+        it 'includes pseudo licenses' do
           expect(licenses).to include(other)
         end
       end
 
       context 'when explicitly asked' do
-        let(:arguments) { { hidden: true, psuedo: true } }
+        let(:arguments) { { hidden: true, pseudo: true } }
 
         it 'includes psudo licenses' do
           expect(licenses).to include(other)
@@ -116,12 +119,30 @@ RSpec.describe Licensee::License do
       end
 
       context 'when explicitly excluded' do
-        let(:arguments) { { hidden: true, psuedo: false } }
+        let(:arguments) { { hidden: true, pseudo: false } }
 
         it "doesn'tincludes psudo licenses" do
           expect(licenses).to_not include(other)
         end
       end
+
+      context 'mispelled' do
+        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
   end
 
@@ -201,7 +222,8 @@ RSpec.describe Licensee::License do
     end
 
     it 'uses the default name when none exists' do
-      expect(other.name).to eql('NOASSERTION')
+      expect(other.name).to eql('Other')
+      expect(no_license.name).to eql('No license')
     end
 
     it 'expoeses the nickname' do
@@ -341,7 +363,7 @@ RSpec.describe Licensee::License do
   end
 
   context 'License.title_regex' do
-    Licensee::License.all(hidden: true, psuedo: false).each do |license|
+    Licensee::License.all(hidden: true, pseudo: false).each do |license|
       context "the #{license.title} license" do
         %i[title nickname key].each do |variation|
           next if license.send(variation).nil?
@@ -451,7 +473,7 @@ RSpec.describe Licensee::License do
   end
 
   context 'source regex' do
-    Licensee::License.all(hidden: true, psuedo: false).each do |license|
+    Licensee::License.all(hidden: true, pseudo: false).each do |license|
       context "the #{license.title} license" do
         let(:source) { URI.parse(license.source) }
 
@@ -469,6 +491,7 @@ RSpec.describe Licensee::License do
                   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}"

data/spec/spec_helper.rb

@@ -109,6 +109,7 @@ RSpec::Matchers.define :be_detected_as do |expected|
     license_file = Licensee::ProjectFiles::LicenseFile.new(actual, 'LICENSE')
     @actual = license_file.content_normalized(wrap: 80)
     return false unless license_file.license
+
     values_match? expected, license_file.license
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.10.0
+  version: 9.10.1
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv