licensed 2.15.2 → 3.2.0

data/lib/licensed/commands/status.rb

@@ -15,22 +15,17 @@ module Licensed
 
       protected
 
-      # Run the command for all enumerated dependencies found in a dependency source,
-      # recording results in a report.
-      # Enumerating dependencies in the source is skipped if a :sources option
-      # is provided and the evaluated `source.class.type` is not in the :sources values
+      # Run the comand and set an error message to review the documentation
+      # when any errors have been reported
       #
-      # app - The application configuration for the source
-      # source - A dependency source enumerator
+      # report - A Licensed::Report object for this command
       #
-      # Returns whether the command succeeded for the dependency source enumerator
-      def run_source(app, source)
-        super do |report|
-          next if Array(options[:sources]).empty?
-          next if options[:sources].include?(source.class.type)
-
-          report.warnings << "skipped source"
-          :skip
+      # Returns whether the command succeeded based on the call to super
+      def run_command(report)
+        super do |result|
+          next if result
+
+          report.errors << "Licensed found errors during source enumeration.  Please see https://github.com/github/licensed/tree/master/docs/commands/status.md#status-errors-and-resolutions for possible resolutions."
         end
       end
 
@@ -47,11 +42,14 @@ module Licensed
       def evaluate_dependency(app, source, dependency, report)
         filename = app.cache_path.join(source.class.type, "#{dependency.name}.#{DependencyRecord::EXTENSION}")
         report["filename"] = filename
+        report["version"] = dependency.version
 
         cached_record = cached_record(filename)
         if cached_record.nil?
+          report["license"] = nil
           report.errors << "cached dependency record not found"
         else
+          report["license"] = cached_record["license"]
           report.errors << "cached dependency record out of date" if cached_record["version"] != dependency.version
           report.errors << "missing license text" if cached_record.licenses.empty?
           if cached_record["review_changed_license"]
@@ -61,7 +59,7 @@ module Licensed
           end
         end
 
-        report.errors.empty?
+        report["allowed"] = report.errors.empty?
       end
 
       # Returns true if a cached record needs further review based on the

data/lib/licensed/configuration.rb

@@ -3,9 +3,14 @@ require "pathname"
 
 module Licensed
   class AppConfiguration < Hash
+    DIRECTORY_NAME_GENERATOR_KEY = "directory_name".freeze
+    RELATIVE_PATH_GENERATOR_KEY = "relative_path".freeze
+    DEFAULT_RELATIVE_PATH_NAME_SEPARATOR = "-".freeze
+    ALL_NAME_GENERATOR_KEYS = [DIRECTORY_NAME_GENERATOR_KEY, RELATIVE_PATH_GENERATOR_KEY].freeze
+
     DEFAULT_CACHE_PATH = ".licenses".freeze
 
-    # Returns the root for a configuration in following order of precendence:
+    # Returns the root for a configuration in following order of precedence:
     # 1. explicitly configured "root" property
     # 2. a found git repository root
     # 3. the current directory
@@ -28,9 +33,9 @@ module Licensed
       self["ignored"] ||= {}
       self["allowed"] ||= []
       self["root"] = AppConfiguration.root_for(self)
-      # defaults to the directory name of the source path if not set
-      self["name"] ||= File.basename(self["source_path"])
-      # setting the cache path might need a valid app name
+      self["name"] = generate_app_name
+      # setting the cache path might need a valid app name.
+      # this must come after setting self["name"]
       self["cache_path"] = detect_cache_path(options, inherited_options)
     end
 
@@ -105,8 +110,9 @@ module Licensed
 
     # Returns the cache path for the application based on:
     # 1. An explicitly set cache path for the application, if set
-    # 2. An inherited root cache path joined with the app name
-    # 3. The default cache path joined with the app name
+    # 2. An inherited shared cache path
+    # 3. An inherited cache path joined with the app name if not shared
+    # 4. The default cache path joined with the app name
     def detect_cache_path(options, inherited_options)
       return options["cache_path"] unless options["cache_path"].to_s.empty?
 
@@ -124,6 +130,65 @@ module Licensed
       raise Licensed::Configuration::LoadError,
         "App #{self["name"]} is missing required property #{property}"
     end
+
+    # Returns a name for the application as one of:
+    # 1. An explicitly configured app name, if set
+    # 2. A generated app name based on an configured "name" options hash
+    # 3. A default value - the source_path directory name
+    def generate_app_name
+      # use default_app_name if a name value is not set
+      return source_path_directory_app_name if self["name"].to_s.empty?
+      # keep the same name value unless a hash is given with naming options
+      return self["name"] unless self["name"].is_a?(Hash)
+
+      generator = self.dig("name", "generator")
+      case generator
+      when nil, DIRECTORY_NAME_GENERATOR_KEY
+        source_path_directory_app_name
+      when RELATIVE_PATH_GENERATOR_KEY
+        relative_path_app_name
+      else
+        raise Licensed::Configuration::LoadError,
+          "Invalid value configured for name.generator: #{generator}.  Value must be one of #{ALL_NAME_GENERATOR_KEYS.join(",")}"
+      end
+    end
+
+    # Returns an app name from the directory name of the configured source path
+    def source_path_directory_app_name
+      File.basename(self["source_path"])
+    end
+
+    # Returns an app name from the relative path from the configured app root
+    # to the configured app source path.
+    def relative_path_app_name
+      source_path_parts = File.expand_path(self["source_path"]).split("/")
+      root_path_parts = File.expand_path(self["root"]).split("/")
+
+      # if the source path is equivalent to the root path,
+      # return the root directory name
+      return root_path_parts[-1] if source_path_parts == root_path_parts
+
+      if source_path_parts[0..root_path_parts.size-1] != root_path_parts
+        raise Licensed::Configuration::LoadError,
+          "source_path must be a descendent of the app root to generate an app name from the relative source_path"
+      end
+
+      name_parts = source_path_parts[root_path_parts.size..-1]
+
+      separator = self.dig("name", "separator") || DEFAULT_RELATIVE_PATH_NAME_SEPARATOR
+      depth = self.dig("name", "depth") || 0
+      if depth < 0
+        raise Licensed::Configuration::LoadError, "name.depth configuration value cannot be less than -1"
+      end
+
+      # offset the depth value by -1 to work as an offset from the end of the array
+      # 0 becomes -1, with a start index of (-1 - -1) = 0, or the full array
+      # 1 becomes 0, with a start index of (-1 - 0) = -1, or only the last element
+      # and so on...
+      depth = depth - 1
+      start_index = depth >= name_parts.length ? 0 : -1 - depth
+      name_parts[start_index..-1].join(separator)
+    end
   end
 
   class Configuration
@@ -151,6 +216,11 @@ module Licensed
     def initialize(options = {})
       apps = options.delete("apps") || []
       apps << default_options.merge(options) if apps.empty?
+
+      # apply a root setting to all app configurations so that it's available
+      # when expanding app source paths
+      apps.each { |app| app["root"] ||= options["root"] if options["root"] }
+
       apps = apps.flat_map { |app| self.class.expand_app_source_path(app) }
       @apps = apps.map { |app| AppConfiguration.new(app, options) }
     end
@@ -158,25 +228,48 @@ module Licensed
     private
 
     def self.expand_app_source_path(app_config)
-      return app_config if app_config["source_path"].to_s.empty?
+      # map a source_path configuration value to an array of non-empty values
+      source_path_array = Array(app_config["source_path"])
+                            .reject { |path| path.to_s.empty? }
+                            .compact
+      app_root = AppConfiguration.root_for(app_config)
+      return app_config.merge("source_path" => app_root) if source_path_array.empty?
 
       # check if the source path maps to an existing directory
-      source_path = File.expand_path(app_config["source_path"], AppConfiguration.root_for(app_config))
-      return app_config if Dir.exist?(source_path)
+      if source_path_array.length == 1
+        source_path = File.expand_path(source_path_array[0], app_root)
+        return app_config.merge("source_path" => source_path) if Dir.exist?(source_path)
+      end
 
       # try to expand the source path for glob patterns
-      expanded_source_paths = Dir.glob(source_path).select { |p| File.directory?(p) }
+      expanded_source_paths = source_path_array.reduce(Set.new) do |matched_paths, pattern|
+        current_matched_paths = if pattern.start_with?("!")
+          # if the pattern is an exclusion, remove all matching files
+          # from the result
+          matched_paths - Dir.glob(pattern[1..-1])
+        else
+          # if the pattern is an inclusion, add all matching files
+          # to the result
+          matched_paths + Dir.glob(pattern)
+        end
+
+        current_matched_paths.select { |p| File.directory?(p) }
+      end
+
       configs = expanded_source_paths.map { |path| app_config.merge("source_path" => path) }
 
       # if no directories are found for the source path, return the original config
-      return app_config if configs.size == 0
+      if configs.size == 0
+        app_config["source_path"] = app_root if app_config["source_path"].is_a?(Array)
+        return app_config
+      end
 
       # update configured values for name and cache_path for uniqueness.
       # this is only needed when values are explicitly set, AppConfiguration
       # will handle configurations that don't have these explicitly set
       configs.each do |config|
         dir_name = File.basename(config["source_path"])
-        config["name"] = "#{config["name"]}-#{dir_name}" if config["name"]
+        config["name"] = "#{config["name"]}-#{dir_name}" if config["name"].is_a?(String)
 
         # if a cache_path is set and is not marked as shared, append the app name
         # to the end of the cache path to make a unique cache path for the app

data/lib/licensed/report.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Licensed
+  class Report < Hash
+    attr_reader :name
+    attr_reader :target
+    def initialize(name:, target:)
+      super()
+      @name = name
+      @target = target
+    end
+
+    def reports
+      @reports ||= []
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def warnings
+      @warnings ||= []
+    end
+
+    def all_reports
+      result = []
+      result << self
+      result.push(*reports.flat_map(&:all_reports))
+    end
+
+    # Returns the data from the report as a hash
+    def to_h
+      # add name, errors and warnings if they have real data
+      output = {}
+      output["name"] = name unless name.to_s.empty?
+      output["errors"] = errors.dup if errors.any?
+      output["warnings"] = warnings.dup if warnings.any?
+
+      # merge the hash data from the report.  command-specified data always
+      # overwrites local data
+      output.merge(super)
+    end
+  end
+end

data/lib/licensed/reporters/cache_reporter.rb

@@ -2,89 +2,73 @@
 module Licensed
   module Reporters
     class CacheReporter < Reporter
-      # Reports on an application configuration in a cache command run
+      # Reports the start of caching records for an app
       #
       # app - An application configuration
-      #
-      # Returns the result of the yielded method
-      # Note - must be called from inside the `report_run` scope
-      def report_app(app)
-        super do |report|
-          shell.info "Caching dependency records for #{app["name"]}"
-          yield report
-        end
+      # report - A report containing information about the app evaluation
+      def begin_report_app(app, report)
+        shell.info "Caching dependency records for #{app["name"]}"
       end
 
-      # Reports on a dependency source enumerator in a cache command run.
-      # Shows the type and count of dependencies found by the source.
+      # Reports the start of caching records for a dependency source
       #
       # source - A dependency source enumerator
-      #
-      # Returns the result of the yielded method
-      # Note - must be called from inside the `report_run` scope
-      def report_source(source)
-        super do |report|
-          shell.info "  #{source.class.type}"
-          result = yield report
+      # report - A report containing information about the source evaluation
+      def begin_report_source(source, report)
+        shell.info "  #{source.class.type}"
+      end
 
-          warning_reports = report.all_reports.select { |r| r.warnings.any? }.to_a
-          if warning_reports.any?
-            shell.newline
-            shell.warn "  * Warnings:"
-            warning_reports.each do |r|
-              display_metadata = r.map { |k, v| "#{k}: #{v}" }.join(", ")
+      # Reports warnings and errors found while evaluating the dependency source
+      #
+      # source - A dependency source enumerator
+      # report - A report containing information about the source evaluation
+      def end_report_source(source, report)
+        warning_reports = report.all_reports.select { |r| r.warnings.any? }.to_a
+        if warning_reports.any?
+          shell.newline
+          shell.warn "  * Warnings:"
+          warning_reports.each do |r|
+            display_metadata = r.map { |k, v| "#{k}: #{v}" }.join(", ")
 
-              shell.warn "    * #{r.name}"
-              shell.warn "    #{display_metadata}" unless display_metadata.empty?
-              r.warnings.each do |warning|
-                shell.warn "      - #{warning}"
-              end
-              shell.newline
+            shell.warn "    * #{r.name}"
+            shell.warn "    #{display_metadata}" unless display_metadata.empty?
+            r.warnings.each do |warning|
+              shell.warn "      - #{warning}"
             end
+            shell.newline
           end
+        end
 
-          errored_reports = report.all_reports.select { |r| r.errors.any? }.to_a
-          if errored_reports.any?
-            shell.newline
-            shell.error "  * Errors:"
-            errored_reports.each do |r|
-              display_metadata = r.map { |k, v| "#{k}: #{v}" }.join(", ")
+        errored_reports = report.all_reports.select { |r| r.errors.any? }.to_a
+        if errored_reports.any?
+          shell.newline
+          shell.error "  * Errors:"
+          errored_reports.each do |r|
+            display_metadata = r.map { |k, v| "#{k}: #{v}" }.join(", ")
 
-              shell.error "    * #{r.name}"
-              shell.error "    #{display_metadata}" unless display_metadata.empty?
-              r.errors.each do |error|
-                shell.error "      - #{error}"
-              end
-              shell.newline
+            shell.error "    * #{r.name}"
+            shell.error "    #{display_metadata}" unless display_metadata.empty?
+            r.errors.each do |error|
+              shell.error "      - #{error}"
             end
-          else
-            shell.confirm "  * #{report.reports.size} #{source.class.type} dependencies"
+            shell.newline
           end
-
-          result
+        else
+          shell.confirm "  * #{report.reports.size} #{source.class.type} dependencies"
         end
       end
 
-      # Reports on a dependency in a cache command run.
-      # Shows whether the dependency's record was cached or reused.
+      # Reports whether the dependency's record was cached or reused.
       #
       # dependency - An application dependency
-      #
-      # Returns the result of the yielded method
-      # Note - must be called from inside the `report_run` scope
-      def report_dependency(dependency)
-        super do |report|
-          result = yield report
-
-          if report.errors.any?
-            shell.error "    Error #{dependency.name} (#{dependency.version})"
-          elsif report["cached"]
-            shell.info "    Caching #{dependency.name} (#{dependency.version})"
-          else
-            shell.info "    Using #{dependency.name} (#{dependency.version})"
-          end
-
-          result
+      # report - A report containing information about the dependency evaluation
+      def end_report_dependency(dependency, report)
+        if report.errors.any?
+          shell.error "    Error #{dependency.name} (#{dependency.version})"
+        elsif report["cached"]
+          shell.info "    Caching #{dependency.name} (#{dependency.version})"
+        else
+          shell.info "    Using #{dependency.name} (#{dependency.version})"
         end
       end
     end

data/lib/licensed/reporters/json_reporter.rb

@@ -4,31 +4,29 @@ require "json"
 module Licensed
   module Reporters
     class JsonReporter < Reporter
-      def report_run(command)
-        super do |report|
-          result = yield report
-
-          report["apps"] = report.reports.map(&:to_h) if report.reports.any?
-          shell.info JSON.pretty_generate(report.to_h)
-
-          result
-        end
+      # Report all information from the command run to the shell as a JSON object
+      #
+      # command - The command being run
+      # report - A report object containing information about the command run
+      def end_report_command(command, report)
+        report["apps"] = report.reports.map(&:to_h) if report.reports.any?
+        shell.info JSON.pretty_generate(report.to_h)
       end
 
-      def report_app(app)
-        super do |report|
-          result = yield report
-          report["sources"] = report.reports.map(&:to_h) if report.reports.any?
-          result
-        end
+      # Add source report information to the app report hash
+      #
+      # app - An application configuration
+      # report - A report object containing information about the app evaluation
+      def end_report_app(app, report)
+        report["sources"] = report.reports.map(&:to_h) if report.reports.any?
       end
 
-      def report_source(source)
-        super do |report|
-          result = yield report
-          report["dependencies"] = report.reports.map(&:to_h) if report.reports.any?
-          result
-        end
+      # Add dependency report information to the source report hash
+      #
+      # source - A dependency source enumerator
+      # report - A report object containing information about the source evaluation
+      def end_report_source(source, report)
+        report["dependencies"] = report.reports.map(&:to_h) if report.reports.any?
       end
     end
   end