license_finder 2.0.1 → 2.0.2

data/lib/license_finder/logger.rb

@@ -28,6 +28,17 @@ module LicenseFinder
         end
       end
 
+      def activation activation
+        preamble = sprintf("package %s:", activation.package.name)
+        if activation.sources.empty?
+          log activation.package.class, sprintf("%s no licenses found", preamble)
+        else
+          activation.sources.each do |source|
+            log activation.package.class, sprintf("%s found license '%s' %s", preamble, activation.license.name, source)
+          end
+        end
+      end
+
       def log prefix, string
         raise NotImplementedError, "#log must be implemented"
       end

data/lib/license_finder/package.rb

@@ -91,7 +91,7 @@ module LicenseFinder
 
     def activations
       licensing.activations.tap do |activations|
-        activations.each { |activation| activation.log(logger) }
+        activations.each { |activation| logger.activation(activation) }
       end
     end
 

data/lib/license_finder/package_managers/bower.rb

@@ -3,17 +3,21 @@ require 'json'
 module LicenseFinder
   class Bower < PackageManager
     def current_packages
-      output = `bower list --json -l action`
-
-      json = JSON(output)
-
-      json.fetch("dependencies",[]).map do |package|
-        BowerPackage.new(package[1], logger: logger)
+      bower_output.map do |package|
+        BowerPackage.new(package, logger: logger)
       end
     end
 
     private
 
+    def bower_output
+      output = `bower list --json -l action`
+
+      JSON(output)
+        .fetch("dependencies", {})
+        .values
+    end
+
     def package_path
       project_path.join('bower.json')
     end

data/lib/license_finder/package_managers/cocoa_pods.rb

@@ -5,14 +5,17 @@ module LicenseFinder
     def current_packages
       podfile = YAML.load_file(lockfile_path)
 
-      acknowledgements = read_plist(acknowledgements_path)["PreferenceSpecifiers"]
-
       podfile["PODS"].map do |pod|
         pod = pod.keys.first if pod.is_a?(Hash)
 
-        pod_name, pod_version = pod.scan(/(.*)\s\((.*)\)/).flatten
-        pod_acknowledgment = acknowledgements.detect { |hash| hash["Title"] == pod_name } || {}
-        CocoaPodsPackage.new(pod_name, pod_version, pod_acknowledgment["FooterText"])
+        name, version = pod.scan(/(.*)\s\((.*)\)/).flatten
+
+        CocoaPodsPackage.new(
+          name,
+          version,
+          license_texts[name],
+          logger: logger
+        )
       end
     end
 
@@ -26,6 +29,12 @@ module LicenseFinder
       project_path.join("Podfile.lock")
     end
 
+    def license_texts
+      # package name => license text
+      @license_texts ||= read_plist(acknowledgements_path)["PreferenceSpecifiers"]
+        .each_with_object({}) { |hash, memo| memo[hash["Title"]] = hash["FooterText"] }
+    end
+
     def acknowledgements_path
       filename = 'Pods-acknowledgements.plist'
       directories = [
@@ -33,7 +42,9 @@ module LicenseFinder
         'Pods/Target Support Files/Pods' # cocoapods >= 0.34
       ]
 
-      directories.map { |dir| project_path.join(dir, 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

@@ -1,7 +1,7 @@
 module LicenseFinder
   class CocoaPodsPackage < Package
-    def initialize(name, version, license_text)
-      super(name, version)
+    def initialize(name, version, license_text, options={})
+      super(name, version, options)
       @license = License.find_by_text(license_text.to_s)
     end
 

data/lib/license_finder/package_managers/gradle.rb

@@ -15,7 +15,9 @@ module LicenseFinder
       options = {
         'GroupTags' => { 'dependencies' => 'dependency' }
       }
-      XmlSimple.xml_in(xml, options).fetch('dependency', []).map do |dep|
+      dependencies = XmlSimple.xml_in(xml, options).fetch('dependency', [])
+
+      dependencies.map do |dep|
         GradlePackage.new(dep, logger: logger)
       end
     end

data/lib/license_finder/package_managers/npm.rb

@@ -6,7 +6,10 @@ module LicenseFinder
 
     def current_packages
       json = npm_json
-      dependencies = DEPENDENCY_GROUPS.map { |g| (json[g] || {}).values }.flatten(1).reject{ |d| d.is_a?(String) }
+      dependencies = DEPENDENCY_GROUPS
+        .map { |g| (json[g] || {}).values }
+        .flatten(1)
+        .reject{ |d| d.is_a?(String) }
 
       pkgs = {} # name => spec
       dependencies.each { |d| recursive_dependencies(d, pkgs) }

data/lib/license_finder/package_managers/pip.rb

@@ -4,14 +4,14 @@ require 'httparty'
 module LicenseFinder
   class Pip < PackageManager
     def current_packages
-      output = `#{LicenseFinder::BIN_PATH.join("license_finder_pip.py")}`
-      JSON(output).map do |package|
+      pip_output.map do |name, version, children, location|
         PipPackage.new(
-          package["name"],
-          package["version"],
-          File.join(package["location"], package["name"]),
-          pypi_def(package["name"], package["version"]),
-          logger: logger
+          name,
+          version,
+          pypi_def(name, version),
+          logger: logger,
+          children: children,
+          install_path: Pathname(location).join(name),
         )
       end
     end
@@ -22,6 +22,13 @@ module LicenseFinder
       project_path.join('requirements.txt')
     end
 
+    def pip_output
+      output = `#{LicenseFinder::BIN_PATH.join("license_finder_pip.py")}`
+      JSON(output).map do |package|
+        package.values_at(*%w[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

data/lib/license_finder/package_managers/pip_package.rb

@@ -1,11 +1,12 @@
 module LicenseFinder
   class PipPackage < Package
     LICENSE_FORMAT = /^License.*::\s*(.*)$/
+    INVALID_LICENSES = ["", "UNKNOWN"].to_set
 
     def self.license_names_from_spec(spec)
-      license = spec["license"]
+      license = spec["license"].to_s.strip
 
-      return [license] if license && license != "UNKNOWN"
+      return [license] unless INVALID_LICENSES.include?(license)
 
       spec
         .fetch("classifiers", [])
@@ -13,7 +14,7 @@ module LicenseFinder
         .map { |c| c.gsub(LICENSE_FORMAT, '\1') }
     end
 
-    def initialize(name, version, install_path, spec, options={})
+    def initialize(name, version, spec, options={})
       super(
         name,
         version,
@@ -21,8 +22,7 @@ module LicenseFinder
           summary: spec["summary"],
           description: spec["description"],
           homepage: spec["home_page"],
-          spec_licenses: self.class.license_names_from_spec(spec),
-          install_path: install_path
+          spec_licenses: self.class.license_names_from_spec(spec)
         )
       )
     end

data/lib/license_finder/packages/activation.rb

@@ -2,19 +2,7 @@ module LicenseFinder
   module Activation
     # An Activation reports that a license has been activated for a package, and
     # tracks the source of that information
-    Basic = Struct.new(:package, :license) do
-      def log(logger)
-        sources.each do |source|
-          log_package(logger, "found license '#{license.name}' #{source}")
-        end
-      end
-
-      private
-
-      def log_package(logger, text)
-        logger.log(package.class, "package #{package.name}: #{text}")
-      end
-    end
+    Basic = Struct.new(:package, :license)
 
     class FromDecision < Basic
       def sources
@@ -45,10 +33,6 @@ module LicenseFinder
       def sources
         []
       end
-
-      def log(logger)
-        log_package(logger, "no licenses found")
-      end
     end
   end
 end

data/lib/license_finder/packages/licensing.rb

@@ -7,30 +7,26 @@ module LicenseFinder
     # among the various sources of licenses we know about.  In order of
     # priority, licenses come from decisions, package specs, or package files.
     def activations
-      afd = activations_from_decisions
-      return afd if afd.any?
-
-      afs = activations_from_spec
-      return afs if afs.any?
-
-      aff = activations_from_files
-      return aff if aff.any?
-
-      [default_activation]
+      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]
+      end
     end
 
     def activations_from_decisions
-      decided_licenses
+      @afd ||= decided_licenses
         .map { |license| Activation::FromDecision.new(package, license) }
     end
 
     def activations_from_spec
-      licenses_from_spec
+      @afs ||= licenses_from_spec
         .map { |license| Activation::FromSpec.new(package, license) }
     end
 
     def activations_from_files
-      license_files
+      @aff ||= license_files
         .group_by(&:license)
         .map { |license, files| Activation::FromFiles.new(package, license, files) }
     end

data/lib/license_finder/reports/csv_report.rb

@@ -3,7 +3,7 @@ require 'csv'
 module LicenseFinder
   class CsvReport < Report
     COMMA_SEP =  ","
-    AVAILABLE_COLUMNS = %w[name version licenses approved summary description]
+    AVAILABLE_COLUMNS = %w[name version licenses approved summary description homepage]
     MISSING_DEPENDENCY_TEXT = "This package is not installed. Please install to determine licenses."
 
     def initialize(dependencies, options)
@@ -35,6 +35,10 @@ module LicenseFinder
       dep.version
     end
 
+    def format_homepage(dep)
+      dep.homepage
+    end
+
     def format_licenses(dep)
       if dep.missing?
         MISSING_DEPENDENCY_TEXT

data/lib/license_finder/version.rb

@@ -1,3 +1,3 @@
 module LicenseFinder
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/license_finder.gemspec

@@ -42,7 +42,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec-its"
-  s.add_development_dependency "xpath"
   s.add_development_dependency "pry"
   s.add_development_dependency "rspec", "~> 3"
   s.add_development_dependency "capybara", "~> 2.0.0"

data/spec/lib/license_finder/license/definitions_spec.rb

@@ -28,6 +28,12 @@ describe LicenseFinder::License, "GPLv2" do
   end
 end
 
+describe LicenseFinder::License, "GPLv3" do
+  it "should be recognized" do
+    expect(described_class.find_by_name("GPLv3").url).to be
+  end
+end
+
 describe LicenseFinder::License, "ISC" do
   it "should be recognized" do
     expect(described_class.find_by_name("ISC").url).to be

data/spec/lib/license_finder/package_managers/pip_package_spec.rb

@@ -11,7 +11,7 @@ module LicenseFinder
     end
 
     def make_package(pypi_def)
-      described_class.new('jasmine', '1.3.1', "jasmine/install/path", pypi_def)
+      described_class.new('jasmine', '1.3.1', pypi_def, install_path: "jasmine/install/path", children: ["achild"])
     end
 
     its(:name) { should == "jasmine" }
@@ -20,7 +20,7 @@ module LicenseFinder
     its(:description) { should == "description" }
     its(:homepage) { should == "homepage" }
     its(:groups) { should == [] } # TODO: any way to extract install_requires and tests_require from `pip list` or `pip show`?
-    its(:children) { should == [] } # TODO: use pipdeptree or something like it
+    its(:children) { should == ["achild"] }
     its(:install_path) { should eq "jasmine/install/path" }
 
 
@@ -60,6 +60,16 @@ module LicenseFinder
           end
         end
 
+        context "with blank license" do
+          it "returns the license from the classifier if it exists" do
+            data = { "license" => "", "classifiers" => [ 'License :: OSI Approved :: Apache 2.0 License' ] }
+
+            subject = make_package(data)
+
+            expect(subject.license_names_from_spec).to eq ['Apache 2.0 License']
+          end
+        end
+
         context "with UNKNOWN license" do
           it "returns the license from the classifier if it exists" do
             data = { "license" => "UNKNOWN", "classifiers" => [ 'License :: OSI Approved :: Apache 2.0 License' ] }

data/spec/lib/license_finder/package_managers/pip_spec.rb

@@ -17,15 +17,15 @@ module LicenseFinder
 
       it 'fetches data from pip' do
         stub_pip [
-          {"name" => "jasmine", "version" => "1.3.1", "location" => "jasmine/path"},
+          {"name" => "jasmine", "version" => "1.3.1", "location" => "jasmine/path", "dependencies" => ["jasmine-core"]},
           {"name" => "jasmine-core", "version" => "1.3.1", "location" => "jasmine-core/path"}
         ].to_json
         stub_pypi("jasmine", "1.3.1", status: 200, body: '{}')
         stub_pypi("jasmine-core", "1.3.1", status: 200, body: '{}')
 
-        expect(pip.current_packages.map { |p| [p.name, p.version, p.install_path] }).to eq [
-          ["jasmine", "1.3.1", "jasmine/path/jasmine"],
-          ["jasmine-core", "1.3.1", "jasmine-core/path/jasmine-core"]
+        expect(pip.current_packages.map { |p| [p.name, p.version, p.install_path.to_s, p.children] }).to eq [
+          ["jasmine", "1.3.1", "jasmine/path/jasmine", ["jasmine-core"]],
+          ["jasmine-core", "1.3.1", "jasmine-core/path/jasmine-core", []]
         ]
       end
 

data/spec/lib/license_finder/packages/activation_spec.rb

@@ -4,6 +4,7 @@ module LicenseFinder
   describe Activation do
     let(:package) { Package.new("p", nil) }
     let(:license) { License.find_by_name("l") }
+    let(:activation) { described_class.new(package, license) }
 
     it "reports that a license has been activated for a package" do
       subject = Activation::Basic.new(package, license)
@@ -12,35 +13,28 @@ module LicenseFinder
     end
 
     describe Activation::FromDecision do
-      it "logs that it came from a decision" do
-        activation = described_class.new(package, license)
-        subject = capture_stdout { activation.log(Logger::Verbose.new) }
-        expect(subject).to eq "LicenseFinder::Package: package p: found license 'l' from decision\n"
+      it "reports that it came from a decision" do
+        expect(activation.sources).to eq ["from decision"]
       end
     end
 
     describe Activation::FromSpec do
-      it "logs that it came from a spec" do
-        activation = described_class.new(package, license)
-        subject = capture_stdout { activation.log(Logger::Verbose.new) }
-        expect(subject).to eq "LicenseFinder::Package: package p: found license 'l' from spec\n"
+      it "reports that it came from a spec" do
+        expect(activation.sources).to eq ["from spec"]
       end
     end
 
     describe Activation::FromFiles do
-      it "logs that it came from some files" do
+      it "reports that it came from some files" do
         files = [double(:file, path: "x"), double(:file, path: "y")]
         activation = described_class.new(package, license, files)
-        subject = capture_stdout { activation.log(Logger::Verbose.new) }
-        expect(subject).to eq "LicenseFinder::Package: package p: found license 'l' from file 'x'\nLicenseFinder::Package: package p: found license 'l' from file 'y'\n"
+        expect(activation.sources).to eq ["from file 'x'", "from file 'y'"]
       end
     end
 
     describe Activation::None do
-      it "logs that no licenses could be found" do
-        activation = described_class.new(package, license)
-        subject = capture_stdout { activation.log(Logger::Verbose.new) }
-        expect(subject).to eq "LicenseFinder::Package: package p: no licenses found\n"
+      it "reports that has no source" do
+        expect(activation.sources).to eq []
       end
     end
   end

data/spec/lib/license_finder/reports/csv_report_spec.rb

@@ -9,12 +9,12 @@ module LicenseFinder
     end
 
     it "understands many columns" do
-      dep = Package.new('gem_a', '1.0', description: "A description", summary: "A summary")
+      dep = Package.new('gem_a', '1.0', description: "A description", summary: "A summary", homepage: "http://homepage.example.com")
       dep.decide_on_license(License.find_by_name("MIT"))
       dep.decide_on_license(License.find_by_name("GPL"))
       dep.whitelisted!
-      subject = described_class.new([dep], columns: %w[name version licenses approved summary description])
-      expect(subject.to_s).to eq("gem_a,1.0,\"MIT,GPL\",Approved,A summary,A description\n")
+      subject = described_class.new([dep], columns: %w[name version licenses approved summary description homepage])
+      expect(subject.to_s).to eq("gem_a,1.0,\"MIT,GPL\",Approved,A summary,A description,http://homepage.example.com\n")
     end
 
     it "ignores unknown columns" do