deriving_license 0.1.5 → 0.1.6

data/deriving_license.gemspec

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

@@ -24,6 +24,13 @@ class DerivingLicense
     "beer" => "beerware",
     "ruby" => "Ruby"
   }
+  
+  # String array of strategies to detect licenses. Write new class functions 
+  # (that take a string of the dependency's name) then add their names here in 
+  # order of fastest to slowest.
+  @@strategies = [
+    "from_gem_specification"
+  ]
 
   def self.run(path=nil)
     unless path
@@ -42,19 +49,20 @@ class DerivingLicense
     
     gemfile = Gemnasium::Parser::Gemfile.new(content)
     
-    licenses = Hash.new(0)
+    detected_licenses = Hash.new(0)
+    
+    # For each dependency specified...
     gemfile.dependencies.each do |d|
-      # See if it's installed locally, and if not add -r to call
-      Bundler.with_clean_env do # This gets out of the bundler context.
-        remote = /#{d.name}/.match( `BUNDLE_GEMFILE=#{path}; gem list #{d.name}` ) ? "" : "-r "      
-        print "Determining license for #{d.name}#{remote.empty? ? "" : " (remote call required)"}..."
-        yaml = `gem specification #{remote}#{d.name} --yaml`
-        @spec = YAML.load(yaml, :safe => true)
+      print "Determining license for #{d.name}..."
+      # Try each license finding strategy...
+      @@strategies.each do |s|
+        @licenses = eval("#{s}(\"#{d.name}\")")
+        break if @licenses # and break out of the search if successful
       end
-      print "#{@spec["licenses"].empty? ? "UNKNOWN" : "SUCCESS"}\n"
-      @spec["licenses"].each{ |l| licenses[l]+=1 }
+      @licenses.each{ |l| detected_licenses[l]+=1 } # add each detected license to the results
+      print "DONE\n"
     end
-    licenses
+    detected_licenses
   end
   
   def self.describe(licenses)
@@ -81,4 +89,17 @@ class DerivingLicense
       puts "There #{unknowns.count==1 ? "is" : "are"} also #{unknowns.count} unknown license#{unknowns.count==1 ? "" : "s"}: #{unknowns.join(', ')}"
     end
   end
+  
+  ##############
+  # STRATEGIES #
+  ##############
+  def self.from_gem_specification(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"]
+  end
 end

data/test/test_deriving_license.rb

@@ -1,6 +1,19 @@
 require 'test/unit'
 require 'deriving_license'
 
+# Monkey-patch stdout to test puts calls
+require 'stringio'
+module Kernel
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out
+  ensure
+    $stdout = STDOUT
+  end
+end
+
 class DerivingLicenseTest < Test::Unit::TestCase
   def test_run_throws_with_no_args
     assert_raise ArgumentError do
@@ -32,5 +45,22 @@ class DerivingLicenseTest < Test::Unit::TestCase
     end
     assert_equal( {"MIT"=>1}, DerivingLicense.run("Gemfile") )
   end
+  
+  def test_describe_with_known_license
+    output = capture_stdout do
+      DerivingLicense.describe({"MIT" => 1})
+    end
+    assert_equal( false, /Detected/.match( output.string ).nil? )
+  end
+  
+  def test_describe_with_unknown_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? )
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deriving_license
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemnasium-parser
@@ -81,9 +81,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: