license_finder 0.8.2-java → 0.9.0-java

data/lib/license_finder/configuration.rb

@@ -1,3 +1,5 @@
+require "rake"
+
 module LicenseFinder
   class Configuration
     attr_accessor :whitelist, :ignore_groups, :dependencies_dir
@@ -41,7 +43,7 @@ module LicenseFinder
       config = self.class.config_hash(config)
 
       @whitelist = config['whitelist'] || []
-      @ignore_groups = (config["ignore_groups"] || []).map(&:to_sym)
+      @ignore_groups = (config["ignore_groups"] || [])
       @dependencies_dir = config['dependencies_file_dir'] || './doc/'
       FileUtils.mkdir_p(@dependencies_dir)
     end
@@ -67,11 +69,11 @@ module LicenseFinder
       whitelisted_licenses.include? license
     end
 
-    def save_to_yaml
+    def save
       File.open(Configuration.config_file_path, 'w') do |file|
         file.write({
-          'whitelist' => @whitelist,
-          'ignore_groups' => @ignore_groups
+          'whitelist' => @whitelist.uniq,
+          'ignore_groups' => @ignore_groups.uniq
         }.to_yaml)
       end
     end

data/lib/license_finder/dependency_manager.rb

@@ -1,9 +1,8 @@
 module LicenseFinder
   module DependencyManager
     def self.sync_with_bundler
-      current_gems = Bundle.current_gems
       modifying {
-        current_dependencies = current_gems.map(&:save_as_dependency)
+        current_dependencies = LicenseFinder.current_gems.map(&:save_as_dependency)
         Dependency.bundler.obsolete(current_dependencies).each(&:destroy)
       }
     end

data/lib/license_finder/license/new_bsd.rb

@@ -5,4 +5,23 @@ class LicenseFinder::License::NewBSD < LicenseFinder::License::Base
   def self.pretty_name
     'New BSD'
   end
+
+  def matches?
+    super || matches_alternate?
+  end
+
+  def matches_alternate?
+    !!(text =~ alternate_license_regex)
+  end
+
+  def alternate_license_regex
+    /#{Regexp.escape(alternate_license_text).gsub(/<[^<>]+>/, '(.*)')}/
+  end
+
+  def alternate_license_text
+    self.class.license_text.gsub(
+      "Neither the name of <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.",
+      "The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission."
+    )
+  end
 end

data/license_finder.gemspec

@@ -2,7 +2,7 @@ require './lib/license_finder/platform'
 
 Gem::Specification.new do |s|
   s.name        = "license_finder"
-  s.version     = "0.8.2"
+  s.version     = "0.9.0"
   s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "David Tengdin", "William Ramsey"]
   s.email       = ["licensefinder@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
@@ -21,9 +21,10 @@ Gem::Specification.new do |s|
   s.add_dependency "bundler"
   s.add_dependency "sequel"
   s.add_dependency "thor"
+  s.add_dependency "rake"
   s.add_dependency LicenseFinder::Platform.sqlite_gem
 
-  %w(rspec rake xpath cucumber).each do |gem|
+  %w(rspec xpath cucumber).each do |gem|
     s.add_development_dependency gem
   end
 

data/readme.md

@@ -23,7 +23,7 @@ License finder will generate reports of action items - i.e., dependencies that d
 $ license_finder
 ```
 
-(Note) If you wish to run license_finder without the progress spinner use the -q or --quiet option.
+(Note) If you wish to run license_finder without the progress spinner use the --quiet option.
 
 On a brand new Rails project, you could expect `license_finder` to output something like the following
 (assuming you whitelisted the MIT license -- see [Configuration](#configuration)):
@@ -85,6 +85,29 @@ $ license_finder approve awesome_gpl_gem
 
 If you rerun `license_finder`, you should no longer see `awesome_gpl_gem` in the output.
 
+### Managing license whitelist
+
+Licenses can be added to a whitelist that tells LicenseFinder to automatically approve dependencies using the specified licenses.
+These licenses can be managed with the `whitelist` command.
+
+To list licenses currently on the whitelist:
+
+```sh
+$ license_finder whitelist list
+```
+
+To add a license to the whitelist:
+
+```sh
+$ license_finder whitelist add MIT
+```
+
+To remove a license from the whitelist:
+
+```sh
+$ license_finder whitelist remove MIT
+```
+
 ### Managing ignored Bundler groups
 
 Bundler groups can be added to an ignore list which will prevent LicenseFinder from evaluating their licenses.

data/spec/lib/license_finder/bundled_gem_saver_spec.rb

@@ -16,7 +16,7 @@ module LicenseFinder
 
     describe "#save" do
       let(:bundled_gem) { BundledGem.new(gemspec) }
-      subject { described_class.find_or_initialize_by_name('spec_name', bundled_gem).save }
+      subject { described_class.find_or_create_by_name('spec_name', bundled_gem).save }
 
       context "when the dependency is new" do
         it "persists gem data" do
@@ -28,9 +28,22 @@ module LicenseFinder
           subject.homepage.should == "homepage"
         end
 
-        it "associates children" do
-          subject.children.map(&:name).should == ['foo']
-          subject.children.each { |child| child.approval.should be }
+        describe "associating children" do
+          context "when the child is in Bundler's current gems" do
+            before { LicenseFinder.stub(:current_gems).and_return([double(:gemspec, name: "foo 0.0")]) }
+
+            it "associates children" do
+              subject.children.map(&:name).should == ['foo']
+              subject.children.each { |child| child.id.should_not be_nil }
+            end
+          end
+
+          context "when the child is not in Bundler's current gems" do
+            it "does not associates children" do
+              subject.children.map(&:name).should == []
+              subject.children.each { |child| child.id.should be_nil }
+            end
+          end
         end
 
         it "marks depenency as unapproved by default" do
@@ -47,109 +60,143 @@ module LicenseFinder
       end
 
       context "when the dependency already existed" do
-        let!(:old_copy) do
-          dep = Dependency.create(
-            name: 'spec_name',
-            version: '0.1.2',
-            summary: 'old summary',
-            description: 'old desription',
-            homepage: 'old homepage'
-          )
-          dep.approval = Approval.create
-          dep
-        end
-
-        it "merges in the latest data" do
-          subject.id.should == old_copy.id
-          subject.name.should == old_copy.name
-          subject.version.should == "2.1.3"
-          subject.summary.should == "summary"
-          subject.description.should == "description"
-          subject.homepage.should == "homepage"
-        end
-
-        it "keeps a manually assigned license" do
-          old_copy.license = LicenseAlias.create(name: 'foo', manual: true)
-          old_copy.save
-          subject.license.name.should == 'foo'
-        end
-
-        it "keeps approval" do
-          old_copy.approval = Approval.create(state: true)
-          old_copy.save
-          subject.approval.state.should == true
-        end
+        before { LicenseFinder.stub(:current_gems).and_return([double(:gemspec, name: "foo 0.0")]) }
+
+        context "the values have not changed" do
+          let!(:original_dependency) do
+            license = LicenseAlias.create(
+              name: 'other'
+            )
+            Dependency.create(
+              name: 'spec_name',
+              version: '2.1.3',
+              summary: 'summary',
+              description: 'description',
+              homepage: 'homepage',
+              license: license
+            )
+          end
+          let(:bundled_gem_saver) { described_class.find_or_create_by_name('spec_name', bundled_gem) }
 
-        it "ensures correct children are associated" do
-          old_copy.add_child Dependency.new(name: 'bob')
-          old_copy.add_child Dependency.new(name: 'joe')
-          old_copy.children.each(&:save)
-          subject.children.map(&:name).should =~ ['foo']
+          it "does not save the dependency" do
+            bundled_gem_saver.dependency.should_not_receive(:save)
+            bundled_gem_saver.save
+          end
         end
 
-        context "with a bundler dependency" do
-          let(:bundled_gem) { BundledGem.new(gemspec, double(:bundler_dependency, groups: %w[1 2 3]))}
+        context "the values have changed" do
+          let!(:old_copy) do
+            dep = Dependency.create(
+              name: 'spec_name',
+              version: '0.1.2',
+              summary: 'old summary',
+              description: 'old desription',
+              homepage: 'old homepage'
+            )
+            dep.approval = Approval.create
+            dep
+          end
 
-          before do
-            old_copy.add_bundler_group BundlerGroup.find_or_create(name: 'a')
-            old_copy.add_bundler_group BundlerGroup.find_or_create(name: 'b')
+          it "merges in the latest data" do
+            subject.id.should == old_copy.id
+            subject.name.should == old_copy.name
+            subject.version.should == "2.1.3"
+            subject.summary.should == "summary"
+            subject.description.should == "description"
+            subject.homepage.should == "homepage"
           end
 
-          it "ensures the correct bundler groups are associated" do
-            subject.bundler_groups.map(&:name).should =~ %w[1 2 3]
+          it "keeps a manually assigned license" do
+            old_copy.license = LicenseAlias.create(name: 'foo', manual: true)
+            old_copy.save
+            subject.license.name.should == 'foo'
           end
-        end
 
-        context "license changes to something other than 'other'" do
-          before do
-            old_copy.license = LicenseAlias.create(name: 'other')
+          it "keeps approval" do
+            old_copy.approval = Approval.create(state: true)
             old_copy.save
-            gemspec.license = "new license"
+            subject.approval.state.should == true
           end
 
-          context "new license is whitelisted" do
-            before { LicenseFinder.config.stub(:whitelist).and_return [gemspec.license] }
+          it "ensures correct children are associated" do
+            old_copy.add_child Dependency.new(name: 'bob')
+            old_copy.add_child Dependency.new(name: 'joe')
+            old_copy.children.each(&:save)
+            subject.children.map(&:name).should =~ ['foo']
+          end
 
-            it "should set the approval to true" do
-              subject.should be_approved
+          context "with a bundler dependency" do
+            let(:bundled_gem) { BundledGem.new(gemspec, double(:bundler_dependency, groups: %w[1 2 3]))}
+
+            before do
+              old_copy.add_bundler_group BundlerGroup.find_or_create(name: 'a')
+              old_copy.add_bundler_group BundlerGroup.find_or_create(name: 'b')
             end
-          end
 
-          context "new license is not whitelisted" do
-            it "should set the approval to false" do
-              subject.should_not be_approved
+            it "ensures the correct bundler groups are associated" do
+              subject.bundler_groups.map(&:name).should =~ %w[1 2 3]
             end
           end
-        end
 
-        context "license changes to unknown (i.e., 'other')" do
-          before do
-            old_copy.license = LicenseAlias.create(name: 'MIT')
-            old_copy.approval = Approval.create(state: false)
-            old_copy.save
-            gemspec.license = "other"
-          end
+          context "license changes to something other than 'other'" do
+            before do
+              old_copy.license = LicenseAlias.create(name: 'other')
+              old_copy.save
+              gemspec.license = "new license"
+            end
 
-          it "should not change the license" do
-            subject.license.name.should == 'MIT'
-          end
+            context "new license is whitelisted" do
+              before { LicenseFinder.config.stub(:whitelist).and_return [gemspec.license] }
+
+              it "should set the approval to true" do
+                subject.should be_approved
+              end
+            end
 
-          it "should not change the approval" do
-            subject.should_not be_approved
+            context "new license is not whitelisted" do
+              it "should set the approval to false" do
+                subject.should_not be_approved
+              end
+            end
           end
-        end
 
-        context "license does not change" do
-          before do
-            old_copy.license = LicenseAlias.create(name: 'MIT')
-            old_copy.approval = Approval.create(state: false)
-            old_copy.save
-            gemspec.license = "MIT"
+          context "license changes to unknown (i.e., 'other')" do
+            before do
+              old_copy.license = LicenseAlias.create(name: 'MIT')
+              old_copy.approval = Approval.create(state: false)
+              old_copy.save
+              gemspec.license = "other"
+            end
+
+            it "should not change the license" do
+              subject.license.name.should == 'MIT'
+            end
+
+            it "should not change the approval" do
+              subject.should_not be_approved
+            end
           end
 
-          it "should not change the license or approval" do
-            subject.should_not be_approved
-            subject.license.name.should == "MIT"
+          context "license does not change" do
+            let(:bundled_gem_saver) { described_class.find_or_create_by_name('spec_name', bundled_gem) }
+
+            before do
+              old_copy.license = LicenseAlias.create(name: 'MIT')
+              old_copy.approval = Approval.create(state: false)
+              old_copy.save
+              gemspec.license = "MIT"
+            end
+
+            it "should not change the license or approval" do
+              dependency = bundled_gem_saver.save
+              dependency.should_not be_approved
+              dependency.license.name.should == "MIT"
+            end
+
+            it "should not save the license" do
+              bundled_gem_saver.dependency.license.should_not_receive(:save)
+              bundled_gem_saver.save
+            end
           end
         end
       end

data/spec/lib/license_finder/cli_spec.rb

@@ -20,7 +20,7 @@ module LicenseFinder
           end
         end
 
-        it "has an -a option to approve the added dependency" do
+        it "has an --approve option to approve the added dependency" do
           DependencyManager.should_receive(:create_non_bundler).with("MIT", "js_dep", "1.2.3")
           DependencyManager.should_receive(:approve!).with("js_dep")
 
@@ -40,10 +40,48 @@ module LicenseFinder
       end
     end
 
+    describe Whitelist do
+      let(:config) { LicenseFinder.config }
+
+      describe "list" do
+        it "shows the whitelist of licenses" do
+          config.should_receive(:whitelist).and_return([])
+
+          silence_stdout do
+            subject.list
+          end
+        end
+      end
+
+      describe "add" do
+        it "adds the specified license to the whitelist" do
+          config.whitelist.should_receive(:push).with("test")
+          config.should_receive(:save)
+
+          silence_stdout do
+            subject.add("test")
+          end
+        end
+      end
+
+      describe "remove" do
+        it "removes the specified license from the whitelist" do
+          config.should_receive(:save)
+          config.whitelist.should_receive(:delete).with("test")
+
+          silence_stdout do
+            subject.remove("test")
+          end
+        end
+      end
+    end
+
     describe IgnoredBundlerGroups do
+      let(:config) { LicenseFinder.config }
+
       describe "list" do
         it "shows the ignored groups in the standard output" do
-          LicenseFinder.config.should_receive(:ignore_groups).and_return([])
+          config.should_receive(:ignore_groups).and_return([])
 
           silence_stdout do
             subject.list
@@ -53,7 +91,8 @@ module LicenseFinder
 
       describe "add" do
         it "adds the specified group to the ignored groups list" do
-          BundlerGroupManager.should_receive(:add_ignored_group).with("test")
+          config.ignore_groups.should_receive(:push).with("test")
+          config.should_receive(:save)
 
           silence_stdout do
             subject.add("test")
@@ -63,7 +102,8 @@ module LicenseFinder
 
       describe "remove" do
         it "removes the specified group from the ignored groups list" do
-          BundlerGroupManager.should_receive(:remove_ignored_group).with("test")
+          config.ignore_groups.should_receive(:delete).with("test")
+          config.should_receive(:save)
 
           silence_stdout do
             subject.remove("test")