license_finder 1.0.0.1 → 1.0.1

data/readme.md

@@ -152,16 +152,24 @@ whitelist:
 ignore_groups:
 #- test
 #- development
+ignore_dependencies:
+#- bundler
 dependencies_file_dir: './doc/'
 project_name: My Project Name
 ```
 
-By modifying this file, you can configure license_finder's behavior.  Licenses
-in the `whitelist` will be automatically approved.  You can exclude test or
-development dependencies by setting `ignore_groups`.  (Currently this only
-works for Bundler.)  You can store the license database and text files in
-another directory by changing `dependencies_file_dir`.  And the `project_name`,
-which defaults to your working directory, appears in the [HTML report](#html-report).
+By modifying this file, you can configure license_finder's behavior.
+
+- Licenses in the `whitelist` will be automatically approved.
+- You can exclude test or development dependencies by setting `ignore_groups`.  (Currently this only
+works for Bundler.)
+- You can exclude specific dependencies by setting `ignore_dependencies`.
+(Think carefully before adding dependencies to this list. A likely item to exclude is
+bundler itself, to avoid noisy changes to the doc files when different people run
+license_finder with different versions of bundler.)
+- You can store the license database and text files in another directory by changing 
+`dependencies_file_dir`. And the `project_name`, which defaults to your working
+directory, appears in the [HTML report](#html-report).
 
 You can also configure license_finder through the command line.  See
 `license_finder whitelist help`, `license_finder ignored_bundler_groups help`
@@ -169,13 +177,9 @@ and `license_finder project_name help` for more details.
 
 ## HTML Report
 
-The HTML report generated by license_finder has two sections, an overview at the top, and then a series of dependency summaries afterwards.
-
-![HTML Report](files/report_breakdown.png)
-
-The individual dependency summary follows a pattern like this:
-
-![HTML Report](files/dependency_breakdown.png)
+The HTML report generated by license_finder shows a summary of the project's dependencies
+and dependencies which need to be approved. The project name at the top of the report can
+be set in `config/license_finder.yml`.
 
 ## Upgrade for pre 0.8.0 users
 

data/spec/lib/license_finder/cli_spec.rb

@@ -124,11 +124,9 @@ module LicenseFinder
 
       describe "list" do
         it "shows the ignored groups in the standard output" do
-          config.should_receive(:ignore_groups).and_return([])
+          config.should_receive(:ignore_groups).and_return(['development'])
 
-          silence_stdout do
-            subject.list
-          end
+          expect(capture_stdout { subject.list }).to match /development/
         end
       end
 
@@ -157,6 +155,50 @@ module LicenseFinder
       end
     end
 
+    describe IgnoredDependencies do
+      let(:config) { LicenseFinder.config }
+
+      describe "list" do
+        context "when there is at least one ignored dependency" do
+          it "shows the ignored dependencies" do
+            expect(config).to receive(:ignore_dependencies).and_return(['bundler'])
+            expect(capture_stdout { subject.list }).to match /bundler/
+          end
+        end
+
+        context "when there are no ignored dependencies" do
+          it "prints '(none)'" do
+            expect(config).to receive(:ignore_dependencies).and_return([])
+            expect(capture_stdout { subject.list }).to match /\(none\)/
+          end
+        end
+      end
+
+      describe "add" do
+        it "adds the specified group to the ignored groups list" do
+          config.ignore_dependencies.should_receive(:push).with("test")
+          config.should_receive(:save)
+          Reporter.should_receive(:write_reports)
+
+          silence_stdout do
+            subject.add("test")
+          end
+        end
+      end
+
+      describe "remove" do
+        it "removes the specified group from the ignored groups list" do
+          config.ignore_dependencies.should_receive(:delete).with("test")
+          config.should_receive(:save)
+          Reporter.should_receive(:write_reports)
+
+          silence_stdout do
+            subject.remove("test")
+          end
+        end
+      end
+    end
+
     describe Main do
       describe "default" do
         it "checks for action items" do

data/spec/lib/license_finder/configuration_spec.rb

@@ -11,11 +11,23 @@ module LicenseFinder
       end
     end
 
+    describe "#last_modified" do
+      let(:time) { double :time }
+      before do
+        allow(Configuration::Persistence).to receive(:last_modified) { time }
+      end
+
+      it 'returns the last modified date of the config file' do
+        expect(LicenseFinder::Configuration.new({}).last_modified).to eq time
+      end
+    end
+
     describe '.new' do
       it "should default missing attributes" do
         subject = described_class.new({})
         subject.whitelist.should == []
         subject.ignore_groups.should == []
+        subject.ignore_dependencies.should == []
         subject.artifacts.dir.should == Pathname('./doc/')
       end
 
@@ -23,12 +35,14 @@ module LicenseFinder
         attributes = {
           "whitelist" => nil,
           "ignore_groups" => nil,
+          "ignore_dependencies" => nil,
           "dependencies_file_dir" => nil,
           "project_name" => nil
         }
         subject = described_class.new(attributes)
         subject.whitelist.should == []
         subject.ignore_groups.should == []
+        subject.ignore_dependencies.should == []
         subject.artifacts.dir.should == Pathname('./doc/')
         subject.project_name.should_not be_nil
       end
@@ -37,12 +51,14 @@ module LicenseFinder
         attributes = {
           "whitelist" => %w{a whitelist},
           "ignore_groups" => %w{test development},
+          "ignore_dependencies" => %w{bundler},
           "dependencies_file_dir" => "some/path",
           "project_name" => "my_app"
         }
         subject = described_class.new(attributes)
         subject.whitelist.should == %w{a whitelist}
         subject.ignore_groups.should == %w{test development}
+        subject.ignore_dependencies.should == %w{bundler}
         subject.artifacts.dir.should == Pathname("some/path")
         subject.project_name.should == "my_app"
       end
@@ -77,6 +93,7 @@ module LicenseFinder
         {
           'whitelist' => ['my_gem'],
           'ignore_groups' => ['other_group', 'test'],
+          'ignore_dependencies' => ['bundler'],
           'project_name' => "New Project Name",
           'dependencies_file_dir' => "./deps"
         }
@@ -91,6 +108,7 @@ module LicenseFinder
         config = described_class.new(attributes)
         config.whitelist << 'my_gem'
         config.ignore_groups << 'test'
+        config.ignore_dependencies << 'bundler'
 
         Configuration::Persistence.should_receive(:set).with(attributes)
         config.save
@@ -98,6 +116,28 @@ module LicenseFinder
     end
   end
 
+  describe Configuration::Artifacts do
+    describe "#last_refreshed" do
+      let(:database_modified_time) { 1 }
+      let(:text_modified_time) { 2 }
+      let(:detailed_text_modified_time) { 3 }
+      let(:html_modified_time) { 4 }
+      let(:markdown_modified_time) { 5 }
+
+      before do
+        allow(File).to receive(:mtime).with(Pathname('./doc/dependencies.db')) { database_modified_time }
+        allow(File).to receive(:mtime).with(Pathname('./doc/dependencies.csv')) { text_modified_time }
+        allow(File).to receive(:mtime).with(Pathname('./doc/dependencies_detailed.csv')) { detailed_text_modified_time }
+        allow(File).to receive(:mtime).with(Pathname('./doc/dependencies.html')) { html_modified_time }
+        allow(File).to receive(:mtime).with(Pathname('./doc/dependencies.md')) { markdown_modified_time }
+      end
+
+      it 'returns the earliest modified date of the config file' do
+        expect(described_class.new(Pathname('./doc')).last_refreshed).to eq database_modified_time
+      end
+    end
+  end
+
   describe Configuration::Persistence do
     describe ".get" do
       it "should use saved configuration" do
@@ -150,5 +190,17 @@ module LicenseFinder
         described_class.init
       end
     end
+
+    describe ".last_modified" do
+      let(:time) { double :time }
+      let(:config_path) { Pathname.new('.').join('config').join('license_finder.yml') }
+      before do
+        allow(File).to receive(:mtime).with(config_path) { time }
+      end
+
+      it "returns the last time the yml file was modified" do
+        expect(described_class.last_modified).to eq time
+      end
+    end
   end
 end

data/spec/lib/license_finder/dependency_manager_spec.rb

@@ -148,27 +148,43 @@ module LicenseFinder
         context "when the database has not changed" do
           before do
             Digest::SHA2.stub_chain(:file, :hexdigest) { 5 }
+            allow(config).to receive(:last_modified) { config_last_update }
+            allow(config.artifacts).to receive(:last_refreshed) { artifacts_last_update }
           end
 
-          context "when the reports exist" do
+          context "and the reports do not exist" do
             before do
-              config.artifacts.stub(:html_file).and_return(file_exists)
+              config.artifacts.stub(:html_file).and_return(file_does_not_exist)
             end
 
-            it "does not write reports" do
-              Reporter.should_not_receive(:write_reports)
+            it "writes reports" do
+              Reporter.should_receive(:write_reports)
               DependencyManager.modifying {}
             end
           end
 
-          context "when the reports do not exist" do
+          context "and the reports exist" do
             before do
-              config.artifacts.stub(:html_file).and_return(file_does_not_exist)
+              config.artifacts.stub(:html_file).and_return(file_exists)
             end
 
-            it "writes reports" do
-              Reporter.should_receive(:write_reports)
-              DependencyManager.modifying {}
+            context "and configs are newer than the reports" do
+              let(:config_last_update) { 4 }
+              let(:artifacts_last_update) { 1 }
+              it "writes reports" do
+                expect(Reporter).to receive(:write_reports)
+                DependencyManager.modifying {}
+              end
+            end
+
+            context "and configs are older than the reports" do
+              let(:config_last_update) { 4 }
+              let(:artifacts_last_update) { 6 }
+
+              it "does not write reports" do
+                expect(Reporter).not_to receive(:write_reports)
+                DependencyManager.modifying {}
+              end
             end
           end
         end

data/spec/lib/license_finder/package_managers/bower_package_spec.rb

@@ -56,7 +56,7 @@ module LicenseFinder
 
         it "returns 'multiple licenses' if there's more than one license" do
           package = BowerPackage.new({ "pkgMeta" => {"licenses" => ["MIT", "BSD"]}, "canonicalDir" => "/some/path" })
-          expect(package.license.name).to eq("multiple licenses")
+          expect(package.license.name).to eq("multiple licenses: MIT, BSD")
         end
       end
 
@@ -82,7 +82,7 @@ module LicenseFinder
             double(:second_file, license: License.find_by_name('Second Detected License'))
           ])
 
-          subject.license.name.should == "other"
+          subject.license.name.should == "multiple licenses: First Detected License, Second Detected License"
         end
       end
     end

data/spec/lib/license_finder/package_managers/bundler_package_spec.rb

@@ -36,21 +36,25 @@ module LicenseFinder
           stub_license_files [double(:file, license: License.find_by_name('Detected License'))]
         end
 
-        it "returns the license from the gemspec if only one unique license provided" do
-          gemspec.licenses = ['MIT', 'Expat']
+        context 'if the gemspec provides two synonymous licenses' do
+          before { gemspec.licenses = ['MIT', 'Expat'] }
 
-          subject.license.name.should == "MIT"
+          it 'returns the license only once' do
+            subject.license.name.should == "MIT"
+          end
         end
 
-        it "returns 'other' if the gemspec provides many" do
-          gemspec.licenses = ['First Gemspec License', 'Second Gemspec License']
+        context 'if the gemspec provides many licenses' do
+          before { gemspec.licenses = ['First Gemspec License', 'Second Gemspec License'] }
 
-          subject.license.name.should == "multiple licenses"
+          it "returns 'multiple licenses' with the names of the licenses from the gemspec (but not those from detected files)" do
+            subject.license.name.should == "multiple licenses: First Gemspec License, Second Gemspec License"
+          end
         end
       end
 
       context "when there is nothing in the spec" do
-        it "returns a license in a file if only one unique license detected" do
+        it "returns a license in a file if there is only one unique license detected" do
           stub_license_files([
             double(:first_file, license: License.find_by_name('MIT')),
             double(:second_file, license: License.find_by_name('Expat'))
@@ -65,13 +69,13 @@ module LicenseFinder
           subject.license.name.should == "other"
         end
 
-        it "returns 'other' if there are many licenses in files" do
+        it "returns 'multiple licenses' if there are many licenses in files" do
           stub_license_files([
             double(:first_file, license: License.find_by_name('First Detected License')),
             double(:second_file, license: License.find_by_name('Second Detected License'))
           ])
 
-          subject.license.name.should == "other"
+          subject.license.name.should == "multiple licenses: First Detected License, Second Detected License"
         end
       end
     end

data/spec/lib/license_finder/package_managers/gradle_package_spec.rb

@@ -40,7 +40,7 @@ module LicenseFinder
         end
 
         it "returns 'multiple licenses'" do
-          subject.license.name.should == 'multiple licenses'
+          subject.license.name.should == 'multiple licenses: Eclipse Public License - v 1.0, GNU Lesser General Public License'
         end
       end
 

data/spec/lib/license_finder/package_managers/maven_package_spec.rb

@@ -46,7 +46,7 @@ module LicenseFinder
         end
 
         it "returns 'multiple licenses'" do
-          subject.license.name.should == 'multiple licenses'
+          subject.license.name.should == 'multiple licenses: Common Public License Version 1.0, Apache 2'
         end
       end
 

data/spec/lib/license_finder/package_managers/npm_package_spec.rb

@@ -52,7 +52,7 @@ module LicenseFinder
 
         it "returns 'multiple licenses' if there's more than one license" do
           package = NpmPackage.new({ "licenses" => ["MIT", "BSD"], "path" => "/some/path" })
-          expect(package.license.name).to eq("multiple licenses")
+          expect(package.license.name).to eq("multiple licenses: MIT, BSD")
         end
       end
 
@@ -78,7 +78,7 @@ module LicenseFinder
             double(:second_file, license: License.find_by_name('Second Detected License'))
           ])
 
-          subject.license.name.should == "other"
+          subject.license.name.should == "multiple licenses: First Detected License, Second Detected License"
         end
       end
     end

data/spec/lib/license_finder/package_managers/pip_package_spec.rb

@@ -73,7 +73,7 @@ module LicenseFinder
 
             subject = make_package(data)
 
-            expect(subject.license.name).to eq('multiple licenses')
+            expect(subject.license.name).to eq('multiple licenses: Apache 2.0 License, GPL')
           end
         end
 

data/spec/lib/license_finder/reports/html_report_spec.rb

@@ -4,8 +4,9 @@ require "capybara"
 module LicenseFinder
   describe HtmlReport do
     describe "#to_s" do
+      let(:dependency_name) { "the-name" }
       let(:dependency) do
-        dep = Dependency.create name: "the-name"
+        dep = Dependency.create name: dependency_name
         dep.apply_better_license License.find_by_name("MIT")
         dep
       end
@@ -64,9 +65,9 @@ module LicenseFinder
 
         it "should show the relationships" do
           should have_text "(foo group)"
-          should have_text "Parents"
+          should have_text "#{dependency_name} is required by:"
           should have_text "foo parent"
-          should have_text "Children"
+          should have_text "#{dependency_name} relies on:"
           should have_text "foo child"
         end
       end
@@ -74,8 +75,8 @@ module LicenseFinder
       context "when the gem has no relationships" do
         it "should not show any relationships" do
           should_not have_text "()"
-          should_not have_text "Parents"
-          should_not have_text "Children"
+          should_not have_text "#{dependency_name} is required by:"
+          should_not have_text "#{dependency_name} relies on:"
         end
       end
     end

data/spec/lib/license_finder/reports/reporter_spec.rb

@@ -6,7 +6,7 @@ module LicenseFinder
       subject { Reporter.write_reports }
 
       before do
-        Dependency.stub(:all) { [double(:dep)] }
+        Dependency.stub(:acknowledged) { [double(:dep)] }
 
         MarkdownReport.stub(:of) { 'markdown report' }
         DetailedTextReport.stub(:of) { 'detailed csv report' }

data/spec/lib/license_finder/tables/dependency_spec.rb

@@ -5,11 +5,14 @@ module LicenseFinder
     describe '.unapproved' do
       before do
         License.find_by_name('MIT').stub(:whitelisted? =>  true)
+        allow(LicenseFinder.config).to receive(:ignore_dependencies) { ['this ignored dependency', 'that ignored dependency'] }
       end
 
-      it "should return all unapproved dependencies" do
+      it "should return all unapproved dependencies that are not ignored" do
         dependency = Dependency.create(name: "unapproved dependency", version: '0.0.1')
         approved = Dependency.create(name: "approved dependency", version: '0.0.1')
+        this_ignored = Dependency.create(name: "this ignored dependency", version: '0.0.1')
+        that_ignored = Dependency.create(name: "that ignored dependency", version: '0.0.1')
         approved.approve!
         whitelisted = Dependency.create(name: "approved dependency", version: '0.0.1')
         whitelisted.license = License.find_by_name('MIT')
@@ -37,6 +40,16 @@ module LicenseFinder
       end
     end
 
+    describe ".acknowledged" do
+      it "returns all dependencies that are not ignored" do
+        acknowledged_dependency = Dependency.create(name: "acknowledged dependency", version: '0.0.1')
+        ignored_dependency = Dependency.create(name: "ignored dependency", version: '0.0.1')
+        allow(LicenseFinder.config).to receive(:ignore_dependencies) { [ignored_dependency.name] }
+
+        expect(Dependency.acknowledged).to match_array [acknowledged_dependency]
+      end
+    end
+
     describe '#approve!' do
       it "should update the database to show the dependency is approved" do
         dependency = Dependency.named("foo")