license_finder 2.1.2 → 3.0.0

data/lib/license_finder/package_managers/go_workspace.rb

@@ -19,11 +19,13 @@ module LicenseFinder
           submodule.install_path =~ /#{repo_name(gp)}$/
         }.first
         if import_path then
-          GoPackage.from_dependency({
-                                     'ImportPath' => repo_name(import_path),
-                                     'InstallPath' => submodule.install_path,
-                                     'Rev' => submodule.revision
-                                    }, nil, @full_version)
+          dependency_info = {
+              'ImportPath' => repo_name(import_path),
+              'Homepage' => repo_name(import_path),
+              'InstallPath' => submodule.install_path,
+              'Rev' => submodule.revision
+          }
+          GoPackage.from_dependency(dependency_info, nil, @full_version)
         end
       end.compact
     end
@@ -69,13 +71,18 @@ module LicenseFinder
         # discovered that `go list' will print a warning and unfortunately exit
         # with status code 1. Setting GOPATH to nil removes those warnings.
         ENV['GOPATH'] = nil
-        val = capture('go list -f \'{{join .Deps "\n"}}\' ./...')
+        val = capture('go list -f "{{join .Deps \"\n\"}}" ./...')
         raise 'go list failed' unless val.last
-        # Select non-standard packages. Non-standard packages typically
-        # have a period somewhere in the namespace (github.com, gopkg.in,
-        # etc.).
-        #
-        val.first.lines.map(&:strip).select { |l| l =~ /.+\..+\// }
+        # Select non-standard packages. `go list std` returns the list of standard
+        # dependencies. We then filter those dependencies out of the full list of
+        # dependencies.
+        deps = val.first.split("\n")
+        capture('go list std').first.split("\n").each do |std|
+          deps.delete_if do |dep|
+            dep =~ /(\/|^)#{std}(\/|$)/
+          end
+        end
+        deps
       end
     end
 

data/lib/license_finder/package_managers/gradle.rb

@@ -1,39 +1,66 @@
 require 'xmlsimple'
+require 'with_env'
 require_relative 'gradle_dependency_finder'
 
 module LicenseFinder
   class Gradle < PackageManager
     def initialize(options={})
       super
-      @command = options[:gradle_command] || 'gradle --console plain'
+      @command = options[:gradle_command] || package_management_command
       @include_groups = options[:gradle_include_groups]
     end
 
     def current_packages
-      command = "#{@command} downloadLicenses"
-      output, success = Dir.chdir(project_path) { capture(command) }
-      raise "Command '#{command}' failed to execute: #{output}" unless success
-
-      dependencies = GradleDependencyFinder.new(project_path).dependencies
-      packages = dependencies.flat_map do |xml_file|
-        options = {'GroupTags' => {'dependencies' => 'dependency'}}
-        contents = XmlSimple.xml_in(xml_file, options).fetch('dependency', [])
-        contents.map do |dep|
-          GradlePackage.new(dep, logger: logger, include_groups: @include_groups)
+      WithEnv.with_env({"TERM" => "dumb"}) do
+        command = "#{@command} downloadLicenses"
+        output, success = Dir.chdir(project_path) { capture(command) }
+        raise "Command '#{command}' failed to execute: #{output}" unless success
+
+        dependencies = GradleDependencyFinder.new(project_path).dependencies
+        packages = dependencies.flat_map do |xml_file|
+          options = {'GroupTags' => {'dependencies' => 'dependency'}}
+          contents = XmlSimple.xml_in(xml_file, options).fetch('dependency', [])
+          contents.map do |dep|
+            GradlePackage.new(dep, logger: logger, include_groups: @include_groups)
+          end
         end
+        packages.uniq
       end
-
-      packages.uniq
     end
 
-    def self.package_management_command
-      "gradle"
+    def package_management_command
+        if Platform.windows?
+          wrapper = 'gradlew.bat'
+          gradle = 'gradle.bat'
+        else
+          wrapper = './gradlew'
+          gradle = 'gradle'
+        end
+
+        File.exist?(File.join(project_path, wrapper)) ? wrapper : gradle
     end
 
     private
 
     def package_path
+      alternate_build_file = build_file_from_settings(project_path)
+      return alternate_build_file if alternate_build_file
+
       project_path.join('build.gradle')
     end
+
+    def build_file_from_settings(project_path)
+      settings_gradle_path = project_path.join 'settings.gradle'
+
+      return nil unless File.exists? settings_gradle_path
+
+      settings_gradle = File.read settings_gradle_path
+
+      match = /rootProject.buildFileName = ['"](?<build_file>.*)['"]/.match settings_gradle
+
+      return nil unless match
+
+      return project_path.join match[:build_file]
+    end
   end
 end

data/lib/license_finder/package_managers/maven.rb

@@ -1,35 +1,49 @@
 require "xmlsimple"
+require_relative "maven_dependency_finder"
 
 module LicenseFinder
   class Maven < PackageManager
+    def initialize(options={})
+      super
+      @ignored_groups = options[:ignored_groups]
+      @include_groups = options[:maven_include_groups]
+    end
+
     def current_packages
-      command = 'mvn license:download-licenses'
+      command = "#{package_management_command} org.codehaus.mojo:license-maven-plugin:download-licenses"
+      command += " -Dlicense.excludedScopes=#{@ignored_groups.to_a.join(',')}" if @ignored_groups and !@ignored_groups.empty?
+
       output, success = Dir.chdir(project_path) { capture(command) }
       raise "Command '#{command}' failed to execute: #{output}" unless success
 
-      xml = license_report.read
-
-      options = {
-        'GroupTags' => { 'licenses' => 'license', 'dependencies' => 'dependency' },
-        'ForceArray' => ['license', 'dependency']
-      }
-      dependencies = XmlSimple.xml_in(xml, options)["dependencies"]
-
-      dependencies.map do |dep|
-        MavenPackage.new(dep, logger: logger)
+      dependencies = MavenDependencyFinder.new(project_path).dependencies
+      packages = dependencies.flat_map do |xml|
+        options = {
+          'GroupTags' => { 'licenses' => 'license', 'dependencies' => 'dependency' },
+          'ForceArray' => ['license', 'dependency']
+        }
+        contents = XmlSimple.xml_in(xml, options)["dependencies"]
+        contents.map do |dep|
+          MavenPackage.new(dep, logger: logger, include_groups: @include_groups)
+        end
       end
+      packages.uniq
     end
 
-    def self.package_management_command
-      "mvn"
+    def package_management_command
+      if Platform.windows?
+        wrapper = 'mvnw.cmd'
+        maven = 'mvn'
+      else
+        wrapper = './mvnw'
+        maven = 'mvn'
+      end
+
+      File.exist?(File.join(project_path, wrapper)) ? wrapper : maven
     end
 
     private
 
-    def license_report
-      project_path.join('target/generated-resources/licenses.xml')
-    end
-
     def package_path
       project_path.join('pom.xml')
     end

data/lib/license_finder/package_managers/maven_dependency_finder.rb

@@ -0,0 +1,13 @@
+module LicenseFinder
+  class MavenDependencyFinder
+    def initialize(project_path)
+      @project_path = project_path
+    end
+
+    def dependencies
+      Pathname
+        .glob(@project_path.join('**', 'target', 'generated-resources', 'licenses.xml'))
+        .map(&:read)
+    end
+  end
+end

data/lib/license_finder/package_managers/maven_package.rb

@@ -1,8 +1,13 @@
 module LicenseFinder
   class MavenPackage < Package
     def initialize(spec, options={})
+      name = spec['artifactId']
+      if options[:include_groups]
+        name = "#{spec['groupId']}:#{name}"
+      end
+
       super(
-        spec["artifactId"],
+        name,
         spec["version"],
         options.merge(
           spec_licenses: Array(spec["licenses"]).map { |l| l["name"] }

data/lib/license_finder/package_managers/npm.rb

@@ -29,7 +29,7 @@ module LicenseFinder
     private
 
     def direct_dependencies
-      package_json = JSON.parse(File.read(package_path))
+      package_json = JSON.parse(File.read(package_path), :max_nesting => false)
       DEPENDENCY_GROUPS.map do |group|
         package_json.fetch(group, {}).keys.map do |dependency|
           {
@@ -51,14 +51,14 @@ module LicenseFinder
     end
 
     def npm_json
-      command = 'npm list --json --long'
+      command = "#{NPM::package_management_command} list --json --long"
       output, success = Dir.chdir(project_path) { capture(command) }
 
       if success
-        json = JSON(output)
+        json = JSON(output, :max_nesting => false)
       else
         json = begin
-                 JSON(output)
+                 JSON(output, :max_nesting => false)
                rescue JSON::ParserError
                  nil
                end

data/lib/license_finder/package_managers/rebar.rb

@@ -2,7 +2,7 @@ module LicenseFinder
   class Rebar < PackageManager
     def initialize(options={})
       super
-      @command = options[:rebar_command] || "rebar"
+      @command = options[:rebar_command] || Rebar::package_management_command
       @deps_path = Pathname(options[:rebar_deps_dir] || "deps")
     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 authors licenses approved summary description homepage install_path package_manager groups]
+    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."
 
     def initialize(dependencies, options)
@@ -51,6 +51,10 @@ module LicenseFinder
       end
     end
 
+    def format_license_links(dep)
+      dep.licenses.map(&:url).join(self.class::COMMA_SEP)
+    end
+
     def format_approved(dep)
       dep.approved? ? "Approved" : "Not approved"
     end

data/lib/license_finder/reports/diff_report.rb

@@ -10,12 +10,8 @@ module LicenseFinder
       dep.status
     end
 
-    def format_current_version(dep)
-      dep.current_version
-    end
-
-    def format_previous_version(dep)
-      dep.previous_version
+    def format_version(dep)
+      dep.version
     end
 
     def format_project_paths(dep)
@@ -25,7 +21,7 @@ module LicenseFinder
     private
 
     def build_columns(dependencies)
-      columns = %w[status name current_version previous_version licenses]
+      columns = %w[status name version licenses]
       columns << 'project_paths' if dependencies.all? { |delta| delta.merged_package? }
       columns
     end

data/lib/license_finder/reports/text_report.rb

@@ -3,7 +3,12 @@ module LicenseFinder
     COMMA_SEP =  ", "
 
     def initialize(dependencies, options={})
-      super(dependencies, options.merge(columns: %w[name version licenses]))
+      super(dependencies, options)
+
+      default_columns = %w[name version licenses]
+      if @columns.empty?
+        @columns = default_columns
+      end
     end
   end
 end

data/lib/license_finder/version.rb

@@ -1,3 +1,3 @@
 module LicenseFinder
-  VERSION = "2.1.2"
+  VERSION = "3.0.0"
 end

data/license_finder.gemspec

@@ -43,6 +43,8 @@ Gem::Specification.new do |s|
   s.add_dependency "httparty"
   s.add_dependency "xml-simple"
   s.add_dependency "rubyzip"
+  # to preserve ruby 1.9.3 support
+  s.add_dependency 'with_env', ((RUBY_VERSION <= '1.9.3') ? '1.0.0' : '> 1.0')
 
   s.add_development_dependency "capybara", "~> 2.0.0"
   s.add_development_dependency "cocoapods", "0.34.0" if LicenseFinder::Platform.darwin?
@@ -53,8 +55,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "webmock", "~> 1.13"
 
+  # to preserve ruby < 2.2.2 support.
+  s.add_development_dependency 'rack', ((RUBY_VERSION < '2.2.2') ? '1.6.0' : '> 1.6')
+
   # temporary to preserve ruby 1.9.3 support.
   s.add_development_dependency "mime-types", "< 3.0"
+  s.add_development_dependency "addressable", "< 2.5.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/lib/license_finder/configuration_spec.rb

@@ -47,14 +47,6 @@ module LicenseFinder
         )
         expect(subject.gradle_command).to eq "secondary"
       end
-
-      it "has default" do
-        subject = described_class.new(
-          {gradle_command: nil},
-          {"gradle_command" => nil}
-        )
-        expect(subject.gradle_command).to eq "gradle --console plain"
-      end
     end
 
     describe "decisions_file" do

data/spec/lib/license_finder/core_spec.rb

@@ -26,10 +26,11 @@ module LicenseFinder
         {
           logger: logger,
           project_path: configuration.project_path,
-          ignore_groups: Set.new,
+          ignored_groups: Set.new,
           go_full_version: nil,
           gradle_command: configuration.gradle_command,
           gradle_include_groups: nil,
+          maven_include_groups: nil,
           rebar_command: configuration.rebar_command,
           rebar_deps_dir: configuration.rebar_deps_dir
         }

data/spec/lib/license_finder/diff_spec.rb

@@ -6,8 +6,8 @@ module LicenseFinder
 
     let(:diff) { subject.compare(file1_content, file2_content) }
 
-    def find_package(name)
-      diff.find { |d| d.name == name }
+    def find_package_with_name(name)
+      diff.find_all { |d| d.name == name }
     end
 
     describe '#compare' do
@@ -16,7 +16,7 @@ module LicenseFinder
         let(:file2_content) { "nokogiri,1.6.6.2,MIT\nrspec,3.2.0,MIT" }
 
         it 'should create and set packages with added diff state' do
-          rspec = find_package('rspec')
+          rspec = find_package_with_name('rspec')[0]
           expect(rspec.status).to eq :added
         end
       end
@@ -26,7 +26,7 @@ module LicenseFinder
         let(:file2_content) { "nokogiri,1.6.6.2,MIT" }
 
         it 'should create and set packages with removed diff state' do
-          rspec = find_package('rspec')
+          rspec = find_package_with_name('rspec')[0]
           expect(rspec.status).to eq :removed
         end
       end
@@ -36,7 +36,7 @@ module LicenseFinder
         let(:file2_content) { "nokogiri,1.6.6.2,MIT" }
 
         it 'should create and set packages with unchanged diff state' do
-          nokogiri = find_package('nokogiri')
+          nokogiri = find_package_with_name('nokogiri')[0]
           expect(nokogiri.status).to eq :unchanged
         end
       end
@@ -46,9 +46,9 @@ module LicenseFinder
         let(:file2_content) { "nokogiri,1.6.6.2,MIT\nminitest,5.7.0,MIT\nfakefs,0.6.7,BSD" }
 
         it 'should create and set packages diff states' do
-          expect(find_package('minitest').status).to eq :added
-          expect(find_package('rspec').status).to eq :removed
-          expect(find_package('nokogiri').status).to eq :unchanged
+          expect(find_package_with_name('minitest')[0].status).to eq :added
+          expect(find_package_with_name('rspec')[0].status).to eq :removed
+          expect(find_package_with_name('nokogiri')[0].status).to eq :unchanged
         end
       end
 
@@ -56,12 +56,37 @@ module LicenseFinder
         let(:file1_content) { "rspec,3.2.0,MIT" }
         let(:file2_content) { "rspec,3.3.0,MIT" }
 
-        it 'should set the state to unchanged and record the version change' do
-          rspec = find_package('rspec')
+        it 'should add the new version and remove the previous version' do
+          rspecs = find_package_with_name('rspec')
+          expect(rspecs.size).to eq(2)
+          rspecs.each do |rspec|
+            case rspec.status
+              when :removed
+                expect(rspec.version).to eq('3.2.0')
+              when :added
+                expect(rspec.version).to eq('3.3.0')
+            end
+          end
+        end
 
-          expect(rspec.status).to eq(:unchanged)
-          expect(rspec.current_version).to eq('3.3.0')
-          expect(rspec.previous_version).to eq('3.2.0')
+        context 'when there are two versions of the same dependency' do
+          let(:file1_content) { "rspec,3.2.0,MIT\nrspec,1.1.0,MIT\nnokogiri,1.6.6.2,MIT" }
+          let(:file2_content) { "rspec,3.3.0,MIT\nrspec,1.1.0,MIT\nnokogiri,1.6.6.2,MIT" }
+          it 'should identify which version was updated' do
+            rspecs = find_package_with_name('rspec')
+            expect(rspecs.size).to eq(3)
+            rspecs.each do |rspec|
+              case rspec.status
+                when :removed
+                  expect(rspec.version).to eq('3.2.0')
+                when :added
+                  expect(rspec.version).to eq('3.3.0')
+                else
+                  expect(rspec.status).to eq(:unchanged)
+                  expect(rspec.version).to eq('1.1.0')
+              end
+            end
+          end
         end
       end
 
@@ -70,16 +95,14 @@ module LicenseFinder
         let(:file2_content) { "rspec,3.3.0,GPLv2" }
 
         it 'should set the state to unchanged and record the version change' do
-          rspec_old = diff.find {|p| p.previous_version == '3.2.0'}
-          rspec_new = diff.find {|p| p.current_version == '3.3.0'}
+          rspec_old = diff.find {|p| p.version == '3.2.0'}
+          rspec_new = diff.find {|p| p.version == '3.3.0'}
 
           expect(rspec_old.status).to eq(:removed)
-          expect(rspec_old.current_version).to eq(nil)
-          expect(rspec_old.previous_version).to eq('3.2.0')
+          expect(rspec_old.version).to eq('3.2.0')
 
           expect(rspec_new.status).to eq(:added)
-          expect(rspec_new.current_version).to eq('3.3.0')
-          expect(rspec_new.previous_version).to eq(nil)
+          expect(rspec_new.version).to eq('3.3.0')
         end
       end
 
@@ -88,17 +111,17 @@ module LicenseFinder
         let(:file2_content) { "rspec,3.2.0,MIT,\"/path/to/project1,/path/to/project2\"\nrails,4.2.0,MIT,/path/to/project1" }
 
         it 'should show the diff of the reports' do
-          rspec = find_package('rspec')
+          rspec = find_package_with_name('rspec')[0]
           expect(rspec.status).to eq(:unchanged)
-          expect(rspec.current_version).to eq('3.2.0')
-          expect(rspec.previous_version).to eq('3.2.0')
-          expect(rspec.subproject_paths).to match_array(['/path/to/project1', '/path/to/project2'])
+          expect(rspec.version).to eq('3.2.0')
+          paths = ['/path/to/project1', '/path/to/project2'].map { |p| File.absolute_path(p) }
+          expect(rspec.subproject_paths).to match_array(paths)
 
-          rails = find_package('rails')
+          rails = find_package_with_name('rails')[0]
           expect(rails.status).to eq(:added)
-          expect(rails.current_version).to eq('4.2.0')
-          expect(rails.previous_version).to eq(nil)
-          expect(rails.subproject_paths).to match_array(['/path/to/project1'])
+          expect(rails.version).to eq('4.2.0')
+          paths = ['/path/to/project1'].map { |p| File.absolute_path(p) }
+          expect(rails.subproject_paths).to match_array(paths)
         end
       end
     end