license_finder 3.0.4 → 3.1.1

data/lib/license_finder/cli.rb

@@ -4,10 +4,8 @@ module LicenseFinder
 end
 
 require 'license_finder/cli/patched_thor'
-
 require 'license_finder/cli/base'
 require 'license_finder/cli/makes_decisions'
-
 require 'license_finder/cli/whitelist'
 require 'license_finder/cli/blacklist'
 require 'license_finder/cli/dependencies'
@@ -16,5 +14,4 @@ require 'license_finder/cli/approvals'
 require 'license_finder/cli/ignored_groups'
 require 'license_finder/cli/ignored_dependencies'
 require 'license_finder/cli/project_name'
-
 require 'license_finder/cli/main'

data/lib/license_finder/cli/approvals.rb

@@ -5,16 +5,16 @@ module LicenseFinder
       include MakesDecisions
 
       auditable
-      desc "add DEPENDENCY...", "Approve one or more dependencies by name"
+      desc 'add DEPENDENCY...', 'Approve one or more dependencies by name'
       def add(*names)
         assert_some names
         modifying { names.each { |name| decisions.approve(name, txn) } }
 
-        say "The #{names.join(", ")} dependency has been approved!", :green
+        say "The #{names.join(', ')} dependency has been approved!", :green
       end
 
       auditable
-      desc "remove DEPENDENCY", "Unapprove a dependency"
+      desc 'remove DEPENDENCY', 'Unapprove a dependency'
       def remove(dep)
         modifying { decisions.unapprove(dep, txn) }
 

data/lib/license_finder/cli/base.rb

@@ -3,8 +3,10 @@ require 'thor'
 module LicenseFinder
   module CLI
     class Base < Thor
-      class_option :project_path, desc: "Path to the project. Defaults to current working directory."
-      class_option :decisions_file, desc: "Where decisions are saved. Defaults to doc/dependency_decisions.yml."
+      class_option :project_path,
+                   desc: 'Path to the project. Defaults to current working directory.'
+      class_option :decisions_file,
+                   desc: 'Where decisions are saved. Defaults to doc/dependency_decisions.yml.'
 
       no_commands do
         def decisions
@@ -21,7 +23,7 @@ module LicenseFinder
       end
 
       def fail(message)
-        say message and exit 1
+        say(message) && exit(1)
       end
 
       def license_finder_config
@@ -36,7 +38,10 @@ module LicenseFinder
           :pip_requirements_path,
           :rebar_command,
           :rebar_deps_dir,
-          :save
+          :mix_command,
+          :mix_deps_dir,
+          :save,
+          :prepare
         ).merge(
           logger: logger_config
         )
@@ -57,15 +62,13 @@ module LicenseFinder
       end
 
       def assert_some(things)
-        unless things.any?
-          raise ArgumentError, "wrong number of arguments (0 for 1+)", caller
-        end
+        raise ArgumentError, 'wrong number of arguments (0 for 1+)', caller unless things.any?
       end
 
       def extract_options(*keys)
         result = {}
         keys.each do |key|
-          result[key.to_sym] = options[key.to_s] if options.has_key? key.to_s
+          result[key.to_sym] = options[key.to_s] if options.key? key.to_s
         end
         result
       end

data/lib/license_finder/cli/blacklist.rb

@@ -4,26 +4,26 @@ module LicenseFinder
       extend Subcommand
       include MakesDecisions
 
-      desc "list", "List all the blacklisted licenses"
+      desc 'list', 'List all the blacklisted licenses'
       def list
-        say "Blacklisted Licenses:", :blue
-        say_each(decisions.blacklisted) { |license| license.name }
+        say 'Blacklisted Licenses:', :blue
+        say_each(decisions.blacklisted, &:name)
       end
 
       auditable
-      desc "add LICENSE...", "Add one or more licenses to the blacklist"
+      desc 'add LICENSE...', 'Add one or more licenses to the blacklist'
       def add(*licenses)
         assert_some licenses
         modifying { licenses.each { |l| decisions.blacklist(l, txn) } }
-        say "Added #{licenses.join(", ")} to the license blacklist"
+        say "Added #{licenses.join(', ')} to the license blacklist"
       end
 
       auditable
-      desc "remove LICENSE...", "Remove one or more licenses from the blacklist"
+      desc 'remove LICENSE...', 'Remove one or more licenses from the blacklist'
       def remove(*licenses)
         assert_some licenses
         modifying { licenses.each { |l| decisions.unblacklist(l, txn) } }
-        say "Removed #{licenses.join(", ")} from the license blacklist"
+        say "Removed #{licenses.join(', ')} from the license blacklist"
       end
     end
   end

data/lib/license_finder/cli/dependencies.rb

@@ -4,16 +4,16 @@ module LicenseFinder
       extend Subcommand
       include MakesDecisions
 
-      method_option :approve, type: :boolean, desc: "Approve the added dependency"
+      method_option :approve, type: :boolean, desc: 'Approve the added dependency'
       auditable
-      desc "add DEPENDENCY LICENSE [VERSION] [--approve]", "Add a dependency that is not managed by a package manager, optionally approving it at the same time"
+      desc 'add DEPENDENCY LICENSE [VERSION] [--approve]', 'Add a dependency that is not managed by a package manager, optionally approving it at the same time'
       def add(name, license, version = nil)
-        modifying {
+        modifying do
           decisions
             .add_package(name, version, txn)
             .license(name, license, txn)
           decisions.approve(name, txn) if options[:approve]
-        }
+        end
         if options[:approve]
           say "The #{name} dependency has been added and approved!", :green
         else
@@ -22,17 +22,17 @@ module LicenseFinder
       end
 
       auditable
-      desc "remove DEPENDENCY", "Remove a dependency that is not managed by a package manager"
+      desc 'remove DEPENDENCY', 'Remove a dependency that is not managed by a package manager'
       def remove(name)
         modifying { decisions.remove_package(name, txn) }
 
         say "The #{name} dependency has been removed.", :green
       end
 
-      desc "list", "List manually added dependencies"
+      desc 'list', 'List manually added dependencies'
       def list
-        say "Manually Added Dependencies:", :blue
-        say_each(decisions.packages) { |package| package.name }
+        say 'Manually Added Dependencies:', :blue
+        say_each(decisions.packages, &:name)
       end
     end
   end

data/lib/license_finder/cli/ignored_dependencies.rb

@@ -4,14 +4,14 @@ module LicenseFinder
       extend Subcommand
       include MakesDecisions
 
-      desc "list", "List all the ignored dependencies"
+      desc 'list', 'List all the ignored dependencies'
       def list
-        say "Ignored Dependencies:", :blue
+        say 'Ignored Dependencies:', :blue
         say_each(decisions.ignored)
       end
 
       auditable
-      desc "add DEPENDENCY", "Add a dependency to be ignored"
+      desc 'add DEPENDENCY', 'Add a dependency to be ignored'
       def add(dep)
         modifying { decisions.ignore(dep, txn) }
 
@@ -19,7 +19,7 @@ module LicenseFinder
       end
 
       auditable
-      desc "remove DEPENDENCY", "Remove a dependency from the ignored dependencies"
+      desc 'remove DEPENDENCY', 'Remove a dependency from the ignored dependencies'
       def remove(dep)
         modifying { decisions.heed(dep, txn) }
 

data/lib/license_finder/cli/ignored_groups.rb

@@ -4,14 +4,14 @@ module LicenseFinder
       extend Subcommand
       include MakesDecisions
 
-      desc "list", "List all the ignored groups"
+      desc 'list', 'List all the ignored groups'
       def list
-        say "Ignored Groups:", :blue
+        say 'Ignored Groups:', :blue
         say_each(decisions.ignored_groups)
       end
 
       auditable
-      desc "add GROUP", "Add a group to be ignored"
+      desc 'add GROUP', 'Add a group to be ignored'
       def add(group)
         modifying { decisions.ignore_group(group, txn) }
 
@@ -19,7 +19,7 @@ module LicenseFinder
       end
 
       auditable
-      desc "remove GROUP", "Remove a group from the ignored groups"
+      desc 'remove GROUP', 'Remove a group from the ignored groups'
       def remove(group)
         modifying { decisions.heed_group(group, txn) }
 

data/lib/license_finder/cli/licenses.rb

@@ -5,7 +5,7 @@ module LicenseFinder
       include MakesDecisions
 
       auditable
-      desc "add DEPENDENCY LICENSE", "Set a dependency's licenses, overwriting any license_finder has found"
+      desc 'add DEPENDENCY LICENSE', "Set a dependency's licenses, overwriting any license_finder has found"
       def add(name, license)
         modifying { decisions.license(name, license, txn) }
 
@@ -13,7 +13,7 @@ module LicenseFinder
       end
 
       auditable
-      desc "remove DEPENDENCY LICENSE", "Remove a manually set license"
+      desc 'remove DEPENDENCY LICENSE', 'Remove a manually set license'
       def remove(dep, lic)
         modifying { decisions.unlicense(dep, lic, txn) }
 

data/lib/license_finder/cli/main.rb

@@ -15,27 +15,44 @@ module LicenseFinder
         'html' => HtmlReport,
         'markdown' => MarkdownReport,
         'csv' => CsvReport
-      }
+      }.freeze
 
-      class_option :format, desc: "The desired output format.", default: 'text', enum: FORMATS.keys
+      class_option :format, desc: 'The desired output format.', default: 'text', enum: FORMATS.keys
       class_option :columns, type: :array, desc: "For text or CSV reports, which columns to print. Pick from: #{CsvReport::AVAILABLE_COLUMNS}", default: %w[name version licenses]
-      class_option :save, desc: "Save report to a file. Default: 'license_report.csv' in project root.", lazy_default: "license_report"
-      class_option :go_full_version, desc: "Whether dependency version should include full version. Only meaningful if used with a Go project. Defaults to false."
-      class_option :gradle_include_groups, desc: "Whether dependency name should include group id. Only meaningful if used with a Java/gradle project. Defaults to false."
-      class_option :gradle_command, desc: "Command to use when fetching gradle packages. Only meaningful if used with a Java/gradle project. Defaults to 'gradlew' / 'gradlew.bat' if the wrapper is present, otherwise to 'gradle'."
-      class_option :maven_include_groups, desc: "Whether dependency name should include group id. Only meaningful if used with a Java/maven project. Defaults to false."
-      class_option :maven_options, desc: "Maven options to append to command. Defaults to empty."
-      class_option :pip_requirements_path, desc: "Path to python requirements file. Defaults to requirements.txt."
+      class_option :save, desc: "Save report to a file. Default: 'license_report.csv' in project root.", lazy_default: 'license_report'
+      class_option :go_full_version, desc: 'Whether dependency version should include full version. Only meaningful if used with a Go project. Defaults to false.'
+      class_option :gradle_include_groups, desc: 'Whether dependency name should include group id. Only meaningful if used with a Java/gradle project. Defaults to false.'
+      class_option :gradle_command,
+                   desc: "Command to use when fetching gradle packages. Only meaningful if used with a Java/gradle project.
+                          Defaults to 'gradlew' / 'gradlew.bat' if the wrapper is present, otherwise to 'gradle'."
+      class_option :maven_include_groups, desc: 'Whether dependency name should include group id. Only meaningful if used with a Java/maven project. Defaults to false.'
+      class_option :maven_options, desc: 'Maven options to append to command. Defaults to empty.'
+      class_option :pip_requirements_path, desc: 'Path to python requirements file. Defaults to requirements.txt.'
       class_option :rebar_command, desc: "Command to use when fetching rebar packages. Only meaningful if used with a Erlang/rebar project. Defaults to 'rebar'."
       class_option :rebar_deps_dir, desc: "Path to rebar dependencies directory. Only meaningful if used with a Erlang/rebar project. Defaults to 'deps'."
-      class_option :subprojects, type: :array, desc: "Generate a single report for multiple sub-projects. Ex: --subprojects='path/to/project1', 'path/to/project2'"
-      class_option :recursive, desc: "Recursively runs License Finder on all sub-projects."
-
-      method_option :quiet, type: :boolean, desc: "silences progress report"
-      method_option :debug, type: :boolean, desc: "emit detailed info about what LicenseFinder is doing"
-      desc "action_items", "List unapproved dependencies (the default action for `license_finder`)"
+      class_option :mix_command, desc: "Command to use when fetching packages through Mix. Only meaningful if used with a Mix project (i.e., Elixir or Erlang). Defaults to 'mix'."
+      class_option :mix_deps_dir, desc: "Path to Mix dependencies directory. Only meaningful if used with a Mix project (i.e., Elixir or Erlang). Defaults to 'deps'."
+
+      # Method options which are shared between report and action_item
+      def self.shared_options
+        method_option :debug,
+                      aliases: '-d',
+                      type: :boolean,
+                      desc: 'Emit detailed info about what LicenseFinder is doing'
+
+        method_option :prepare,
+                      aliases: '-p',
+                      type: :boolean,
+                      desc: 'Prepares the project first for license_finder',
+                      default: false,
+                      required: false
+      end
 
+      desc 'action_items', 'List unapproved dependencies (the default action for `license_finder`)'
+      method_option :quiet, aliases: '-q', type: :boolean, desc: 'Silences progress report', required: false
+      shared_options
       def action_items
+        run_prepare_phase if prepare?
         any_packages = license_finder.any_packages?
         unapproved = license_finder.unapproved
         blacklisted = license_finder.blacklisted
@@ -44,21 +61,21 @@ module LicenseFinder
         say "\n"
 
         unless any_packages
-          say "No dependencies recognized!", :red
+          say 'No dependencies recognized!', :red
           exit 0
         end
 
         if unapproved.empty?
-          say "All dependencies are approved for use", :green
+          say 'All dependencies are approved for use', :green
         else
           unless blacklisted.empty?
-            say "Blacklisted dependencies:", :red
+            say 'Blacklisted dependencies:', :red
             say report_of(blacklisted)
           end
 
           other_unapproved = unapproved - blacklisted
           unless other_unapproved.empty?
-            say "Dependencies that need approval:", :yellow
+            say 'Dependencies that need approval:', :yellow
             say report_of(other_unapproved)
           end
 
@@ -68,31 +85,34 @@ module LicenseFinder
 
       default_task :action_items
 
-      desc "report", "Print a report of the project's dependencies to stdout"
+      desc 'report', "Print a report of the project's dependencies to stdout"
+      shared_options
+      method_option :recursive, aliases: '-r', type: :boolean, default: false,
+                                desc: 'Recursively runs License Finder on all sub-projects'
 
+      method_option :subprojects, aliases: '-s', type: :array,
+                                  desc: "Generate a single report for multiple sub-projects. Ex: --subprojects='path/to/project1', 'path/to/project2'"
       def report
         logger_config[:quiet] = true
-
-        subproject_paths = options[:subprojects] if subprojects?
-        subproject_paths = ProjectFinder.new(license_finder.config.project_path).find_projects if recursive?
+        subproject_paths = options[:subprojects]
+        subproject_paths = ProjectFinder.new(license_finder.config.project_path).find_projects if options[:recursive]
 
         if subproject_paths && !subproject_paths.empty?
           finder = LicenseAggregator.new(license_finder_config, subproject_paths)
           report = MergedReport.new(finder.dependencies, options)
         else
+          run_prepare_phase if prepare?
           report = report_of(license_finder.acknowledged)
         end
         save? ? save_report(report, options[:save]) : say(report)
       end
 
-      desc "version", "Print the version of LicenseFinder"
-
+      desc 'version', 'Print the version of LicenseFinder'
       def version
         puts LicenseFinder::VERSION
       end
 
-      desc "diff OLDFILE NEWFILE", "Command to view the differences between two generated reports (csv)."
-
+      desc 'diff OLDFILE NEWFILE', 'Command to view the differences between two generated reports (csv).'
       def diff(file1, file2)
         f1 = IO.read(file1)
         f2 = IO.read(file2)
@@ -100,14 +120,14 @@ module LicenseFinder
         save? ? save_report(report, options[:save]) : say(report)
       end
 
-      subcommand "dependencies", Dependencies, "Add or remove dependencies that your package managers are not aware of"
-      subcommand "licenses", Licenses, "Set a dependency's licenses, if the licenses found by license_finder are missing or wrong"
-      subcommand "approvals", Approvals, "Manually approve dependencies, even if their licenses are not whitelisted"
-      subcommand "ignored_groups", IgnoredGroups, "Exclude test and development dependencies from action items and reports"
-      subcommand "ignored_dependencies", IgnoredDependencies, "Exclude individual dependencies from action items and reports"
-      subcommand "whitelist", Whitelist, "Automatically approve any dependency that has a whitelisted license"
-      subcommand "blacklist", Blacklist, "Forbid approval of any dependency whose licenses are all blacklisted"
-      subcommand "project_name", ProjectName, "Set the project name, for display in reports"
+      subcommand 'dependencies', Dependencies, 'Add or remove dependencies that your package managers are not aware of'
+      subcommand 'licenses', Licenses, "Set a dependency's licenses, if the licenses found by license_finder are missing or wrong"
+      subcommand 'approvals', Approvals, 'Manually approve dependencies, even if their licenses are not whitelisted'
+      subcommand 'ignored_groups', IgnoredGroups, 'Exclude test and development dependencies from action items and reports'
+      subcommand 'ignored_dependencies', IgnoredDependencies, 'Exclude individual dependencies from action items and reports'
+      subcommand 'whitelist', Whitelist, 'Automatically approve any dependency that has a whitelisted license'
+      subcommand 'blacklist', Blacklist, 'Forbid approval of any dependency whose licenses are all blacklisted'
+      subcommand 'project_name', ProjectName, 'Set the project name, for display in reports'
 
       private
 
@@ -126,12 +146,12 @@ module LicenseFinder
         !!options[:save]
       end
 
-      def recursive?
-        !!options[:recursive]
+      def prepare?
+        options[:prepare]
       end
 
-      def subprojects?
-        !!options[:subprojects]
+      def run_prepare_phase
+        license_finder.prepare_projects
       end
     end
   end

data/lib/license_finder/cli/makes_decisions.rb

@@ -7,8 +7,8 @@ module LicenseFinder
 
       module ClassMethods
         def auditable
-          method_option :who, desc: "The person making this decision"
-          method_option :why, desc: "The reason for making this decision"
+          method_option :who, desc: 'The person making this decision'
+          method_option :why, desc: 'The reason for making this decision'
           method_option :version, desc: 'The version that will be approved'
         end
       end

data/lib/license_finder/cli/patched_thor.rb

@@ -3,7 +3,7 @@ module LicenseFinder
     module Rootcommand
       # Helper to auto-generate the documentation for a group of commands
       def subcommand(namespace, klass, namespace_description)
-        description = "#{namespace} [#{(klass.tasks.keys - ["help"]).join("|")}]"
+        description = "#{namespace} [#{(klass.tasks.keys - ['help']).join('|')}]"
         desc description, "#{namespace_description} - see `license_finder #{namespace} help` for more information"
         super namespace, klass
       end
@@ -13,20 +13,19 @@ module LicenseFinder
     module Subcommand
       # Hack to override the help message produced by Thor.
       # https://github.com/wycats/thor/issues/261#issuecomment-16880836
-      def banner(command, namespace = nil, subcommand = nil)
+      def banner(command, _namespace = nil, _subcommand = nil)
         "#{basename} #{underscore_name(name)} #{command.usage}"
       end
 
       protected
 
       def underscore_name(name)
-        underscored = name.split("::").last
-        underscored.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        underscored.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        underscored.tr!("-", "_")
+        underscored = name.split('::').last
+        underscored.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        underscored.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        underscored.tr!('-', '_')
         underscored.downcase
       end
     end
   end
 end
-