license_finder 2.0.0.rc2 → 2.0.0

data/lib/license_finder/cli/patched_thor.rb

@@ -1,5 +1,3 @@
-require 'thor'
-
 module LicenseFinder
   module CLI
     module Rootcommand

data/lib/license_finder/cli/whitelist.rb

@@ -12,19 +12,17 @@ module LicenseFinder
 
       auditable
       desc "add LICENSE...", "Add one or more licenses to the whitelist"
-      def add(license, *other_licenses)
-        licenses = modify_each(license, *other_licenses) do |l|
-          decisions.whitelist(l, txn)
-        end
+      def add(*licenses)
+        assert_some licenses
+        modifying { licenses.each { |l| decisions.whitelist(l, txn) } }
         say "Added #{licenses.join(", ")} to the license whitelist"
       end
 
       auditable
       desc "remove LICENSE...", "Remove one or more licenses from the whitelist"
-      def remove(license, *other_licenses)
-        licenses = modify_each(license, *other_licenses) do |l|
-          decisions.unwhitelist(l, txn)
-        end
+      def remove(*licenses)
+        assert_some licenses
+        modifying { licenses.each { |l| decisions.unwhitelist(l, txn) } }
         say "Removed #{licenses.join(", ")} from the license whitelist"
       end
     end

data/lib/license_finder/configuration.rb

@@ -1,6 +1,6 @@
 module LicenseFinder
   class Configuration
-    def self.with_optional_saved_config(primary_config, project_path = Pathname.new('.'))
+    def self.with_optional_saved_config(primary_config, project_path)
       config_file = project_path.join('config', 'license_finder.yml')
       saved_config = config_file.exist? ? YAML.load(config_file.read) : {}
       new(primary_config, saved_config)

data/lib/license_finder/core.rb

@@ -0,0 +1,68 @@
+require 'license_finder/logger'
+
+require 'license_finder/license'
+
+require 'license_finder/configuration'
+require 'license_finder/package_manager'
+require 'license_finder/decisions'
+require 'license_finder/decision_applier'
+
+require 'forwardable'
+module LicenseFinder
+  # Coordinates setup
+  class Core
+    def self.default_logger
+      Logger::Default.new
+    end
+
+    # +options+ look like:
+    # {
+    #   logger: { quiet: true, debug: false },
+    #   project_path: "./some/project/path/"
+    #   gradle_command: "gradlew",
+    #   decisions_file: "./some/path.yml",
+    # }
+    # +gradle_command+ and +decisions_file+ are optional, see Configuration
+    def initialize(options)
+      @logger = Logger.new(options.fetch(:logger))
+      @project_path = Pathname(options.fetch(:project_path))
+      @config = Configuration.with_optional_saved_config(options, project_path)
+      @decisions = Decisions.saved!(config.decisions_file)
+    end
+
+    def modifying
+      yield
+      decisions.save!(config.decisions_file)
+    end
+
+    extend Forwardable
+    def_delegators :decision_applier, :acknowledged, :unapproved
+    attr_reader :decisions
+
+    def project_name
+      decisions.project_name || project_path.basename.to_s
+    end
+
+    private
+
+    attr_reader :config, :logger, :project_path
+
+    # The core of the system. The saved decisions are applied to the current
+    # packages.
+    def decision_applier
+      # lazy, do not move to `initialize`
+      DecisionApplier.new(decisions: decisions, packages: current_packages)
+    end
+
+    def current_packages
+      # lazy, do not move to `initialize`
+      PackageManager.current_packages(
+        logger: logger,
+        project_path: project_path,
+        gradle_command: config.gradle_command,
+        ignore_groups: decisions.ignored_groups
+      )
+    end
+  end
+end
+

data/lib/license_finder/decision_applier.rb

@@ -2,7 +2,7 @@ module LicenseFinder
   class DecisionApplier
     def initialize(options)
       @decisions = options.fetch(:decisions)
-      @packages = options.fetch(:packages)
+      @system_packages = options.fetch(:packages)
     end
 
     def unapproved
@@ -10,16 +10,19 @@ module LicenseFinder
     end
 
     def acknowledged
-      base_packages = decisions.packages + packages
-      base_packages.
-        reject { |package| ignored?(package) }.
-        map    { |package| with_decided_licenses(package) }.
-        map    { |package| with_approval(package) }
+      packages.reject { |package| ignored?(package) }
     end
 
     private
 
-    attr_reader :packages, :decisions
+    attr_reader :system_packages, :decisions
+
+    def packages
+      result = decisions.packages + system_packages
+      result
+        .map { |package| with_decided_licenses(package) }
+        .map { |package| with_approval(package) }
+    end
 
     def ignored?(package)
       decisions.ignored?(package.name) ||

data/lib/license_finder/license.rb

@@ -1,3 +1,13 @@
+require "license_finder/license/text"
+require "license_finder/license/template"
+
+require "license_finder/license/matcher"
+require "license_finder/license/header_matcher"
+require "license_finder/license/any_matcher"
+require "license_finder/license/none_matcher"
+
+require "license_finder/license/definitions"
+
 module LicenseFinder
   class License
     class << self
@@ -55,13 +65,3 @@ module LicenseFinder
     end
   end
 end
-
-require "license_finder/license/text"
-require "license_finder/license/template"
-
-require "license_finder/license/matcher"
-require "license_finder/license/header_matcher"
-require "license_finder/license/any_matcher"
-require "license_finder/license/none_matcher"
-
-require "license_finder/license/definitions"

data/lib/license_finder/license/template.rb

@@ -1,9 +1,10 @@
 module LicenseFinder
   class License
     class Template
+      TEMPLATE_PATH = ROOT_PATH.join("license", "templates")
+
       def self.named(name)
-        path = ROOT_PATH.join("license", "templates", "#{name}.txt")
-        new(path.read)
+        new TEMPLATE_PATH.join("#{name}.txt").read
       end
 
       attr_reader :content

data/lib/license_finder/logger.rb

@@ -28,10 +28,6 @@ module LicenseFinder
         end
       end
 
-      def license package, package_name, license, how
-        log package, sprintf("package %s: found license '%s' %s", package_name, license, how)
-      end
-
       def log prefix, string
         raise NotImplementedError, "#log must be implemented"
       end
@@ -44,13 +40,13 @@ module LicenseFinder
 
     class Progress < Base
       def log prefix, string
-        STDOUT.print(".") && STDOUT.flush
+        print(".") && $stdout.flush
       end
     end
 
     class Verbose < Base
       def log prefix, string
-        STDOUT.printf("%s: %s\n", prefix, string)
+        printf("%s: %s\n", prefix, string)
       end
     end
 

data/lib/license_finder/package.rb

@@ -1,21 +1,19 @@
+require 'license_finder/packages/licensing'
+require 'license_finder/packages/license_files'
+
 module LicenseFinder
   # Super-class that adapts data from different package management
   # systems (gems, npm, pip, etc.) to a common interface.
   #
-  # For guidance on adding a new system use the shared behavior
-  #
-  #     it_behaves_like "a Package"
-  #
-  # Additional guidelines are:
-  #
-  # - if you're going to use Package#licenses ...
-  #   - and the package spec will report licenses,
-  #     pass :spec_licenses in the constructor options
-  #   - and the package's files can be searched for licenses
-  #     pass :install_path in the constructor options
-  # - else
-  #   - implement #licenses
+  # Guidance on adding a new system
   #
+  # - subclass Package, and initialize based on the data you receive from the
+  #   package manager
+  # - if the package specs will report license names, pass :spec_licenses in the
+  #   constructor options
+  # - if the package's files can be searched for licenses pass :install_path in
+  #   the constructor options
+  # - otherwise, override #licenses_from_spec or #license_files
   class Package
     attr_reader :logger
 
@@ -32,7 +30,7 @@ module LicenseFinder
     end
 
     def initialize(name, version = nil, options={})
-      @logger = options[:logger] || LicenseFinder::Logger::Default.new
+      @logger = options[:logger] || Core.default_logger
 
       @name = name
       @version = version
@@ -88,20 +86,17 @@ module LicenseFinder
     attr_reader :install_path # checked in tests, otherwise private
 
     def licenses
-      @licenses ||= determine_licenses.to_set
+      @licenses ||= activations.map(&:license).to_set
     end
 
-    def determine_licenses
-      dl = @decided_licenses
-      return dl if dl.any?
-
-      lfs = licenses_from_spec
-      return lfs if lfs.any?
-
-      lff = licenses_from_files
-      return lff if lff.any?
+    def activations
+      licensing.activations.tap do |activations|
+        activations.each { |activation| activation.log(logger) }
+      end
+    end
 
-      [default_license].to_set
+    def licensing
+      Licensing.new(self, @decided_licenses, licenses_from_spec, license_files)
     end
 
     def decide_on_license(license)
@@ -109,27 +104,13 @@ module LicenseFinder
     end
 
     def licenses_from_spec
-      license_names_from_spec.map do |name|
-        License.find_by_name(name).tap do |license|
-          logger.license self.class, self.name, license.name, "from spec" if license
-        end
-      end.compact.to_set
-    end
-
-    def licenses_from_files
-      license_files.map do |license_file|
-        license_file.license.tap do |license|
-          logger.license self.class, self.name, license.name, "from file '#{license_file.path}'" if license
-        end
-      end.compact.to_set
+      license_names_from_spec
+        .map { |name| License.find_by_name(name) }
+        .to_set
     end
 
     def license_files
-      PossibleLicenseFiles.find(install_path)
-    end
-
-    def default_license
-      License.find_by_name nil
+      LicenseFiles.find(install_path)
     end
 
     def missing?
@@ -138,7 +119,7 @@ module LicenseFinder
   end
 end
 
-require 'license_finder/package_managers/manual_package'
+require 'license_finder/packages/manual_package'
 require 'license_finder/package_managers/bower_package'
 require 'license_finder/package_managers/bundler_package'
 require 'license_finder/package_managers/pip_package'

data/lib/license_finder/package_manager.rb

@@ -17,22 +17,20 @@ module LicenseFinder
     end
 
     def self.current_packages(options)
-      package_managers.
-        map { |pm| pm.new(options) }.
-        select(&:active?).
-        map(&:current_packages_with_relations).
-        flatten
+      package_managers
+        .map { |pm| pm.new(options) }
+        .select(&:active?)
+        .flat_map(&:current_packages_with_relations)
     end
 
-    attr_reader :logger
-
     def initialize options={}
-      @logger       = options[:logger] || LicenseFinder::Logger::Default.new
-      @package_path = options[:package_path] # dependency injection for tests
+      @logger       = options[:logger] || Core.default_logger
+      @project_path = options[:project_path]
     end
 
     def active?
-      injected_package_path.exist?.tap { |is_active| logger.active self.class, is_active }
+      package_path.exist?
+        .tap { |is_active| logger.active self.class, is_active }
     end
 
     def current_packages_with_relations
@@ -48,9 +46,7 @@ module LicenseFinder
 
     private
 
-    def injected_package_path
-      @package_path || package_path
-    end
+    attr_reader :logger, :project_path
   end
 end
 
@@ -61,3 +57,5 @@ require 'license_finder/package_managers/pip'
 require 'license_finder/package_managers/maven'
 require 'license_finder/package_managers/cocoa_pods'
 require 'license_finder/package_managers/gradle'
+
+require 'license_finder/package'

data/lib/license_finder/package_managers/bower.rb

@@ -15,7 +15,7 @@ module LicenseFinder
     private
 
     def package_path
-      Pathname.new('bower.json')
+      project_path.join('bower.json')
     end
   end
 end

data/lib/license_finder/package_managers/bundler.rb

@@ -28,7 +28,7 @@ module LicenseFinder
     end
 
     def package_path
-      Pathname.new("Gemfile")
+      project_path.join("Gemfile")
     end
 
     def bundler_defs

data/lib/license_finder/package_managers/cocoa_pods.rb

@@ -19,11 +19,11 @@ module LicenseFinder
     private
 
     def package_path
-      Pathname.new("Podfile")
+      project_path.join("Podfile")
     end
 
     def lockfile_path
-      Pathname.new("Podfile.lock")
+      project_path.join("Podfile.lock")
     end
 
     def acknowledgements_path
@@ -33,7 +33,7 @@ module LicenseFinder
         'Pods/Target Support Files/Pods' # cocoapods >= 0.34
       ]
 
-      directories.map { |dir| Pathname.new(dir).join(filename) }.find(&:exist?)
+      directories.map { |dir| project_path.join(dir, filename) }.find(&:exist?)
     end
 
     def read_plist pathname

data/lib/license_finder/package_managers/cocoa_pods_package.rb

@@ -2,11 +2,11 @@ module LicenseFinder
   class CocoaPodsPackage < Package
     def initialize(name, version, license_text)
       super(name, version)
-      @license_text = license_text
+      @license = License.find_by_text(license_text.to_s)
     end
 
-    def licenses
-      [License.find_by_text(@license_text.to_s) || default_license].to_set
+    def licenses_from_spec
+      [@license].compact
     end
   end
 end

data/lib/license_finder/package_managers/gradle.rb

@@ -23,11 +23,11 @@ module LicenseFinder
     private
 
     def license_report
-      Pathname.new('build/reports/license/dependency-license.xml')
+      project_path.join('build/reports/license/dependency-license.xml')
     end
 
     def package_path
-      Pathname.new('build.gradle')
+      project_path.join('build.gradle')
     end
   end
 end

data/lib/license_finder/package_managers/maven.rb

@@ -21,11 +21,11 @@ module LicenseFinder
     private
 
     def license_report
-      Pathname.new('target/generated-resources/licenses.xml')
+      project_path.join('target/generated-resources/licenses.xml')
     end
 
     def package_path
-      Pathname.new('pom.xml')
+      project_path.join('pom.xml')
     end
   end
 end