license_finder 0.5.0 → 0.6.0

data/spec/lib/license_finder/dependency_spec.rb

@@ -3,16 +3,16 @@ require 'spec_helper'
 describe LicenseFinder::Dependency do
   let(:attributes) do
     {
-        'name' => "spec_name",
-        'version' => "2.1.3",
-        'license' => "GPL",
-        'approved' => false,
-        'license_url' => 'http://www.apache.org/licenses/LICENSE-2.0.html',
-        'notes' => 'some notes',
-        'license_files' => [{'path' => '/Users/pivotal/foo/lic1'}, {'path' => '/Users/pivotal/bar/lic2'}],
-        'readme_files' => [{'path' => '/Users/pivotal/foo/Readme1'}, {'path' => '/Users/pivotal/bar/Readme2'}],
-        'source' => "bundle",
-        'bundler_groups' => nil
+      'name' => "spec_name",
+      'version' => "2.1.3",
+      'license' => "GPLv2",
+      'approved' => false,
+      'notes' => 'some notes',
+      'homepage' => 'homepage',
+      'license_files' => [{'path' => '/Users/pivotal/foo/lic1'}, {'path' => '/Users/pivotal/bar/lic2'}],
+      'readme_files' => [{'path' => '/Users/pivotal/foo/Readme1'}, {'path' => '/Users/pivotal/bar/Readme2'}],
+      'source' => "bundle",
+      'bundler_groups' => nil
     }
   end
 
@@ -37,15 +37,13 @@ describe LicenseFinder::Dependency do
     end
   end
 
-
   describe '.from_hash' do
     subject { LicenseFinder::Dependency.from_hash(attributes) }
 
     its(:name) { should == 'spec_name' }
     its(:version) { should == '2.1.3' }
-    its(:license) { should == 'GPL' }
+    its(:license) { should == 'GPLv2' }
     its(:approved) { should == false }
-    its(:license_url) { should == "http://www.apache.org/licenses/LICENSE-2.0.html" }
     its(:notes) { should == "some notes" }
     its(:license_files) { should == %w(/Users/pivotal/foo/lic1 /Users/pivotal/bar/lic2) }
     its(:readme_files) { should == %w(/Users/pivotal/foo/Readme1 /Users/pivotal/bar/Readme2) }
@@ -56,10 +54,11 @@ describe LicenseFinder::Dependency do
       should == {
         'name' => 'spec_name',
         'version' => '2.1.3',
-        'license' => 'GPL',
+        'license' => 'GPLv2',
         'approved' => false,
         'source' => 'bundle',
-        'license_url' => 'http://www.apache.org/licenses/LICENSE-2.0.html',
+        'homepage' => 'homepage',
+        'license_url' => LicenseFinder::License::GPLv2.license_url,
         'notes' => 'some notes',
         'license_files' => [
           {'path' => '/Users/pivotal/foo/lic1'},
@@ -78,6 +77,24 @@ describe LicenseFinder::Dependency do
     end
   end
 
+  describe '#license_url' do
+    context "class exists for license type" do
+      it "should return the license url configured in the class" do
+        LicenseFinder::Dependency.new('license' => "GPLv2").license_url.should == LicenseFinder::License::GPLv2.license_url
+      end
+
+      it "should handle differences in case" do
+        LicenseFinder::Dependency.new('license' => "gplv2").license_url.should == LicenseFinder::License::GPLv2.license_url
+      end
+    end
+
+    context "class does not exist for license type" do
+      it "should return nil" do
+        LicenseFinder::Dependency.new('license' => "FakeLicense").license_url.should be_nil
+      end
+    end
+  end
+
   describe '#to_s' do
     let(:gem) do
       LicenseFinder::Dependency.new(
@@ -85,56 +102,75 @@ describe LicenseFinder::Dependency do
         'version' => '1.0',
         'summary' => 'summary foo',
         'description' => 'description bar',
-        'license' => license,
-        'license_url' => license_url,
-        'license_files' => license_files,
-        'readme_files' => readme_files,
-        'bundler_groups' => bundler_groups
+        'license' => "MIT"
       )
     end
-    let(:bundler_groups) { [] }
-    let(:license_files) { [] }
-    let(:readme_files) { [] }
-    let(:license_url) { "" }
-    let(:license) { "MIT" }
 
     subject { gem.to_s.strip }
 
-    it 'should generate text with all the gem attributes' do
-      should == "test_gem 1.0, MIT, summary foo, description bar"
-    end
-
-    context "when license is 'other'" do
-      context "when the gem includes license files and readme files" do
-        let(:license_files) { %w(somefile) }
-        let(:readme_files) { %w(somereadme) }
-        let(:license) { 'other' }
-
-        it "should generate text with the gem attributes, license files, and readme files" do
-          should == <<-STRING.strip
-test_gem 1.0, other, summary foo, description bar
-  license files:
-    somefile
-  readme files:
-    somereadme
-          STRING
-        end
+    it 'should generate text with the gem name, version, and license' do
+      should == "test_gem, 1.0, MIT"
+    end
+  end
+
+  describe '#to_html' do
+    let(:dependency) { LicenseFinder::Dependency.new 'approved' => true }
+    subject { dependency.to_html }
+
+    context "when the dependency is approved" do
+      it "should add an approved class to dependency's container" do
+        should include %{class="approved"}
       end
     end
 
-    context "when the gem has a license url" do
-      let(:license_url) { "www.foobar.com"}
+    context "when the dependency is not approved" do
+      before { dependency.approved = false }
 
-      it "should include the license_url" do
-        should == "test_gem 1.0, MIT, www.foobar.com, summary foo, description bar"
+      it "should not add an approved class to he dependency's container" do
+        should include %{class="unapproved"}
       end
     end
 
-    context "when the gem has any bundler groups" do
-      let(:bundler_groups) { %w(staging production) }
+    context "when the gem has at least one bundler group" do
+      before { dependency.bundler_groups = ["group"] }
+      it "should show the bundler group(s) in parens" do
+        should include "(group)"
+      end
+    end
+
+    context "when the gem has no bundler groups" do
+      before { dependency.bundler_groups = [] }
+
+      it "should not show any parens or bundler group info" do
+        should_not include "()"
+      end
+
+    end
+
+    context "when the gem has at least one parent" do
+      before { dependency.parents = [ OpenStruct.new(:name => "foo parent") ]}
+      it "should include a parents section" do
+        should include "Parents"
+      end
+    end
+
+    context "when the gem has no parents" do
+      it "should not include any parents section in the output" do
+        should_not include "Parents"
+      end
+    end
+
+    context "when the gem has at least one child" do
+      before { dependency.children = [ OpenStruct.new(:name => "foo child") ]}
+
+      it "should include a Children section" do
+        should include "Children"
+      end
+    end
 
-      it "should include the bundler groups" do
-        should == "test_gem 1.0, MIT, summary foo, description bar, staging, production"
+    context "when the gem has no children" do
+      it "should not include any Children section in the output" do
+        should_not include "Children"
       end
     end
   end
@@ -155,9 +191,9 @@ test_gem 1.0, other, summary foo, description bar
         'name' => 'foo',
         'license' => 'MIT',
         'version' => '0.0.1',
-        'license_url' => 'http://www.example.com/license1.htm',
         'license_files' => "old license files",
         'readme_files' => "old readme files",
+        'old_homepage' => "http://old.homepage"
       )
     end
 
@@ -166,12 +202,12 @@ test_gem 1.0, other, summary foo, description bar
         'name' => 'foo',
         'license' => 'MIT',
         'version' => '0.0.2',
-        'license_url' => 'http://www.example.com/license2.htm',
         'license_files' => "new license files",
         'readme_files' => "new readme files",
         'summary' => 'foo summary',
         'description' => 'awesome foo description!',
-        'bundler_groups' => [1,2,3]
+        'bundler_groups' => [1,2,3],
+        'homepage' => "http://new.homepage"
       )
     end
 
@@ -183,14 +219,14 @@ test_gem 1.0, other, summary foo, description bar
       }.to raise_error
     end
 
-    it 'should return the new version, license url, license files, readme files, and source' do
+    it 'should return the new version, license files, readme files, source, and homepage' do
       merged = subject.merge(new_dep)
 
       merged.version.should == '0.0.2'
-      merged.license_url.should == 'http://www.example.com/license2.htm'
       merged.license_files.should == new_dep.license_files
       merged.readme_files.should == new_dep.readme_files
       merged.source.should == new_dep.source
+      merged.homepage.should == new_dep.homepage
     end
     
     it 'should return the new summary and description and bundle groups' do

data/spec/lib/license_finder/license/apache_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe LicenseFinder::License::Apache do
-  subject { LicenseFinder::License::Apache.new("") }
+describe LicenseFinder::License::Apache2 do
+  subject { LicenseFinder::License::Apache2.new("") }
 
   it_behaves_like "a license matcher"
 end

data/spec/lib/license_finder/license/mit_spec.rb

@@ -7,7 +7,7 @@ describe LicenseFinder::License::MIT do
 
   describe "#matches?" do
     it "should return true if the text contains the MIT url" do
-      subject.text = "MIT License is awesome http://www.opensource.org/licenses/mit-license"
+      subject.text = "MIT License is awesome http://opensource.org/licenses/mit-license"
       should be_matches
 
       subject.text = "MIT Licence is awesome http://www.opensource.org/licenses/mit-license"

data/spec/lib/license_finder/license_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe LicenseFinder::License::Base do
+  describe ".names" do
+    subject do
+      Class.new(LicenseFinder::License::Base) do
+        def self.demodulized_name; "FooLicense"; end
+        self.alternative_names = ["foo license"]
+      end.names
+    end
+
+    it { should =~ ["FooLicense", "foo license"] }
+  end
+end

data/spec/lib/license_finder/license_url_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+class FooLicense < LicenseFinder::License::Base
+  self.alternative_names = ["the foo license"]
+  self.license_url = "http://foo.license.com"
+end
+
+describe LicenseFinder::LicenseUrl do
+  describe ".find_by_name" do
+    subject { LicenseFinder::LicenseUrl }
+
+    specify { subject.find_by_name("FooLicense").should      == "http://foo.license.com" }
+    specify { subject.find_by_name("fOolICENse").should      == "http://foo.license.com" }
+    specify { subject.find_by_name("the foo license").should == "http://foo.license.com" }
+
+    specify { subject.find_by_name(nil).should be_nil }
+    specify { subject.find_by_name("").should be_nil }
+    specify { subject.find_by_name("unknown license").should be_nil }
+  end
+end

data/spec/lib/license_finder/reporter_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe LicenseFinder::Reporter do
+
+end

data/spec/lib/license_finder_spec.rb

@@ -69,6 +69,7 @@ describe LicenseFinder do
         config.dependencies_dir.should == './elsewhere'
         config.dependencies_yaml.should == './elsewhere/dependencies.yml'
         config.dependencies_text.should == './elsewhere/dependencies.txt'
+        config.dependencies_html.should == './elsewhere/dependencies.html'
       end
 
       it 'should default the dependency files when the directory is not provided' do
@@ -76,6 +77,7 @@ describe LicenseFinder do
         config.dependencies_dir.should == '.'
         config.dependencies_yaml.should == './dependencies.yml'
         config.dependencies_text.should == './dependencies.txt'
+        config.dependencies_html.should == './dependencies.html'
       end
     end
   end

data/spec/spec_helper.rb

@@ -13,4 +13,3 @@ end
 RSpec.configure do |config|
   config.mock_with :rr
 end
-

data/spec/support/license_examples.rb

@@ -21,4 +21,10 @@ shared_examples_for "a license matcher" do
       end
     end
   end
+
+  describe "#license_text" do
+    it "should always produce a license text" do
+      subject.class.license_text.should_not be_nil, "No license text found for #{subject.class}! Add a license template to lib/templates named '#{subject.class.demodulized_name}.txt'"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_finder
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,8 +143,28 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Find and display licenses of a project's gem dependencies, so that you
-  know what your limitations are when distributing your application.
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: ! "  Do you know the licenses of all your application's dependencies?
+  What open source software licenses will your business accept?\n\n  LicenseFinder
+  culls your Gemfile, detects the licenses of the gems in it, and gives you a report
+  that you can act on. If you already know \n  what licenses your business is comfortable
+  with, you can whitelist them, leaving you with an action report of only those dependencies
+  that have \n  licenses that fall outside of the whitelist.\n"
 email:
 - brent@pivotalabs.com
 executables:
@@ -154,28 +174,38 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.markdown
 - Rakefile
 - bin/license_finder
-- features/executables/license_finder.feature
-- features/rake_tasks/action_items.feature
-- features/rake_tasks/action_items_ok.feature
-- features/rake_tasks/generate_dependencies.feature
-- features/rake_tasks/init.feature
-- features/rake_tasks/regressions.feature
+- features/approve_dependencies.feature
+- features/html_report.feature
+- features/license_finder.feature
+- features/license_finder_rake_task.feature
+- features/rails_rake.feature
 - features/step_definitions/steps.rb
+- features/text_report.feature
 - files/license_finder.yml
+- lib/data/licenses/Apache2.txt
+- lib/data/licenses/BSD.txt
+- lib/data/licenses/GPLv2.txt
+- lib/data/licenses/ISC.txt
+- lib/data/licenses/LGPL.txt
+- lib/data/licenses/MIT.txt
+- lib/data/licenses/NewBSD.txt
+- lib/data/licenses/Ruby.txt
+- lib/data/licenses/SimplifiedBSD.txt
 - lib/license_finder.rb
+- lib/license_finder/bundle.rb
 - lib/license_finder/bundled_gem.rb
-- lib/license_finder/bundler_dependency_query.rb
 - lib/license_finder/cli.rb
+- lib/license_finder/configuration.rb
 - lib/license_finder/dependency.rb
 - lib/license_finder/dependency_list.rb
-- lib/license_finder/finder.rb
 - lib/license_finder/license.rb
-- lib/license_finder/license/apache.rb
+- lib/license_finder/license/apache2.rb
 - lib/license_finder/license/bsd.rb
 - lib/license_finder/license/gplv2.rb
 - lib/license_finder/license/isc.rb
@@ -184,18 +214,14 @@ files:
 - lib/license_finder/license/new_bsd.rb
 - lib/license_finder/license/ruby.rb
 - lib/license_finder/license/simplified_bsd.rb
+- lib/license_finder/license_url.rb
 - lib/license_finder/possible_license_file.rb
 - lib/license_finder/railtie.rb
+- lib/license_finder/reporter.rb
+- lib/license_finder/viewable.rb
 - lib/tasks/license_finder.rake
-- lib/templates/Apache.txt
-- lib/templates/BSD.txt
-- lib/templates/GPLv2.txt
-- lib/templates/ISC.txt
-- lib/templates/LGPL.txt
-- lib/templates/MIT.txt
-- lib/templates/NewBSD.txt
-- lib/templates/Ruby.txt
-- lib/templates/SimplifiedBSD.txt
+- lib/templates/dependency.html.erb
+- lib/templates/dependency_list.html.erb
 - license_finder.gemspec
 - spec/fixtures/APACHE-2-LICENSE
 - spec/fixtures/GPLv2
@@ -225,7 +251,6 @@ files:
 - spec/lib/license_finder/bundled_gem_spec.rb
 - spec/lib/license_finder/dependency_list_spec.rb
 - spec/lib/license_finder/dependency_spec.rb
-- spec/lib/license_finder/finder_spec.rb
 - spec/lib/license_finder/license/apache_spec.rb
 - spec/lib/license_finder/license/bsd_spec.rb
 - spec/lib/license_finder/license/gplv2_spec.rb
@@ -235,7 +260,10 @@ files:
 - spec/lib/license_finder/license/new_bsd_spec.rb
 - spec/lib/license_finder/license/ruby_spec.rb
 - spec/lib/license_finder/license/simplified_bsd_spec.rb
+- spec/lib/license_finder/license_spec.rb
+- spec/lib/license_finder/license_url_spec.rb
 - spec/lib/license_finder/possible_license_file_spec.rb
+- spec/lib/license_finder/reporter_spec.rb
 - spec/lib/license_finder_spec.rb
 - spec/spec_helper.rb
 - spec/support/license_examples.rb
@@ -252,27 +280,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3316457450269870236
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3316457450269870236
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Know your dependencies - and the licenses they are binding your application
-  to.
+summary: Audit the OSS licenses of your application's dependencies.
 test_files:
-- features/executables/license_finder.feature
-- features/rake_tasks/action_items.feature
-- features/rake_tasks/action_items_ok.feature
-- features/rake_tasks/generate_dependencies.feature
-- features/rake_tasks/init.feature
-- features/rake_tasks/regressions.feature
+- features/approve_dependencies.feature
+- features/html_report.feature
+- features/license_finder.feature
+- features/license_finder_rake_task.feature
+- features/rails_rake.feature
 - features/step_definitions/steps.rb
+- features/text_report.feature
 - spec/fixtures/APACHE-2-LICENSE
 - spec/fixtures/GPLv2
 - spec/fixtures/ISC-LICENSE
@@ -301,7 +334,6 @@ test_files:
 - spec/lib/license_finder/bundled_gem_spec.rb
 - spec/lib/license_finder/dependency_list_spec.rb
 - spec/lib/license_finder/dependency_spec.rb
-- spec/lib/license_finder/finder_spec.rb
 - spec/lib/license_finder/license/apache_spec.rb
 - spec/lib/license_finder/license/bsd_spec.rb
 - spec/lib/license_finder/license/gplv2_spec.rb
@@ -311,7 +343,10 @@ test_files:
 - spec/lib/license_finder/license/new_bsd_spec.rb
 - spec/lib/license_finder/license/ruby_spec.rb
 - spec/lib/license_finder/license/simplified_bsd_spec.rb
+- spec/lib/license_finder/license_spec.rb
+- spec/lib/license_finder/license_url_spec.rb
 - spec/lib/license_finder/possible_license_file_spec.rb
+- spec/lib/license_finder/reporter_spec.rb
 - spec/lib/license_finder_spec.rb
 - spec/spec_helper.rb
 - spec/support/license_examples.rb