license_finder 2.0.0.rc2 → 2.0.0

data/lib/license_finder/package_managers/npm.rb

@@ -36,7 +36,7 @@ module LicenseFinder
     end
 
     def package_path
-      Pathname.new('package.json')
+      project_path.join('package.json')
     end
 
     # node_module can be empty hash if it is included elsewhere

data/lib/license_finder/package_managers/pip.rb

@@ -19,7 +19,7 @@ module LicenseFinder
     private
 
     def package_path
-      Pathname.new('requirements.txt')
+      project_path.join('requirements.txt')
     end
 
     def pypi_def(name, version)

data/lib/license_finder/package_managers/pip_package.rb

@@ -1,14 +1,16 @@
 module LicenseFinder
   class PipPackage < Package
+    LICENSE_FORMAT = /^License.*::\s*(.*)$/
+
     def self.license_names_from_spec(spec)
       license = spec["license"]
 
       return [license] if license && license != "UNKNOWN"
 
-      spec.
-        fetch("classifiers", []).
-        select { |c| c.start_with?("License") }.
-        map { |c| c.gsub(/^License.*::\s*(.*)$/, '\1') }
+      spec
+        .fetch("classifiers", [])
+        .select { |c| c =~ LICENSE_FORMAT }
+        .map { |c| c.gsub(LICENSE_FORMAT, '\1') }
     end
 
     def initialize(name, version, install_path, spec, options={})

data/lib/license_finder/packages/activation.rb

@@ -0,0 +1,54 @@
+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
+
+    class FromDecision < Basic
+      def sources
+        ["from decision"]
+      end
+    end
+
+    class FromSpec < Basic
+      def sources
+        ["from spec"]
+      end
+    end
+
+    class FromFiles < Basic
+      def initialize(package, license, files)
+        super(package, license)
+        @files = files
+      end
+
+      attr_reader :files
+
+      def sources
+        files.map { |file| "from file '#{file.path}'" }
+      end
+    end
+
+    class None < Basic
+      def sources
+        []
+      end
+
+      def log(logger)
+        log_package(logger, "no licenses found")
+      end
+    end
+  end
+end

data/lib/license_finder/{possible_license_files.rb → packages/license_files.rb}

@@ -1,5 +1,7 @@
+require 'license_finder/packages/possible_license_file'
+
 module LicenseFinder
-  class PossibleLicenseFiles
+  class LicenseFiles
     CANDIDATE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
     CANDIDATE_PATH_WILDCARD = "*{#{CANDIDATE_FILE_NAMES.join(',')}}*"
 
@@ -12,9 +14,9 @@ module LicenseFinder
     end
 
     def find
-      paths_of_candidate_files.map do |path|
-        PossibleLicenseFile.new(path)
-      end
+      paths_of_candidate_files
+        .map { |path| PossibleLicenseFile.new(path) }
+        .reject { |file| file.license.nil? }
     end
 
     private
@@ -22,9 +24,9 @@ module LicenseFinder
     attr_reader :install_path
 
     def paths_of_candidate_files
-      candidate_files_and_dirs.map do |path|
-        path.directory? ? path.children : path
-      end.flatten.uniq
+      candidate_files_and_dirs
+        .flat_map { |path| path.directory? ? path.children : path }
+        .uniq
     end
 
     def candidate_files_and_dirs

data/lib/license_finder/packages/licensing.rb

@@ -0,0 +1,43 @@
+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
+      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]
+    end
+
+    def activations_from_decisions
+      decided_licenses
+        .map { |license| Activation::FromDecision.new(package, license) }
+    end
+
+    def activations_from_spec
+      licenses_from_spec
+        .map { |license| Activation::FromSpec.new(package, license) }
+    end
+
+    def activations_from_files
+      license_files
+        .group_by(&:license)
+        .map { |license, files| Activation::FromFiles.new(package, license, files) }
+    end
+
+    def default_activation
+      default_license = License.find_by_name nil
+      Activation::None.new(package, default_license)
+    end
+  end
+end

data/lib/license_finder/{possible_license_file.rb → packages/possible_license_file.rb}

@@ -12,8 +12,6 @@ module LicenseFinder
       License.find_by_text(text)
     end
 
-    private
-
     def text
       @text ||= (@path.respond_to?(:binread) ? @path.binread : @path.read)
     end

data/lib/license_finder/version.rb

@@ -1,3 +1,3 @@
 module LicenseFinder
-  VERSION = "2.0.0.rc2"
+  VERSION = "2.0.0"
 end

data/spec/fixtures/license_directory/COPYING

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/license_directory/LICENSE/MIT.txt

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/license_names/COPYING.txt

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/license_names/LICENSE

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/license_names/Licence.rdoc

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/license_names/Mit-License

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/license_names/README.rdoc

@@ -0,0 +1 @@
+The MIT License

data/spec/fixtures/nested_gem/vendor/LICENSE

@@ -0,0 +1 @@
+The MIT License

data/spec/lib/license_finder/cli/approvals_spec.rb

@@ -32,11 +32,17 @@ module LicenseFinder
         end
 
         it "sets approver and approval message" do
-          expect(decisions).to receive(:approve).with("foo", hash_including(who: "Julian", why:  "We really need this"))
-
+          subject.options = {
+            who: "Julian",
+            why: "We really need this"
+          }
           silence_stdout do
-            Main.start(["approval", "add", "--who", "Julian", "--why", "We really need this", "foo"])
+            subject.add("foo")
           end
+
+          approval = subject.decisions.approval_of("foo")
+          expect(approval.who).to eq "Julian"
+          expect(approval.why).to eq "We really need this"
         end
       end
 

data/spec/lib/license_finder/cli/dependencies_spec.rb

@@ -31,10 +31,13 @@ module LicenseFinder
         end
 
         it "has an --approve option to approve the added dependency" do
-          expect(decisions).to receive(:approve).with("js_dep", hash_including(who: "Julian", why:  "We really need this"))
+          subject.options = { approve: true, who: "Julian", why: "We really need this" }
           silence_stdout do
-            Main.start(["dependencies", "add", "--approve", "--who", "Julian", "--why", "We really need this", "js_dep", "MIT", "1.2.3"])
+            subject.add("js_dep", "MIT")
           end
+          approval = subject.decisions.approval_of("js_dep")
+          expect(approval.who).to eq "Julian"
+          expect(approval.why).to eq "We really need this"
         end
       end
 

data/spec/lib/license_finder/cli/main_spec.rb

@@ -30,44 +30,36 @@ module LicenseFinder
       describe "#report" do
         let(:packages) { [Package.new('one dependency', "1.1")] }
 
+        def report
+          capture_stdout { subject.report }
+        end
+
         it "reports acknowleged dependencies" do
-          result = capture_stdout do
-            Main.start(["report"])
-          end
-          expect(result).to eq "\"one dependency\", 1.1, unknown\n"
+          expect(report).to eq "\"one dependency\", 1.1, unknown\n"
         end
 
         it "will output a specific format" do
-          result = capture_stdout do
-            Main.start(%w[report --format markdown])
-          end
+          subject.options = { format: 'markdown' }
 
-          expect(result).to include "## Action"
+          expect(report).to include "## Action"
         end
 
         it "will output a custom csv" do
-          result = capture_stdout do
-            Main.start(%w[report --format csv --columns name version])
-          end
+          subject.options = { format: 'csv', columns: ['name', 'version'] }
 
-          expect(result).to eq "one dependency,1.1\n"
+          expect(report).to eq "one dependency,1.1\n"
         end
 
         context "in html reports" do
-          subject do
-            result = capture_stdout do
-              Main.start(%w[report --format html])
-            end
-
-            html = Capybara.string(result)
-            html.find "h1"
+          before do
+            subject.options = { format: 'html' }
           end
 
           context "when the project has a name" do
             before { decisions.name_project("given project name") }
 
             it "should show the project name" do
-              is_expected.to have_text "given project name"
+              expect(report).to include "given project name"
             end
           end
 
@@ -75,21 +67,24 @@ module LicenseFinder
             before { allow(Dir).to receive(:getwd).and_return("/path/to/a_project") }
 
             it "should default to the directory name" do
-              is_expected.to have_text "a_project"
+              expect(report).to include "a_project"
             end
           end
         end
       end
 
       describe "#action_items" do
+        def action_items
+          subject.options = { quiet: true, format: 'text' }
+          subject.action_items
+        end
+
         context "with unapproved dependencies" do
           let(:packages) { [Package.new('one dependency')] }
 
           it "reports unapproved dependencies" do
             result = capture_stdout do
-              expect do
-                Main.start(%w[action_items --quiet])
-              end.to raise_error(SystemExit)
+              expect { action_items }.to raise_error(SystemExit)
             end
             expect(result).to match /dependencies/i
             expect(result).to match /one dependency/
@@ -98,9 +93,7 @@ module LicenseFinder
 
         it "reports that all dependencies are approved" do
           result = capture_stdout do
-            expect do
-              Main.start(%w[action_items --quiet])
-            end.not_to raise_error
+            expect { action_items }.not_to raise_error
           end
           expect(result).to match /approved/i
         end

data/spec/lib/license_finder/configuration_spec.rb

@@ -4,9 +4,7 @@ module LicenseFinder
   describe Configuration do
     describe ".with_optional_saved_config" do
       it "should init and use saved config" do
-        fake_project_dir = Pathname.new(__FILE__).dirname.join('..', '..', 'fixtures')
-
-        subject = described_class.with_optional_saved_config({}, fake_project_dir)
+        subject = described_class.with_optional_saved_config({}, fixture_path("."))
         expect(subject.gradle_command).to eq('gradlew')
       end
     end

data/spec/lib/license_finder/decision_applier_spec.rb

@@ -12,24 +12,24 @@ module LicenseFinder
       end
 
       it "applies decided licenses" do
-        decisions = Decisions.new.
-          add_package("manual", nil).
-          license("manual", "MIT")
+        decisions = Decisions.new
+          .add_package("manual", nil)
+          .license("manual", "MIT")
         decision_applier = described_class.new(decisions: decisions, packages: [])
         expect(decision_applier.acknowledged.last.licenses).to eq Set.new([License.find_by_name("MIT")])
       end
 
       it "ignores specific packages" do
-        decisions = Decisions.new.
-          add_package("manual", nil).
-          ignore("manual")
+        decisions = Decisions.new
+          .add_package("manual", nil)
+          .ignore("manual")
         decision_applier = described_class.new(decisions: decisions, packages: [])
         expect(decision_applier.acknowledged).to be_empty
       end
 
       it "ignores packages in certain groups" do
-        decisions = Decisions.new.
-          ignore_group("development")
+        decisions = Decisions.new
+          .ignore_group("development")
         dev_dep = Package.new("dep", nil, groups: ["development"])
         decision_applier = described_class.new(
           decisions: decisions,
@@ -39,9 +39,9 @@ module LicenseFinder
       end
 
       it "adds manual approvals to packages" do
-        decisions = Decisions.new.
-          add_package("manual", nil).
-          approve("manual", who: "Approver", why: "Because")
+        decisions = Decisions.new
+          .add_package("manual", nil)
+          .approve("manual", who: "Approver", why: "Because")
         decision_applier = described_class.new(decisions: decisions, packages: [])
         dep = decision_applier.acknowledged.last
         expect(dep).to be_approved
@@ -51,10 +51,10 @@ module LicenseFinder
       end
 
       it "adds whitelist approvals to packages" do
-        decisions = Decisions.new.
-          add_package("manual", nil).
-          license("manual", "MIT").
-          whitelist("MIT")
+        decisions = Decisions.new
+          .add_package("manual", nil)
+          .license("manual", "MIT")
+          .whitelist("MIT")
         decision_applier = described_class.new(decisions: decisions, packages: [])
         dep = decision_applier.acknowledged.last
         expect(dep).to be_approved

data/spec/lib/license_finder/decisions_spec.rb

@@ -16,34 +16,35 @@ module LicenseFinder
 
     describe ".remove_package" do
       it "drops a package" do
-        packages = subject.
-          add_package("dep", nil).
-          remove_package("dep").
-          packages
+        packages = subject
+          .add_package("dep", nil)
+          .remove_package("dep")
+          .packages
         expect(packages.size).to eq 0
       end
 
       it "does nothing if package was never added" do
-        packages = subject.
-          remove_package("dep").
-          packages
+        packages = subject
+          .remove_package("dep")
+          .packages
         expect(packages.size).to eq 0
       end
     end
 
     describe ".license" do
       it "will report license for a dependency" do
-        license = subject.
-          license("dep", "MIT").
-          licenses_of("dep").first
+        license = subject
+          .license("dep", "MIT")
+          .licenses_of("dep")
+          .first
         expect(license).to eq License.find_by_name("MIT")
       end
 
       it "will report multiple licenses" do
-        licenses = subject.
-          license("dep", "MIT").
-          license("dep", "GPL").
-          licenses_of("dep")
+        licenses = subject
+          .license("dep", "MIT")
+          .license("dep", "GPL")
+          .licenses_of("dep")
         expect(licenses).to eq [
           License.find_by_name("MIT"),
           License.find_by_name("GPL"),
@@ -51,37 +52,39 @@ module LicenseFinder
       end
 
       it "adapts names" do
-        license = subject.
-          license("dep", "Expat").
-          licenses_of("dep").first
+        license = subject
+          .license("dep", "Expat")
+          .licenses_of("dep")
+          .first
         expect(license).to eq License.find_by_name("MIT")
       end
     end
 
     describe ".unlicense" do
       it "will not report the given dependency as licensed" do
-        licenses = subject.
-          license("dep", "MIT").
-          unlicense("dep", "MIT").
-          licenses_of("dep")
+        licenses = subject
+          .license("dep", "MIT")
+          .unlicense("dep", "MIT")
+          .licenses_of("dep")
         expect(licenses).to be_empty
       end
 
       it "will only remove the specified license" do
-        licenses = subject.
-          license("dep", "MIT").
-          license("dep", "GPL").
-          unlicense("dep", "MIT").
-          licenses_of("dep")
+        licenses = subject
+          .license("dep", "MIT")
+          .license("dep", "GPL")
+          .unlicense("dep", "MIT")
+          .licenses_of("dep")
         expect(licenses).to eq [License.find_by_name("GPL")].to_set
       end
 
       it "is cumulative" do
-        license = subject.
-          license("dep", "MIT").
-          unlicense("dep", "MIT").
-          license("dep", "MIT").
-          licenses_of("dep").first
+        license = subject
+          .license("dep", "MIT")
+          .unlicense("dep", "MIT")
+          .license("dep", "MIT")
+          .licenses_of("dep")
+          .first
         expect(license).to eq License.find_by_name("MIT")
       end
     end
@@ -99,17 +102,17 @@ module LicenseFinder
 
     describe ".unapprove" do
       it "will not report the given dependency as approved" do
-        decisions = subject.
-          approve("dep").
-          unapprove("dep")
+        decisions = subject
+          .approve("dep")
+          .unapprove("dep")
         expect(subject).not_to be_approved("dep")
       end
 
       it "is cumulative" do
-        decisions = subject.
-          approve("dep").
-          unapprove("dep").
-          approve("dep")
+        decisions = subject
+          .approve("dep")
+          .unapprove("dep")
+          .approve("dep")
         expect(subject).to be_approved("dep")
       end
     end
@@ -133,24 +136,24 @@ module LicenseFinder
 
     describe ".unwhitelist" do
       it "will not report the given license as approved" do
-        decisions = subject.
-          whitelist("MIT").
-          unwhitelist("MIT")
+        decisions = subject
+          .whitelist("MIT")
+          .unwhitelist("MIT")
         expect(decisions).not_to be_whitelisted(License.find_by_name("MIT"))
       end
 
       it "is cumulative" do
-        decisions = subject.
-          whitelist("MIT").
-          unwhitelist("MIT").
-          whitelist("MIT")
+        decisions = subject
+          .whitelist("MIT")
+          .unwhitelist("MIT")
+          .whitelist("MIT")
         expect(decisions).to be_whitelisted(License.find_by_name("MIT"))
       end
 
       it "adapts names" do
-        decisions = subject.
-          whitelist("MIT").
-          unwhitelist("Expat")
+        decisions = subject
+          .whitelist("MIT")
+          .unwhitelist("Expat")
         expect(decisions).not_to be_whitelisted(License.find_by_name("MIT"))
       end
     end
@@ -164,42 +167,41 @@ module LicenseFinder
 
     describe ".heed" do
       it "will not report heeded dependencies" do
-        decisions = subject.
-          ignore("dep").
-          heed("dep")
+        decisions = subject
+          .ignore("dep")
+          .heed("dep")
         expect(decisions).not_to be_ignored("dep")
       end
 
       it "is cumulative" do
-        decisions = subject.
-          ignore("dep").
-          heed("dep").
-          ignore("dep")
+        decisions = subject
+          .ignore("dep")
+          .heed("dep")
+          .ignore("dep")
         expect(decisions).to be_ignored("dep")
       end
     end
 
     describe ".ignore_group" do
       it "will report ignored groups" do
-        decisions = subject.
-          ignore_group("development")
+        decisions = subject.ignore_group("development")
         expect(decisions).to be_ignored_group("development")
       end
     end
 
     describe ".heed_group" do
       it "will not report heeded groups" do
-        decisions = subject.
-          ignore_group("development").
-          heed_group("development")
+        decisions = subject
+          .ignore_group("development")
+          .heed_group("development")
         expect(decisions).not_to be_ignored_group("development")
       end
 
       it "is cumulative" do
-        decisions = subject.
-          ignore_group("development").
-          heed_group("development").
-          ignore_group("development")
+        decisions = subject
+          .ignore_group("development")
+          .heed_group("development")
+          .ignore_group("development")
         expect(decisions).to be_ignored_group("development")
       end
     end
@@ -213,9 +215,9 @@ module LicenseFinder
 
     describe ".unname_project" do
       it "reports project name" do
-        decisions = subject.
-          name_project("proj").
-          unname_project
+        decisions = subject
+          .name_project("proj")
+          .unname_project
         expect(decisions.project_name).to be_nil
       end
     end
@@ -227,8 +229,7 @@ module LicenseFinder
 
       it "can restore added packages" do
         decisions = roundtrip(
-          subject.
-          add_package("dep", "0.2.0")
+          subject.add_package("dep", "0.2.0")
         )
         packages = decisions.packages
         expect(packages.map(&:name)).to eq ["dep"]
@@ -236,9 +237,9 @@ module LicenseFinder
 
       it "can restore removed packages" do
         decisions = roundtrip(
-          subject.
-          add_package("dep", nil).
-          remove_package("dep")
+          subject
+            .add_package("dep", nil)
+            .remove_package("dep")
         )
         expect(decisions.packages.size).to eq 0
       end
@@ -252,10 +253,10 @@ module LicenseFinder
 
       it "can restore unlicenses" do
         licenses = roundtrip(
-          subject.
-          license("dep", "MIT").
-          license("dep", "GPL").
-          unlicense("dep", "MIT")
+          subject
+            .license("dep", "MIT")
+            .license("dep", "GPL")
+            .unlicense("dep", "MIT")
         ).licenses_of("dep")
         expect(licenses).to eq [License.find_by_name("GPL")].to_set
       end
@@ -272,9 +273,9 @@ module LicenseFinder
 
       it "can restore unapprovals" do
         decisions = roundtrip(
-          subject.
-          approve("dep").
-          unapprove("dep")
+          subject
+            .approve("dep")
+            .unapprove("dep")
         )
         expect(decisions).not_to be_approved("dep")
       end
@@ -288,9 +289,9 @@ module LicenseFinder
 
       it "can restore un-whitelists" do
         decisions = roundtrip(
-          subject.
-          whitelist("MIT").
-          unwhitelist("MIT")
+          subject
+            .whitelist("MIT")
+            .unwhitelist("MIT")
         )
         expect(decisions).not_to be_whitelisted(License.find_by_name("MIT"))
       end
@@ -302,43 +303,41 @@ module LicenseFinder
 
       it "can restore heeds" do
         decisions = roundtrip(
-          subject.
-          ignore("dep").
-          heed("dep")
+          subject
+            .ignore("dep")
+            .heed("dep")
         )
         expect(decisions).not_to be_ignored("dep")
       end
 
       it "can restore ignored groups" do
         decisions = roundtrip(
-          subject.
-          ignore_group("development")
+          subject.ignore_group("development")
         )
         expect(decisions).to be_ignored_group("development")
       end
 
       it "can restore heeded groups" do
         decisions = roundtrip(
-          subject.
-          ignore_group("development").
-          heed_group("development")
+          subject
+            .ignore_group("development")
+            .heed_group("development")
         )
         expect(decisions).not_to be_ignored_group("development")
       end
 
       it "can restore project names" do
         decisions = roundtrip(
-          subject.
-          name_project("an-app")
+          subject.name_project("an-app")
         )
         expect(decisions.project_name).to eq "an-app"
       end
 
       it "can restore project unnames" do
         decisions = roundtrip(
-          subject.
-          name_project("an-app").
-          unname_project
+          subject
+            .name_project("an-app")
+            .unname_project
         )
         expect(decisions.project_name).to be_nil
       end