licensee 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5679eed370a9490f7bfffbddcea3b122a2c7c51c
-  data.tar.gz: c996b5aa61156447d43447602c4bdcebb4de2319
+  metadata.gz: e37a24f1e7dc1930d8b678d9dc59546575779dc7
+  data.tar.gz: 30980d421079b9b0f8eed4572d983492e5cf41c9
 SHA512:
-  metadata.gz: 9de5537537c4be5c6b571706e95e15cc9eefc943dc5f90a907e2770f0b5a08f47aee0961532c38d9270fd403fd05e2c95b28ded6d153a945036baf71c7494d2c
-  data.tar.gz: 6491f09ee2e2929d249fba51349b4ff3a77c81b1b20012932e09b73d23b3e0eba54bc43fe9deff4f50df7dc52936909d7679eb14f09cc5faf2f3bea7ba28c8e6
+  metadata.gz: d5d36072eca3ddb72b3fb3e3f96ad7263b2bad1e1ec4c6b9871720a5cdcdd980409de660dce463f4f2190c8457327a86de8141cb9944e0b83091db2323369755
+  data.tar.gz: 75f7e2dce4b3a626aadeaac6cdc6654852ac8d79be846623f8573b596ac6932cfac520f5e1cd07bcdd286f25416b7cfe7ff92f708b6e323faf93189a50007881

data/README.md

@@ -31,6 +31,8 @@ Confidence: 98.42%
 Matcher: Licensee::GitMatcher
 ```
 
+Alternately, `licensee <directory>` will treat the argument as the project directory, and `licensee <file>` will attempt to match the individual file specified, both with output that looks like the above.
+
 ## License API
 
 ```ruby

data/bin/licensee

@@ -3,21 +3,32 @@ require_relative '../lib/licensee'
 
 path = ARGV[0] || Dir.pwd
 
-options = { detect_packages: true, detect_readme: true }
-project = Licensee::GitProject.new(path, options)
-file = project.matched_file
+def print_file(license_file)
+  if license_file
+    puts "License file: #{license_file.filename}"
+    puts "Attribution: #{license_file.attribution}" if license_file.attribution
+  end
+end
 
-if project.license_file
-  puts "License file: #{project.license_file.filename}"
-  if project.license_file.attribution
-    puts "Attribution: #{project.license_file.attribution}"
+def print_evaluation(file)
+  if file
+    puts "License: #{file.license ? file.license.meta['title'] : 'no license'}"
+    puts "Confidence: #{file.confidence}%"
+    puts "Method: #{file.matcher.class}"
+  else
+    puts 'Unknown'
   end
 end
 
-if file
-  puts "License: #{file.license ? file.license.meta['title'] : 'no license'}"
-  puts "Confidence: #{file.confidence}%"
-  puts "Method: #{file.matcher.class}"
+if File.file?(path)
+  contents = File.read(path, encoding: 'utf-8')
+  license_file = Licensee::Project::LicenseFile.new(contents, path)
+  print_file(license_file)
+  print_evaluation(license_file)
 else
-  puts 'Unknown'
+  options = { detect_packages: true, detect_readme: true }
+  project = Licensee::GitProject.new(path, options)
+  file = project.matched_file
+  print_file(project.license_file)
+  print_evaluation(file)
 end

data/lib/licensee/license.rb

@@ -140,7 +140,7 @@ module Licensee
     def raw_content
       return if pseudo_license?
       @raw_content ||= if File.exist?(path)
-        File.open(path).read
+        File.read(path, encoding: 'utf-8')
       else
         raise Licensee::InvalidLicense, "'#{key}' is not a valid license key"
       end

data/lib/licensee/project.rb

@@ -23,7 +23,7 @@ module Licensee
     def license_file
       return @license_file if defined? @license_file
       @license_file = begin
-        content, name = find_file { |name| LicenseFile.name_score(name) }
+        content, name = find_file { |n| LicenseFile.name_score(n) }
         LicenseFile.new(content, name) if content && name
       end
     end
@@ -32,7 +32,7 @@ module Licensee
       return unless detect_readme?
       return @readme if defined? @readme
       @readme = begin
-        content, name = find_file { |name| Readme.name_score(name) }
+        content, name = find_file { |n| Readme.name_score(n) }
         content = Readme.license_content(content)
         Readme.new(content, name) if content && name
       end
@@ -42,7 +42,7 @@ module Licensee
       return unless detect_packages?
       return @package_file if defined? @package_file
       @package_file = begin
-        content, name = find_file { |name| PackageInfo.name_score(name) }
+        content, name = find_file { |n| PackageInfo.name_score(n) }
         PackageInfo.new(content, name) if content && name
       end
     end

data/lib/licensee/projects/fs_project.rb

@@ -15,8 +15,16 @@ module Licensee
     def find_file
       files = []
 
-      Dir.foreach(path) do |file|
-        next unless ::File.file?(::File.join(path, file))
+      if ::File.file?(path)
+        pattern = ::File.basename(path)
+        @path = ::File.dirname(path)
+      else
+        pattern = '*'
+      end
+
+      Dir.glob(::File.join(path, pattern)) do |file|
+        next unless ::File.file?(file)
+        file = ::File.basename(file)
         if (score = yield file) > 0
           files.push(name: file, score: score)
         end

data/lib/licensee/projects/git_project.rb

@@ -1,8 +1,8 @@
 # Git-based project
 #
-# analyze a given git repository for license information
+# Analyze a given (bare) Git repository for license information
 module Licensee
-  class GitProject < Licensee::Project
+  class GitProject < Project
     attr_reader :repository, :revision
 
     class InvalidRepository < ArgumentError; end
@@ -16,7 +16,7 @@ module Licensee
 
       @revision = revision
       super(**args)
-    rescue Rugged::RepositoryError
+    rescue Rugged::OSError, Rugged::RepositoryError
       raise InvalidRepository
     end
 

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 module Licensee
-  VERSION = '8.0.0'.freeze
+  VERSION = '8.1.0'.freeze
 end

data/test/fixtures/apache-2.0/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/test/functions.rb

@@ -12,7 +12,7 @@ def fixture_path(fixture)
 end
 
 def license_from_path(path)
-  license = File.open(path).read.match(/\A(---\n.*\n---\n+)?(.*)/m).to_a[2]
+  license = File.read(path, encoding: 'utf-8').match(/\A(---\n.*\n---\n+)?(.*)/m).to_a[2]
   license.sub! '[fullname]', 'Ben Balter'
   license.sub! '[year]', '2014'
   license.sub! '[email]', 'ben@github.invalid'

data/test/test_licensee.rb

@@ -12,6 +12,11 @@ class TestLicensee < Minitest::Test
     assert_equal 'mit', Licensee.license(fixture_path('licenses.git')).key
   end
 
+  should "detect a file's license" do
+    file = fixture_path('apache-2.0/LICENSE')
+    assert_equal 'apache-2.0', Licensee.license(file).key
+  end
+
   should 'init a project' do
     project = Licensee.project(fixture_path('licenses.git'))
     assert_equal Licensee::GitProject, project.class

data/test/test_licensee_bin.rb

@@ -15,4 +15,19 @@ class TestLicenseeBin < Minitest::Test
     assert_equal 0, status
     assert stderr.empty?
   end
+
+  should 'work via commandline with file argument' do
+    root = File.expand_path '..', File.dirname(__FILE__)
+    Dir.chdir root
+    stdout, stderr, status = Open3.capture3("#{root}/bin/licensee LICENSE.md")
+
+    msg = "expected #{stdout} to include `License: MIT`"
+    assert stdout.include?('License: MIT'), msg
+
+    msg = "expected #{stdout} to include `Matched file: LICENSE.md`"
+    assert stdout.include?('License file: LICENSE.md'), msg
+
+    assert_equal 0, status
+    assert stderr.empty?
+  end
 end

data/test/test_licensee_copyright_matcher.rb

@@ -27,7 +27,8 @@ class TestLicenseeCopyrightMatchers < Minitest::Test
   end
 
   should 'not false positive' do
-    text = File.open(Licensee::License.find('mit').path).read.split('---').last
+    path = Licensee::License.find('mit').path
+    text = File.read(path, encoding: 'utf-8').split('---').last
     file = Licensee::Project::LicenseFile.new(text)
     assert_equal nil, Licensee::Matchers::Copyright.new(file).match
   end

data/test/test_licensee_exact_matcher.rb

@@ -2,7 +2,8 @@ require 'helper'
 
 class TestLicenseeExactMatchers < Minitest::Test
   def setup
-    text = File.open(Licensee::License.find('mit').path).read.split('---').last
+    path = Licensee::License.find('mit').path
+    text = File.read(path, encoding: 'utf-8').split('---').last
     @mit = Licensee::Project::LicenseFile.new(text)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -124,6 +124,7 @@ files:
 - lib/licensee/projects/fs_project.rb
 - lib/licensee/projects/git_project.rb
 - lib/licensee/version.rb
+- test/fixtures/apache-2.0/LICENSE
 - test/fixtures/bower-with-readme/README.md
 - test/fixtures/bower-with-readme/bower.json
 - test/fixtures/bower/bower.json
@@ -249,9 +250,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem to detect open source project licenses
 test_files: []
-has_rdoc: