deriving_license 0.2.4 → 0.2.5

data/README.md

@@ -7,7 +7,7 @@ Strategies:
 * from\_gem\_specification
 * from\_license\_file
 * from\_scraping\_homepage
-* from\_parsing\_readme (not yet implemented)
+* from\_parsing\_readme
 
 Example output:
 
@@ -18,84 +18,20 @@ Example output:
 	Determining license for adt:
 		Trying from_gem_specification strategy...FAILED
 		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...FAILED
+		Trying from_license_file strategy...CUSTOM
 	Determining license for app_constants:
 		Trying from_gem_specification strategy...FAILED
 		Trying from_scraping_homepage strategy...SUCCESS
 	Determining license for bcrypt-ruby:
 		Trying from_gem_specification strategy...FAILED
 		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...FAILED
-	Determining license for bootstrap-sass:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...FAILED
-	Determining license for jquery-rails:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for json:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for nokogiri:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for pg:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for quiet_assets:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for rack-protection:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...FAILED
-	Determining license for symmetric-encryption:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for newrelic_rpm:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for uglifier:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for sass-rails:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...SUCCESS
-	Determining license for coffee-rails:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...SUCCESS
-	Determining license for rspec-rails:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for capybara:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for factory_girl_rails:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for faker:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for better_errors:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for binding_of_caller:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for debugger:
-		Trying from_gem_specification strategy...SUCCESS
-	Determining license for simplecov:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for ci_reporter:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
-	Determining license for sqlite3:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...FAILED
-		Trying from_license_file strategy...FAILED
-	Determining license for mysql2:
-		Trying from_gem_specification strategy...FAILED
-		Trying from_scraping_homepage strategy...SUCCESS
+		Trying from_license_file strategy...CUSTOM
+		
+	...
     
 	Detected 4 known licenses:
 	MIT: Expat License (14 instances)[http://directory.fsf.org/wiki/License:Expat]
 	Ruby: Ruby License (6 instances)[http://www.ruby-lang.org/en/about/license.txt]
 	BSD: FreeBSD Copyright (2 instances)[http://www.freebsd.org/copyright/freebsd-license.html]
-	GPL: GNU General Public License (2 instances)[http://en.wikipedia.org/wiki/GNU_General_Public_License]
+	GPL: GNU General Public License (2 instances)[http://en.wikipedia.org/wiki/GNU_General_Public_License]
+	The following dependencies have custom licenses: adt, bcrypt-ruby, bootstrap-sass, rack-protection, sass-rails, coffee-rails, sqlite3

data/deriving_license.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'deriving_license'
-  s.version     = '0.2.4'
+  s.version     = '0.2.5'
   s.summary     = "Deriving Licence finds the license agreements for all gems in your Gemfile"
   s.description = "Deriving Licence finds the license agreements for all gems in your Gemfile if included in your project, or in a Gemfile passed to the included binary"
   s.authors     = ["Tom Allen"]

data/lib/deriving_license.rb

@@ -25,7 +25,8 @@ class DerivingLicense
     "FreeBSD" => "BSD",
     "Expat" => "MIT",
     "beer" => "beerware",
-    "ruby" => "Ruby"
+    "ruby" => "Ruby",
+    "Apache License" => "Apache",
   }
   
   # String array of strategies to detect licenses. Write new class functions 
@@ -34,7 +35,8 @@ class DerivingLicense
   @@strategies = [
     "from_gem_specification",
     "from_scraping_homepage",
-    "from_license_file"
+    "from_license_file",
+    "from_parsing_readme",
   ]
   
   @@specs_cache = {} # Cache of gem specifications previously fetched.
@@ -60,6 +62,7 @@ class DerivingLicense
       content = Gemnasium::Parser::Gemfile.new(content)
     end
     detected_licenses = Hash.new(0)
+    detected_licenses["custom"]=[]
     
     # For each dependency specified...
     content.dependencies.each do |d|
@@ -69,12 +72,26 @@ class DerivingLicense
         print "\tTrying #{s} strategy..."
         @licenses = eval("#{s}(\"#{d.name}\")")
         unless @licenses.empty? # and break out of the search if successful
-          print "SUCCESS\n"
+          if @licenses.count == 1 and @licenses[0] == "custom"
+            print "CUSTOM\n"
+          else
+            print "SUCCESS\n"
+          end
           break
         end
         print "FAILED\n"
       end
-      @licenses.each{ |l| detected_licenses[l]+=1 } # add each detected license to the results
+      @licenses.each do |l| # add each detected license to the results
+        unless l == "custom"
+          detected_licenses[l]+=1
+        else
+          detected_licenses["custom"] << "#{d.name}" # the 'custom' key is 
+            # special and holds an array of the deps with custom licenses.
+        end
+      end
+    end
+    if detected_licenses["custom"].empty?
+      detected_licenses.delete("custom")
     end
     detected_licenses
   end
@@ -83,24 +100,29 @@ class DerivingLicense
     # Print link to description of each license type, then attempt to determine 
     # whether any notable restrictions apply (e.g. you can't sell this project, 
     # you must include a copy of the GPL, etc)
-    unknowns = []
+    unrecognized = []
     output = []
     licenses.each do |l|
-      instances = "(#{l.last} instance#{l.last == 1 ? "" : "s"})"
-      key = @@license_aliases[l.first]
-      key ||= l.first
-      if @@license_details[key]
-        output << "#{key}: #{@@license_details[key][:name]} #{instances}[#{@@license_details[key][:link]}]"
-      else
-        unknowns << key
+      unless l.first == "custom"
+        instances = "(#{l.last} instance#{l.last == 1 ? "" : "s"})"
+        key = @@license_aliases[l.first]
+        key ||= l.first
+        if @@license_details[key]
+          output << "#{key}: #{@@license_details[key][:name]} #{instances}[#{@@license_details[key][:link]}]"
+        else
+          unrecognized << key
+        end
       end
     end
     unless output.empty?
       puts "Detected #{output.count} known license#{output.count==1 ? "" : "s"}:"
       output.each{|o| puts o}
     end
-    unless unknowns.empty?
-      puts "There #{unknowns.count==1 ? "is" : "are"} also #{unknowns.count} unknown license#{unknowns.count==1 ? "" : "s"}: #{unknowns.join(', ')}"
+    unless unrecognized.empty?
+      puts "There #{unrecognized.count==1 ? "is" : "are"} also #{unrecognized.count} unrecognized license#{unrecognized.count==1 ? "" : "s"}: #{unrecognized.join(', ')}"
+    end
+    unless licenses["custom"].nil? or licenses["custom"].empty?
+      puts "The following dependencies have custom licenses: #{licenses["custom"].join(', ')}"
     end
   end
   
@@ -118,6 +140,24 @@ class DerivingLicense
     @spec
   end
   
+  def self.yield_gem_source_directory(dep)
+    # Yields a path to a temporary directory containing the gem source, then 
+    # cleans up after itself. Supply a block taking the gem_dir_path and 
+    # interrogate the directory as required.
+    Bundler.with_clean_env do # This gets out of the bundler context.
+      @fetch_output = `gem fetch #{dep}`
+      @unpack_output = `gem unpack #{dep} --target=./deriving_license_tmp`
+    end
+    unpack_dir = /'([\/a-zA-Z0-9._\-]*)'/.match(@unpack_output)[1]
+    gem_filename = /Downloaded\ ([\/a-zA-Z0-9._\-]*)$/.match(@fetch_output)[1]
+    gem_filename += ".gem"
+    
+    yield unpack_dir, gem_filename if block_given?
+    
+    `rm -rf ./deriving_license_tmp` # Clean up tmp dir. Don't fuck this up.
+    `rm #{gem_filename}` # Remove fetched gem.
+  end
+  
   ##############
   # STRATEGIES #
   ##############
@@ -128,50 +168,51 @@ class DerivingLicense
   
   def self.from_license_file(dep)
     licenses = []
-    Bundler.with_clean_env do # This gets out of the bundler context.
-      @fetch_output = `gem fetch #{dep}`
-      @unpack_output = `gem unpack #{dep} --target=./deriving_license_tmp`
-    end
-    unpack_dir = /'([\/a-zA-Z0-9._\-]*)'/.match(@unpack_output)[1]
-    gem_filename = /Downloaded\ ([\/a-zA-Z0-9._\-]*)$/.match(@fetch_output)[1]
-    gem_filename += ".gem"
-    license_file_paths = []
-    Find.find(unpack_dir) do |path|
-      license_file_paths << path if path =~ /(license|LICENSE)$/
-    end
-    return [] unless license_file_paths
+
+    yield_gem_source_directory(dep) do |gem_source_directory|
+
+      license_file_paths = []
+      Find.find(gem_source_directory) do |path|
+        license_file_paths << path if path =~ /(license|LICENSE)$/
+      end
+      break unless license_file_paths
     
-    # Found filename with the word "license", so now look for known license 
-    # names in the rest of this filename.
-    license_file_paths.each do |p|
-      (@@license_details.keys + @@license_aliases.keys).each do |n|
-        if /#{n}/.match(p)
-          licenses << n
+      # Found filename with the word "license", so now look for known license 
+      # names in the rest of this filename.
+      license_file_paths.each do |p|
+        (@@license_details.keys + @@license_aliases.keys).each do |n|
+          if /#{n}/.match(p)
+            licenses << n
+            break
+          end
         end
       end
-    end
     
-    if licenses.empty?
-      # Failing that, open each file and check the content in a similar manner.
-      license_file_paths.each do |p|
-        if File.exist?(p)
-          File.open(p).each_line do |l|
-            if /license/.match(l)
-              # Found the word "license", so now look for known license names.
-              (@@license_details.keys + @@license_aliases.keys).each do |n|
-                if /#{n}/.match(l)
-                  licenses << n
-                  return licenses
+      if licenses.empty?
+        # Failing that, open each file and check the content in a similar manner.
+        license_file_paths.each do |p|
+          if File.exist?(p)
+            File.open(p).each_line do |l|
+              if /license/.match(l)
+                # Found the word "license", so now look for known license names.
+                (@@license_details.keys + @@license_aliases.keys).each do |n|
+                  if /#{n}/.match(l)
+                    licenses << n
+                    break
+                  end
                 end
               end
             end
           end
         end
       end
-    end
+      
+      # Finally, if we couldn't find a known license, but a license file 
+      # exists, report it as custom.
+      licenses << "custom"
+      
+    end # end of call to yield_gem_source_directory
     
-    `rm -rf ./deriving_license_tmp` # Clean up tmp dir. Don't fuck this up.
-    `rm #{gem_filename}` # Remove fetched gem.
     return licenses
 
   end
@@ -198,10 +239,39 @@ class DerivingLicense
         end
       end
     end
-    [] # If we didn't return early, there's no match.
+    return licenses # If we didn't return early, there's no match.
   end
   
   def self.from_parsing_readme(dep)
-    []
+    licenses = []
+
+    yield_gem_source_directory(dep) do |gem_source_directory|
+
+      readme_file_paths = []
+      Find.find(gem_source_directory) do |path|
+        readme_file_paths << path if path =~ /(read\.me|readme|README)$/
+      end
+      break unless readme_file_paths
+    
+      # Open each readme file and check the content.
+      readme_file_paths.each do |p|
+        if File.exist?(p)
+          File.open(p).each_line do |l|
+            if /license/.match(l)
+              # Found the word "license", so now look for known license names.
+              (@@license_details.keys + @@license_aliases.keys).each do |n|
+                if /#{n}/.match(l)
+                  licenses << n
+                  break
+                end
+              end
+            end
+          end
+        end
+      end
+    
+    end # end of call to yield_gem_source_directory
+    return licenses
   end
-end
+  
+end # end of DerivingLicense class

data/test/test_deriving_license.rb

@@ -53,14 +53,14 @@ class DerivingLicenseTest < Test::Unit::TestCase
     assert_equal( false, /Detected/.match( output.string ).nil? )
   end
   
-  def test_describe_with_unknown_license
+  def test_describe_with_unrecognized_license
     output = capture_stdout do
       DerivingLicense.describe({"Cheese" => 1})
     end
     # Shouldn't say "detected"
     assert_equal( true, /Detected/.match( output.string ).nil? )
     # Should say "unknown"
-    assert_equal( false, /unknown/.match( output.string ).nil? )
+    assert_equal( false, /unrecognized/.match( output.string ).nil? )
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deriving_license
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemnasium-parser
@@ -97,9 +97,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Deriving Licence finds the license agreements for all gems in your Gemfile
 test_files:
 - test/test_deriving_license.rb
+has_rdoc: