license_finder 4.0.2 → 5.0.0

data/lib/license_finder/cli/makes_decisions.rb

@@ -24,8 +24,9 @@ module LicenseFinder
         }
       end
 
-      def modifying(&block)
-        license_finder.modifying(&block)
+      def modifying
+        yield
+        decisions.save!(config.decisions_file_path)
       end
     end
   end

data/lib/license_finder/configuration.rb

@@ -19,6 +19,44 @@ module LicenseFinder
       true
     end
 
+    def mix_command
+      get(:mix_command) || 'mix'
+    end
+
+    def merge(other_hash)
+      dup_with other_hash
+    end
+
+    def rebar_deps_dir
+      path = get(:rebar_deps_dir) || 'deps'
+      project_path.join(path).expand_path
+    end
+
+    def mix_deps_dir
+      path = get(:mix_deps_dir) || 'deps'
+      project_path.join(path).expand_path
+    end
+
+    def decisions_file_path
+      path = File.join(project_path, 'doc/dependency_decisions.yml') unless project_path.nil?
+      path = get(:decisions_file) unless get(:decisions_file).nil?
+      path = 'doc/dependency_decisions.yml' if path.nil?
+      Pathname.new(path)
+    end
+
+    def log_directory
+      path = get(:log_directory) || 'lf_logs'
+      project_path.join(path).expand_path
+    end
+
+    def project_path
+      Pathname(path_prefix).expand_path
+    end
+
+    def logger_mode
+      get(:logger)
+    end
+
     def gradle_command
       get(:gradle_command)
     end
@@ -47,31 +85,41 @@ module LicenseFinder
       get(:rebar_command)
     end
 
-    def mix_command
-      get(:mix_command) || 'mix'
+    def prepare
+      get(:prepare) || prepare_no_fail
     end
 
-    def rebar_deps_dir
-      path = get(:rebar_deps_dir) || 'deps'
-      project_path.join(path).expand_path
+    def prepare_no_fail
+      get(:prepare_no_fail)
     end
 
-    def mix_deps_dir
-      path = get(:mix_deps_dir) || 'deps'
-      project_path.join(path).expand_path
+    def save_file
+      get(:save)
     end
 
-    def decisions_file_path
-      path = get(:decisions_file) || 'doc/dependency_decisions.yml'
-      project_path.join(path).expand_path
+    def aggregate_paths
+      get(:aggregate_paths)
     end
 
-    def project_path
-      Pathname(path_prefix).expand_path
+    def recursive
+      get(:recursive)
     end
 
-    def prepare
-      get(:prepare)
+    def format
+      get(:format)
+    end
+
+    def columns
+      get(:columns)
+    end
+
+    protected
+
+    attr_accessor :primary_config
+    def dup_with(other_hash)
+      dup.tap do |dup|
+        dup.primary_config.merge!(other_hash)
+      end
     end
 
     private
@@ -82,6 +130,11 @@ module LicenseFinder
       @primary_config[key.to_sym] || @saved_config[key.to_s]
     end
 
+    def initialize_copy(orig)
+      super
+      @primary_config = @primary_config.dup
+    end
+
     def path_prefix
       get(:project_path) || ''
     end

data/lib/license_finder/core.rb

@@ -6,7 +6,9 @@ require 'license_finder/license'
 require 'license_finder/configuration'
 require 'license_finder/package_manager'
 require 'license_finder/decisions'
+require 'license_finder/decisions_factory'
 require 'license_finder/decision_applier'
+require 'license_finder/scanner'
 
 module LicenseFinder
   # Coordinates setup
@@ -26,9 +28,10 @@ module LicenseFinder
     #   rebar_command: "rebar",
     #   rebar_deps_dir: "deps",
     # }
-    def initialize(options = {})
-      @logger = Logger.new(options.fetch(:logger, {}))
-      @config = Configuration.with_optional_saved_config(options)
+    def initialize(configuration)
+      @logger = Logger.new(configuration.logger_mode)
+      @config = configuration
+      @scanner = Scanner.new(options)
     end
 
     def modifying
@@ -48,11 +51,12 @@ module LicenseFinder
     end
 
     def decisions
-      @decisions ||= Decisions.fetch_saved(config.decisions_file_path)
+      @decisions ||= DecisionsFactory.decisions(config.decisions_file_path)
     end
 
     def prepare_projects
-      package_managers = PackageManager.active_package_managers options
+      clear_logs
+      package_managers = @scanner.active_package_managers
       package_managers.each do |manager|
         logger.debug manager.class, 'Running prepare on project'
         manager.prepare
@@ -74,13 +78,18 @@ module LicenseFinder
 
     def current_packages
       # lazy, do not move to `initialize`
-      PackageManager.active_packages options
+      @scanner.active_packages
+    end
+
+    def clear_logs
+      FileUtils.rmdir config.log_directory if File.directory? config.log_directory
     end
 
     def options
       {
         logger: logger,
         project_path: config.project_path,
+        log_directory: File.join(config.log_directory, project_name),
         ignored_groups: decisions.ignored_groups,
         go_full_version: config.go_full_version,
         gradle_command: config.gradle_command,
@@ -92,7 +101,8 @@ module LicenseFinder
         rebar_deps_dir: config.rebar_deps_dir,
         mix_command: config.mix_command,
         mix_deps_dir: config.mix_deps_dir,
-        prepare: config.prepare
+        prepare: config.prepare,
+        prepare_no_fail: config.prepare_no_fail
       }
     end
   end

data/lib/license_finder/decisions_factory.rb

@@ -0,0 +1,11 @@
+module LicenseFinder
+  class DecisionsFactory
+    @decisions = {}
+    class << self
+      def decisions(decisions_file_path)
+        @decisions[decisions_file_path] = Decisions.fetch_saved(decisions_file_path) if @decisions[decisions_file_path].nil?
+        @decisions[decisions_file_path]
+      end
+    end
+  end
+end

data/lib/license_finder/license/templates/SimplifiedBSD.txt

@@ -10,7 +10,7 @@ modification, are permitted provided that the following conditions are met:
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

data/lib/license_finder/license_aggregator.rb

@@ -1,7 +1,7 @@
 module LicenseFinder
   class LicenseAggregator
-    def initialize(license_finder_config, aggregate_paths)
-      @license_finder_config = license_finder_config
+    def initialize(config, aggregate_paths)
+      @config = config
       @aggregate_paths = aggregate_paths
     end
 
@@ -10,7 +10,10 @@ module LicenseFinder
     end
 
     def any_packages?
-      finders.map(&:any_packages?).reduce(:|)
+      finders.map do |finder|
+        finder.prepare_projects if @config.prepare
+        finder.any_packages?
+      end.reduce(:|)
     end
 
     def unapproved
@@ -26,10 +29,12 @@ module LicenseFinder
     def finders
       return @finders unless @finders.nil?
       @finders = if @aggregate_paths.nil?
-                   [LicenseFinder::Core.new(@license_finder_config)]
+                   [LicenseFinder::Core.new(@config)]
                  else
                    @aggregate_paths.map do |path|
-                     LicenseFinder::Core.new(@license_finder_config.merge(project_path: path))
+                     # Passing file paths as values instead of allowing them to evaluate in config
+                     LicenseFinder::Core.new(@config.merge(project_path: path,
+                                                           decisions_file: @config.decisions_file_path))
                    end
                  end
     end
@@ -37,7 +42,7 @@ module LicenseFinder
     def aggregate_packages
       return @packages unless @packages.nil?
       all_packages = finders.flat_map do |finder|
-        finder.prepare_projects if @license_finder_config[:prepare]
+        finder.prepare_projects if @config.prepare
         finder.acknowledged.map { |dep| MergedPackage.new(dep, [finder.project_path]) }
       end
       @packages = all_packages.group_by { |package| [package.name, package.version] }

data/lib/license_finder/logger.rb

@@ -8,13 +8,13 @@ module LicenseFinder
 
     attr_reader :mode
 
-    def initialize(options = {})
+    def initialize(mode = nil)
       @system_logger = ::Logger.new(STDOUT)
       @system_logger.formatter = proc do |_, _, _, msg|
         "#{msg}\n"
       end
 
-      self.mode = options[:mode] || MODE_INFO
+      self.mode = mode || MODE_INFO
     end
 
     [MODE_INFO, MODE_DEBUG].each do |level|

data/lib/license_finder/package.rb

@@ -1,5 +1,5 @@
-require 'license_finder/packages/licensing'
-require 'license_finder/packages/license_files'
+require 'license_finder/package_utils/licensing'
+require 'license_finder/package_utils/license_files'
 
 module LicenseFinder
   # Super-class that adapts data from different package management
@@ -20,6 +20,7 @@ module LicenseFinder
     def self.license_names_from_standard_spec(spec)
       licenses = spec['licenses'] || [spec['license']].compact
       licenses = [licenses] unless licenses.is_a?(Array)
+      licenses = licenses.flatten
       licenses.map do |license|
         if license.is_a? Hash
           license['type']
@@ -167,17 +168,18 @@ module LicenseFinder
 end
 
 require 'license_finder/packages/manual_package'
-require 'license_finder/package_managers/bower_package'
-require 'license_finder/package_managers/go_package'
-require 'license_finder/package_managers/bundler_package'
-require 'license_finder/package_managers/pip_package'
-require 'license_finder/package_managers/npm_package'
-require 'license_finder/package_managers/maven_package'
-require 'license_finder/package_managers/gradle_package'
-require 'license_finder/package_managers/cocoa_pods_package'
-require 'license_finder/package_managers/carthage_package'
-require 'license_finder/package_managers/rebar_package'
-require 'license_finder/package_managers/mix_package'
-require 'license_finder/package_managers/merged_package'
-require 'license_finder/package_managers/nuget_package'
-require 'license_finder/package_managers/conan_package'
+require 'license_finder/packages/bower_package'
+require 'license_finder/packages/go_package'
+require 'license_finder/packages/bundler_package'
+require 'license_finder/packages/pip_package'
+require 'license_finder/packages/npm_package'
+require 'license_finder/packages/maven_package'
+require 'license_finder/packages/gradle_package'
+require 'license_finder/packages/cocoa_pods_package'
+require 'license_finder/packages/carthage_package'
+require 'license_finder/packages/rebar_package'
+require 'license_finder/packages/mix_package'
+require 'license_finder/packages/merged_package'
+require 'license_finder/packages/nuget_package'
+require 'license_finder/packages/conan_package'
+require 'license_finder/packages/yarn_package'

data/lib/license_finder/package_manager.rb

@@ -17,39 +17,6 @@ module LicenseFinder
     include LicenseFinder::SharedHelpers
 
     class << self
-      def package_managers
-        [GoDep, GoWorkspace, Go15VendorExperiment, Glide, Gvt, Govendor, Dep, Bundler, NPM, Pip,
-         Yarn, Bower, Maven, Gradle, CocoaPods, Rebar, Nuget, Carthage, Mix, Conan]
-      end
-
-      def active_packages(options = { project_path: Pathname.new('') })
-        package_managers = active_package_managers(options)
-        installed_package_managers = package_managers.select { |pm| pm.class.installed?(options[:logger]) }
-        installed_package_managers.flat_map(&:current_packages_with_relations)
-      end
-
-      def active_package_managers(options = { project_path: Pathname.new('') })
-        logger = options[:logger]
-
-        active_pm_classes = []
-        package_managers.each do |pm_class|
-          active = pm_class.new(options).active?
-          if active
-            logger.info pm_class, 'is active', color: :green
-            active_pm_classes << pm_class
-          else
-            logger.debug pm_class, 'is not active', color: :red
-          end
-        end
-
-        if active_pm_classes.empty?
-          logger.info 'License Finder', 'No active and installed package managers found for project.', color: :red
-        end
-
-        active_pm_classes -= active_pm_classes.map(&:takes_priority_over)
-        active_pm_classes.map { |pm_class| pm_class.new(options) }
-      end
-
       def takes_priority_over
         nil
       end
@@ -78,9 +45,22 @@ module LicenseFinder
       end
     end
 
+    def self.command_exists?(command)
+      _stdout, _stderr, status =
+        if LicenseFinder::Platform.windows?
+          Cmd.run("where #{command}")
+        else
+          Cmd.run("which #{command}")
+        end
+
+      status.success?
+    end
+
     def initialize(options = {})
+      @prepare_no_fail = options[:prepare_no_fail]
       @logger       = options[:logger] || Core.default_logger
       @project_path = options[:project_path]
+      @log_directory = options[:log_directory]
     end
 
     def active?
@@ -94,15 +74,24 @@ module LicenseFinder
 
     def prepare
       if self.class.prepare_command
-        _stdout, _stderr, status = Cmd.run(self.class.prepare_command)
-        raise "Prepare command '#{self.class.prepare_command}' failed" unless status.success?
+        _stdout, stderr, status = Cmd.run(self.class.prepare_command)
+        unless status.success?
+          log_errors stderr
+          raise "Prepare command '#{self.class.prepare_command}' failed" unless @prepare_no_fail
+        end
       else
         logger.debug self.class, 'no prepare step provided', color: :red
       end
     end
 
     def current_packages_with_relations
-      packages = current_packages
+      begin
+        packages = current_packages
+      rescue StandardError => e
+        raise e unless @prepare_no_fail
+        packages = []
+      end
+
       packages.each do |parent|
         parent.children.each do |child_name|
           child = packages.detect { |child_package| child_package.name == child_name }
@@ -112,20 +101,24 @@ module LicenseFinder
       packages
     end
 
-    def self.command_exists?(command)
-      _stdout, _stderr, status =
-        if LicenseFinder::Platform.windows?
-          Cmd.run("where #{command}")
-        else
-          Cmd.run("which #{command}")
-        end
-
-      status.success?
-    end
-
     private
 
     attr_reader :logger, :project_path
+
+    def log_errors(stderr)
+      logger.info self.class.prepare_command, 'did not succeed.', color: :red
+      logger.info self.class.prepare_command, stderr, color: :red
+      log_to_file stderr
+    end
+
+    def log_to_file(contents)
+      FileUtils.mkdir_p @log_directory
+      log_file = File.join(@log_directory, "prepare_#{self.class.package_management_command || 'errors'}.log")
+      File.open(log_file, 'w') do |f|
+        f.write("Prepare command \"#{self.class.prepare_command}\" failed with:\n")
+        f.write("#{contents}\n\n")
+      end
+    end
   end
 end