license_finder 1.2 → 2.0.0.rc2

data/lib/license_finder/package_manager.rb

@@ -1,5 +1,29 @@
 module LicenseFinder
+  # Super-class for the different package managers
+  # (Bundler, NPM, Pip, etc.)
+  #
+  # For guidance on adding a new package manager use the shared behavior
+  #
+  #     it_behaves_like "a PackageManager"
+  #
+  # Additional guidelines are:
+  #
+  # - implement #current_packages, to return a list of `Package`s this package manager is tracking
+  # - implement #package_path, a `Pathname` which, if the file exists, indicates the package manager is in use on this project
+  #
   class PackageManager
+    def self.package_managers
+      [Bundler, NPM, Pip, Bower, Maven, Gradle, CocoaPods]
+    end
+
+    def self.current_packages(options)
+      package_managers.
+        map { |pm| pm.new(options) }.
+        select(&:active?).
+        map(&:current_packages_with_relations).
+        flatten
+    end
+
     attr_reader :logger
 
     def initialize options={}
@@ -11,6 +35,17 @@ module LicenseFinder
       injected_package_path.exist?.tap { |is_active| logger.active self.class, is_active }
     end
 
+    def current_packages_with_relations
+      packages = current_packages
+      packages.each do |parent|
+        parent.children.each do |child_name|
+          child = packages.detect { |child| child.name == child_name }
+          child.parents << parent.name if child
+        end
+      end
+      packages
+    end
+
     private
 
     def injected_package_path
@@ -18,3 +53,11 @@ module LicenseFinder
     end
   end
 end
+
+require 'license_finder/package_managers/bower'
+require 'license_finder/package_managers/bundler'
+require 'license_finder/package_managers/npm'
+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'

data/lib/license_finder/package_managers/bower.rb

@@ -3,7 +3,7 @@ require 'json'
 module LicenseFinder
   class Bower < PackageManager
     def current_packages
-      output = `bower list --json`
+      output = `bower list --json -l action`
 
       json = JSON(output)
 

data/lib/license_finder/package_managers/bower_package.rb

@@ -1,50 +1,29 @@
 module LicenseFinder
   class BowerPackage < Package
     def initialize(bower_module, options={})
-      super options
-      @bower_module = bower_module
-      @module_metadata = bower_module.fetch("pkgMeta", Hash.new)
-    end
-
-    def name
-      module_metadata.fetch("name", nil)
-    end
-
-    def version
-      module_metadata.fetch("version", nil)
-    end
-
-    def summary
-      module_metadata.fetch("description", nil)
-    end
-
-    def description
-      module_metadata.fetch("readme", nil)
-    end
-
-    def homepage
-      module_metadata.fetch("homepage", nil)
-    end
-
-    def children
-      [] # no way to determine child deps from bower (maybe?)
-    end
-
-    def groups
-      [] # no concept of dev/test groups in bower (maybe?)
-    end
-
-    private
-
-    attr_reader :bower_module
-    attr_reader :module_metadata
-
-    def install_path
-      bower_module["canonicalDir"]
-    end
-
-    def license_names_from_spec
-      Package.license_names_from_standard_spec(module_metadata)
+      spec = bower_module.fetch("pkgMeta", Hash.new)
+
+      if spec.empty?
+        endpoint = bower_module.fetch("endpoint", Hash.new)
+        name = endpoint["name"]
+        version = endpoint["target"]
+      else
+        name = spec["name"]
+        version = spec["version"]
+      end
+
+      super(
+        name,
+        version,
+        options.merge(
+          summary: spec["description"],
+          description: spec["readme"],
+          homepage: spec["homepage"],
+          spec_licenses: Package.license_names_from_standard_spec(spec),
+          install_path: bower_module["canonicalDir"],
+          missing: bower_module["missing"]
+        )
+      )
     end
   end
 end

data/lib/license_finder/package_managers/bundler.rb

@@ -4,8 +4,8 @@ module LicenseFinder
   class Bundler < PackageManager
     def initialize options={}
       super
-      @ignore_groups = options[:ignore_groups] # dependency injection for tests
-      @definition    = options[:definition]    # dependency injection for tests
+      @ignore_groups = options[:ignore_groups]
+      @definition    = options[:definition] # dependency injection for tests
     end
 
     def current_packages
@@ -20,16 +20,13 @@ module LicenseFinder
 
     private
 
+    attr_reader :ignore_groups
+
     def definition
       # DI
       @definition ||= ::Bundler::Definition.build(package_path, lockfile_path, nil)
     end
 
-    def ignore_groups
-      # DI
-      @ignore_groups ||= LicenseFinder.config.ignore_groups
-    end
-
     def package_path
       Pathname.new("Gemfile")
     end

data/lib/license_finder/package_managers/bundler_package.rb

@@ -1,36 +1,19 @@
 module LicenseFinder
   class BundlerPackage < Package
-    extend Forwardable
-    def_delegators :gem_def, :summary, :description, :name, :homepage
-
-    attr_reader :gem_def
-
-    def initialize(gem_def, bundler_def, options={})
-      super options
-      @gem_def = gem_def
-      @bundler_def = bundler_def
-    end
-
-    def groups
-      Array(@bundler_def && @bundler_def.groups)
-    end
-
-    def version
-      gem_def.version.to_s
-    end
-
-    def children
-      gem_def.dependencies.map(&:name)
-    end
-
-    private
-
-    def install_path
-      gem_def.full_gem_path
-    end
-
-    def license_names_from_spec
-      gem_def.licenses
+    def initialize(spec, bundler_def, options={})
+      super(
+        spec.name,
+        spec.version.to_s,
+        options.merge(
+          summary: spec.summary,
+          description: spec.description,
+          homepage: spec.homepage,
+          children: spec.dependencies.map(&:name),
+          groups: Array(bundler_def && bundler_def.groups),
+          spec_licenses: spec.licenses,
+          install_path: spec.full_gem_path
+        )
+      )
     end
   end
 end

data/lib/license_finder/package_managers/cocoa_pods.rb

@@ -33,7 +33,7 @@ module LicenseFinder
         'Pods/Target Support Files/Pods' # cocoapods >= 0.34
       ]
 
-      directories.map { |dir| Pathname.new(File.join(dir, filename)) }.find(&:exist?)
+      directories.map { |dir| Pathname.new(dir).join(filename) }.find(&:exist?)
     end
 
     def read_plist pathname

data/lib/license_finder/package_managers/cocoa_pods_package.rb

@@ -1,18 +1,10 @@
 module LicenseFinder
   class CocoaPodsPackage < Package
-    attr_reader :name, :version
-    attr_reader :summary, :description, :homepage
-
-    def initialize(name, version, license_text, options={})
-      super options
-      @name = name
-      @version = version
+    def initialize(name, version, license_text)
+      super(name, version)
       @license_text = license_text
     end
 
-    def groups; []; end
-    def children; []; end
-
     def licenses
       [License.find_by_text(@license_text.to_s) || default_license].to_set
     end

data/lib/license_finder/package_managers/gradle.rb

@@ -2,8 +2,13 @@ require "xmlsimple"
 
 module LicenseFinder
   class Gradle < PackageManager
+    def initialize(options={})
+      super
+      @command = options[:gradle_command] || "gradle"
+    end
+
     def current_packages
-      `#{LicenseFinder.config.gradle_command} downloadLicenses`
+      `#{@command} downloadLicenses`
 
       xml = license_report.read
 
@@ -11,7 +16,6 @@ module LicenseFinder
         'GroupTags' => { 'dependencies' => 'dependency' }
       }
       XmlSimple.xml_in(xml, options).fetch('dependency', []).map do |dep|
-        dep["license"].reject! { |l| l["name"] == "No license found" }
         GradlePackage.new(dep, logger: logger)
       end
     end

data/lib/license_finder/package_managers/gradle_package.rb

@@ -1,36 +1,12 @@
 module LicenseFinder
   class GradlePackage < Package
-    attr_reader :name, :version
+    def initialize(spec, options={})
+      _, name, version = spec["name"].split(":")
+      licenses = Array(spec["license"])
+        .map { |l| l["name"] }
+        .reject { |name| name == "No license found" }
 
-    def initialize(gradle_dependency, options={})
-      super options
-      @gradle_dependency = gradle_dependency
-      @name = @gradle_dependency["name"].split(":")[1]
-      @version = @gradle_dependency["name"].split(":")[2]
-    end
-
-    def description
-      ""
-    end
-
-    def summary
-      ""
-    end
-
-    def homepage
-      ""
-    end
-
-    def groups
-      []
-    end
-
-    def children
-      []
-    end
-
-    def license_names_from_spec
-      @gradle_dependency["license"].map { |l| l["name"] }
+      super(name, version, options.merge(spec_licenses: licenses))
     end
   end
 end

data/lib/license_finder/package_managers/manual_package.rb

@@ -0,0 +1,25 @@
+module LicenseFinder
+  class ManualPackage < Package
+    def ==(other)
+      eql? other
+    end
+
+    def eql?(other)
+      name == other.name # && version.to_s == other.version.to_s # ignore version
+    end
+
+    def hash
+      name.hash # ^ version.to_s.hash # ignore version
+    end
+
+    private
+
+    def licenses_from_spec
+      Set.new
+    end
+
+    def licenses_from_files
+      Set.new
+    end
+  end
+end

data/lib/license_finder/package_managers/maven_package.rb

@@ -1,42 +1,13 @@
 module LicenseFinder
   class MavenPackage < Package
-    attr_reader :mvn_dependency
-
-    def initialize(mvn_dependency, options={})
-      super options
-      @mvn_dependency = mvn_dependency
-    end
-
-    def name
-      mvn_dependency["artifactId"]
-    end
-
-    def version
-      mvn_dependency["version"]
-    end
-
-    def description
-      ""
-    end
-
-    def summary
-      ""
-    end
-
-    def homepage
-      ""
-    end
-
-    def groups
-      []
-    end
-
-    def children
-      []
-    end
-
-    def license_names_from_spec
-      mvn_dependency["licenses"].map { |l| l["name"] }
+    def initialize(spec, options={})
+      super(
+        spec["artifactId"],
+        spec["version"],
+        options.merge(
+          spec_licenses: Array(spec["licenses"]).map { |l| l["name"] }
+        )
+      )
     end
   end
 end

data/lib/license_finder/package_managers/npm.rb

@@ -2,15 +2,15 @@ require 'json'
 
 module LicenseFinder
   class NPM < PackageManager
-    DEPENDENCY_GROUPS = ["dependencies", "devDependencies", "bundleDependencies", "bundledDependencies"]
+    DEPENDENCY_GROUPS = ["dependencies", "devDependencies"]
 
     def current_packages
       json = npm_json
       dependencies = DEPENDENCY_GROUPS.map { |g| (json[g] || {}).values }.flatten(1).reject{ |d| d.is_a?(String) }
 
-      dependencies.map do |node_module|
-        NpmPackage.new(node_module, logger: logger)
-      end
+      pkgs = {} # name => spec
+      dependencies.each { |d| recursive_dependencies(d, pkgs) }
+      pkgs.values.map { |d| NpmPackage.new(d, logger: logger) }
     end
 
     private
@@ -38,5 +38,17 @@ module LicenseFinder
     def package_path
       Pathname.new('package.json')
     end
+
+    # node_module can be empty hash if it is included elsewhere
+    def recursive_dependencies(node_module, memo)
+      key = node_module['name']
+      memo[key] ||= {}
+      memo[key].merge!(node_module)
+      node_module.fetch('dependencies', {}).each do |dep_key, data|
+        data['name'] ||= dep_key
+        recursive_dependencies(data, memo)
+      end
+      memo
+    end
   end
 end

data/lib/license_finder/package_managers/npm_package.rb

@@ -1,48 +1,17 @@
 module LicenseFinder
   class NpmPackage < Package
-    def initialize(node_module, options={})
-      super options
-      @node_module = node_module
-    end
-
-    def name
-      node_module["name"]
-    end
-
-    def version
-      node_module["version"]
-    end
-
-    def summary
-      node_module["description"]
-    end
-
-    def description
-      node_module["readme"]
-    end
-
-    def homepage
-      node_module["homepage"]
-    end
-
-    def children
-      [] # no way to determine child deps from npm (maybe?)
-    end
-
-    def groups
-      [] # no concept of dev/test groups in npm (maybe?)
-    end
-
-    private
-
-    attr_reader :node_module
-
-    def install_path
-      node_module["path"]
-    end
-
-    def license_names_from_spec
-      Package.license_names_from_standard_spec(node_module)
+    def initialize(spec, options={})
+      super(
+        spec["name"],
+        spec["version"],
+        options.merge(
+          description: spec["description"],
+          homepage: spec["homepage"],
+          spec_licenses: Package.license_names_from_standard_spec(spec),
+          install_path: spec["path"],
+          children: spec.fetch("dependencies", {}).map { |_, d| d["name"] }
+        )
+      )
     end
   end
 end