licensee 9.9.2 → 9.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb4651c6f3bae8fae051ec33b3517ebb09191402f8e7e5d1b0fd949a85b71393
-  data.tar.gz: 6fd1952939f6c0940fb0c132092b7b025803f76cb3789450ddabd53883dd0a88
+  metadata.gz: 9d245d544a683bfaff9448e8654a409cea3b6ddc808ba7f7b966c84e031255ea
+  data.tar.gz: 801c8048260b692571828fce99aa754afeb99063849e3e330e7fbb0b1b7117db
 SHA512:
-  metadata.gz: 36016536deeadbd74cb8078622b4e89c8b744f139661076252a62d3543d9e70c8b84df70cfe0cff340b75f17d92e174b21cbd7e2eef1c8a7ae95219fb41b33e1
-  data.tar.gz: c67c0456e2477d69e7fad5a753c789bf5cdfc426bb7eec3dfda23cf23dce311906e47cc00b2ce3b1af1772e85be3f1d147fdc19426be6e968111b497578efe51
+  metadata.gz: 918b6abcf12b00722fb85c64112f2e11334a4b43d6f3b7d3335156a6bb21b0077432030f6c132aa0950af0b4860102a9a1c2d8548a5de5e1529852ae13e29ed1
+  data.tar.gz: 919b0c1a4390a2dd964e7f4d245194ef47e108e1336fc4f04b9795a97f17475ebc64dce12ff1bbd97bb805f5d1fc95774ece1878af17a89f4d57cf974582944b

data/lib/licensee/license_meta.rb

@@ -53,5 +53,9 @@ module Licensee
       key = 'spdx_id' if key == 'spdx-id'
       super(key)
     end
+
+    def source
+      "https://spdx.org/licenses/#{spdx_id}.html" if spdx_id
+    end
   end
 end

data/lib/licensee/matchers/dice.rb

@@ -18,9 +18,9 @@ module Licensee
       #    that begin with the title of a non-open source CC license variant
       # 2. The percentage change in file length may not exceed the inverse
       #    of the confidence threshold
-      def potential_licenses
-        @potential_licenses ||= begin
-          Licensee.licenses(hidden: true).select do |license|
+      def potential_matches
+        @potential_matches ||= begin
+          super.select do |license|
             if license.creative_commons? && file.potential_false_positive?
               false
             else
@@ -29,18 +29,20 @@ module Licensee
           end
         end
       end
+      alias potential_licenses potential_matches
 
-      def licenses_by_similiarity
-        @licenses_by_similiarity ||= begin
-          licenses = potential_licenses.map do |license|
-            [license, license.similarity(file)]
+      def matches_by_similarity
+        @matches_by_similarity ||= begin
+          matches = potential_matches.map do |potential_match|
+            [potential_match, potential_match.similarity(file)]
           end
-          licenses.sort_by { |_, similarity| similarity }.reverse
+          matches.sort_by { |_, similarity| similarity }.reverse
         end
       end
+      alias licenses_by_similarity matches_by_similarity
 
       def matches
-        @matches ||= licenses_by_similiarity.select do |_, similarity|
+        @matches ||= matches_by_similarity.select do |_, similarity|
           similarity >= Licensee.confidence_threshold
         end
       end

data/lib/licensee/matchers/exact.rb

@@ -3,8 +3,8 @@ module Licensee
     class Exact < Licensee::Matchers::Matcher
       def match
         return @match if defined? @match
-        @match = Licensee.licenses(hidden: true).find do |license|
-          license.length == @file.length && license.wordset == @file.wordset
+        @match = potential_matches.find do |potential_match|
+          potential_match.wordset == file.wordset
         end
       end
 

data/lib/licensee/matchers/matcher.rb

@@ -21,6 +21,12 @@ module Licensee
       def confidence
         raise 'Not implemented'
       end
+
+      private
+
+      def potential_matches
+        @potential_matches ||= Licensee.licenses(hidden: true)
+      end
     end
   end
 end

data/lib/licensee/project_files/project_file.rb

@@ -42,9 +42,23 @@ module Licensee
         @data = metadata || {}
       end
 
+      # TODO: In the next major release, filename should be the basename
+      # and path should be either the absolute path or the relative path to
+      # the project root, but maintaining the alias for backward compatability
       def filename
         @data[:name]
       end
+      alias path filename
+
+      def directory
+        @data[:dir] || '.'
+      end
+      alias dir directory
+
+      def path_relative_to_root
+        File.join(directory, filename)
+      end
+      alias relative_path path_relative_to_root
 
       def possible_matchers
         raise 'Not implemented'
@@ -64,7 +78,6 @@ module Licensee
       end
 
       alias match license
-      alias path filename
 
       def matched_license
         license.spdx_id if license

data/lib/licensee/projects/fs_project.rb

@@ -10,14 +10,14 @@ module Licensee
     class FSProject < Licensee::Projects::Project
       def initialize(path, **args)
         if ::File.file?(path)
-          @pattern = ::File.basename(path)
-          @dir = ::File.dirname(path)
+          @pattern = File.basename(path)
+          @dir = File.expand_path File.dirname(path)
         else
           @pattern = '*'
-          @dir = path
+          @dir = File.expand_path(path)
         end
 
-        @root = args.delete(:search_root) || @dir
+        @root = File.expand_path(args.delete(:search_root) || @dir)
         unless valid_search_root?
           raise 'Search root must be the project path directory or its ancestor'
         end
@@ -33,9 +33,10 @@ module Licensee
       #  :dir  - the directory path containing the file
       def files
         @files ||= search_directories.flat_map do |dir|
+          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: dir }
+            { name: ::File.basename(file), dir: relative_dir }
           end.compact
         end
       end
@@ -46,13 +47,12 @@ module Licensee
       #
       # Returns the file contents as a string
       def load_file(file)
-        ::File.read(::File.join(file[:dir], file[:name]))
+        File.read dir_path.join(file[:dir], file[:name])
       end
 
       # Returns true if @dir is @root or it's descendant
       def valid_search_root?
-        dir = Pathname.new(@dir)
-        dir.fnmatch?(@root) || dir.fnmatch?(::File.join(@root, '**'))
+        dir_path.fnmatch?(@root) || dir_path.fnmatch?(::File.join(@root, '**'))
       end
 
       # Returns the set of unique paths to search for project files
@@ -66,13 +66,16 @@ module Licensee
       # Enumerates all directories to search, from @dir to @root
       def search_enumerator
         root = Pathname.new(@root)
-        dir = Pathname.new(@dir)
         Enumerator.new do |yielder|
-          dir.relative_path_from(root).ascend do |relative|
+          dir_path.relative_path_from(root).ascend do |relative|
             yielder.yield root.join(relative)
           end
         end
       end
+
+      def dir_path
+        @dir_path ||= Pathname.new(@dir)
+      end
     end
   end
 end

data/lib/licensee/projects/git_project.rb

@@ -59,9 +59,12 @@ module Licensee
       #  :name - the file's path relative to the repo root
       #  :oid  - the file's OID
       def files
-        @files ||= commit.tree.map do |entry|
-          next unless entry[:type] == :blob
-          { name: entry[:name], oid: entry[:oid] }
+        @files ||= files_from_tree(commit.tree)
+      end
+
+      def files_from_tree(tree, dir = '.')
+        tree.select { |e| e[:type] == :blob }.map do |entry|
+          entry.merge(dir: dir)
         end.compact
       end
     end

data/lib/licensee/projects/project.rb

@@ -68,13 +68,13 @@ module Licensee
         return unless detect_readme?
         return @readme if defined? @readme
         @readme = begin
-          content, name = find_file do |n|
+          content, file = find_file do |n|
             Licensee::ProjectFiles::ReadmeFile.name_score(n)
           end
           content = Licensee::ProjectFiles::ReadmeFile.license_content(content)
 
-          return unless content && name
-          Licensee::ProjectFiles::ReadmeFile.new(content, name)
+          return unless content && file
+          Licensee::ProjectFiles::ReadmeFile.new(content, file)
         end
       end
       alias readme readme_file
@@ -83,12 +83,12 @@ module Licensee
         return unless detect_packages?
         return @package_file if defined? @package_file
         @package_file = begin
-          content, name = find_file do |n|
+          content, file = find_file do |n|
             Licensee::ProjectFiles::PackageManagerFile.name_score(n)
           end
 
-          return unless content && name
-          Licensee::ProjectFiles::PackageManagerFile.new(content, name)
+          return unless content && file
+          Licensee::ProjectFiles::PackageManagerFile.new(content, file)
         end
       end
 
@@ -115,7 +115,7 @@ module Licensee
       def find_file(&block)
         return if files.empty? || files.nil?
         file = find_files(&block).first
-        [load_file(file), file[:name]] if file
+        [load_file(file), file] if file
       end
 
       # Given an array of LicenseFiles, ensures LGPL is the first entry,
@@ -147,14 +147,14 @@ module Licensee
           matched_files.reject(&:copyright?).map(&:license).uniq
         end
       end
-    end
 
-    def files
-      raise 'Not implemented'
-    end
+      def files
+        raise 'Not implemented'
+      end
 
-    def load_file(_file)
-      raise 'Not implemented'
+      def load_file(_file)
+        raise 'Not implemented'
+      end
     end
   end
 end

data/lib/licensee/version.rb

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

data/spec/fixtures/detect.json

@@ -5,7 +5,7 @@
       "spdx_id": "MIT",
       "meta": {
         "title": "MIT License",
-        "source": "https://opensource.org/licenses/MIT",
+        "source": "https://spdx.org/licenses/MIT.html",
         "description": "A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.",
         "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. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.",
         "using": [

data/spec/licensee/license_meta_spec.rb

@@ -126,7 +126,7 @@ RSpec.describe Licensee::LicenseMeta do
     let(:expected) do
       {
         title:       'MIT License',
-        source:      'https://opensource.org/licenses/MIT',
+        source:      'https://spdx.org/licenses/MIT.html',
         description: subject.description.to_s,
         how:         subject.how.to_s,
         using:       using,

data/spec/licensee/matchers/dice_matcher_spec.rb

@@ -17,17 +17,17 @@ RSpec.describe Licensee::Matchers::Dice do
   end
 
   it 'builds a list of potential licenses' do
-    expect(subject.potential_licenses).to eql([agpl, gpl])
+    expect(subject.potential_matches).to eql([agpl, gpl])
   end
 
   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.76581285938317])
+    expect(subject.matches_by_similarity[0]).to eql([gpl, 100.0])
+    expect(subject.matches_by_similarity[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.76581285938317])
+    expect(subject.matches_by_similarity[0]).to eql([gpl, 100.0])
+    expect(subject.matches_by_similarity[1]).to eql([agpl, 95.76581285938317])
   end
 
   it 'returns the match confidence' do

data/spec/licensee/project_files/project_file_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Licensee::ProjectFiles::ProjectFile do
   let(:content) { mit.content }
   let(:possible_matchers) { [Licensee::Matchers::Exact] }
 
-  subject { described_class.new(content, filename) }
+  subject { Licensee::ProjectFiles::LicenseFile.new(content, filename) }
   before do
     allow(subject).to receive(:possible_matchers).and_return(possible_matchers)
   end
@@ -50,8 +50,8 @@ RSpec.describe Licensee::ProjectFiles::ProjectFile do
       {
         filename:           'LICENSE.txt',
         content:            mit.content.to_s,
-        content_hash:       nil,
-        content_normalized: nil,
+        content_hash:       subject.content_hash,
+        content_normalized: subject.content_normalized,
         matcher:            {
           name:       :exact,
           confidence: 100

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 9.9.2
+  version: 9.9.3
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv