license_finder 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 145e1e16abccb31283a36af7e17e267debf7311e
-  data.tar.gz: 30c980da2290161caf8be382f506aed979a31a8e
+  metadata.gz: 20f8ab76aa0c6a0b12a159a4e177648106c9cd7b
+  data.tar.gz: e4a0d2d69fd8cbaeea45c300b676daa6b2a5399b
 SHA512:
-  metadata.gz: 5041534cffb5b947d28b4280774a95a605350f67fde724643cb062141ed6141a79f6e395a5b909623640d4569cf1b2e2668caa27eb4e7629eda49d85767c65cc
-  data.tar.gz: 96b37486e8b5a22beeb4cec03a0f7d67394cb6ffd293c66b854647c883d4b854274ba2d0aed428533de88dc3da4077df10a8f917988fdf20d7e7f6b92811b28d
+  metadata.gz: 822abefcd6d88446a2d178890691ebd0e696cc3572be07d70ff809b1fce088cc2b5eea9b6bfda8e390400f78f8cf69567e702001707696e5d3c55e2c4bb7e175
+  data.tar.gz: 42f08fc6c49d0ff7a408864e5c5fb7d49ca8119d4ec7832c573a1ed6eb59d13f50d02874c30a4baa6e967fdf4de1d59287536a017d48d9c0db411cf62d33c4b1

data/CHANGELOG.rdoc

@@ -1,9 +1,17 @@
 === TBD
 
+* Features
+
+  * Can maintain whitelisted licenses from command line
+  * Improve New BSD license detection
+
+=== 0.8.2 / 2012-07-09
+
 * Features
 
   * Switch to thor for CLI, to support future additions to CLI
   * Restore ability to manage (add/remove) dependencies that Bundler can't find
+  * Can maintain ignored bundler groups from command line
 
 * Bugfixes
 

data/features/cli.feature

@@ -16,7 +16,7 @@ Feature: License Finder command line executable
 
   Scenario: Auditing an application with whitelisted licenses
     Given I have an app with license finder that depends on a MIT licensed gem
-    When I whitelist MIT and 'other' licenses
+    When I whitelist MIT and 'other' and New BSD licenses
     Then it should exit with status code 0
     And I should see all gems approved for use
 
@@ -24,3 +24,13 @@ Feature: License Finder command line executable
     Given I have a project that depends on mime-types with a manual license type
     When I run license_finder
     Then the mime-types license remains set with my manual license type
+
+  Scenario: Viewing help for license_finder subcommand
+    Given I have an app with license finder
+    When I run license_finder help on a specific command
+    Then I should see the correct subcommand usage instructions
+
+  Scenario: Viewing help for license_finder default
+    Given I have an app with license finder
+    When I run license_finder help
+    Then I should the correct default usage instructions

data/features/html_report.feature

@@ -19,5 +19,5 @@ Feature: HTML Report
 
   Scenario: Dependency summary
     And my app depends on MIT and GPL licensed gems
-    When I whitelist MIT and 'other' licenses
+    When I whitelist MIT and 'other' and New BSD licenses
     Then I should see only see GPL liceneses as unapproved in the html

data/features/ignore_bundle_groups.feature

@@ -3,8 +3,21 @@ Feature: Ignore Bundle Groups
   I want to ignore certain bundler groups
   So that any gems I use in development, or for testing, are automatically approved for use
 
-  Scenario:
+  Scenario: Bundler groups can be added to the ignore list
+    Given I have an app with license finder
+    And I add the test group to the ignored bundler groups
+    When I get the ignored groups
+    Then I should see the test group in the output
+
+  Scenario: Ignored bundler groups are not evaluated for licenses
     Given I have an app with license finder that depends on a GPL licensed gem in the test bundler group
-    And I ignore the test group
+    And I add the test group to the ignored bundler groups
     When I run license_finder
     Then I should not see the GPL licensed gem in the output
+
+  Scenario: Bundler groups can be removed from the ignore list
+    Given I have an app with license finder
+    And I add the test group to the ignored bundler groups
+    And I remove the test group from the ignored bundler groups
+    When I get the ignored groups
+    Then I should not see the test group in the output

data/features/step_definitions/approve_dependencies_steps.rb

@@ -8,7 +8,7 @@ When(/^I approve that gem$/) do
   @output = @user.execute_command "license_finder"
   @output.should include "gpl_gem"
   @output = @user.execute_command "license_finder approve gpl_gem"
-  @output = @user.execute_command "license_finder -q"
+  @output = @user.execute_command "license_finder --quiet"
 end
 
 Then(/^I should not see that gem in the console output$/) do

data/features/step_definitions/cli_steps.rb

@@ -17,11 +17,19 @@ Given(/^I have a project that depends on mime\-types with a manual license type$
   @user.create_rails_app
   @user.add_gem_dependency('mime-types')
   @user.bundle_app
-  @user.execute_command "license_finder -q"
+  @user.execute_command "license_finder --quiet"
   @output = @user.execute_command "license_finder license Ruby mime-types"
   @output.should =~ /mime-types.*Ruby/
 end
 
+When(/^I run license_finder help on a specific command$/) do
+  @output = @user.execute_command "license_finder dependencies help add"
+end
+
+When(/^I run license_finder help$/) do
+  @output = @user.execute_command "license_finder help"
+end
+
 Then(/^it creates a config directory with the license_finder config$/) do
   File.should be_exists(@user.app_path('config'))
   text = "---\nwhitelist:\n#- MIT\n#- Apache 2.0\nignore_groups:\n#- test\n#- development\ndependencies_file_dir: './doc/'\n"
@@ -43,3 +51,11 @@ end
 Then(/^the mime\-types license remains set with my manual license type$/) do
   @output.should =~ /mime-types.*Ruby/
 end
+
+Then(/^I should see the correct subcommand usage instructions$/) do
+  @output.should include 'license_finder dependencies add LICENSE'
+end
+
+Then(/^I should the correct default usage instructions$/) do
+  @output.should include 'license_finder help [COMMAND]'
+end

data/features/step_definitions/html_report_steps.rb

@@ -25,7 +25,7 @@ end
 
 When(/^I whitelist the MIT license$/) do
   @user.configure_license_finder_whitelist ["MIT"]
-  @user.execute_command "license_finder -q"
+  @user.execute_command "license_finder --quiet"
 end
 
 Then(/^I should see my specific gem details listed in the html$/) do

data/features/step_definitions/ignore_bundle_groups_steps.rb

@@ -4,10 +4,26 @@ Given(/^I have an app with license finder that depends on a GPL licensed gem in
   @user.add_dependency_to_app 'gpl_gem', :license => 'GPL', :bundler_groups => 'test'
 end
 
-And(/^I ignore the test group$/) do
-  @user.configure_license_finder_bundler_ignore_groups('test')
+When(/^I add the test group to the ignored bundler groups$/) do
+  @user.execute_command('license_finder ignored_bundler_group add test')
+end
+
+When(/^I remove the test group from the ignored bundler groups$/) do
+  @user.execute_command('license_finder ignored_bundler_group remove test')
+end
+
+When(/^I get the ignored groups$/) do
+  @output = @user.execute_command('license_finder ignored_bundler_group list')
 end
 
 Then(/^I should not see the GPL licensed gem in the output$/) do
   @output.should_not include 'gpl_gem'
 end
+
+Then(/^I should see the test group in the output$/) do
+  @output.should include 'test'
+end
+
+Then(/^I should not see the test group in the output$/) do
+  @output.should_not include 'test'
+end

data/features/step_definitions/non_bundler_steps.rb

@@ -9,7 +9,7 @@ When(/^I add my JS dependency$/) do
 end
 
 When(/^I add my JS dependency with an approval flag$/) do
-  @output = @user.execute_command 'license_finder dependencies add -a MIT my_js_dep 1.2.3'
+  @output = @user.execute_command 'license_finder dependencies add --approve MIT my_js_dep 1.2.3'
   @output.should == "The my_js_dep dependency has been added and approved!\n"
 end
 
@@ -18,16 +18,16 @@ When(/^I remove my JS dependency$/) do
 end
 
 Then(/^I should see the JS dependency in the console output$/) do
-  @output = @user.execute_command 'license_finder -q'
+  @output = @user.execute_command 'license_finder --quiet'
   @output.should include 'my_js_dep, 1.2.3, MIT'
 end
 
 Then(/^I should not see the JS dependency in the console output$/) do
-  @output = @user.execute_command 'license_finder -q'
+  @output = @user.execute_command 'license_finder --quiet'
   @output.should_not include 'my_js_dep, 1.2.3, MIT'
 end
 
 Then(/^I should not see the JS dependency in the console output since it is approved$/) do
-  @output = @user.execute_command 'license_finder -q'
+  @output = @user.execute_command 'license_finder --quiet'
   @output.should_not include 'my_js_dep, 1.2.3, MIT'
 end

data/features/step_definitions/rails_rake_steps.rb

@@ -4,7 +4,7 @@ Given /^I have a rails app(?:lication)? with license finder$/ do
 end
 
 When(/^I run rake license_finder$/) do
-  @output = @user.execute_command "rake license_finder -q"
+  @output = @user.execute_command "rake license_finder --quiet"
 end
 
 Then(/^I should see a normal output$/) do

data/features/step_definitions/set_license_steps.rb

@@ -6,9 +6,9 @@ Given(/^I have an app with license finder that depends on an other licensed gem$
 end
 
 When(/^I set that gems license to MIT from the command line$/) do
-  @output = @user.execute_command 'license_finder -q'
+  @output = @user.execute_command 'license_finder --quiet'
   @output = @user.execute_command 'license_finder license MIT other_gem'
-  @output = @user.execute_command 'license_finder -q'
+  @output = @user.execute_command 'license_finder --quiet'
 end
 
 Then(/^I should see that other gems license set to MIT$/) do

data/features/step_definitions/shared_steps.rb

@@ -11,12 +11,12 @@ Given(/^I have an app with license finder$/) do
 end
 
 When(/^I run license_finder$/) do
-  @output = @user.execute_command "license_finder -q"
+  @output = @user.execute_command "license_finder --quiet"
 end
 
-When(/^I whitelist MIT and 'other' licenses$/) do
-  @user.configure_license_finder_whitelist ["MIT","other"]
-  @output = @user.execute_command "license_finder -q"
+When(/^I whitelist MIT and 'other' and New BSD licenses$/) do
+  @user.configure_license_finder_whitelist ["MIT","other","New BSD"]
+  @output = @user.execute_command "license_finder --quiet"
 end
 
 module DSL
@@ -108,14 +108,6 @@ module DSL
       end
     end
 
-    def configure_license_finder_bundler_ignore_groups(ignored_groups=[])
-      ignored_groups = Array ignored_groups
-      FileUtils.mkdir_p(config_path)
-      File.open(File.join(config_path, "license_finder.yml"), "w") do |f|
-        f.write({'ignore_groups' => ignored_groups}.to_yaml)
-      end
-    end
-
     def execute_command(command)
       Bundler.with_clean_env do
         @output = `cd #{app_path} && bundle exec #{command}`

data/features/step_definitions/whitelist_steps.rb

@@ -4,11 +4,42 @@ Given(/^I have an app with license finder that depends on an MIT license$/) do
   @user.add_dependency_to_app 'mit_gem', :license => 'MIT'
 end
 
+Given(/^I have an app with license finder that depends on an BSD license$/) do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+  @user.add_dependency_to_app 'bsd_gem', :license => 'BSD'
+end
+
+When(/^I whitelist the BSD license$/) do
+  @user.execute_command 'license_finder whitelist add BSD'
+end
+
 When(/^I whitelist the Expat license$/) do
-  @user.configure_license_finder_whitelist ["Expat"]
-  @output = @user.execute_command 'license_finder -q'
+  @user.execute_command 'license_finder whitelist add Expat'
+end
+
+When(/^I view the whitelisted licenses$/) do
+  @output = @user.execute_command 'license_finder whitelist list'
+end
+
+When(/^I remove Expat from the whitelist$/) do
+  @output = @user.execute_command 'license_finder whitelist remove Expat'
 end
 
 Then(/^I should not see a MIT licensed gem unapproved$/) do
+  @output = @user.execute_command 'license_finder --quiet'
   @output.should_not include 'mit_gem'
 end
+
+Then(/^I should see Expat in the output$/) do
+  @output.should include 'Expat'
+end
+
+Then(/^I should not see Expat in the output$/) do
+  @output.should_not include 'Expat'
+end
+
+Then(/^I should not see a BSD licensed gem unapproved$/) do
+  @output = @user.execute_command 'license_finder --quiet'
+  @output.should_not include 'bsd_gem'
+end

data/features/whitelist.feature

@@ -3,7 +3,25 @@ Feature: Whitelist licenses
   I want to whitelist certain OSS licenses that my business has pre-approved
   So that any dependencies with those licenses do not show up as action items
 
-  Scenario: Whitelist with MIT License alternative name "Expat" should whitelist "MIT" licenses
+  Scenario: Adding a license to the whitelist
+    Given I have an app with license finder
+    When I whitelist the Expat license
+    And I view the whitelisted licenses
+    Then I should see Expat in the output
+
+  Scenario: Whitelisting the BSD License should approve BSD licensed dependencies
+    Given I have an app with license finder that depends on an BSD license
+    When I whitelist the BSD license
+    Then I should not see a BSD licensed gem unapproved
+
+  Scenario: Removing a license from the whitelist
+    Given I have an app with license finder
+    When I whitelist the Expat license
+    And I remove Expat from the whitelist
+    And I view the whitelisted licenses
+    Then I should not see Expat in the output
+
+  Scenario: Whitelist with MIT License aliased name "Expat" should whitelist "MIT" licenses
     Given I have an app with license finder that depends on an MIT license
     When I whitelist the Expat license
     Then I should not see a MIT licensed gem unapproved

data/lib/license_finder.rb

@@ -34,6 +34,10 @@ module LicenseFinder
     @config ||= Configuration.ensure_default
   end
 
+  def self.current_gems
+    @current_gems ||= Bundle.current_gems
+  end
+
   def self.load_rake_tasks
     load 'tasks/license_finder.rake'
   end

data/lib/license_finder/bundle.rb

@@ -1,3 +1,5 @@
+require "bundler"
+
 module LicenseFinder
   class Bundle
     attr_writer :ignore_groups
@@ -34,7 +36,7 @@ module LicenseFinder
     end
 
     def included_groups
-      definition.groups - ignore_groups
+      definition.groups - ignore_groups.map(&:to_sym)
     end
 
     def gemfile_path

data/lib/license_finder/bundled_gem.rb

@@ -42,7 +42,7 @@ module LicenseFinder
     end
 
     def save_as_dependency
-      BundledGemSaver.find_or_initialize_by_name(@spec.name, self).save
+      BundledGemSaver.find_or_create_by_name(@spec.name, self).save
     end
   end
 end

data/lib/license_finder/bundled_gem_saver.rb

@@ -4,7 +4,9 @@ module LicenseFinder
     def_delegators :spec, :name, :version, :summary, :description, :homepage
     def_delegators :bundled_gem, :bundler_dependency, :determine_license, :children
 
-    def self.find_or_initialize_by_name(name, bundled_gem)
+    attr_reader :dependency, :bundled_gem
+
+    def self.find_or_create_by_name(name, bundled_gem)
       dependency = Dependency.named(name)
       new(dependency, bundled_gem)
     end
@@ -26,19 +28,27 @@ module LicenseFinder
 
     private
 
-    attr_reader :dependency, :bundled_gem
-
     def spec
       bundled_gem.spec
     end
 
     def apply_dependency_definition
-      dependency.version = version.to_s
-      dependency.summary = summary
-      dependency.description = description
-      dependency.homepage = homepage
-      dependency.license ||= LicenseAlias.create(name: determine_license)
-      dependency.save
+      if values_have_changed?
+        dependency.version = version.to_s
+        dependency.summary = summary
+        dependency.description = description
+        dependency.homepage = homepage
+        dependency.license ||= LicenseAlias.create(name: determine_license)
+        dependency.save
+      end
+    end
+
+    def values_have_changed?
+      return dependency.version != version.to_s ||
+        dependency.summary != summary ||
+        dependency.description != description ||
+        dependency.homepage != homepage ||
+        dependency.license.name != determine_license
     end
 
     def refresh_bundler_groups
@@ -53,14 +63,27 @@ module LicenseFinder
     def refresh_children
       dependency.remove_all_children
       children.each do |child|
-        dependency.add_child Dependency.named(child)
+        if child_required?(child)
+          dependency.add_child Dependency.named(child)
+        end
       end
     end
 
+    def child_required?(child)
+      current_gem_names.include?(child)
+    end
+
+    def current_gem_names
+      @current_gem_names ||= LicenseFinder.current_gems.map { |gem| gem.name.split(" ")[0] }
+    end
+
     def apply_better_license
       if dependency.license && !dependency.license.manual && determine_license != 'other'
-        dependency.license.name = determine_license
-        dependency.license.save
+        new_name = determine_license
+        unless new_name == dependency.license.name
+          dependency.license.name = new_name
+          dependency.license.save
+        end
       end
     end
   end

data/lib/license_finder/cli.rb

@@ -19,8 +19,17 @@ module LicenseFinder
       end
     end
 
-    class Dependencies < Base
-      option :approve, type: :boolean, aliases: :a
+    # Thor fix for `license_finder <subcommand> help <action>`
+    class Subcommand < Base
+      # Hack to override the help message produced by Thor.
+      # https://github.com/wycats/thor/issues/261#issuecomment-16880836
+      def self.banner(command, namespace = nil, subcommand = nil)
+        "#{basename} #{name.split("::").last.downcase} #{command.usage}"
+      end
+    end
+
+    class Dependencies < Subcommand
+      option :approve, type: :boolean, desc: "Approve the added dependency"
       desc "add LICENSE DEPENDENCY_NAME [VERSION] [--approve]", "Add a dependency that is not managed by Bundler"
       def add(license, name, version = nil)
         die_on_error {
@@ -44,9 +53,69 @@ module LicenseFinder
       end
     end
 
+    class Whitelist < Subcommand
+      desc "list", "List all the whitelisted licenses"
+      def list
+        whitelist = LicenseFinder.config.whitelist
+
+        say "Whitelisted Licenses:", :blue
+        whitelist.each do |license|
+          say license
+        end
+      end
+
+      desc "add", "Add a license to the whitelist"
+      def add(license)
+        die_on_error {
+          LicenseFinder.config.whitelist.push(license)
+          LicenseFinder.config.save
+        }
+        say "Added #{license} to the license whitelist"
+      end
+
+      desc "remove", "Remove a license from the whitelist"
+      def remove(license)
+        die_on_error {
+          LicenseFinder.config.whitelist.delete(license)
+          LicenseFinder.config.save
+        }
+        say "Removed #{license} from the license whitelist"
+      end
+    end
+
+    class IgnoredBundlerGroups < Subcommand
+      desc "list", "List all the ignored bundler groups"
+      def list
+        ignored = LicenseFinder.config.ignore_groups
+
+        say "Ignored Bundler Groups:", :blue
+        ignored.each do |group|
+          say group
+        end
+      end
+
+      desc "add", "Add a bundler group to be ignored"
+      def add(group)
+        die_on_error {
+          LicenseFinder.config.ignore_groups.push(group)
+          LicenseFinder.config.save
+        }
+        say "Added #{group} to the ignored bundler groups"
+      end
+
+      desc "remove", "Remove a bundler group from the ignored bundler groups"
+      def remove(group)
+        die_on_error {
+          LicenseFinder.config.ignore_groups.delete(group)
+          LicenseFinder.config.save
+        }
+        say "Removed #{group} from the ignored bundler groups"
+      end
+    end
+
     class Main < Base
-      option :quiet, type: :boolean, aliases: :q
-      desc "rescan", "Find new dependencies."
+      option :quiet, type: :boolean, desc: "silences loading output"
+      desc "rescan", "Find new dependencies. (Default action)"
       def rescan
         die_on_error {
           spinner {
@@ -96,6 +165,8 @@ module LicenseFinder
       end
 
       subcommand "dependencies", Dependencies, "manage non-Bundler dependencies"
+      subcommand "ignored_bundler_groups", IgnoredBundlerGroups, "manage ignored bundler groups"
+      subcommand "whitelist", Whitelist, "manage whitelisted licenses"
 
       private