license_finder 0.2.0 → 0.3.0

data/README.markdown

@@ -10,7 +10,7 @@ For a Rails project add license_finder to your Gemfile:
     gem 'license_finder', :git => "https://github.com/pivotal/LicenseFinder.git"
 
 Run 'rake license:init'
-This will create a config/license_finder.yml file that lets you configure license finder.
+This will create a config/license_finder.yml file that lets you configure license finder.  This is where you should add licenses which are allowed on the project, so they will be automatically approved.
 
 Run 'rake license:generate_dependencies'
 This will write out a dependencies.yml and dependencies.txt file in the root of your project. 
@@ -19,6 +19,9 @@ It will also merge in an existing dependencies.yml file, if one exists.
 Run 'rake license:action_items'
 This will output a list of unapproved dependencies to the console
 
+Run 'rake license:action_items:ok'
+This will return a non-zero exit status if there are unapproved dependencies. Great for CI.
+
 As a standalone script:
     cd ~
     git clone http://github.com/pivotal/LicenseFinder.git license_finder
@@ -81,4 +84,14 @@ bin/license_finder:
         disclaimer_of_liability: "mit: THE AUTHORS OR COPYRIGHT HOLDERS"
       readme_files:
       - file_name: README
-        mentions_license: true
+        mentions_license: true
+
+Gem Maintainers
+===============
+
+Please add a license to your gemspec!
+
+    Gem::Specification.new do |s|
+      s.name = "my_great_gem"
+      s.license = "MIT"
+    end

data/lib/license_finder/file_parser.rb

@@ -28,5 +28,13 @@ module LicenseFinder
     rescue
       ''
     end
+    
+    def without_punctuation(text)
+      text.gsub('#', '').gsub(' ', '')
+    end
+    
+    def cleaned_up(text)
+      without_punctuation(on_single_line(text))
+    end
   end
 end

data/lib/license_finder/gem_spec_details.rb

@@ -28,9 +28,11 @@ module LicenseFinder
     end
 
     def determine_license
+      return @spec.license if @spec.license
       return 'MIT' if license_files.any?{|f| f.mit_license_body? || f.mit_license_header?}
       return 'Apache 2.0' if license_files.any?(&:apache_license_body?)
       return 'GPLv2' if license_files.any?(&:gplv2_license_body?)
+      return 'ruby' if license_files.any?(&:ruby_license_body?)
       'other'
     end
 

data/lib/license_finder/license_file.rb

@@ -7,7 +7,8 @@ module LicenseFinder
     MIT_DISCLAIMER_REGEX = /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 ((\w+ ){2,8})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\./
     MIT_ONE_LINER_REGEX = /is released under the MIT license/
     MIT_URL_REGEX = %r{MIT Licence.*http://www.opensource.org/licenses/mit-license}
-    
+    RUBY_URL_REGEX = %r{http://www.ruby-lang.org/en/LICENSE.txt}
+
     def body_type
       if mit_license_body?
         'mit'
@@ -15,6 +16,8 @@ module LicenseFinder
         'apache'
       elsif gplv2_license_body?
         'gplv2'
+      elsif ruby_license_body?
+        'ruby'
       else
         'other'
       end
@@ -29,10 +32,14 @@ module LicenseFinder
     end
 
     def mit_license_body?
-      !!on_single_line(text).index(on_single_line(MIT_LICENSE_TEXT)) || 
+      !!cleaned_up(text).index(cleaned_up(MIT_LICENSE_TEXT)) || 
       !!(on_single_line(text) =~ MIT_URL_REGEX)
     end
 
+    def ruby_license_body?
+      !!(on_single_line(text) =~ RUBY_URL_REGEX)
+    end
+
     def apache_license_body?
       !!on_single_line(text).index(on_single_line(APACHE_LICENSE_TEXT))
     end

data/lib/license_finder/version.rb

@@ -1,3 +1,3 @@
 module LicenseFinder
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/dependency_list_spec.rb

@@ -20,6 +20,10 @@ describe LicenseFinder::DependencyList do
       def full_gem_path
         @path || 'install/path'
       end
+
+      def license
+        nil
+      end
     end
 
   end

data/spec/fixtures/mit_licensed_with_hashes/MIT-LICENSE

@@ -0,0 +1,20 @@
+# Copyright (c) 2010, 2011 Matthew Kocher
+#  
+# 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.

data/spec/gem_spec_details_spec.rb

@@ -24,6 +24,10 @@ describe LicenseFinder::GemSpecDetails do
           'install/path'
         end
       end
+
+      def license
+        nil
+      end
     end
   end
 
@@ -34,6 +38,31 @@ describe LicenseFinder::GemSpecDetails do
   its(:dependency_version) { should == '2.1.3' }
   its(:install_path) { should == 'install/path' }
 
+  describe "#gemspec licenses" do
+    it "returns the license from the gemspec if provided" do
+      mock_gemspec = @mock_gemspec.new
+      stub(mock_gemspec).license { "MIT" }
+      LicenseFinder::GemSpecDetails.new(mock_gemspec).determine_license.should == "MIT"
+    end
+
+    it "returns 'ruby' if if is a ruby license" do
+      mock_gemspec = @mock_gemspec.new
+      mock_license_file = LicenseFinder::LicenseFile.new('gem', 'gem/license/path')
+      stub(mock_license_file).mit_license_body? { false }
+      stub(mock_license_file).mit_license_header? { false }
+      stub(mock_license_file).apache_license_body? { false }
+      stub(mock_license_file).gplv2_license_body? { false }
+
+      stub(mock_license_file).ruby_license_body? { true }
+
+
+      gemspec_details = LicenseFinder::GemSpecDetails.new(mock_gemspec)
+      stub(gemspec_details).license_files { [ mock_license_file ] }
+
+      gemspec_details.determine_license.should == "ruby"
+    end
+  end
+
   describe "#license_files" do
     it "is empty if there aren't any license files" do
       LicenseFinder::GemSpecDetails.new(@mock_gemspec.new).license_files.should == []
@@ -61,6 +90,8 @@ describe LicenseFinder::GemSpecDetails do
     end
   end
 
+
+
   describe "#readme_files" do
     it "is empty if there aren't any readme files" do
       LicenseFinder::GemSpecDetails.new(@mock_gemspec.new).readme_files.should == []
@@ -119,6 +150,20 @@ describe LicenseFinder::GemSpecDetails do
       its(:notes) { should == '' }
     end
 
+
+    describe 'with MIT License with hashes' do
+      subject do
+        LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/mit_licensed_with_hashes'), ['MIT']).dependency
+      end
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'MIT' }
+      its(:approved) { should == true }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
     describe 'with Apache License' do
       subject do
         LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/apache_licensed_gem'), ['Apache 2.0']).dependency

data/spec/license_file_spec.rb

@@ -63,7 +63,17 @@ describe LicenseFinder::LicenseFile do
     its(:disclaimer_of_liability) { should == 'mit: THE AUTHORS OR COPYRIGHT HOLDERS' }
   end
   
-  
+  context "with ruby url in README" do
+    before do
+      stub(IO).read { "Same as Ruby's \n\nhttp://www.ruby-lang.org/en/LICENSE.txt" }
+      stub(IO).binread { "Same as Ruby's \n\nhttp://www.ruby-lang.org/en/LICENSE.txt" }
+    end
+
+    its(:body_type) { should == 'ruby' }
+    its(:disclaimer_of_liability) { should == 'other' }
+  end
+
+
 
   context "with Apache like license" do
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_finder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -96,6 +96,7 @@ files:
 - spec/fixtures/mit_licensed_gem/LICENSE
 - spec/fixtures/mit_licensed_gem_in_README/README.rdoc
 - spec/fixtures/mit_licensed_gem_via_url/README
+- spec/fixtures/mit_licensed_with_hashes/MIT-LICENSE
 - spec/fixtures/nested_gem/vendor/LICENSE
 - spec/fixtures/nested_readme/vendor/README
 - spec/fixtures/no_license/.gitkeep
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: license_finder
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: License finding heaven.
@@ -156,6 +157,7 @@ test_files:
 - spec/fixtures/mit_licensed_gem/LICENSE
 - spec/fixtures/mit_licensed_gem_in_README/README.rdoc
 - spec/fixtures/mit_licensed_gem_via_url/README
+- spec/fixtures/mit_licensed_with_hashes/MIT-LICENSE
 - spec/fixtures/nested_gem/vendor/LICENSE
 - spec/fixtures/nested_readme/vendor/README
 - spec/fixtures/no_license/.gitkeep