license_finder 3.0.4 → 3.1.1

data/lib/license_finder/package_managers/pip.rb

@@ -3,9 +3,9 @@ require 'httparty'
 
 module LicenseFinder
   class Pip < PackageManager
-    def initialize(options={})
+    def initialize(options = {})
       super
-      @requirements_path = options[:pip_requirements_path] || 'requirements.txt'
+      @requirements_path = options[:pip_requirements_path] || Pathname('requirements.txt')
     end
 
     def current_packages
@@ -16,36 +16,36 @@ module LicenseFinder
           pypi_def(name, version),
           logger: logger,
           children: children,
-          install_path: Pathname(location).join(name),
+          install_path: Pathname(location).join(name)
         )
       end
     end
 
     def self.package_management_command
-      "pip"
+      'pip'
     end
 
     private
 
-    def package_path
-      unless project_path.nil?
-        project_path.join(@requirements_path)
+    def possible_package_paths
+      if project_path.nil?
+        [@requirements_path]
       else
-        @requirements_path
+        [project_path.join(@requirements_path)]
       end
     end
 
     def pip_output
-      output = `#{LicenseFinder::BIN_PATH.join("license_finder_pip.py")} #{package_path}`
+      output = `#{LicenseFinder::BIN_PATH.join('license_finder_pip.py')} #{detected_package_path}`
       JSON(output).map do |package|
-        package.values_at(*%w[name version dependencies location])
+        package.values_at('name', 'version', 'dependencies', 'location')
       end
     end
 
     def pypi_def(name, version)
       response = HTTParty.get("https://pypi.python.org/pypi/#{name}/#{version}/json")
       if response.code == 200
-        JSON.parse(response.body).fetch("info", {})
+        JSON.parse(response.body).fetch('info', {})
       else
         {}
       end

data/lib/license_finder/package_managers/pip_package.rb

@@ -1,28 +1,28 @@
 module LicenseFinder
   class PipPackage < Package
     LICENSE_FORMAT = /^License.*::\s*(.*)$/
-    INVALID_LICENSES = ["", "UNKNOWN"].to_set
+    INVALID_LICENSES = ['', 'UNKNOWN'].to_set
 
     def self.license_names_from_spec(spec)
-      license = spec["license"].to_s.strip
+      license = spec['license'].to_s.strip
 
       return [license] unless INVALID_LICENSES.include?(license)
 
       spec
-        .fetch("classifiers", [])
+        .fetch('classifiers', [])
         .select { |c| c =~ LICENSE_FORMAT }
         .map { |c| c.gsub(LICENSE_FORMAT, '\1') }
     end
 
-    def initialize(name, version, spec, options={})
+    def initialize(name, version, spec, options = {})
       super(
         name,
         version,
         options.merge(
-          authors: spec["author"],
-          summary: spec["summary"],
-          description: spec["description"],
-          homepage: spec["home_page"],
+          authors: spec['author'],
+          summary: spec['summary'],
+          description: spec['description'],
+          homepage: spec['home_page'],
           spec_licenses: self.class.license_names_from_spec(spec)
         )
       )

data/lib/license_finder/package_managers/rebar.rb

@@ -1,9 +1,9 @@
 module LicenseFinder
   class Rebar < PackageManager
-    def initialize(options={})
+    def initialize(options = {})
       super
-      @command = options[:rebar_command] || Rebar::package_management_command
-      @deps_path = Pathname(options[:rebar_deps_dir] || "deps")
+      @command = options[:rebar_command] || Rebar.package_management_command
+      @deps_path = Pathname(options[:rebar_deps_dir] || 'deps')
     end
 
     def current_packages
@@ -19,24 +19,24 @@ module LicenseFinder
     end
 
     def self.package_management_command
-      "rebar"
+      'rebar'
     end
 
     private
 
     def rebar_ouput
       command = "#{@command} list-deps"
-      output, success = Dir.chdir(project_path) { capture(command) }
-      raise "Command '#{command}' failed to execute: #{output}" unless success
+      stdout, stderr, status = Dir.chdir(project_path) { Cmd.run(command) }
+      raise "Command '#{command}' failed to execute: #{stderr}" unless status.success?
 
-      output
+      stdout
         .each_line
-        .reject { |line| line.start_with?("=") }
-        .map { |line| line.split(" ") }
+        .reject { |line| line.start_with?('=') }
+        .map { |line| line.split(' ') }
     end
 
-    def package_path
-      project_path.join('rebar.config')
+    def possible_package_paths
+      [project_path.join('rebar.config')]
     end
   end
 end

data/lib/license_finder/package_managers/yarn.rb

@@ -0,0 +1,62 @@
+module LicenseFinder
+  class Yarn < PackageManager
+    SHELL_COMMAND = 'yarn licenses list --no-progress --json'.freeze
+
+    def possible_package_paths
+      [project_path.join('yarn.lock')]
+    end
+
+    def current_packages
+      stdout, _stderr, status = Cmd.run(Yarn::SHELL_COMMAND)
+      return [] unless status.success?
+
+      packages = []
+      incompatible_packages = []
+
+      json_strings = stdout.split("\n")
+      json_objects = json_strings.map { |json_object| JSON.parse(json_object) }
+
+      if json_objects.last['type'] == 'table'
+        license_json = json_objects.pop['data']
+        packages = packages_from_json(license_json)
+      end
+
+      json_objects.each do |json_object|
+        match = /(?<name>[\w,\-]+)@(?<version>(\d+\.?)+)/ =~ json_object['data'].to_s
+        if match
+          package = Package.new(name, version, spec_licenses: ['unknown'])
+          incompatible_packages.push(package)
+        end
+      end
+
+      packages + incompatible_packages.uniq
+    end
+
+    def self.takes_priority_over
+      NPM
+    end
+
+    def self.package_management_command
+      'yarn'
+    end
+
+    def self.prepare_command
+      'yarn install'
+    end
+
+    private
+
+    def packages_from_json(json_data)
+      body = json_data['body']
+      head = json_data['head']
+
+      packages = body.map do |json_package|
+        Hash[head.zip(json_package)]
+      end
+
+      packages.map do |package_hash|
+        Package.new(package_hash['Name'], package_hash['Version'], spec_licenses: [package_hash['License']], homepage: package_hash['VendorUrl'])
+      end
+    end
+  end
+end

data/lib/license_finder/packages/activation.rb

@@ -6,13 +6,13 @@ module LicenseFinder
 
     class FromDecision < Basic
       def sources
-        ["from decision"]
+        ['from decision']
       end
     end
 
     class FromSpec < Basic
       def sources
-        ["from spec"]
+        ['from spec']
       end
     end
 

data/lib/license_finder/packages/license_files.rb

@@ -2,8 +2,8 @@ require 'license_finder/packages/possible_license_file'
 
 module LicenseFinder
   class LicenseFiles
-    CANDIDATE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
-    CANDIDATE_PATH_WILDCARD = "*{#{CANDIDATE_FILE_NAMES.join(',')}}*"
+    CANDIDATE_FILE_NAMES = %w[LICENSE License Licence COPYING README Readme ReadMe].freeze
+    CANDIDATE_PATH_WILDCARD = "*{#{CANDIDATE_FILE_NAMES.join(',')}}*".freeze
 
     def self.find(install_path)
       new(install_path).find
@@ -24,10 +24,10 @@ module LicenseFinder
     attr_reader :install_path
 
     def paths_of_candidate_files
-      candidate_files_and_dirs.
-        flat_map { |path| path.directory? ? path.children : path }.
-        reject { |path| path.directory? }.
-        uniq
+      candidate_files_and_dirs
+        .flat_map { |path| path.directory? ? path.children : path }
+        .reject(&:directory?)
+        .uniq
     end
 
     def candidate_files_and_dirs

data/lib/license_finder/packages/licensing.rb

@@ -2,33 +2,31 @@ require 'license_finder/packages/activation'
 
 module LicenseFinder
   Licensing = Struct.new(:package, :decided_licenses, :licenses_from_spec, :license_files) do
-
     # Implements the algorithm for choosing the right set of licenses from
     # among the various sources of licenses we know about.  In order of
     # priority, licenses come from decisions, package specs, or package files.
     def activations
-      case
-      when activations_from_decisions.any? then activations_from_decisions
-      when activations_from_spec.any?      then activations_from_spec
-      when activations_from_files.any?     then activations_from_files
-      else                                      [default_activation]
+      if activations_from_decisions.any? then activations_from_decisions
+      elsif activations_from_spec.any?      then activations_from_spec
+      elsif activations_from_files.any?     then activations_from_files
+      else [default_activation]
       end
     end
 
     def activations_from_decisions
       @afd ||= decided_licenses
-        .map { |license| Activation::FromDecision.new(package, license) }
+               .map { |license| Activation::FromDecision.new(package, license) }
     end
 
     def activations_from_spec
       @afs ||= licenses_from_spec
-        .map { |license| Activation::FromSpec.new(package, license) }
+               .map { |license| Activation::FromSpec.new(package, license) }
     end
 
     def activations_from_files
       @aff ||= license_files
-        .group_by(&:license)
-        .map { |license, files| Activation::FromFiles.new(package, license, files) }
+               .group_by(&:license)
+               .map { |license, files| Activation::FromFiles.new(package, license, files) }
     end
 
     def default_activation

data/lib/license_finder/packages/manual_package.rb

@@ -5,11 +5,11 @@ module LicenseFinder
     end
 
     def eql?(other)
-      name == other.name # && version.to_s == other.version.to_s # ignore version
+      name == other.name
     end
 
     def hash
-      name.hash # ^ version.to_s.hash # ignore version
+      name.hash
     end
 
     private

data/lib/license_finder/project_finder.rb

@@ -17,10 +17,11 @@ module LicenseFinder
 
     def collect_project_path(all_paths)
       potential_project_path = all_paths.first
-      if active_project?(potential_project_path)
-        remove_nested(potential_project_path, all_paths)
-        return potential_project_path.to_s
-      end
+      is_active_project = active_project?(potential_project_path)
+      return unless is_active_project
+
+      remove_nested(potential_project_path, all_paths)
+      potential_project_path.to_s
     end
 
     private
@@ -50,7 +51,7 @@ module LicenseFinder
     end
 
     def nested_path?(path, pathname)
-      (path.to_s).start_with?(pathname.to_s) && path.to_s != pathname.to_s
+      path.to_s.start_with?(pathname.to_s) && path.to_s != pathname.to_s
     end
   end
 end

data/lib/license_finder/report.rb

@@ -10,6 +10,7 @@ module LicenseFinder
     end
 
     private
+
     attr_reader :dependencies, :project_name
 
     def sorted_dependencies

data/lib/license_finder/reports/csv_report.rb

@@ -2,9 +2,9 @@ require 'csv'
 
 module LicenseFinder
   class CsvReport < Report
-    COMMA_SEP = ","
-    AVAILABLE_COLUMNS = %w[name version authors licenses license_links approved summary description homepage install_path package_manager groups]
-    MISSING_DEPENDENCY_TEXT = "This package is not installed. Please install to determine licenses."
+    COMMA_SEP = ','.freeze
+    AVAILABLE_COLUMNS = %w[name version authors licenses license_links approved summary description homepage install_path package_manager groups].freeze
+    MISSING_DEPENDENCY_TEXT = 'This package is not installed. Please install to determine licenses.'.freeze
 
     def initialize(dependencies, options)
       super
@@ -56,7 +56,7 @@ module LicenseFinder
     end
 
     def format_approved(dep)
-      dep.approved? ? "Approved" : "Not approved"
+      dep.approved? ? 'Approved' : 'Not approved'
     end
 
     def format_summary(dep)

data/lib/license_finder/reports/diff_report.rb

@@ -2,7 +2,7 @@ module LicenseFinder
   class DiffReport < CsvReport
     AVAILABLE_COLUMNS = AVAILABLE_COLUMNS + %w[status current_version previous_version project_paths]
 
-    def initialize(dependencies, options={})
+    def initialize(dependencies, options = {})
       super(dependencies, options.merge(columns: build_columns(dependencies)))
     end
 
@@ -22,7 +22,7 @@ module LicenseFinder
 
     def build_columns(dependencies)
       columns = %w[status name version licenses]
-      columns << 'project_paths' if dependencies.all? { |delta| delta.merged_package? }
+      columns << 'project_paths' if dependencies.all?(&:merged_package?)
       columns
     end
   end

data/lib/license_finder/reports/erb_report.rb

@@ -38,7 +38,7 @@ module LicenseFinder
     end
 
     def link_to(text, link = "##{text}")
-      %{<a href="#{link}">#{text}</a>}
+      %(<a href="#{link}">#{text}</a>)
     end
 
     def license_names(dependency)
@@ -51,9 +51,7 @@ module LicenseFinder
 
     def version_groups(dependency)
       result = "v#{dependency.version}"
-      if dependency.groups.any?
-        result << " (#{dependency.groups.join(", ")})"
-      end
+      result << " (#{dependency.groups.join(', ')})" if dependency.groups.any?
       result
     end
   end

data/lib/license_finder/reports/html_report.rb

@@ -3,11 +3,11 @@ module LicenseFinder
     private
 
     def template_name
-      "html_report"
+      'html_report'
     end
 
     def bootstrap
-      TEMPLATE_PATH.join("bootstrap.css").read
+      TEMPLATE_PATH.join('bootstrap.css').read
     end
   end
 end

data/lib/license_finder/reports/markdown_report.rb

@@ -3,7 +3,7 @@ module LicenseFinder
     private
 
     def template_name
-      "markdown_report"
+      'markdown_report'
     end
   end
 end

data/lib/license_finder/reports/merged_report.rb

@@ -3,7 +3,7 @@ module LicenseFinder
     AVAILABLE_COLUMNS = AVAILABLE_COLUMNS + ['subproject_paths']
 
     def initialize(dependencies, options = {})
-      options[:columns] ||= %w(name version licenses subproject_paths)
+      options[:columns] ||= %w[name version licenses subproject_paths]
       super(dependencies, options)
     end
 

data/lib/license_finder/reports/text_report.rb

@@ -1,14 +1,12 @@
 module LicenseFinder
   class TextReport < CsvReport
-    COMMA_SEP =  ", "
+    COMMA_SEP = ', '.freeze
 
-    def initialize(dependencies, options={})
+    def initialize(dependencies, options = {})
       super(dependencies, options)
 
       default_columns = %w[name version licenses]
-      if @columns.empty?
-        @columns = default_columns
-      end
+      @columns = default_columns if @columns.empty?
     end
   end
 end