license_finder 0.8.1 → 0.8.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 145e1e16abccb31283a36af7e17e267debf7311e
+  data.tar.gz: 30c980da2290161caf8be382f506aed979a31a8e
+SHA512:
+  metadata.gz: 5041534cffb5b947d28b4280774a95a605350f67fde724643cb062141ed6141a79f6e395a5b909623640d4569cf1b2e2668caa27eb4e7629eda49d85767c65cc
+  data.tar.gz: 96b37486e8b5a22beeb4cec03a0f7d67394cb6ffd293c66b854647c883d4b854274ba2d0aed428533de88dc3da4077df10a8f917988fdf20d7e7f6b92811b28d

data/.gitignore

@@ -10,3 +10,4 @@ doc/dependencies.*
 db/schema.rb
 config/
 .pairs
+*.swp

data/CHANGELOG.rdoc

@@ -1,8 +1,21 @@
+=== TBD
+
+* Features
+
+  * Switch to thor for CLI, to support future additions to CLI
+  * Restore ability to manage (add/remove) dependencies that Bundler can't find
+
+* Bugfixes
+
+  * Fix bug preventing manual approval of child dependencies (Issue #23)
+  * Fix issue with database URI when the absolute path to the database file
+    contains spaces.
+  * Upgrading from 0.7.2 no longer removes non-gem dependencies (Issue #20)
+
 === 0.8.1 / 2013-04-14
 
 * Features
 
-  * Add spinner to show that the binary is actually doing something.
   * JRuby version of the gem.
   * Official ruby 2.0 support.
   * CLI interface for moving dependencies.* files to `doc/`.

data/bin/license_finder

@@ -1,65 +1,5 @@
 #!/usr/bin/env ruby
 
 require 'license_finder'
-require 'optparse'
 
-module SpinnerStrategy
-  module Spin
-    def self.run
-      thread = Thread.new() {
-        wheel = '\|/-'
-        i = 0
-        while not LicenseFinder::CLI.class_variable_get("@@run_complete") do
-          print "\r ---------- #{wheel[i]} ----------"
-          i = (i + 1) % 4
-        end
-      }
-      yield
-      thread.join
-    end
-  end
-
-  module Noop
-    def self.run
-      yield
-    end
-  end
-end
-
-options = {}
-spinner = SpinnerStrategy::Spin
-skip = false
-
-OptionParser.new do |opts|
-  opts.banner = "Usage: license_finder [options] [dependency]"
-
-  opts.on("-a", "--approve", "Approve a gem by name.") do |gem_name|
-    options[:approve] = true
-  end
-
-  opts.on("-l", "--license [LICENSE]", "Update a gem's license.") do |license|
-    options[:license] = license
-  end
-
-  opts.on("-q", "--quiet") do
-    spinner = SpinnerStrategy::Noop
-  end
-
-  opts.on("-m", "--move") do
-    skip = true
-    `sed '$d' < config/license_finder.yml > tmp34567.txt`
-    `mv tmp34567.txt config/license_finder.yml`
-    `echo "dependencies_file_dir: './doc/'" >> config/license_finder.yml`
-    `mkdir doc`
-    `mv dependencies.* doc/`
-    puts "Congratulations, you have cleaned up your root directory!'"
-  end
-end.parse!
-
-unless options.empty?
-  options[:dependency] = ARGV.last
-end
-
-spinner.run {
-  LicenseFinder::CLI.execute!(options)
-} unless skip
+LicenseFinder::CLI::Main.start

data/db/migrate/201304181524_add_manual_to_dependencies.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:dependencies) do
+      add_column :manual, TrueClass # i.e., keep this dependency eternally
+    end
+  end
+end

data/features/non_bundler_dependencies.feature

@@ -0,0 +1,19 @@
+Feature: Tracking non-Bundler Dependencies
+  So that I can track JS and other dependencies not tracked by Bundler
+  As an application developer using license finder
+  I want to be able to manually manage non-Bundler dependencies
+
+  Scenario: Adding a non-Bundler dependency
+    Given I have an app with license finder
+    When I add my JS dependency
+    Then I should see the JS dependency in the console output
+
+  Scenario: Auto approving a non-Bundler dependency I add
+    Given I have an app with license finder
+    When I add my JS dependency with an approval flag
+    Then I should not see the JS dependency in the console output since it is approved
+
+  Scenario: Removing a non-Bundler dependency
+    Given I have an app with license finder and a JS dependency
+    When I remove my JS dependency
+    Then I should not see the JS dependency in the console output

data/features/step_definitions/approve_dependencies_steps.rb

@@ -7,7 +7,7 @@ end
 When(/^I approve that gem$/) do
   @output = @user.execute_command "license_finder"
   @output.should include "gpl_gem"
-  @output = @user.execute_command "license_finder -a gpl_gem"
+  @output = @user.execute_command "license_finder approve gpl_gem"
   @output = @user.execute_command "license_finder -q"
 end
 

data/features/step_definitions/cli_steps.rb

@@ -18,7 +18,7 @@ Given(/^I have a project that depends on mime\-types with a manual license type$
   @user.add_gem_dependency('mime-types')
   @user.bundle_app
   @user.execute_command "license_finder -q"
-  @output = @user.execute_command "license_finder -l Ruby mime-types"
+  @output = @user.execute_command "license_finder license Ruby mime-types"
   @output.should =~ /mime-types.*Ruby/
 end
 

data/features/step_definitions/html_report_steps.rb

@@ -1,8 +1,3 @@
-Given(/^I have an app with license finder$/) do
-  @user = ::DSL::User.new
-  @user.create_nonrails_app
-end
-
 Given(/^my app depends on a gem with specific details$/) do
   @gem_name = "mit_licensed_gem"
   @table = {
@@ -54,7 +49,7 @@ end
 Then(/^I should see only see GPL liceneses as unapproved in the html$/) do
   html = File.read(@user.dependencies_html_path)
   page = Capybara.string(html)
-  page.should have_content '8 total'
+  page.should have_content '9 total'
   page.should have_content '1 unapproved'
   page.should have_content '1 GPL'
 end

data/features/step_definitions/ignore_bundle_groups_steps.rb

@@ -5,7 +5,7 @@ Given(/^I have an app with license finder that depends on a GPL licensed gem in
 end
 
 And(/^I ignore the test group$/) do
-  @user.configure_license_finder_bundler_whitelist('test')
+  @user.configure_license_finder_bundler_ignore_groups('test')
 end
 
 Then(/^I should not see the GPL licensed gem in the output$/) do

data/features/step_definitions/non_bundler_steps.rb

@@ -0,0 +1,33 @@
+Given(/^I have an app with license finder and a JS dependency$/) do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+  @output = @user.execute_command 'license_finder dependencies add MIT my_js_dep 1.2.3'
+end
+
+When(/^I add my JS dependency$/) do
+  @output = @user.execute_command 'license_finder dependencies add MIT my_js_dep 1.2.3'
+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.should == "The my_js_dep dependency has been added and approved!\n"
+end
+
+When(/^I remove my JS dependency$/) do
+  @user.execute_command 'license_finder dependencies remove my_js_dep'
+end
+
+Then(/^I should see the JS dependency in the console output$/) do
+  @output = @user.execute_command 'license_finder -q'
+  @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.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.should_not include 'my_js_dep, 1.2.3, MIT'
+end

data/features/step_definitions/set_license_steps.rb

@@ -7,7 +7,7 @@ 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 -lq MIT other_gem'
+  @output = @user.execute_command 'license_finder license MIT other_gem'
   @output = @user.execute_command 'license_finder -q'
 end
 

data/features/step_definitions/shared_steps.rb

@@ -5,6 +5,11 @@ require 'capybara'
 
 ########## COMMON STEPS ##########
 
+Given(/^I have an app with license finder$/) do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+end
+
 When(/^I run license_finder$/) do
   @output = @user.execute_command "license_finder -q"
 end
@@ -103,11 +108,11 @@ module DSL
       end
     end
 
-    def configure_license_finder_bundler_whitelist(whitelisted_groups=[])
-      whitelisted_groups = Array whitelisted_groups
+    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' => whitelisted_groups}.to_yaml)
+        f.write({'ignore_groups' => ignored_groups}.to_yaml)
       end
     end
 

data/lib/license_finder.rb

@@ -5,32 +5,30 @@ require 'erb'
 module LicenseFinder
   ROOT_PATH = Pathname.new(__FILE__).dirname
 
-  DEPENDENCY_ATTRIBUTES = [
-    "name", "version", "license", "license_url", "approved", "notes",
-    "license_files", "bundler_groups", "summary",
-    "description", "homepage", "children", "parents", "manual"
-  ]
-
-  autoload :Bundle, 'license_finder/bundle'
-  autoload :BundledGem, 'license_finder/bundled_gem'
-  autoload :CLI, 'license_finder/cli'
-  autoload :Configuration, 'license_finder/configuration'
-  autoload :License, 'license_finder/license'
-  autoload :LicenseUrl, 'license_finder/license_url'
-  autoload :PossibleLicenseFile, 'license_finder/possible_license_file'
-  autoload :DependencyReport, 'license_finder/dependency_report'
-  autoload :HtmlReport, 'license_finder/html_report'
-  autoload :TextReport, 'license_finder/text_report'
-  autoload :Reporter, 'license_finder/reporter'
-  autoload :BundleSyncer, 'license_finder/bundle_syncer'
-  autoload :YmlToSql, 'license_finder/yml_to_sql'
-  autoload :Dependency, 'license_finder/tables/dependency'
-  autoload :Approval, 'license_finder/tables/approval'
-  autoload :LicenseAlias, 'license_finder/tables/license_alias'
+  Error = Class.new(StandardError)
+
+  autoload :Bundle,               'license_finder/bundle'
+  autoload :BundledGem,           'license_finder/bundled_gem'
+  autoload :BundledGemSaver,      'license_finder/bundled_gem_saver'
+  autoload :CLI,                  'license_finder/cli'
+  autoload :Configuration,        'license_finder/configuration'
+  autoload :DependencyManager,    'license_finder/dependency_manager'
+  autoload :License,              'license_finder/license'
+  autoload :LicenseUrl,           'license_finder/license_url'
+  autoload :Platform,             'license_finder/platform'
+  autoload :PossibleLicenseFile,  'license_finder/possible_license_file'
+  autoload :PossibleLicenseFiles, 'license_finder/possible_license_files'
+  autoload :YmlToSql,             'license_finder/yml_to_sql'
+
+  autoload :Approval,     'license_finder/tables/approval'
   autoload :BundlerGroup, 'license_finder/tables/bundler_group'
-  autoload :GemSaver, 'license_finder/gem_saver'
-  autoload :LicenseFiles, 'license_finder/license_files'
-  autoload :Platform, 'license_finder/platform'
+  autoload :Dependency,   'license_finder/tables/dependency'
+  autoload :LicenseAlias, 'license_finder/tables/license_alias'
+
+  autoload :DependencyReport, 'license_finder/reports/dependency_report'
+  autoload :HtmlReport,       'license_finder/reports/html_report'
+  autoload :Reporter,         'license_finder/reports/reporter'
+  autoload :TextReport,       'license_finder/reports/text_report'
 
   def self.config
     @config ||= Configuration.ensure_default

data/lib/license_finder/bundle.rb

@@ -2,8 +2,8 @@ module LicenseFinder
   class Bundle
     attr_writer :ignore_groups
 
-    def self.current_gem_dependencies(bundler_definition=nil)
-      new(bundler_definition).gems.map(&:save_or_merge)
+    def self.current_gems(bundler_definition=nil)
+      new(bundler_definition).gems
     end
 
     def initialize(bundler_definition=nil)

data/lib/license_finder/bundled_gem.rb

@@ -34,15 +34,15 @@ module LicenseFinder
     end
 
     def license_files
-      LicenseFiles.new(@spec.full_gem_path).files
+      PossibleLicenseFiles.new(@spec.full_gem_path).find
     end
 
     def sort_order
       dependency_name.downcase
     end
 
-    def save_or_merge
-      GemSaver.find_or_initialize_by_name(@spec.name, self).save
+    def save_as_dependency
+      BundledGemSaver.find_or_initialize_by_name(@spec.name, self).save
     end
   end
 end

data/lib/license_finder/{gem_saver.rb → bundled_gem_saver.rb}

@@ -1,13 +1,11 @@
 module LicenseFinder
-  class GemSaver
+  class BundledGemSaver
     extend Forwardable
     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)
-      dependency = Dependency.find_or_create(name: name) do |d|
-        d.approval = Approval.create
-      end
+      dependency = Dependency.named(name)
       new(dependency, bundled_gem)
     end
 
@@ -55,7 +53,7 @@ module LicenseFinder
     def refresh_children
       dependency.remove_all_children
       children.each do |child|
-        dependency.add_child Dependency.find_or_create(name: child.to_s)
+        dependency.add_child Dependency.named(child)
       end
     end
 

data/lib/license_finder/cli.rb

@@ -1,49 +1,126 @@
+require 'thor'
+
 module LicenseFinder
   module CLI
-    extend self
-
-    @@run_complete = false
-
-    def check_for_action_items
-      BundleSyncer.sync!
-      @@run_complete = true
-      generate_reports
+    class Base < Thor
+      def self.subcommand(namespace, klass, namespace_description)
+        description = "#{namespace} [#{(klass.tasks.keys - ["help"]).join("|")}]"
+        desc description, "#{namespace_description} - see `license_finder #{namespace} help` for more information"
+        super namespace, klass
+      end
 
-      unapproved = Dependency.unapproved
+      private
 
-      puts "\r" + " "*24
-      if unapproved.count == 0
-        puts "All gems are approved for use"
-      else
-        puts "Dependencies that need approval:"
-        puts TextReport.new(unapproved)
+      def die_on_error
+        yield
+      rescue LicenseFinder::Error => e
+        say e.message, :red
         exit 1
       end
     end
 
-    def execute!(options={})
-      if options.empty?
-        check_for_action_items
-      else
-        dependency = Dependency.first(name: options[:dependency])
-
-        @@run_complete = true
-        puts "\r" + " "*24
+    class Dependencies < Base
+      option :approve, type: :boolean, aliases: :a
+      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 {
+          DependencyManager.create_non_bundler(license, name, version)
+          DependencyManager.approve!(name) if options[:approve]
+        }
         if options[:approve]
-          dependency.approve!
-          puts "The #{dependency.name} has been approved!\n\n"
-        elsif options[:license]
-          dependency.set_license_manually options[:license]
-          puts "The #{dependency.name} has been marked as using #{options[:license]} license!\n\n"
+          say "The #{name} dependency has been added and approved!", :green
+        else
+          say "The #{name} dependency has been added!", :green
         end
+      end
+
+      desc "remove DEPENDENCY_NAME", "Remove a dependency that is not managed by Bundler"
+      def remove(name)
+        die_on_error {
+          DependencyManager.destroy_non_bundler(name)
+        }
 
-        generate_reports
+        say "The #{name} dependency has been removed.", :green
       end
     end
 
-    private
-    def generate_reports
-      Reporter.write_reports
+    class Main < Base
+      option :quiet, type: :boolean, aliases: :q
+      desc "rescan", "Find new dependencies."
+      def rescan
+        die_on_error {
+          spinner {
+            DependencyManager.sync_with_bundler
+          }
+        }
+
+        action_items
+      end
+      default_task :rescan
+
+      desc "approve DEPENDENCY_NAME", "Approve a dependency by name."
+      def approve(name)
+        die_on_error {
+          DependencyManager.approve!(name)
+        }
+
+        say "The #{name} dependency has been approved!", :green
+      end
+
+      desc "license LICENSE DEPENDENCY_NAME", "Update a dependency's license."
+      def license(license, name)
+        die_on_error {
+          DependencyManager.license!(name, license)
+        }
+
+        say "The #{name} dependency has been marked as using #{license} license!", :green
+      end
+
+      desc "move", "Move dependency.* files from root directory to doc/."
+      def move
+        Configuration.move!
+        say "Congratulations, you have cleaned up your root directory!'", :green
+      end
+
+      desc "action_items", "List unapproved dependencies"
+      def action_items
+        unapproved = Dependency.unapproved
+
+        if unapproved.empty?
+          say "All gems are approved for use", :green
+        else
+          say "Dependencies that need approval:", :red
+          say TextReport.new(unapproved)
+          exit 1
+        end
+      end
+
+      subcommand "dependencies", Dependencies, "manage non-Bundler dependencies"
+
+      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