license_finder 1.1.1-java → 1.2-java

data/TODO.md

@@ -0,0 +1,28 @@
+
+# immediate
+
+- gradle and maven are broken
+  - [x] let's refactor `PossibleLicenseFiles` to accept a nil install_path
+  - [x] then remove `#licenses_from_files` from `{maven,gradle}_package.rb`
+  - [x] update docs in package.rb to reflect what our expectations are.
+- [x] commit the rest of the WIP
+
+
+# architecture
+
+- [x] package managers should use instance methods so we can inject things like loggers
+- [ ] are we sprinkling database logic around too much? see 23f4cae for related work.
+
+
+# renamings, etc.
+
+- [x] retitle the shared example "it conforms to interface required by PackageSaver"
+- [x] shared specs should go into a separate file(s)
+- [ ] classes under `package_managers` should be in a PackageManagers module
+- [ ] `license_names_from_standard_spec` should be the default instance method
+- [ ] #groups in some Packages, #included_groups etc. in others
+
+
+# docs
+
+- [ ] specify gradle version >= 1.8

data/bin/license_finder_pip.py

@@ -0,0 +1,18 @@
+#! /usr/bin/env python
+
+import json
+from pip.util import get_installed_distributions
+
+packages = []
+
+for dist in get_installed_distributions():
+    packages.append(
+        {
+            "name": dist.project_name,
+            "version": dist.version,
+            "location": dist.location,
+            "dependencies": map(lambda dependency: dependency.project_name, dist.requires())
+        }
+    )
+
+print json.dumps(packages)

data/db/migrate/201410031451_rename_dependency_license_name.rb

@@ -0,0 +1,6 @@
+Sequel.migration do
+  up do
+    rename_column :dependencies, :license_name, :license_names
+    run %Q{UPDATE dependencies SET license_names='["' || license_names || '"]'}
+  end
+end

data/features/multiple_licenses.feature

@@ -0,0 +1,9 @@
+Feature: Dependencies with multiple licenses
+  As a developer
+  I want multi-licensed dependencies to be approved if one license is whitelisted
+  So that any dependencies with those licenses do not show up as action items
+
+  Scenario: Depending on whitelisted licenses
+    Given I have an app that depends on BSD and GPL-2 licenses
+    When I whitelist the GPL-2 license
+    Then I should not see a BSD and GPL-2 licensed gem unapproved

data/features/step_definitions/cli_steps.rb

@@ -3,7 +3,7 @@ Given(/^I have an app that has no config directory$/) do
   @user.create_ruby_app
   path = @user.config_path
   path.rmtree if path.exist?
-  path.should_not be_exist
+  expect(path).to_not be_exist
 end
 
 Given(/^I have an app with an unapproved dependency$/) do
@@ -21,31 +21,31 @@ When(/^I run license_finder help$/) do
 end
 
 Then(/^it creates a config directory with the license_finder config$/) do
-  @user.config_path.should be_exist
+  expect(@user.config_path).to be_exist
   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\ngradle_command: # only meaningful if used with a Java/gradle project. Defaults to "gradle".\n|
-  @user.config_file.read.should == text.gsub(/^\s+/, "")
+  expect(@user.config_file.read).to eq(text.gsub(/^\s+/, ""))
 end
 
 Then /^it should exit with status code (\d)$/ do |status|
-  $?.exitstatus.should == status.to_i
+  expect($last_command_exit_status.exitstatus).to eq(status.to_i)
 end
 
 Then(/^should list my unapproved dependency in the output$/) do
-  @user.should be_seeing 'unapproved_gem'
+  expect(@user).to be_seeing 'unapproved_gem'
 end
 
 Then(/^I should see all dependencies approved for use$/) do
-  @user.should be_seeing 'All dependencies are approved for use'
+  expect(@user).to be_seeing 'All dependencies are approved for use'
 end
 
 Then(/^I should see the correct subcommand usage instructions$/) do
-  @user.should be_seeing 'license_finder ignored_bundler_groups add GROUP'
+  expect(@user).to be_seeing 'license_finder ignored_bundler_groups add GROUP'
 end
 
 Then(/^I should see the default usage instructions$/) do
-  @user.should be_seeing 'license_finder help [COMMAND]'
+  expect(@user).to be_seeing 'license_finder help [COMMAND]'
 end
 
 Then(/^I should see License Finder has the MIT license$/) do
-  @user.should be_seeing_something_like /license_finder.*MIT/
+  expect(@user).to be_seeing_something_like /license_finder.*MIT/
 end

data/features/step_definitions/cocoapod_steps.rb

@@ -4,5 +4,5 @@ Given(/^A Podfile with dependencies$/) do
 end
 
 Then(/^I should see a CocoaPods dependency with a license$/) do
-  @user.should be_seeing_line "ABTest, 0.0.5, MIT"
+  expect(@user).to be_seeing_line "ABTest, 0.0.5, MIT"
 end

data/features/step_definitions/configure_bundler_groups_steps.rb

@@ -18,13 +18,13 @@ When(/^I get the ignored groups$/) do
 end
 
 Then(/^I should not see the test gem in the output$/) do
-  @user.should_not be_seeing 'gpl_gem'
+  expect(@user).to_not be_seeing 'gpl_gem'
 end
 
 Then(/^I should see the test group in the output$/) do
-  @user.should be_seeing 'test'
+  expect(@user).to be_seeing 'test'
 end
 
 Then(/^I should not see the test group in the output$/) do
-  @user.should_not be_seeing 'test'
+  expect(@user).to_not be_seeing 'test'
 end

data/features/step_definitions/configure_whitelist_steps.rb

@@ -28,18 +28,18 @@ end
 
 Then(/^I should not see a MIT licensed gem unapproved$/) do
   @user.execute_command 'license_finder --quiet'
-  @user.should_not be_seeing 'mit_gem'
+  expect(@user).to_not be_seeing 'mit_gem'
 end
 
 Then(/^I should see Expat in the output$/) do
-  @user.should be_seeing 'Expat'
+  expect(@user).to be_seeing 'Expat'
 end
 
 Then(/^I should not see Expat in the output$/) do
-  @user.should_not be_seeing 'Expat'
+  expect(@user).to_not be_seeing 'Expat'
 end
 
 Then(/^I should not see a BSD licensed gem unapproved$/) do
   @user.execute_command 'license_finder --quiet'
-  @user.should_not be_seeing 'bsd_gem'
+  expect(@user).to_not be_seeing 'bsd_gem'
 end

data/features/step_definitions/gradle_steps.rb

@@ -4,5 +4,5 @@ Given(/^A build.gradle file with dependencies$/) do
 end
 
 Then(/^I should see a Gradle dependency with a license$/) do
-  @user.should be_seeing_line "junit, 4.11, Common Public License Version 1.0"
+  expect(@user).to be_seeing_line "junit, 4.11, Common Public License Version 1.0"
 end

data/features/step_definitions/manually_added_steps.rb

@@ -10,7 +10,7 @@ end
 
 When(/^I add my JS dependency with an approval flag$/) do
   @user.execute_command 'license_finder dependencies add --approve MIT my_js_dep 1.2.3'
-  @user.should be_seeing "The my_js_dep dependency has been added and approved"
+  expect(@user).to be_seeing "The my_js_dep dependency has been added and approved"
 end
 
 When(/^I remove my JS dependency$/) do
@@ -19,10 +19,10 @@ end
 
 Then(/^I should see the JS dependency in the console output$/) do
   @user.execute_command 'license_finder --quiet'
-  @user.should be_seeing 'my_js_dep, 1.2.3, MIT'
+  expect(@user).to be_seeing 'my_js_dep, 1.2.3, MIT'
 end
 
 Then(/^I should not see the JS dependency in the console output$/) do
   @user.execute_command 'license_finder --quiet'
-  @user.should_not be_seeing 'my_js_dep, 1.2.3, MIT'
+  expect(@user).to_not be_seeing 'my_js_dep, 1.2.3, MIT'
 end

data/features/step_definitions/manually_approved_steps.rb

@@ -6,19 +6,19 @@ end
 
 When(/^I approve that gem$/) do
   @user.execute_command "license_finder"
-  @user.should be_seeing "gpl_gem"
+  expect(@user).to be_seeing "gpl_gem"
   @user.execute_command "license_finder approve gpl_gem --approver 'Julian' --message 'We really need this'"
   @user.execute_command "license_finder --quiet"
 end
 
 Then(/^I should not see that gem in the console output$/) do
-  @user.should_not be_seeing "gpl_gem"
+  expect(@user).to_not be_seeing "gpl_gem"
 end
 
 Then(/^I should see that gem approved in dependencies\.html$/) do
   @user.in_gem_html("gpl_gem") do |gpl_gem|
-    gpl_gem[:class].split(' ').should include "approved"
-    gpl_gem.should have_content "Julian"
-    gpl_gem.should have_content "We really need this"
+    expect(gpl_gem[:class].split(' ')).to include "approved"
+    expect(gpl_gem).to have_content "Julian"
+    expect(gpl_gem).to have_content "We really need this"
   end
 end

data/features/step_definitions/manually_assigned_license_steps.rb

@@ -12,11 +12,11 @@ When(/^I set one gem's license to MIT from the command line$/) do
 end
 
 Then(/^I should see that gem's license set to MIT$/) do
-  @user.should be_seeing 'other_gem, 1.0, MIT'
+  expect(@user).to be_seeing 'other_gem, 1.0, MIT'
 end
 
 Then(/^I should see other gems have not changed their licenses$/) do
-  @user.should be_seeing 'control_gem, 1.0, other'
+  expect(@user).to be_seeing 'control_gem, 1.0, other'
 end
 
 Given(/^I have an app that depends on a manually licensed gem$/) do
@@ -25,10 +25,10 @@ Given(/^I have an app that depends on a manually licensed gem$/) do
   @user.create_and_depend_on_gem 'changed_gem', license: 'MIT'
   @user.execute_command "license_finder --quiet"
   @user.execute_command "license_finder license Ruby changed_gem"
-  @user.should be_seeing_something_like /changed_gem.*Ruby/
+  expect(@user).to be_seeing_something_like /changed_gem.*Ruby/
 end
 
 Then(/^the gem should keep its manually assigned license$/) do
-  @user.should be_seeing_something_like /changed_gem.*ruby/
+  expect(@user).to be_seeing_something_like /changed_gem.*ruby/
 end
 

data/features/step_definitions/maven_steps.rb

@@ -4,5 +4,5 @@ Given(/^A pom file with dependencies$/) do
 end
 
 Then(/^I should see a Maven dependency with a license$/) do
-  @user.should be_seeing_line "junit, 4.11, Common Public License Version 1.0"
+  expect(@user).to be_seeing_line "junit, 4.11, Common Public License Version 1.0"
 end

data/features/step_definitions/multiple_licenses_steps.rb

@@ -0,0 +1,14 @@
+Given(/^I have an app that depends on BSD and GPL-2 licenses$/) do
+  @user = ::DSL::User.new
+  @user.create_ruby_app
+  @user.create_and_depend_on_gem 'bsd_and_gpl2_gem', licenses: %w(BSD GPL-2)
+end
+
+When(/^I whitelist the GPL-2 license$/) do
+  @user.execute_command 'license_finder whitelist add GPL-2'
+end
+
+Then(/^I should not see a BSD and GPL-2 licensed gem unapproved$/) do
+  @user.execute_command 'license_finder --quiet'
+  expect(@user).to_not be_seeing 'bsd_and_gpl2_gem'
+end

data/features/step_definitions/node_steps.rb

@@ -4,5 +4,5 @@ Given(/^A package file with dependencies$/) do
 end
 
 Then(/^I should see a Node dependency with a license$/) do
-  @user.should be_seeing_line "http-server, 0.6.1, MIT"
+  expect(@user).to be_seeing_line "http-server, 0.6.1, MIT"
 end

data/features/step_definitions/python_steps.rb

@@ -4,5 +4,5 @@ Given(/^A requirements file with dependencies$/) do
 end
 
 Then(/^I should see a Python dependency with a license$/) do
-  @user.should be_seeing_line "argparse, 1.2.1, Python Software Foundation License"
+  expect(@user).to be_seeing_line "argparse, 1.2.1, Python Software Foundation License"
 end

data/features/step_definitions/report_csv_steps.rb

@@ -11,10 +11,10 @@ Given(/^I have a dependencies\.txt file$/) do
 end
 
 Then(/^I should see those version and license details in the dependencies\.csv file$/) do
-  @user.app_path("doc/dependencies.csv").read.should include "info_gem, 1.1.1, MIT"
+  expect(@user.app_path("doc/dependencies.csv").read).to include "info_gem, 1.1.1, MIT"
 end
 
 Then(/^I should see dependencies\.txt replaced by dependencies\.csv$/) do
-  @user.app_path("doc/dependencies.txt").should_not be_exist
-  @user.app_path("doc/dependencies.csv").should be_exist
+  expect(@user.app_path("doc/dependencies.txt")).to_not be_exist
+  expect(@user.app_path("doc/dependencies.csv")).to be_exist
 end

data/features/step_definitions/report_html_steps.rb

@@ -30,9 +30,9 @@ end
 
 Then(/^I should see my specific gem details listed in the html$/) do
   @user.in_gem_html(@gem_name) do |section|
-    section.find("a[href='#{@gem_homepage}']", text: @gem_name).should be
+    expect(section.find("a[href='#{@gem_homepage}']", text: @gem_name)).to be
     @table.values.each do |property_value|
-      section.should have_content property_value
+      expect(section).to have_content property_value
     end
   end
 end
@@ -47,14 +47,14 @@ end
 
 Then(/^I should see only see GPL liceneses as unapproved in the html$/) do
   @user.in_html do |page|
-    page.should have_content '1 GPL'
+    expect(page).to have_content '1 GPL'
     action_items = page.find('.action-items')
-    action_items.should have_content '(GPL)'
+    expect(action_items).to have_content '(GPL)'
   end
 end
 
 def is_html_status?(gem, approval)
   @user.in_gem_html(gem) do |gpl_gem|
-    gpl_gem[:class].split(' ').should include approval
+    expect(gpl_gem[:class].split(' ')).to include approval
   end
 end

data/features/step_definitions/shared_steps.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'pathname'
 require 'bundler'
 require 'capybara'
+require 'open3'
 
 ########## COMMON STEPS ##########
 
@@ -23,7 +24,7 @@ Then(/^I should see the project name (\w+) in the html$/) do |project_name|
   @user.in_html do |page|
     title = page.find("h1")
 
-    title.should have_content project_name
+    expect(title).to have_content project_name
   end
 end
 
@@ -171,7 +172,12 @@ module DSL
     private
 
     def gemspec_string(gem_name, options)
-      license = options.fetch(:license)
+      if options.has_key?(:license) && options.has_key?(:licenses)
+        raise "Can't specify both `license` and `licenses`"
+      end
+
+      license_key = ([:license, :licenses] & options.keys).first
+      license_value = options.fetch(license_key)
       summary = options.fetch(:summary, "")
       description = options.fetch(:description, "")
       version = options[:version] || "0.0.0"
@@ -183,7 +189,7 @@ module DSL
         s.version = "#{version}"
         s.author = "Cucumber"
         s.summary = "#{summary}"
-        s.license = "#{license}"
+        s.#{license_key} = #{license_value.inspect}
         s.description = "#{description}"
         s.homepage = "#{homepage}"
       end
@@ -224,7 +230,7 @@ module DSL
 
     def bundle_install
       ::Bundler.with_clean_env do
-        shell_out("bundle install --gemfile=#{app_path.join("Gemfile")} --path=#{sandbox_path.join("bundle")}")
+        shell_out("cd #{app_path} && bundle check || bundle install")
       end
     end
 
@@ -282,8 +288,19 @@ module DSL
     end
 
     def shell_out(command, allow_failures = false)
-      output = `#{command}`
-      raise RuntimeError.new("command failed #{command}") unless $?.success? || allow_failures
+      output = `#{command} 2>&1`
+      status = $?
+      unless status.success? || allow_failures
+        message_format = <<EOM
+Command failed: `%s`
+output: %s
+exit: %d
+EOM
+        message = sprintf message_format, command, output.chomp, status.exitstatus
+        raise RuntimeError.new(message)
+      end
+
+      $last_command_exit_status = status
       output
     end
   end

data/lib/license_finder.rb

@@ -4,10 +4,13 @@ require 'erb'
 
 module LicenseFinder
   ROOT_PATH = Pathname.new(__FILE__).dirname
+  BIN_PATH = ROOT_PATH.join("../bin")
 
   Error = Class.new(StandardError)
 
+  autoload :Logger,               'license_finder/logger'
   autoload :CLI,                  'license_finder/cli'
+  autoload :PackageManager,       'license_finder/package_manager'
   autoload :DependencyManager,    'license_finder/dependency_manager'
   autoload :PackageSaver,         'license_finder/package_saver'
   autoload :License,              'license_finder/license'

data/lib/license_finder/cli.rb

@@ -11,11 +11,10 @@ module LicenseFinder
 
       private
 
-      def sync_with_spinner
+      def sync_with_package_managers options={}
         die_on_error {
-          spinner {
-            DependencyManager.sync_with_package_managers
-          }
+          logger = LicenseFinder::Logger.new options
+          DependencyManager.new(logger: logger).sync_with_package_managers
         }
       end
 
@@ -25,29 +24,6 @@ module LicenseFinder
         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>`
@@ -76,8 +52,10 @@ module LicenseFinder
       desc "add LICENSE DEPENDENCY_NAME [VERSION] [--approve] [--approver APPROVER_NAME] [--message APPROVAL_MESSAGE]", "Add a dependency that is not managed by a package manager, optionally storing who approved the dependency and why"
       def add(license, name, version = nil)
         die_on_error {
-          DependencyManager.manually_add(license, name, version)
-          DependencyManager.approve!(name, options[:approver], options[:message]) if options[:approve]
+          DependencyManager.new.tap do |dependency_manager|
+            dependency_manager.manually_add(license, name, version)
+            dependency_manager.approve!(name, options[:approver], options[:message]) if options[:approve]
+          end
         }
         if options[:approve]
           say "The #{name} dependency has been added and approved!", :green
@@ -89,7 +67,7 @@ module LicenseFinder
       desc "remove DEPENDENCY_NAME", "Remove a dependency that is not managed by a package manager"
       def remove(name)
         die_on_error {
-          DependencyManager.manually_remove(name)
+          DependencyManager.new.manually_remove(name)
         }
 
         say "The #{name} dependency has been removed.", :green
@@ -104,7 +82,7 @@ module LicenseFinder
           yield
 
           LicenseFinder.config.save
-          sync_with_spinner
+          sync_with_package_managers
         }
       end
     end
@@ -215,9 +193,10 @@ module LicenseFinder
 
     class Main < Base
       method_option :quiet, type: :boolean, desc: "silences loading output"
+      method_option :debug, type: :boolean, desc: "emit detailed info about what LicenseFinder is doing"
       desc "rescan", "Find new dependencies. (Default action)"
       def rescan
-        sync_with_spinner
+        sync_with_package_managers options
         show_results
       end
 
@@ -235,7 +214,7 @@ module LicenseFinder
       def approve(name, *other_names)
         names = other_names.unshift name
         die_on_error {
-          names.each { |name| DependencyManager.approve!(name, options[:approver], options[:message]) }
+          names.each { |name| DependencyManager.new.approve!(name, options[:approver], options[:message]) }
         }
 
         say "The #{names.join(", ")} dependency has been approved!", :green
@@ -244,7 +223,7 @@ module LicenseFinder
       desc "license LICENSE DEPENDENCY_NAME", "Update a dependency's license"
       def license(license, name)
         die_on_error {
-          DependencyManager.license!(name, license)
+          DependencyManager.new.license!(name, license)
         }
 
         say "The #{name} dependency has been marked as using #{license} license!", :green