deriving_license 0.2.7 → 0.2.8

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
-*.gem
+*.gem
+coverage

data/Gemfile

@@ -2,4 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rake", ">= 0.8.7"
+# NB: For convenient testing, it's worth keeping this here.
+group :test do
+  gem "rake", ">= 0.8.7"
+end

data/deriving_license.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'deriving_license'
-  s.version     = '0.2.7'
+  s.version     = '0.2.8'
   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"]
@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "gemnasium-parser"
   s.add_runtime_dependency "safe_yaml"
   s.add_runtime_dependency "curb"
+  s.add_development_dependency "simplecov"
 end

data/lib/deriving_license.rb

@@ -10,7 +10,7 @@ class DerivingLicense
   
   # TODO: Scrape http://www.gnu.org/licenses/license-list.html#SoftwareLicenses 
   # and auto-magically generate these details.
-  @@license_details = {
+  @license_details = {
     # key -> hash of (Name, Link, [Tags]), where tags is an array that may include [:gpl_compatible, :copyleft_compatible, :has_restrictions]
     "GPL" => {name:"GNU General Public License",link:"http://en.wikipedia.org/wiki/GNU_General_Public_License",tags:[:gpl_compatible, :copyleft_compatible, :has_restrictions]},
     "MIT" => {name:"Expat License",link:"http://directory.fsf.org/wiki/License:Expat",tags:[:gpl_compatible, :has_restrictions]},
@@ -20,11 +20,12 @@ class DerivingLicense
     "Apache" => {name:"Apache License",link:"http://www.apache.org/licenses/LICENSE-2.0",tags:[:has_restrictions]},
   }
 
-  @@license_aliases = {
+  @license_aliases = {
     # hash of names to keys of the license in the master list.
     "FreeBSD" => "BSD",
     "Expat" => "MIT",
     "beer" => "beerware",
+    "BEER-WARE" => "beerware",
     "ruby" => "Ruby",
     "Apache License" => "Apache",
   }
@@ -32,16 +33,16 @@ class DerivingLicense
   # 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 = [
+  @strategies = [
     "from_gem_specification",
     "from_scraping_homepage",
     "from_license_file",
     "from_parsing_readme",
   ]
   
-  @@specs_cache = {} # Cache of gem specifications previously fetched.
+  @specs_cache = {} # Cache of gem specifications previously fetched.
 
-  def self.run(path=nil)
+  def self.run(path=nil, strategies=nil)
     unless path
       raise ArgumentError.new("Path to Gemfile or Gemspec required")
     end
@@ -56,6 +57,8 @@ class DerivingLicense
       raise "Invalid path to gemfile or gemspec."
     end
     
+    available_strategies = strategies.nil? ? @strategies : strategies
+    
     if /(gemspec)+/.match(path.downcase)
       content = Gemnasium::Parser::Gemspec.new(content)
     else
@@ -68,7 +71,7 @@ class DerivingLicense
     content.dependencies.each do |d|
       print "Determining license for #{d.name}:\n"
       # Try each license finding strategy...
-      @@strategies.each do |s|
+      available_strategies.each do |s|
         print "\tTrying #{s} strategy..."
         @licenses = eval("#{s}(\"#{d.name}\")")
         unless @licenses.empty? # and break out of the search if successful
@@ -105,10 +108,10 @@ class DerivingLicense
     licenses.each do |l|
       unless l.first == "custom"
         instances = "(#{l.last} instance#{l.last == 1 ? "" : "s"})"
-        key = @@license_aliases[l.first]
+        key = @license_aliases[l.first]
         key ||= l.first
-        if @@license_details[key]
-          output << "#{key}: #{@@license_details[key][:name]} #{instances}[#{@@license_details[key][:link]}]"
+        if @license_details[key]
+          output << "#{key}: #{@license_details[key][:name]} #{instances} [#{@license_details[key][:link]}]"
         else
           unrecognized << key
         end
@@ -121,14 +124,14 @@ class DerivingLicense
     unless unrecognized.empty?
       puts "There #{unrecognized.count==1 ? "is" : "are"} also #{unrecognized.count} unrecognized license#{unrecognized.count==1 ? "" : "s"}: #{unrecognized.join(', ')}"
     end
-    if licenses["custom"] and !licenses["custom"].empty?
+    if licenses.has_key?("custom") and !licenses["custom"].empty?
       puts "The following dependencies have custom licenses: #{licenses["custom"].join(', ')}"
     end
   end
   
   def self.get_gem_spec(dep)
     # Check spec cache first.
-    @spec = @@specs_cache[dep]
+    @spec = @specs_cache[dep]
     return @spec if @spec
     # 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.
@@ -136,7 +139,7 @@ class DerivingLicense
       yaml = `gem specification #{remote}#{dep} --yaml`
       @spec = YAML.load(yaml, :safe => true)
     end
-    @@specs_cache[dep] = @spec # Cache it.
+    @specs_cache[dep] = @spec # Cache it.
     @spec
   end
   
@@ -163,9 +166,9 @@ class DerivingLicense
     paths.each do |p|
       if File.exist?(p)
         File.open(p).each_line do |l|
-          if /license/.match(l)
+          if /license/i.match(l)
             # Found the word "license", so now look for known license names.
-            (@@license_details.keys + @@license_aliases.keys).each do |n|
+            (@license_details.keys + @license_aliases.keys).each do |n|
               if /#{n}/.match(l)
                 licenses << n
                 break
@@ -180,7 +183,7 @@ class DerivingLicense
   
   def self.search_in_content(content)
     licenses = []
-    (@@license_details.keys + @@license_aliases.keys).each do |n|
+    (@license_details.keys + @license_aliases.keys).each do |n|
       if /#{n}/.match(content)
         licenses << n
         return licenses
@@ -259,9 +262,11 @@ class DerivingLicense
 
       readme_file_paths = []
       Find.find(gem_source_directory) do |path|
-        readme_file_paths << path if path =~ /(read\.me|readme|README)$/
+        if path =~ /(read\.me|readme)/i
+          readme_file_paths << path 
+        end
       end
-      break unless readme_file_paths
+      break if readme_file_paths.empty?
     
       # Open each readme file and check the content.
       licenses = search_in_paths(readme_file_paths)

data/test/empty.gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+

data/test/requires_license_file_parsing.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "deriving_license" # This library has a license file that is self-describing.

data/test/requires_license_file_parsing_but_is_custom.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "bcrypt-ruby" # bcrypt gem has a license file, but it's custom.

data/test/requires_license_filename.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "coffee-rails" # Coffeescript gem has a license file whose filename says it all.

data/test/requires_readme_file_parsing.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "app_constants" # This gem specifies its license in its readme file.

data/test/requires_scraping.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "rails" # Rails gem describes it's license on the Rails website.

data/test/test_deriving_license.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'test/unit'
 require 'deriving_license'
 
@@ -21,12 +24,6 @@ class DerivingLicenseTest < Test::Unit::TestCase
     end
   end
 
-  def test_run_throws_with_multiple_args
-    assert_raise ArgumentError do
-      DerivingLicense.run("Gemfile1", "Gemfile2")
-    end
-  end
-  
   def test_run_throws_if_path_is_invalid
     assert_raise ArgumentError do
       DerivingLicense.run("Ceci n'est pas un dossier.")
@@ -39,11 +36,17 @@ class DerivingLicenseTest < Test::Unit::TestCase
     end
   end
   
+  def test_run_with_empty_gemfile_returns_empty_hash
+    assert_equal( true, DerivingLicense.run("./test/empty.gemfile").empty? )
+  end
+  
   def test_run_with_valid_arg
     assert_nothing_raised do
-      DerivingLicense.run("Gemfile")
+      output = capture_stdout do
+        @result = DerivingLicense.run("Gemfile")
+      end
     end
-    assert_equal( {"MIT"=>1}, DerivingLicense.run("Gemfile") )
+    assert_equal( true, @result.has_key?("MIT") )
   end
   
   def test_describe_with_known_license
@@ -62,5 +65,45 @@ class DerivingLicenseTest < Test::Unit::TestCase
     # Should say "unknown"
     assert_equal( false, /unrecognized/.match( output.string ).nil? )
   end
+  
+  def test_from_scraping_strategy
+    output = capture_stdout do
+      @result = DerivingLicense.run("./test/requires_scraping.gemfile", ["from_scraping_homepage"])
+    end
+    assert_equal( false, @result.empty? )
+    assert_equal( false, /from_scraping_homepage strategy...SUCCESS/.match( output.string ).nil? ) # Should be SUCCESS
+  end
 
+  def test_from_license_filename
+    output = capture_stdout do
+      @result = DerivingLicense.run("./test/requires_license_filename.gemfile", ["from_license_file"])
+    end
+    assert_equal( false, @result.empty? )
+    assert_equal( true, /from_license_file strategy...FAILED/.match( output.string ).nil? ) # Shouldn't be FAILED
+  end
+  
+  def test_from_license_file_parsing
+    output = capture_stdout do
+      @result = DerivingLicense.run("./test/requires_license_file_parsing.gemfile", ["from_license_file"])
+    end
+    assert_equal( false, @result.empty? )
+    assert_equal( true, /from_license_file strategy...FAILED/.match( output.string ).nil? ) # Shouldn't be FAILED
+  end
+  
+  def test_from_license_file_parsing_but_is_custom
+    output = capture_stdout do
+      @result = DerivingLicense.run("./test/requires_license_file_parsing_but_is_custom.gemfile", ["from_license_file"])
+    end
+    assert_equal( false, @result.empty? )
+    assert_equal( false, /from_license_file strategy...CUSTOM/.match( output.string ).nil? ) # Should be CUSTOM
+  end
+  
+  def test_from_readme_file_parsing
+    output = capture_stdout do
+      @result = DerivingLicense.run("./test/requires_readme_file_parsing.gemfile", ["from_parsing_readme"])
+    end
+    assert_equal( false, @result.empty? )
+    assert_equal( false, /from_parsing_readme strategy...SUCCESS/.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.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemnasium-parser
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
 email: tom@jugglethis.net
@@ -75,6 +91,12 @@ files:
 - bin/deriving_license
 - deriving_license.gemspec
 - lib/deriving_license.rb
+- test/empty.gemfile
+- test/requires_license_file_parsing.gemfile
+- test/requires_license_file_parsing_but_is_custom.gemfile
+- test/requires_license_filename.gemfile
+- test/requires_readme_file_parsing.gemfile
+- test/requires_scraping.gemfile
 - test/test_deriving_license.rb
 homepage: http://www.github.com/Schwolop/deriving_license
 licenses:
@@ -102,5 +124,11 @@ signing_key:
 specification_version: 3
 summary: Deriving Licence finds the license agreements for all gems in your Gemfile
 test_files:
+- test/empty.gemfile
+- test/requires_license_file_parsing.gemfile
+- test/requires_license_file_parsing_but_is_custom.gemfile
+- test/requires_license_filename.gemfile
+- test/requires_readme_file_parsing.gemfile
+- test/requires_scraping.gemfile
 - test/test_deriving_license.rb
 has_rdoc: