Allow custom licensee behavior overrides

.licenses/bundler/bundler.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: bundler
-version: 2.3.7
+version: 2.3.8
 type: bundler
 summary: The best way to manage your application's dependencies
 homepage: https://bundler.io

.licenses/bundler/licensee.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: licensee
-version: 9.15.1
+version: 9.15.2
 type: bundler
 summary: A Ruby Gem to detect open source project licenses
 homepage: https://github.com/benbalter/licensee

docs/configuration.md

@@ -4,7 +4,7 @@ A configuration file specifies the details of enumerating and operating on licen
 
 Configuration can be specified in either YML or JSON formats, with examples given in YML.  The example
 below describes common configuration values and their purposes.  See [configuration options documentation](./configuration)
-for in depth information.  
+for in depth information.
 
 Additionally, some dependency sources have their own specific configuration options.  See the [source documentation](./sources) for details.
 

docs/configuration/customizing_licensee.md

@@ -0,0 +1,13 @@
+# Customize Licensee's behavior
+
+Licensed uses [Licensee](https://github.com/licensee/licensee) to detect and evaluate OSS licenses for project dependencies found during source enumeration.  Licensed can optionally [customize Licensee's behavior](https://github.com/licensee/licensee/blob/jonabc-patch-1/docs/customizing.md#customizing-licensees-behavior) based on options set in the configuration file.
+
+**NOTE** Matching licenses based on package manager metadata and README references is always enabled and cannot currently be configured.
+
+```yml
+licensee:
+  # the confidence threshold is an integer between 1 and 100. the value represents
+  # the minimum percentage confidence that Licensee must have to report a matched license
+  # https://github.com/licensee/licensee/blob/jonabc-patch-1/docs/customizing.md#adjusting-the-confidence-threshold
+  confidence_threshold: 90 # default value: 98
+```

lib/licensed/commands/cache.rb

@@ -29,6 +29,18 @@ def run_command(report)
         files.clear
       end
 
+      # Run the command for an application configurations.
+      # Applies a licensee configuration for the duration of the operation.
+      #
+      # report - A Licensed::Report object for this command
+      #
+      # Returns whether the command succeeded
+      def run_app(app, report)
+        with_licensee_configuration(app, report) do
+          super
+        end
+      end
+
       # 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
@@ -136,6 +148,22 @@ def cache_paths
       def files
         @files ||= Set.new
       end
+
+      # Configure licensee for the duration of a yielded operation
+      def with_licensee_configuration(app, report)
+        licensee_configuration = app["licensee"]
+        return yield unless licensee_configuration
+
+        report["licensee"] = licensee_configuration
+
+        if new_threshold = licensee_configuration["confidence_threshold"]
+          old_threshold, Licensee.confidence_threshold = Licensee.confidence_threshold, new_threshold
+        end
+
+        yield
+      ensure
+        Licensee.confidence_threshold = old_threshold if old_threshold
+      end
     end
   end
 end

licensed.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency "licensee", ">= 9.14.0", "< 10.0.0"
+  spec.add_dependency "licensee", ">= 9.15.2", "< 10.0.0"
   spec.add_dependency "thor", ">= 0.19"
   spec.add_dependency "pathname-common_prefix", "~> 0.0.1"
   spec.add_dependency "tomlrb", ">= 1.2", "< 3.0"

test/commands/cache_test.rb

@@ -273,6 +273,17 @@
     end
   end
 
+  it "sets licensee configuration when evaluating an app" do
+    config.apps.each do |app|
+      app["licensee"] = { "confidence_threshold" => 50 }
+    end
+
+    run_command
+
+    report = reporter.report.all_reports.find { |r| r.target.is_a?(Licensed::AppConfiguration) }
+    assert_equal({ "confidence_threshold" => 50 }, report["licensee"])
+  end
+
   describe "with multiple apps" do
     let(:apps) do
       [