deriving_license 0.1.6 → 0.2.0

data/README.md

@@ -1,41 +1,74 @@
 deriving_license
 ================
 
-Finds the license agreements for all gems in your Gemfile
+Finds the license agreements for all gems in your Gemfile. This is achieved by running through a collection of strategies for each dependency until one succeeds in determining the license in use.
+
+Strategies:
+* from\_gem\_specification
+* from\_license\_file (not yet implemented)
+* from\_scraping\_homepage (not yet implemented)
+* from\_parsing\_readme (not yet implemented)
 
 Example output:
 
-    $ deriving_license ~/Code/rails_sample_app/Gemfile
-    Determining license for rails...UNKNOWN
-    Determining license for adt...UNKNOWN
-    Determining license for app_constants (remote call required)...UNKNOWN
-    Determining license for bcrypt-ruby...UNKNOWN
-    Determining license for bootstrap-sass...UNKNOWN
-    Determining license for jquery-rails...SUCCESS
-    Determining license for json...SUCCESS
-    Determining license for nokogiri...UNKNOWN
-    Determining license for pg...SUCCESS
-    Determining license for quiet_assets...UNKNOWN
-    Determining license for rack-protection...UNKNOWN
-    Determining license for symmetric-encryption (remote call required)...UNKNOWN
-    Determining license for newrelic_rpm...UNKNOWN
-    Determining license for uglifier...SUCCESS
-    Determining license for sass-rails...UNKNOWN
-    Determining license for coffee-rails...UNKNOWN
-    Determining license for rspec-rails...SUCCESS
-    Determining license for capybara...UNKNOWN
-    Determining license for factory_girl_rails...UNKNOWN
-    Determining license for faker...UNKNOWN
-    Determining license for better_errors...SUCCESS
-    Determining license for binding_of_caller...UNKNOWN
-    Determining license for debugger...SUCCESS
-    Determining license for simplecov...UNKNOWN
-    Determining license for ci_reporter...UNKNOWN
-    Determining license for sqlite3...UNKNOWN
-    Determining license for mysql2...UNKNOWN
+    $ deriving_license ~/Code/rails-sample-app/Gemfile
+    Determining license for rails:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for adt:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for app_constants:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for bcrypt-ruby:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for bootstrap-sass:
+    	Trying from_gem_specification 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
+    Determining license for pg:
+    	Trying from_gem_specification strategy...SUCCESS
+    Determining license for quiet_assets:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for rack-protection:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for symmetric-encryption:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for newrelic_rpm:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for uglifier:
+    	Trying from_gem_specification strategy...SUCCESS
+    Determining license for sass-rails:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for coffee-rails:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for rspec-rails:
+    	Trying from_gem_specification strategy...SUCCESS
+    Determining license for capybara:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for factory_girl_rails:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for faker:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for better_errors:
+    	Trying from_gem_specification strategy...SUCCESS
+    Determining license for binding_of_caller:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for debugger:
+    	Trying from_gem_specification strategy...SUCCESS
+    Determining license for simplecov:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for ci_reporter:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for sqlite3:
+    	Trying from_gem_specification strategy...FAILED
+    Determining license for mysql2:
+    	Trying from_gem_specification strategy...FAILED
     
-    Detected 3 known licenses:
+    Detected 4 known licenses:
     MIT: Expat License (4 instances)[http://directory.fsf.org/wiki/License:Expat]
+    Ruby: Ruby License (2 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 (1 instance)[http://en.wikipedia.org/wiki/GNU_General_Public_License]
-    There is also 1 unknown license: Ruby
+    GPL: GNU General Public License (1 instance)[http://en.wikipedia.org/wiki/GNU_General_Public_License]

data/deriving_license.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'deriving_license'
-  s.version     = '0.1.6'
+  s.version     = '0.2.0'
   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

@@ -1,6 +1,7 @@
 require "gemnasium/parser"
 require "bundler"
 require "safe_yaml"
+require "open-uri"
 
 class DerivingLicense
   
@@ -29,7 +30,8 @@ class DerivingLicense
   # (that take a string of the dependency's name) then add their names here in 
   # order of fastest to slowest.
   @@strategies = [
-    "from_gem_specification"
+    "from_gem_specification",
+    "from_scraping_homepage"
   ]
 
   def self.run(path=nil)
@@ -53,14 +55,18 @@ class DerivingLicense
     
     # For each dependency specified...
     gemfile.dependencies.each do |d|
-      print "Determining license for #{d.name}..."
+      print "Determining license for #{d.name}:\n"
       # Try each license finding strategy...
       @@strategies.each do |s|
+        print "\tTrying #{s} strategy..."
         @licenses = eval("#{s}(\"#{d.name}\")")
-        break if @licenses # and break out of the search if successful
+        unless @licenses.empty? # and break out of the search if successful
+          print "SUCCESS\n"
+          break
+        end
+        print "FAILED\n"
       end
       @licenses.each{ |l| detected_licenses[l]+=1 } # add each detected license to the results
-      print "DONE\n"
     end
     detected_licenses
   end
@@ -90,16 +96,50 @@ class DerivingLicense
     end
   end
   
-  ##############
-  # STRATEGIES #
-  ##############
-  def self.from_gem_specification(dep)
+  def self.get_gem_spec(dep)
     # See if the gem is installed locally, and if not add -r to call
     Bundler.with_clean_env do # This gets out of the bundler context.
       remote = /#{dep}/.match( `gem list #{dep}` ) ? "" : "-r "      
       yaml = `gem specification #{remote}#{dep} --yaml`
       @spec = YAML.load(yaml, :safe => true)
     end
-    @spec["licenses"]
+    @spec
+  end
+  
+  ##############
+  # STRATEGIES #
+  ##############
+  def self.from_gem_specification(dep)
+    spec = get_gem_spec(dep)
+    spec["licenses"]
+  end
+  
+  def self.from_license_file(dep)
+    []
+  end
+  
+  def self.from_scraping_homepage(dep)
+    spec = get_gem_spec(dep)
+    licenses = []
+    unless spec["homepage"]
+      []
+    end
+    content = open(spec["homepage"])
+    content.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
+          end
+        end
+      end
+    end
+    [] # If we didn't return early, there's no match.
+  end
+  
+  def self.from_parsing_readme(dep)
+    []
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deriving_license
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: