license_finder 0.4.5 → 0.5.0

data/spec/lib/license_finder/dependency_list_spec.rb

@@ -1,42 +1,28 @@
 require 'spec_helper'
 
 describe LicenseFinder::DependencyList do
+  def build_gemspec(name, version)
+    Gem::Specification.new do |s|
+      s.name = name
+      s.version = version
+      s.summary = 'summary'
+      s.description = 'description'
+    end
+  end
+
   before do
     config = stub(LicenseFinder).config.stub!
     config.whitelist { [] }
     config.ignore_groups { [] }
-
-    @mock_gemspec = Class.new do
-      def initialize(name = nil, version = nil, path = nil)
-        @name = name
-        @version = version
-        @path = path
-      end
-
-      def name
-        @name || 'spec_name'
-      end
-
-      def version
-        @version || '2.1.3'
-      end
-
-      def full_gem_path
-        @path || 'install/path'
-      end
-
-      def license
-        nil
-      end
-    end
   end
 
-  describe 'from Bundler' do
+  describe '.from_bundler' do
     subject do
-      mock_bundler = Object.new
-      stub(Bundler::Definition).build {mock_bundler}
-      stub(mock_bundler).groups {[]}
-      stub(mock_bundler).specs_for { [@mock_gemspec.new('gem1', '1.2.3'), @mock_gemspec.new('gem2', '0.4.2')] }
+      bundle = stub(Bundler::Definition).build.stub!
+      bundle.dependencies { [] }
+      bundle.groups { [] }
+      bundle.specs_for { [build_gemspec('gem1', '1.2.3'), build_gemspec('gem2', '0.4.2')] }
+
       LicenseFinder::DependencyList.from_bundler
     end
 
@@ -44,58 +30,88 @@ describe LicenseFinder::DependencyList do
       subject.dependencies.size.should == 2
     end
 
-    describe "first" do
-      let(:dep) { subject.dependencies.first }
-      it { dep.name.should == 'gem1' }
-      it { dep.version.should == '1.2.3' }
-    end
+    it 'should maintain the incoming order' do
+      subject.dependencies[0].name.should == 'gem1'
+      subject.dependencies[0].version.should == '1.2.3'
 
-    describe "second" do
-      let(:dep) { subject.dependencies[1] }
-      it { dep.name.should == 'gem2' }
-      it { dep.version.should == '0.4.2' }
+      subject.dependencies[1].name.should == 'gem2'
+      subject.dependencies[1].version.should == '0.4.2'
     end
-
   end
 
-  describe 'from yaml' do
-    subject { LicenseFinder::DependencyList.from_yaml("--- \n- name: \"gem1\"\n  version: \"1.2.3\"\n  license: \"MIT\"\n  approved: false\n- name: \"gem2\"\n  version: \"0.4.2\"\n  license: \"MIT\"\n  approved: false\n") }
+  describe '#from_yaml' do
+    subject do
+      LicenseFinder::DependencyList.from_yaml([
+        {'name' => 'gem1', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false},
+        {'name' => 'gem2', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false}
+      ].to_yaml)
+    end
 
-    it "should have 2 dependencies" do
+    it 'should have 2 dependencies' do
       subject.dependencies.size.should == 2
     end
 
-    describe "first" do
-      let(:dep) { subject.dependencies.first }
-      it { dep.name.should == 'gem1' }
-      it { dep.version.should == '1.2.3' }
-    end
+    it 'should maintain the incoming order' do
+      subject.dependencies[0].name.should == 'gem1'
+      subject.dependencies[0].version.should == '1.2.3'
 
-    describe "second" do
-      let(:dep) { subject.dependencies[1] }
-      it { dep.name.should == 'gem2' }
-      it { dep.version.should == '0.4.2' }
+      subject.dependencies[1].name.should == 'gem2'
+      subject.dependencies[1].version.should == '0.4.2'
     end
+  end
 
+  describe '#as_yaml' do
+    it "should generate yaml" do
+      list = LicenseFinder::DependencyList.new([
+        LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false, 'source' => "bundle"),
+        LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false)
+      ])
+
+      list.as_yaml.should == [
+        {
+          'name' => 'a_gem',
+          'version' => '1.2.3',
+          'license' => 'MIT',
+          'approved' => false,
+          'source' => nil,
+          'license_url' => '',
+          'notes' => '',
+          'license_files' => nil,
+          'readme_files' => nil
+        },
+        {
+          'name' => 'b_gem',
+          'version' => '0.4.2',
+          'license' => 'MIT',
+          'approved' => false,
+          'source' => 'bundle',
+          'license_url' => '',
+          'notes' => '',
+          'license_files' => nil,
+          'readme_files' => nil
+        }
+      ]
+    end
   end
 
-  describe 'to_yaml' do
+  describe '#to_yaml' do
     it "should generate yaml" do
       list = LicenseFinder::DependencyList.new([
-                                                   LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false),
-                                                   LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false)
-                                               ])
+        LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false, 'source' => "bundle"),
+        LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false)
+      ])
 
-      list.to_yaml.should == "--- \n- name: \"a_gem\"\n  version: \"1.2.3\"\n  license: \"MIT\"\n  approved: false\n  license_url: \"\"\n  notes: \"\"\n  license_files:\n  readme_files:\n- name: \"b_gem\"\n  version: \"0.4.2\"\n  license: \"MIT\"\n  approved: false\n  license_url: \"\"\n  notes: \"\"\n  license_files:\n  readme_files:\n"
+      yaml = YAML.load(list.to_yaml)
+      yaml.should == list.as_yaml
     end
   end
 
   describe 'round trip' do
     it 'should recreate from to_yaml' do
       list = LicenseFinder::DependencyList.new([
-                                                   LicenseFinder::Dependency.new('name' => 'gem1', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false),
-                                                   LicenseFinder::Dependency.new('name' => 'gem2', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false)
-                                               ])
+        LicenseFinder::Dependency.new('name' => 'gem1', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false),
+        LicenseFinder::Dependency.new('name' => 'gem2', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false)
+      ])
 
       new_list = LicenseFinder::DependencyList.from_yaml(list.to_yaml)
       new_list.dependencies.size.should == 2
@@ -104,106 +120,79 @@ describe LicenseFinder::DependencyList do
     end
   end
 
-  describe 'updating dependency list' do
-    before(:each) do
-      @yml_same = LicenseFinder::Dependency.new('name' => 'same_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => true, 'license_url' => 'a', 'notes' => 'b')
-      @yml_updated = LicenseFinder::Dependency.new('name' => 'updated_gem', 'version' => '1.0.1', 'license' => 'MIT', 'approved' => true, 'license_url' => 'a', 'notes' => 'b')
-      @yml_new_license = LicenseFinder::Dependency.new('name' => 'new_license_gem', 'version' => '1.0.1', 'license' => 'MIT', 'approved' => true, 'license_url' => 'a', 'notes' => 'b')
-      @yml_manual_license = LicenseFinder::Dependency.new('name' => 'manual_license_gem', 'version' => '1.0.1', 'license' => 'Ruby', 'approved' => true, 'license_url' => 'a', 'notes' => 'b')
-      @yml_removed_gem = LicenseFinder::Dependency.new('name' => 'removed_gem', 'version' => '1.0.1', 'license' => 'MIT', 'approved' => true, 'license_url' => 'a', 'notes' => 'b')
-      @yml_new_whitelist = LicenseFinder::Dependency.new('name' => 'new_whitelist_gem', 'version' => '1.0.1', 'license' => 'MIT', 'approved' => false, 'license_url' => 'a', 'notes' => 'b')
-
-      @gemspec_same = LicenseFinder::Dependency.new('name' => 'same_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false)
-      @gemspec_new = LicenseFinder::Dependency.new('name' => 'brand_new_gem', 'version' => '0.9', 'license' => 'MIT', 'approved' => false)
-      @gemspec_updated = LicenseFinder::Dependency.new('name' => 'updated_gem', 'version' => '1.1.2', 'license' => 'MIT', 'approved' => false)
-      @gemspec_new_license = LicenseFinder::Dependency.new('name' => 'new_license_gem', 'version' => '2.0.1', 'license' => 'Apache 2.0', 'approved' => false)
-      @gemspec_new_whitelist = LicenseFinder::Dependency.new('name' => 'new_whitelist_gem', 'version' => '1.0.1', 'license' => 'MIT', 'approved' => true)
-      @gemspec_manual_license = LicenseFinder::Dependency.new('name' => 'manual_license_gem', 'version' => '1.2.1', 'license' => 'other', 'approved' => false)
-
-      @list_from_yml = LicenseFinder::DependencyList.new([@yml_same, @yml_updated, @yml_new_license, @yml_removed_gem, @yml_new_whitelist, @yml_manual_license])
-      @list_from_gemspec = LicenseFinder::DependencyList.new([@gemspec_same, @gemspec_new, @gemspec_updated, @gemspec_new_license, @gemspec_new_whitelist, @gemspec_manual_license])
-    end
-
-    it "should ignore existing gems with the same version" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'same_gem' }
-      dep.approved.should == @yml_same.approved
-      dep.license_url.should == 'a'
-      dep.notes.should == 'b'
-    end
-
-    it "should keep old license value if gemspec license is other" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'manual_license_gem' }
-      dep.license.should == @yml_manual_license.license
-      dep.version.should == @gemspec_manual_license.version
-      dep.approved.should == @yml_manual_license.approved
-      dep.license_url.should == 'a'
-      dep.notes.should == 'b'
-    end
-
-    it "should add new gem" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'brand_new_gem' }
-      dep.should_not be_nil
-      dep.version.should == @gemspec_new.version
-      dep.approved.should == @gemspec_new.approved
-      dep.license.should == @gemspec_new.license
-      dep.license_url.should == ''
-      dep.notes.should == ''
-    end
-
-    it "should update version if gem exists and license is the same" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'updated_gem' }
-      dep.name.should == @gemspec_updated.name
-      dep.approved.should == @yml_updated.approved
-      dep.license_url.should == 'a'
-      dep.notes.should == 'b'
-    end
-
-    it "should replace gem if version and license are different" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'new_license_gem' }
-      dep.name.should == @gemspec_new_license.name
-      dep.version.should == @gemspec_new_license.version
-      dep.approved.should == @gemspec_new_license.approved
-      dep.license_url.should == ''
-      dep.notes.should == ''
-    end
-
-    it "should update approved if gemspec gem is approved" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'new_whitelist_gem' }
-      dep.name.should == @gemspec_new_whitelist.name
-      dep.version.should == @gemspec_new_whitelist.version
-      dep.approved.should == @gemspec_new_whitelist.approved
-      dep.license_url.should == 'a'
-      dep.notes.should == 'b'
-    end
-
-    it "should remove gem if new list doesn't contain it" do
-      dep = @list_from_yml.merge(@list_from_gemspec).dependencies.detect { |d| d.name == 'removed_gem' }
-      dep.should be_nil
+  describe '#merge' do
+    let(:old_dep) do
+      LicenseFinder::Dependency.new(
+        'name' => 'foo',
+        'version' => '0.0.1',
+        'source' => 'bundle'
+      )
+    end
+    let(:old_list) { LicenseFinder::DependencyList.new([old_dep]) }
+
+    let(:new_dep) do
+      LicenseFinder::Dependency.new(
+        'name' => 'foo',
+        'version' => '0.0.2',
+        'source' => 'bundle'
+      )
+    end
+    let(:new_list) { LicenseFinder::DependencyList.new([new_dep]) }
+
+    it 'should merge dependencies with the same name' do
+      merged_list = old_list.merge(new_list)
+
+      merged_deps = merged_list.dependencies.select { |d| d.name == 'foo' }
+      merged_deps.should have(1).item
+
+      merged_dep = merged_deps.first
+      merged_dep.name.should == 'foo'
+      merged_dep.version.should == '0.0.2'
+    end
+
+    it 'should add new dependencies' do
+      new_dep.name = 'bar'
+
+      merged_list = old_list.merge(new_list)
+      merged_list.dependencies.should include(new_dep)
+    end
+
+    it 'should keep dependencies not originating from the bundle' do
+      old_dep.source = ''
+
+      merged_list = old_list.merge(new_list)
+      merged_list.dependencies.should include(old_dep)
+    end
+
+    it 'should remove dependencies missing from the bundle' do
+      old_dep.source = 'bundle'
+
+      merged_list = old_list.merge(new_list)
+      merged_list.dependencies.should_not include(old_dep)
     end
   end
 
   describe "#to_s" do
     it "should return a human readable list of dependencies" do
-      gem1 = LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => true)
-      gem2 = LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '0.9', 'license' => 'other', 'approved' => false, 'license_url' => 'http://foo.com/LICENSE')
 
-      list = LicenseFinder::DependencyList.new([gem1, gem2])
+      gem1 = Struct.new(:name, :to_s).new("a", "a string ")
+      gem2 = Struct.new(:name, :to_s).new("b", "b string")
+
+      list = LicenseFinder::DependencyList.new([gem2, gem1])
 
-      list.to_s.should == "a_gem 0.9, other, http://foo.com/LICENSE\n  license files:\n  readme files:\nb_gem 1.2.3, MIT"
+      list.to_s.should == "a string b string"
     end
   end
 
   describe '#action_items' do
     it "should return all unapproved dependencies" do
-      gem1 = LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => true)
-      gem2 = LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '0.9', 'license' => 'other', 'approved' => false)
-      gem3 = LicenseFinder::Dependency.new('name' => 'c_gem', 'version' => '0.2', 'license' => 'other', 'approved' => false)
+      gem1 = Struct.new(:name, :to_s, :approved).new("a", "a string ", true)
+      gem2 = Struct.new(:name, :to_s, :approved).new("b", "b string ", false)
+      gem3 = Struct.new(:name, :to_s, :approved).new("c", "c string", false)
 
       list = LicenseFinder::DependencyList.new([gem1, gem2, gem3])
 
-      list.action_items.should == "a_gem 0.9, other\n  license files:\n  readme files:\nc_gem 0.2, other\n  license files:\n  readme files:"
+      list.action_items.should == "b string c string"
     end
   end
 end
-
-

data/spec/lib/license_finder/dependency_spec.rb

@@ -10,7 +10,9 @@ describe LicenseFinder::Dependency do
         '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'}]
+        'readme_files' => [{'path' => '/Users/pivotal/foo/Readme1'}, {'path' => '/Users/pivotal/bar/Readme2'}],
+        'source' => "bundle",
+        'bundler_groups' => nil
     }
   end
 
@@ -35,6 +37,7 @@ describe LicenseFinder::Dependency do
     end
   end
 
+
   describe '.from_hash' do
     subject { LicenseFinder::Dependency.from_hash(attributes) }
 
@@ -44,10 +47,191 @@ describe LicenseFinder::Dependency do
     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 == ["/Users/pivotal/foo/lic1", "/Users/pivotal/bar/lic2"] }
-    its(:readme_files) { should == ["/Users/pivotal/foo/Readme1", "/Users/pivotal/bar/Readme2"] }
-    its(:to_yaml_entry) { should == "- name: \"spec_name\"\n  version: \"2.1.3\"\n  license: \"GPL\"\n  approved: false\n  license_url: \"http://www.apache.org/licenses/LICENSE-2.0.html\"\n  notes: \"some notes\"\n  license_files:\n  - path: \"/Users/pivotal/foo/lic1\"\n  - path: \"/Users/pivotal/bar/lic2\"\n  readme_files:\n  - path: \"/Users/pivotal/foo/Readme1\"\n  - path: \"/Users/pivotal/bar/Readme2\"\n" }
+    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) }
+    its(:source) { should == "bundle" }
+    its(:bundler_groups) { should == [] }
+
+    its(:as_yaml) do
+      should == {
+        'name' => 'spec_name',
+        'version' => '2.1.3',
+        'license' => 'GPL',
+        'approved' => false,
+        'source' => 'bundle',
+        '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'}
+        ]
+      }
+    end
+
+    it 'should generate yaml' do
+      yaml = YAML.load(subject.to_yaml)
+      yaml.should == subject.as_yaml
+    end
   end
-end
 
+  describe '#to_s' do
+    let(:gem) do
+      LicenseFinder::Dependency.new(
+        'name' => 'test_gem',
+        '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
+      )
+    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
+      end
+    end
+
+    context "when the gem has a license url" do
+      let(:license_url) { "www.foobar.com"}
+
+      it "should include the license_url" do
+        should == "test_gem 1.0, MIT, www.foobar.com, summary foo, description bar"
+      end
+    end
+
+    context "when the gem has any bundler groups" do
+      let(:bundler_groups) { %w(staging production) }
+
+      it "should include the bundler groups" do
+        should == "test_gem 1.0, MIT, summary foo, description bar, staging, production"
+      end
+    end
+  end
+
+  describe '#source' do
+    it "should default to nil" do
+      LicenseFinder::Dependency.new.source.should be_nil
+    end
+
+    it "should be overridable" do
+      LicenseFinder::Dependency.new("source" => "foo").source.should == "foo"
+    end
+  end
+
+  describe '#merge' do
+    subject do
+      LicenseFinder::Dependency.new(
+        '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",
+      )
+    end
+
+    let(:new_dep) do
+      LicenseFinder::Dependency.new(
+        '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]
+      )
+    end
+
+    it 'should raise an error if the names do not match' do
+      new_dep.name = 'bar'
+
+      expect {
+        subject.merge(new_dep)
+      }.to raise_error
+    end
+
+    it 'should return the new version, license url, license files, readme files, and source' 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
+    end
+    
+    it 'should return the new summary and description and bundle groups' do
+      merged = subject.merge new_dep
+      
+      merged.summary.should     == new_dep.summary
+      merged.description.should == new_dep.description
+      merged.bundler_groups.should == new_dep.bundler_groups
+    end
+
+    it 'should return the old notes' do
+      subject.notes = 'old notes'
+      new_dep.notes = 'new notes'
+
+      merged = subject.merge(new_dep)
 
+      merged.notes.should == 'old notes'
+    end
+
+    it 'should return the new license and approval if the license is different' do
+      subject.license = "MIT"
+      subject.approved = true
+
+      new_dep.license = "GPLv2"
+      new_dep.approved = false
+
+      merged = subject.merge(new_dep)
+
+      merged.license.should == "GPLv2"
+      merged.approved.should == false
+    end
+
+    it 'should return the old license and approval if the new license is the same or "other"' do
+      subject.approved = false
+      new_dep.approved = true
+
+      subject.merge(new_dep).approved.should == false
+
+      new_dep.license = 'other'
+
+      subject.merge(new_dep).approved.should == false
+    end
+  end
+end