license_finder 1.0.0.1 → 1.0.1

data/CHANGELOG.rdoc

@@ -1,4 +1,24 @@
-=== 1.0.0 / Unreleased
+=== 1.0.1 / 2014-05-28
+
+* Features
+
+  * For dependencies with multiple licenses, the dependency is listed as
+    'multiple licenses' along with the names of each license
+  * Added 'ignore_dependencies' config option to allow specific
+    dependencies to be excluded from reports.
+
+* Bugfixes
+
+  * Dependency reports generate when license_finder.yml updates
+  * Dependency reports generate when config is changed through the command line
+
+=== 1.0.0.1 / 2014-05-23
+
+* Bugfixes
+
+  * LicenseFinder detects its own license
+
+=== 1.0.0 / 2014-04-03
 
 * Features
 

data/features/configure_ignore_dependencies.feature

@@ -0,0 +1,16 @@
+Feature: Ignore Dependencies
+  As a developer
+  I want to ignore certain dependencies
+  To avoid noisy doc changes when there are safe dependencies with high version churn
+
+  Scenario: Select dependencies can be ignored
+    Given I have an app that depends on bundler
+    And I ignore the bundler dependency
+    When I get the ignored dependencies 
+    Then I should see 'bundler' in the output
+    And I should not see 'bundler' in the dependency docs
+
+  Scenario: Ignored dependencies do not appear in the unapproved list
+    Given I have an app that depends on bundler
+    When I ignore the bundler dependency
+    Then the bundler dependency is not listed as an action item

data/features/step_definitions/cli_steps.rb

@@ -22,7 +22,7 @@ end
 
 Then(/^it creates a config directory with the license_finder config$/) do
   @user.config_path.should be_exist
-  text = "---\nwhitelist:\n#- MIT\n#- Apache 2.0\nignore_groups:\n#- test\n#- development\ndependencies_file_dir: './doc/'\nproject_name: # project name\n"
+  text = "---\nwhitelist:\n#- MIT\n#- Apache 2.0\nignore_groups:\n#- test\n#- development\nignore_dependencies:\n#- bundler\ndependencies_file_dir: './doc/'\nproject_name: # project name\n"
   @user.config_file.read.should == text.gsub(/^\s+/, "")
 end
 

data/features/step_definitions/configure_ignore_dependencies.rb

@@ -0,0 +1,35 @@
+Given(/^I have an app that depends on bundler$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_gem 'bundler_faker', license: 'Whatever'
+  @user.depend_on_local_gem 'bundler_faker', groups: ['test', 'development', 'production']
+  @user.create_gem 'gpl_gem', license: 'GPL'
+  @user.depend_on_local_gem 'gpl_gem', groups: ['test']
+end
+
+Given(/^I ignore the bundler dependency$/) do
+  @user.execute_command('license_finder ignored_dependencies add bundler_faker')
+end
+
+When(/^I get the ignored dependencies$/) do
+  @user.execute_command('license_finder ignored_dependencies list')
+end
+
+Then(/^I should see 'bundler' in the output$/) do
+  expect(@user).to be_seeing 'bundler_faker'
+end
+
+Then(/^the bundler dependency is not listed as an action item$/) do
+  @user.execute_command('license_finder > /dev/null')
+  @user.execute_command('license_finder action_items')
+  expect(@user).not_to be_seeing 'bundler_faker'
+end
+
+Then(/^I should not see 'bundler' in the dependency docs$/)do
+  @user.execute_command('license_finder')
+  dependencies_csv_path =  @user.app_path.join('doc', 'dependencies.csv')
+  dependencies_csv = File.open(dependencies_csv_path, 'r')
+
+  expect(dependencies_csv.read).not_to match /bundler_faker/
+end
+

data/files/license_finder.yml

@@ -5,5 +5,7 @@ whitelist:
 ignore_groups:
 #- test
 #- development
+ignore_dependencies:
+#- bundler
 dependencies_file_dir: './doc/'
 project_name: # project name

data/lib/license_finder/cli.rb

@@ -11,12 +11,43 @@ module LicenseFinder
 
       private
 
+      def sync_with_spinner
+        die_on_error {
+          spinner {
+            DependencyManager.sync_with_package_managers
+          }
+        }
+      end
+
       def die_on_error
         yield
       rescue LicenseFinder::Error => e
         say e.message, :red
         exit 1
       end
+
+      def spinner
+        if options[:quiet]
+          yield
+        else
+          begin
+            thread = Thread.new {
+              wheel = '\|/-'
+              i = 0
+              while true do
+                print "\r ---------- #{wheel[i]} ----------"
+                i = (i + 1) % 4
+              end
+            }
+            yield
+          ensure
+            if thread
+              thread.kill
+              puts "\r" + " "*24
+            end
+          end
+        end
+      end
     end
 
     # Thor fix for `license_finder <subcommand> help <action>`
@@ -73,7 +104,7 @@ module LicenseFinder
           yield
 
           LicenseFinder.config.save
-          Reporter.write_reports
+          sync_with_spinner
         }
       end
     end
@@ -150,18 +181,52 @@ module LicenseFinder
       end
     end
 
+    class IgnoredDependencies < ConfigSubcommand
+      desc "list", "List all the ignored dependencies"
+      def list
+        ignored = LicenseFinder.config.ignore_dependencies
+
+        say "Ignored Dependencies:", :blue
+        if ignored.any?
+          ignored.each do |group|
+            say group
+          end
+        else
+          say '(none)'
+        end
+      end
+
+      desc "add DEPENDENCY", "Add a dependency to be ignored"
+      def add(group)
+        modifying {
+          LicenseFinder.config.ignore_dependencies.push(group)
+        }
+        say "Added #{group} to the ignored dependencies"
+      end
+
+      desc "remove DEPENDENCY", "Remove a dependency from the ignored dependencies"
+      def remove(group)
+        modifying {
+          LicenseFinder.config.ignore_dependencies.delete(group)
+        }
+        say "Removed #{group} from the ignored dependencies"
+      end
+    end
+
     class Main < Base
       method_option :quiet, type: :boolean, desc: "silences loading output"
       desc "rescan", "Find new dependencies. (Default action)"
       def rescan
-        die_on_error {
-          spinner {
-            DependencyManager.sync_with_package_managers
-          }
-        }
+        sync_with_spinner
+        show_results
+      end
 
+      desc "show_results", "Display ignored dependencies and action items"
+      def show_results
+        IgnoredDependencies.new.list
         action_items
       end
+
       default_task :rescan
 
       method_option :approver, desc: "The person granting the approval"
@@ -206,33 +271,10 @@ module LicenseFinder
 
       subcommand "dependencies", Dependencies, "Manually manage dependencies that your package managers are not aware of"
       subcommand "ignored_bundler_groups", IgnoredBundlerGroups, "Manage ignored Bundler groups"
+      subcommand "ignored_dependencies", IgnoredDependencies, "Manage ignored dependencies"
       subcommand "whitelist", Whitelist, "Manage whitelisted licenses"
       subcommand "project_name", ProjectName, "Manage the project name"
 
-      private
-
-      def spinner
-        if options[:quiet]
-          yield
-        else
-          begin
-            thread = Thread.new {
-              wheel = '\|/-'
-              i = 0
-              while true do
-                print "\r ---------- #{wheel[i]} ----------"
-                i = (i + 1) % 4
-              end
-            }
-            yield
-          ensure
-            if thread
-              thread.kill
-              puts "\r" + " "*24
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/license_finder/configuration.rb

@@ -7,6 +7,10 @@ module LicenseFinder
       prepare(Persistence.get)
     end
 
+    def last_modified
+      Persistence.last_modified
+    end
+
     def self.move!
       config = prepare(Persistence.get.merge('dependencies_file_dir' => './doc/'))
       config.save
@@ -24,11 +28,12 @@ module LicenseFinder
       result
     end
 
-    attr_accessor :whitelist, :ignore_groups, :artifacts, :project_name
+    attr_accessor :whitelist, :ignore_groups, :ignore_dependencies, :artifacts, :project_name
 
     def initialize(config)
       @whitelist     = Array(config['whitelist'])
       @ignore_groups = Array(config["ignore_groups"])
+      @ignore_dependencies = Array(config["ignore_dependencies"])
       @artifacts     = Artifacts.new(Pathname(config['dependencies_file_dir'] || './doc/'))
       @project_name  = config['project_name'] || determine_project_name
     end
@@ -43,6 +48,7 @@ module LicenseFinder
       {
         'whitelist' => whitelist.uniq,
         'ignore_groups' => ignore_groups.uniq,
+        'ignore_dependencies' => ignore_dependencies.uniq,
         'dependencies_file_dir' => artifacts.dir.to_s,
         'project_name' => project_name
       }
@@ -92,6 +98,12 @@ module LicenseFinder
       def legacy_text_file
         join("dependencies.txt")
       end
+
+      def last_refreshed
+        [database_file, text_file, detailed_text_file, html_file, markdown_file].map do |path|
+          File.mtime(path)
+        end.min
+      end
     end
 
     module Persistence
@@ -111,6 +123,10 @@ module LicenseFinder
         file.open('w') { |f| f.write(YAML.dump(hash)) }
       end
 
+      def last_modified
+        File.mtime(file)
+      end
+
       private
 
       def inited?

data/lib/license_finder/dependency_manager.rb

@@ -38,10 +38,9 @@ module LicenseFinder
       result = DB.transaction { yield }
       checksum_after = checksum
 
-      unless checksum_before == checksum_after
-        Reporter.write_reports
-      end
-      unless LicenseFinder.config.artifacts.html_file.exist?
+      database_changed = checksum_before != checksum_after
+
+      if database_changed || reports_do_not_exist || reports_are_stale
         Reporter.write_reports
       end
 
@@ -50,6 +49,14 @@ module LicenseFinder
 
     private # not really private, but it looks like it is!
 
+    def self.reports_do_not_exist
+      !(LicenseFinder.config.artifacts.html_file.exist?)
+    end
+
+    def self.reports_are_stale
+      LicenseFinder.config.last_modified > LicenseFinder.config.artifacts.last_refreshed
+    end
+
     def self.current_packages
       package_managers.select(&:active?).map(&:current_packages).flatten
     end

data/lib/license_finder/package.rb

@@ -24,32 +24,38 @@ module LicenseFinder
     private
 
     def determine_license
-      if one_license_from_spec?
-        licenses_from_spec.first
-      elsif no_licenses_from_spec? && one_license_from_files?
-        licenses_from_files.first
-      elsif multiple_licenses_from_spec_and_files?
-        multiple_licenses
+      if licenses_from_spec.any?
+        choose_license_from licenses_from_spec
+      elsif licenses_from_files.any?
+        choose_license_from licenses_from_files
       else
         default_license
       end
     end
 
-    def multiple_licenses_from_spec_and_files?
-      (licenses_from_spec+licenses_from_spec).uniq.size > 1
+    def choose_license_from licenses
+      if ( licenses.uniq.size > 1 )
+        License.find_by_name "multiple licenses: #{(licenses).map(&:name).uniq.join(', ')}"
+      else
+        licenses.first
+      end
     end
 
-    def one_license_from_spec?
-      licenses_from_spec.uniq.size == 1
-    end
+    # def multiple_licenses_from_spec_and_files?
+      # (licenses_from_spec+licenses_from_files).uniq.size > 1
+    # end
 
-    def one_license_from_files?
-      licenses_from_files.uniq.size == 1
-    end
+    # def one_license_from_spec?
+      # licenses_from_spec.uniq.size == 1
+    # end
 
-    def no_licenses_from_spec?
-      licenses_from_spec.uniq.size == 0
-    end
+    # def one_license_from_files?
+      # licenses_from_files.uniq.size == 1
+    # end
+
+    # def no_licenses_from_spec?
+      # licenses_from_spec.uniq.size == 0
+    # end
 
     def licenses_from_spec
       license_names_from_spec.map do |name|
@@ -66,7 +72,11 @@ module LicenseFinder
     end
 
     def multiple_licenses
-      License.find_by_name 'multiple licenses'
+      if ( licenses_from_spec.uniq.size > 1 )
+        License.find_by_name "multiple licenses: #{(licenses_from_spec).map(&:name).uniq.join(', ')}"
+      else 
+        License.find_by_name "multiple licenses: #{(licenses_from_files).map(&:name).uniq.join(', ')}"
+      end
     end
 
     def default_license

data/lib/license_finder/reports/reporter.rb

@@ -3,7 +3,7 @@ module LicenseFinder
     extend self
 
     def write_reports
-      dependencies = Dependency.all
+      dependencies = Dependency.acknowledged
       artifacts = LicenseFinder.config.artifacts
 
       write_file artifacts.text_file,          TextReport.of(dependencies)

data/lib/license_finder/tables/dependency.rb

@@ -26,7 +26,14 @@ module LicenseFinder
     end
 
     def self.unapproved
-      all.reject(&:approved?)
+      acknowledged.reject(&:approved?)
+    end
+
+    def self.acknowledged
+      ignored_dependencies = LicenseFinder.config.ignore_dependencies
+      all.reject do |dependency|
+        ignored_dependencies.include? dependency.name
+      end
     end
 
     def self.named(name)

data/lib/templates/html_report.erb

@@ -99,13 +99,13 @@
         <p><%= dependency.description %></p>
         <% if dependency.parents.any? -%>
           <dl>
-            <dt>Parents</dt>
+            <dt><%=dependency.name%> is required by:</dt>
             <dd><%= dependency.parents.map(&:name).join(", ") -%></dd>
           </dl>
         <% end -%>
         <% if dependency.children.any? -%>
           <dl>
-            <dt>Children</dt>
+            <dt><%=dependency.name%> relies on:</dt>
             <dd><%= dependency.children.map(&:name).join(", ") -%></dd>
           </dl>
         <% end -%>

data/license_finder.gemspec

@@ -3,8 +3,8 @@ require './lib/license_finder/platform'
 Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   s.name        = "license_finder"
-  s.version     = "1.0.0.1"
-  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "Trevor John", "David Tengdin", "William Ramsey"]
+  s.version     = "1.0.1"
+  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "Trevor John", "David Tengdin", "William Ramsey", "David Dening"]
   s.email       = ["commoncode@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
   s.summary     = "Audit the OSS licenses of your application's dependencies."