license_finder 0.4.5 → 0.5.0

data/lib/license_finder/license/apache.rb

@@ -0,0 +1,5 @@
+class LicenseFinder::License::Apache < LicenseFinder::License::Base
+  def self.pretty_name
+    'Apache 2.0'
+  end
+end

data/lib/license_finder/license/bsd.rb

@@ -0,0 +1,2 @@
+class LicenseFinder::License::BSD < LicenseFinder::License::Base
+end

data/lib/license_finder/license/gplv2.rb

@@ -0,0 +1,2 @@
+class LicenseFinder::License::GPLv2 < LicenseFinder::License::Base
+end

data/lib/license_finder/license/isc.rb

@@ -0,0 +1,2 @@
+class LicenseFinder::License::ISC < LicenseFinder::License::Base
+end

data/lib/license_finder/license/lgpl.rb

@@ -0,0 +1,2 @@
+class LicenseFinder::License::LGPL < LicenseFinder::License::Base
+end

data/lib/license_finder/license/mit.rb

@@ -0,0 +1,20 @@
+class LicenseFinder::License::MIT < LicenseFinder::License::Base
+  HEADER_REGEX = /The MIT Licen[sc]e/
+  ONE_LINER_REGEX = /is released under the MIT licen[sc]e/
+  URL_REGEX = %r{MIT Licen[sc]e.*http://www.opensource.org/licenses/mit-license}
+
+  def matches?
+    super || matches_url? || matches_header?
+  end
+
+  private
+
+  def matches_url?
+    !!(text =~ URL_REGEX)
+  end
+
+  def matches_header?
+    header = text.split("\n").first
+    header && ((header.strip =~ HEADER_REGEX) || !!(text =~ ONE_LINER_REGEX))
+  end
+end

data/lib/license_finder/license/new_bsd.rb

@@ -0,0 +1,5 @@
+class LicenseFinder::License::NewBSD < LicenseFinder::License::Base
+  def self.pretty_name
+    'New BSD'
+  end
+end

data/lib/license_finder/license/ruby.rb

@@ -0,0 +1,11 @@
+class LicenseFinder::License::Ruby < LicenseFinder::License::Base
+  URL_REGEX = %r{http://www.ruby-lang.org/en/LICENSE.txt}
+
+  def self.pretty_name
+    'ruby'
+  end
+
+  def matches?
+    super || !!(text =~ URL_REGEX)
+  end
+end

data/lib/license_finder/license/simplified_bsd.rb

@@ -0,0 +1,5 @@
+class LicenseFinder::License::SimplifiedBSD < LicenseFinder::License::Base
+  def self.pretty_name
+    'Simplified BSD'
+  end
+end

data/lib/license_finder/{file_parser.rb → possible_license_file.rb}

@@ -1,5 +1,5 @@
 module LicenseFinder
-  class FileParser
+  class PossibleLicenseFile
     def initialize(install_path, file_path)
       @install_path = Pathname.new(install_path)
       @file_path = Pathname.new(file_path)
@@ -18,23 +18,15 @@ module LicenseFinder
     end
 
     def text
-      @text ||= @file_path.send((@file_path.respond_to? :binread) ? :binread : :read)
+      @text ||= @file_path.send(@file_path.respond_to?(:binread) ? :binread : :read)
     end
-    
-    private
-    
-    def on_single_line(text)
-      text.gsub(/\s+/, ' ').gsub("'", "\"")
-    rescue
-      ''
-    end
-    
-    def without_punctuation(text)
-      text.gsub('#', '').gsub(' ', '')
-    end
-    
-    def cleaned_up(text)
-      without_punctuation(on_single_line(text))
+
+    def license
+      license = LicenseFinder::License.all.detect do |klass|
+        klass.new(text).matches?
+      end
+
+      license && license.pretty_name
     end
   end
 end

data/lib/tasks/license_finder.rake

@@ -1,6 +1,7 @@
 namespace :license do
   desc 'write out example config file'
   task :init do
+    `mkdir -p ./config`
     FileUtils.cp(File.join(File.dirname(__FILE__), '..', '..', 'files', 'license_finder.yml'), './config/license_finder.yml')
   end
 
@@ -11,19 +12,18 @@ namespace :license do
 
   desc 'action items'
   task :action_items => :generate_dependencies do
-    puts "Dependencies that need approval:"
-    puts LicenseFinder::Finder.new.action_items
+    LicenseFinder::CLI.new.check_for_action_items
   end
 
-  desc 'All gems approved for use'
+  desc 'return a failure status code for unapproved dependencies'
   task 'action_items:ok' => :generate_dependencies do
+    puts "rake license:action_items:ok is deprecated and will be removed in version 1.0.  Use rake license:action_items instead."
+
     found = LicenseFinder::Finder.new.action_items
-    if found.size > 0
-      puts "Dependencies that need approval:"
-      puts found
-    else
+    if found.size == 0
       puts "All gems are approved for use"
+    else
+      exit 1
     end
-    exit 1 unless found.size == 0
   end
 end

data/lib/templates/BSD.txt

@@ -0,0 +1,24 @@
+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. All advertising materials mentioning features or use of this software
+   must display the following acknowledgement:
+   This product includes software developed by <organization>.
+4. Neither the name of <organization> 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 <COPYRIGHT HOLDER> ''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 <COPYRIGHT HOLDER> 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/lib/templates/NewBSD.txt

@@ -0,0 +1,21 @@
+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 <organization> 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 <COPYRIGHT HOLDER> 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/lib/templates/Ruby.txt

@@ -0,0 +1,52 @@
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+    modifications to Usenet or an equivalent medium, or by allowing
+    the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+    together with instructions (in the manual page or equivalent)
+    on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+    the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/lib/templates/SimplifiedBSD.txt

@@ -0,0 +1,23 @@
+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.
+
+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 OWNER 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.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.

data/license_finder.gemspec

@@ -1,15 +1,16 @@
 Gem::Specification.new do |s|
   s.name        = "license_finder"
-  s.version     = "0.4.5"
-  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards"]
+  s.version     = "0.5.0"
+  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers"]
   s.email       = ["brent@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
   s.summary     = "Know your dependencies - and the licenses they are binding your application to."
   s.description = "Find and display licenses of a project's gem dependencies, so that you know what your limitations are when distributing your application."
   s.license     = "MIT"
 
+  s.add_dependency "bundler"
   s.add_development_dependency "rails", ">=3"
-  %w(rspec rr rake cucumber rails).each do |gem|
+  %w(rspec rr rake cucumber rails pry).each do |gem|
     s.add_development_dependency gem
   end
 

data/spec/lib/license_finder/bundled_gem_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe LicenseFinder::BundledGem do
+  subject { LicenseFinder::BundledGem.new(gemspec) }
+
+  let(:gemspec) do
+    Gem::Specification.new do |s|
+      s.name = 'spec_name'
+      s.version = '2.1.3'
+      s.summary = 'summary'
+      s.description = 'description'
+    end
+  end
+
+  def fixture_path(fixture)
+    File.realpath(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec', 'fixtures', fixture))
+  end
+
+  its(:name) { should == 'spec_name 2.1.3' }
+  its(:dependency_name) { should == 'spec_name' }
+  its(:dependency_version) { should == '2.1.3' }
+  its(:install_path) { should == gemspec.full_gem_path }
+
+  describe "#determine_license" do
+    subject do
+      details = LicenseFinder::BundledGem.new(gemspec)
+      stub(details).license_files { [license_file] }
+      details
+    end
+
+    let(:license_file) { LicenseFinder::PossibleLicenseFile.new('gem', 'gem/license/path') }
+
+    it "returns the license from the gemspec if provided" do
+      stub(gemspec).license { "Some License" }
+
+      subject.determine_license.should == "Some License"
+    end
+
+    it "returns the matched license if detected" do
+      stub(license_file).license { "Detected License" }
+
+      subject.determine_license.should == "Detected License"
+    end
+
+    it "returns 'other' otherwise" do
+      stub(license_file).license { nil }
+
+      subject.determine_license.should == "other"
+    end
+  end
+
+  describe "#license_files" do
+    it "is empty if there aren't any license files" do
+      subject.license_files.should == []
+    end
+
+    it "includes files with names like LICENSE, License or COPYING" do
+      stub(gemspec).full_gem_path { fixture_path('license_names') }
+
+      subject.license_files.map(&:file_name).should =~
+        %w[COPYING.txt LICENSE Mit-License README.rdoc Licence.rdoc]
+    end
+
+    it "includes files deep in the hierarchy" do
+      stub(gemspec).full_gem_path { fixture_path('nested_gem') }
+
+      subject.license_files.map { |f| [f.file_name, f.file_path] }.should =~ [
+        %w[LICENSE vendor/LICENSE]
+      ]
+    end
+
+    it "includes both files nested inside LICENSE directory and top level files" do
+      stub(gemspec).full_gem_path { fixture_path('license_directory') }
+      found_license_files = subject.license_files
+
+      found_license_files.map { |f| [f.file_name, f.file_path] }.should =~ [
+        %w[BSD-2-Clause.txt LICENSE/BSD-2-Clause.txt],
+        %w[GPL-2.0.txt LICENSE/GPL-2.0.txt],
+        %w[MIT.txt LICENSE/MIT.txt],
+        %w[RUBY.txt LICENSE/RUBY.txt],
+        %w[COPYING COPYING],
+        %w[LICENSE LICENSE/LICENSE]
+      ]
+    end
+  end
+
+  describe "#readme_files" do
+    it "is empty if there aren't any readme files" do
+      subject.readme_files.should == []
+    end
+
+    it "includes files with names like README, Readme or COPYING" do
+      stub(gemspec).full_gem_path { fixture_path('readme') }
+
+      subject.readme_files.map(&:file_name).should =~ [
+        "Project ReadMe",
+        "README",
+        "Readme.markdown"
+      ]
+    end
+
+    it "includes files deep in the hierarchy" do
+      stub(gemspec).full_gem_path { fixture_path('nested_readme') }
+
+      subject.readme_files.map { |f| [f.file_name, f.file_path] }.should =~ [
+        %w[README vendor/README]
+      ]
+    end
+  end
+
+  describe '#dependency' do
+    subject { LicenseFinder::BundledGem.new(gemspec).dependency }
+
+    its(:name) { should == 'spec_name' }
+    its(:version) { should == '2.1.3' }
+    its(:summary) { should == 'summary' }
+    its(:source) { should == 'bundle' }
+    its(:description) { should == 'description' }
+
+    describe 'with a known license' do
+      before do
+        stub(gemspec).full_gem_path { fixture_path('mit_licensed_gem') }
+        any_instance_of(LicenseFinder::PossibleLicenseFile, :license => 'Detected License')
+      end
+
+      its(:license) { should == 'Detected License' }
+    end
+
+    describe 'with an unknown license' do
+      before do
+        stub(gemspec).full_gem_path { fixture_path('other_licensed_gem') }
+        any_instance_of(LicenseFinder::PossibleLicenseFile, :license => nil)
+      end
+
+      its(:license) { should == 'other' }
+    end
+
+    describe 'with UTF8 file License' do
+      before do
+        stub(gemspec).full_gem_path { fixture_path('utf8_gem') }
+      end
+
+      it "handles non UTF8 encodings" do
+        expect { subject }.not_to raise_error ArgumentError, "invalid byte sequence in UTF-8"
+      end
+    end
+  end
+end