license_finder 0.6.0 → 0.7.0

data/spec/lib/license_finder/html_report_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+module LicenseFinder
+  describe HtmlReport do
+    describe "#to_s" do
+      let(:dependency) { Dependency.new 'approved' => true }
+      subject { HtmlReport.new([dependency]).to_s }
+
+      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 dependency is not approved" do
+        before { dependency.approved = false }
+
+        it "should not add an approved class to he dependency's container" do
+          should include %{class="unapproved"}
+        end
+      end
+
+      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
+
+      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
+  end
+end

data/spec/lib/license_finder/persistence/yaml/configuration_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe LicenseFinder::Persistence::Configuration do
+  it_behaves_like "a persistable configuration"
+end

data/spec/lib/license_finder/persistence/yaml/dependency_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe LicenseFinder::Persistence::Dependency do
+  it_behaves_like "a persistable dependency"
+end

data/spec/lib/license_finder/possible_license_file_spec.rb

@@ -6,8 +6,7 @@ describe LicenseFinder::PossibleLicenseFile do
 
     context "ignoring text" do
       before do
-        stub(IO).read { "file text" }
-        stub(IO).binread { "file text" }
+        subject.stub(:text).and_return('file text')
       end
 
       its(:file_path) { should == 'nested/path' }
@@ -20,10 +19,9 @@ describe LicenseFinder::PossibleLicenseFile do
 
   context "with a known license" do
     before do
-      stub(IO).read { "a known license" }
-      stub(IO).binread { "a known license" }
+      subject.stub(:text).and_return('a known license')
 
-      stub(LicenseFinder::License::MIT).new("a known license").stub!.matches? { true }
+      LicenseFinder::License::MIT.stub(:new).with('a known license').and_return(double('MIT license', :matches? => true))
     end
 
     its(:license) { should == "MIT" }
@@ -31,10 +29,7 @@ describe LicenseFinder::PossibleLicenseFile do
 
   context "with an unknown license" do
     before do
-      stub(IO).read { "" }
-      stub(IO).binread { "" }
-
-      any_instance_of(LicenseFinder::License::Base, :matches? => false)
+      subject.stub(:text).and_return('')
     end
 
     its(:license) { should be_nil }

data/spec/lib/license_finder/reporter_spec.rb

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

data/spec/lib/license_finder/source_syncer_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+module LicenseFinder
+  describe SourceSyncer do
+    it "deletes any dependencies no longer in the source" do
+      foo_dep     = double :foo, name: "foo"
+
+      foo_dep.should_receive(:destroy)
+
+      SourceSyncer.new([], [foo_dep]).sync!
+    end
+
+    it "merges any dependencies in the source" do
+      source_foo  = double :source_foo, name: "foo"
+      foo = double :foo, name: "foo"
+
+      foo.should_receive(:merge).with source_foo
+
+      SourceSyncer.new([source_foo], [foo]).sync!
+    end
+
+    it "creates any new source dependencies" do
+      source_dep = double :source_dep, name: "foo", attributes: double(:attributes)
+
+      source_dep.should_receive :save
+
+      SourceSyncer.new([source_dep], []).sync!
+    end
+
+    it "returns the synced dependency set" do
+      source_dep = double(:source_dep, name: "source_dep", attributes: double(:attributes)).as_null_object
+      existing_dep = double :existing_dep, name: "existing", merge: nil
+
+      SourceSyncer.new([source_dep, existing_dep], [existing_dep]).sync!.should =~ [source_dep, existing_dep]
+    end
+  end
+end

data/spec/lib/license_finder/text_report_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module LicenseFinder
+  describe TextReport do
+    describe '#to_s' do
+      let(:dep1) do
+        Dependency.new(
+          'name' => 'gem_a',
+          'version' => '1.0',
+          'license' => "MIT"
+        )
+      end
+
+      let(:dep2) do
+        Dependency.new(
+          'name' => 'gem_b',
+          'version' => '1.0',
+          'license' => "MIT"
+        )
+      end
+
+      subject { TextReport.new([dep2, dep1]).to_s }
+
+      it 'should generate a text report with the name, version, and license of each dependency, sorted by name' do
+        should == "gem_a, 1.0, MIT\ngem_b, 1.0, MIT"
+      end
+    end
+  end
+end

data/spec/lib/license_finder_spec.rb

@@ -10,8 +10,9 @@ describe LicenseFinder do
     end
 
     before do
-      stub(File).exists?('./config/license_finder.yml') { true }
-      stub(File).open('./config/license_finder.yml').stub!.readlines.stub!.join { config.to_yaml }
+      LicenseFinder.instance_variable_set(:@config, nil)
+      File.stub(:exists?).with('./config/license_finder.yml').and_return(true)
+      File.stub(:read).with('./config/license_finder.yml').and_return(config.to_yaml)
     end
 
     after do
@@ -19,8 +20,8 @@ describe LicenseFinder do
     end
 
     it "should handle a missing configuration file" do
-      stub(File).exists?('./config/license_finder.yml') { false }
-      dont_allow(File).open('./config/license_finder.yml')
+      File.stub(:exists?).with('./config/license_finder.yml').and_return(false)
+      File.should_not_receive(:open).with('./config/license_finder.yml')
 
       LicenseFinder.config.whitelist.should == []
       LicenseFinder.config.ignore_groups.should == []
@@ -28,12 +29,9 @@ describe LicenseFinder do
     end
 
     it "should load the configuration exactly once" do
-      mock(File).open('./config/license_finder.yml').stub!.readlines.stub!.join { config.to_yaml }
+      File.should_receive(:read).with('./config/license_finder.yml').once.and_return(config.to_yaml)
 
       LicenseFinder.config.whitelist
-
-      dont_allow(File).open('./config/license_finder.yml')
-
       LicenseFinder.config.whitelist
     end
 
@@ -43,7 +41,7 @@ describe LicenseFinder do
       end
 
       it "should load an empty whitelist from license_finder.yml when there are no whitelist items" do
-        stub(File).open('./config/license_finder.yml').stub!.readlines.stub!.join { config.merge('whitelist' => nil).to_yaml }
+        File.stub(:read).with('./config/license_finder.yml').and_return(config.merge('whitelist' => nil).to_yaml)
 
         LicenseFinder.config.whitelist.should =~ []
       end
@@ -55,7 +53,7 @@ describe LicenseFinder do
       end
 
       it "should load an empty ignore_groups list from license_finder.yml when there are no ignore groups" do
-        stub(File).open('./config/license_finder.yml').stub!.readlines.stub!.join { config.merge('ignore_groups' => nil).to_yaml }
+        File.stub(:read).with('./config/license_finder.yml').and_return(config.merge('ignore_groups' => nil).to_yaml)
 
         LicenseFinder.config.ignore_groups.should == []
       end
@@ -63,7 +61,7 @@ describe LicenseFinder do
 
     describe "#dependencies_dir" do
       it 'should allow the dependencies file directory to be configured' do
-        stub(File).open('./config/license_finder.yml').stub!.readlines.stub!.join { config.merge('dependencies_file_dir' => './elsewhere').to_yaml }
+        File.stub(:read).with('./config/license_finder.yml').and_return(config.merge('dependencies_file_dir' => './elsewhere').to_yaml)
 
         config = LicenseFinder.config
         config.dependencies_dir.should == './elsewhere'

data/spec/spec_helper.rb

@@ -11,5 +11,5 @@ Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each do |file|
 end
 
 RSpec.configure do |config|
-  config.mock_with :rr
+  config.mock_with :rspec
 end

data/spec/support/license_examples.rb

@@ -2,7 +2,7 @@ shared_examples_for "a license matcher" do
   describe "#matches?" do
     context "when a license text template exists" do
       before do
-        stub(subject.class).license_text { 'AWESOME "FOO" LICENSE' }
+        subject.class.stub(:license_text).and_return('AWESOME "FOO" LICENSE')
       end
 
       it "should return true if the body matches exactly" do

data/spec/support/shared_examples/persistence/configuration.rb

@@ -0,0 +1,34 @@
+shared_examples_for "a persistable configuration" do
+  let(:klass) { described_class }
+
+  let(:attributes) do
+    {
+      "whitelist" => ["FooLicense", "BarLicense"],
+      "ignore_groups" => [:test, :development]
+    }
+  end
+
+  describe '.new' do
+    subject { klass.new(attributes) }
+
+    context "with known attributes" do
+      it "should set the all of the attributes on the instance" do
+        attributes.each do |key, value|
+          subject.send("#{key}").should == value
+        end
+      end
+    end
+  end
+
+  describe "#whitelist" do
+    it "should default to an empty array" do
+      klass.new.whitelist.should == []
+    end
+  end
+
+  describe "#ignore_groups" do
+    it "should default to an empty array" do
+      klass.new.ignore_groups.should == []
+    end
+  end
+end

data/spec/support/shared_examples/persistence/dependency.rb

@@ -0,0 +1,139 @@
+shared_examples_for "a persistable dependency" do
+  let(:klass) { described_class }
+
+  let(:attributes) do
+    {
+      'name' => "spec_name",
+      'version' => "2.1.3",
+      'license' => "GPLv2",
+      'approved' => false,
+      'notes' => 'some notes',
+      'homepage' => 'homepage',
+      'license_files' => ['/Users/pivotal/foo/lic1', '/Users/pivotal/bar/lic2'],
+      'readme_files' => ['/Users/pivotal/foo/Readme1', '/Users/pivotal/bar/Readme2'],
+      'source' => "bundle",
+      'bundler_groups' => ["test"]
+    }
+  end
+
+  before do
+    klass.delete_all
+  end
+
+  describe '.new' do
+    subject { klass.new(attributes) }
+
+    context "with known attributes" do
+      it "should set the all of the attributes on the instance" do
+        attributes.each do |key, value|
+          if key != "approved"
+            subject.send("#{key}").should equal(value), "expected #{value.inspect} for #{key}, got #{subject.send("#{key}").inspect}"
+          else
+            subject.approved?.should == value
+          end
+        end
+      end
+    end
+
+    context "with unknown attributes" do
+      before do
+        attributes['foo'] = 'bar'
+      end
+
+      it "should raise an exception" do
+        expect { subject }.to raise_exception(NoMethodError)
+      end
+    end
+  end
+
+  describe '.unapproved' do
+    it "should return all unapproved dependencies" do
+      klass.new(name: "unapproved dependency", approved: false).save
+      klass.new(name: "approved dependency", approved: true).save
+
+      unapproved = klass.unapproved
+      unapproved.count.should == 1
+      unapproved.collect(&:approved?).any?.should be_false
+    end
+  end
+
+  describe '.find_by_name' do
+    subject { klass.find_by_name gem_name }
+    let(:gem_name) { "foo" }
+
+    context "when a gem with the provided name exists" do
+      before do
+        klass.new(
+          'name' => gem_name,
+          'version' => '0.0.1'
+        ).save
+      end
+
+      its(:name) { should == gem_name }
+      its(:version) { should == '0.0.1' }
+    end
+
+    context "when no gem with the provided name exists" do
+      it { should == nil }
+    end
+  end
+
+  describe "#config" do
+    it 'should respond to it' do
+      klass.new.should respond_to(:config)
+    end
+  end
+
+  describe '#attributes' do
+    it "should return a hash containing the values of all the accessible properties" do
+      dep = klass.new(attributes)
+      attributes = dep.attributes
+      LicenseFinder::DEPENDENCY_ATTRIBUTES.each do |name|
+        attributes[name].should == dep.send(name)
+      end
+    end
+  end
+
+  describe '#save' do
+    it "should persist all of the dependency's attributes" do
+      dep = klass.new(attributes)
+      dep.save
+
+      saved_dep = klass.find_by_name(dep.name)
+
+      attributes.each do |key, value|
+        if key != "approved"
+          saved_dep.send("#{key}").should eql(value), "expected #{value.inspect} for #{key}, got #{saved_dep.send("#{key}").inspect}"
+        else
+          saved_dep.approved?.should == value
+        end
+      end
+    end
+  end
+
+  describe "#update_attributes" do
+    it "should update the provided attributes with the provided values" do
+      gem = klass.new(attributes)
+      updated_attributes = {"version" => "new_version", "license" => "updated_license"}
+      gem.update_attributes(updated_attributes)
+
+      saved_gem = klass.find_by_name(gem.name)
+      saved_gem.version.should == "new_version"
+      saved_gem.license.should == "updated_license"
+    end
+  end
+
+  describe "#destroy" do
+    it "should remove itself from the database" do
+      foo_dep = klass.new(name: "foo")
+      bar_dep = klass.new(name: "bar")
+      foo_dep.save
+      bar_dep.save
+
+      expect { foo_dep.destroy }.to change { klass.all.count }.by -1
+
+      klass.all.count.should == 1
+      klass.all.first.name.should == "bar"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_finder
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-15 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,22 +63,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rr
-  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +161,6 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE
-- README.markdown
 - Rakefile
 - bin/license_finder
 - features/approve_dependencies.feature
@@ -185,6 +168,7 @@ files:
 - features/license_finder.feature
 - features/license_finder_rake_task.feature
 - features/rails_rake.feature
+- features/set_license.feature
 - features/step_definitions/steps.rb
 - features/text_report.feature
 - files/license_finder.yml
@@ -199,11 +183,13 @@ files:
 - lib/data/licenses/SimplifiedBSD.txt
 - lib/license_finder.rb
 - lib/license_finder/bundle.rb
+- lib/license_finder/bundle_syncer.rb
 - lib/license_finder/bundled_gem.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/dependency_report.rb
+- lib/license_finder/html_report.rb
 - lib/license_finder/license.rb
 - lib/license_finder/license/apache2.rb
 - lib/license_finder/license/bsd.rb
@@ -215,14 +201,21 @@ files:
 - lib/license_finder/license/ruby.rb
 - lib/license_finder/license/simplified_bsd.rb
 - lib/license_finder/license_url.rb
+- lib/license_finder/persistence.rb
+- lib/license_finder/persistence/yaml.rb
+- lib/license_finder/persistence/yaml/configuration.rb
+- lib/license_finder/persistence/yaml/dependency.rb
 - lib/license_finder/possible_license_file.rb
 - lib/license_finder/railtie.rb
 - lib/license_finder/reporter.rb
-- lib/license_finder/viewable.rb
+- lib/license_finder/source_syncer.rb
+- lib/license_finder/text_report.rb
 - lib/tasks/license_finder.rake
 - lib/templates/dependency.html.erb
-- lib/templates/dependency_list.html.erb
+- lib/templates/html_report.erb
+- lib/templates/text_report.erb
 - license_finder.gemspec
+- readme.md
 - spec/fixtures/APACHE-2-LICENSE
 - spec/fixtures/GPLv2
 - spec/fixtures/ISC-LICENSE
@@ -248,9 +241,12 @@ files:
 - spec/fixtures/readme/README
 - spec/fixtures/readme/Readme.markdown
 - spec/fixtures/utf8_gem/README
+- spec/lib/license_finder/bundle_spec.rb
+- spec/lib/license_finder/bundle_syncer_spec.rb
 - spec/lib/license_finder/bundled_gem_spec.rb
-- spec/lib/license_finder/dependency_list_spec.rb
+- spec/lib/license_finder/cli_spec.rb
 - spec/lib/license_finder/dependency_spec.rb
+- spec/lib/license_finder/html_report_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
@@ -262,11 +258,17 @@ files:
 - 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/persistence/yaml/configuration_spec.rb
+- spec/lib/license_finder/persistence/yaml/dependency_spec.rb
 - spec/lib/license_finder/possible_license_file_spec.rb
 - spec/lib/license_finder/reporter_spec.rb
+- spec/lib/license_finder/source_syncer_spec.rb
+- spec/lib/license_finder/text_report_spec.rb
 - spec/lib/license_finder_spec.rb
 - spec/spec_helper.rb
 - spec/support/license_examples.rb
+- spec/support/shared_examples/persistence/configuration.rb
+- spec/support/shared_examples/persistence/dependency.rb
 homepage: https://github.com/pivotal/LicenseFinder
 licenses:
 - MIT
@@ -282,7 +284,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3316457450269870236
+      hash: -3357817247708009893
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -291,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3316457450269870236
+      hash: -3357817247708009893
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -304,6 +306,7 @@ test_files:
 - features/license_finder.feature
 - features/license_finder_rake_task.feature
 - features/rails_rake.feature
+- features/set_license.feature
 - features/step_definitions/steps.rb
 - features/text_report.feature
 - spec/fixtures/APACHE-2-LICENSE
@@ -331,9 +334,12 @@ test_files:
 - spec/fixtures/readme/README
 - spec/fixtures/readme/Readme.markdown
 - spec/fixtures/utf8_gem/README
+- spec/lib/license_finder/bundle_spec.rb
+- spec/lib/license_finder/bundle_syncer_spec.rb
 - spec/lib/license_finder/bundled_gem_spec.rb
-- spec/lib/license_finder/dependency_list_spec.rb
+- spec/lib/license_finder/cli_spec.rb
 - spec/lib/license_finder/dependency_spec.rb
+- spec/lib/license_finder/html_report_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
@@ -345,8 +351,14 @@ test_files:
 - 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/persistence/yaml/configuration_spec.rb
+- spec/lib/license_finder/persistence/yaml/dependency_spec.rb
 - spec/lib/license_finder/possible_license_file_spec.rb
 - spec/lib/license_finder/reporter_spec.rb
+- spec/lib/license_finder/source_syncer_spec.rb
+- spec/lib/license_finder/text_report_spec.rb
 - spec/lib/license_finder_spec.rb
 - spec/spec_helper.rb
 - spec/support/license_examples.rb
+- spec/support/shared_examples/persistence/configuration.rb
+- spec/support/shared_examples/persistence/dependency.rb