license_finder 2.0.0.rc2 → 2.0.0

data/features/features/configure/whitelist_licenses_spec.rb

@@ -2,39 +2,39 @@ require 'feature_helper'
 
 describe "Whitelisted licenses" do
   # As a developer
-  # I want to whitelist certain OSS licenses that my business has pre-approved
+  # I want to whitelist certain licenses that my business has pre-approved
   # So that any dependencies with those licenses do not show up as action items
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
 
-  before { user.create_empty_project }
+  before { developer.create_empty_project }
 
   specify "approve dependencies with those licenses" do
-    user.execute_command 'license_finder dependencies add bsd_gem BSD'
-    user.execute_command 'license_finder whitelist add BSD'
+    developer.execute_command 'license_finder dependencies add bsd_gem BSD'
+    developer.execute_command 'license_finder whitelist add BSD'
 
-    user.run_license_finder
-    expect(user).to_not be_seeing 'bsd_gem'
+    developer.run_license_finder
+    expect(developer).to_not be_seeing 'bsd_gem'
   end
 
   specify "approve dependencies with any of those licenses" do
-    user.execute_command 'license_finder dependencies add dep_with_many_licenses GPL'
-    user.execute_command 'license_finder licenses add dep_with_many_licenses MIT'
-    user.execute_command 'license_finder whitelist add GPL'
+    developer.execute_command 'license_finder dependencies add dep_with_many_licenses GPL'
+    developer.execute_command 'license_finder licenses add dep_with_many_licenses MIT'
+    developer.execute_command 'license_finder whitelist add GPL'
 
-    user.run_license_finder
-    expect(user).not_to be_seeing 'dep_with_many_licenses'
+    developer.run_license_finder
+    expect(developer).not_to be_seeing 'dep_with_many_licenses'
   end
 
   specify "are shown in the CLI" do
-    user.execute_command 'license_finder whitelist add Expat'
-    expect(user).to be_seeing 'Expat'
-    user.execute_command 'license_finder whitelist list'
-    expect(user).to be_seeing 'MIT'
-
-    user.execute_command 'license_finder whitelist remove Expat'
-    expect(user).to be_seeing 'Expat'
-    user.execute_command 'license_finder whitelist list'
-    expect(user).to_not be_seeing 'MIT'
+    developer.execute_command 'license_finder whitelist add Expat'
+    expect(developer).to be_seeing 'Expat'
+    developer.execute_command 'license_finder whitelist list'
+    expect(developer).to be_seeing 'MIT'
+
+    developer.execute_command 'license_finder whitelist remove Expat'
+    expect(developer).to be_seeing 'Expat'
+    developer.execute_command 'license_finder whitelist list'
+    expect(developer).to_not be_seeing 'MIT'
   end
 end

data/features/features/package_managers/bower_spec.rb

@@ -4,11 +4,11 @@ describe "Bower Dependencies" do
   # As a JS developer
   # I want to be able to manage Bower dependencies
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:js_developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
     LicenseFinder::TestingDSL::BowerProject.create
-    user.run_license_finder
-    expect(user).to be_seeing_line "gmaps, 0.2.30, MIT"
+    js_developer.run_license_finder
+    expect(js_developer).to be_seeing_line "gmaps, 0.2.30, MIT"
   end
 end

data/features/features/package_managers/cocoapods_spec.rb

@@ -1,14 +1,14 @@
 require 'feature_helper'
 
 describe "CocoaPods Dependencies", ios: true do
-  # As a Mac developer
+  # As a Cocoa developer
   # I want to be able to manage CocoaPods dependencies
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:cocoa_developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
     LicenseFinder::TestingDSL::CocoaPodsProject.create
-    user.run_license_finder
-    expect(user).to be_seeing_line "ABTest, 0.0.5, MIT"
+    cocoa_developer.run_license_finder
+    expect(cocoa_developer).to be_seeing_line "ABTest, 0.0.5, MIT"
   end
 end

data/features/features/package_managers/gradle_spec.rb

@@ -4,11 +4,11 @@ describe "Gradle Dependencies" do
   # As a Java developer
   # I want to be able to manage Gradle dependencies
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:java_developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
     LicenseFinder::TestingDSL::GradleProject.create
-    user.run_license_finder
-    expect(user).to be_seeing_line 'junit, 4.11, "Common Public License Version 1.0"'
+    java_developer.run_license_finder
+    expect(java_developer).to be_seeing_line 'junit, 4.11, "Common Public License Version 1.0"'
   end
 end

data/features/features/package_managers/maven_spec.rb

@@ -4,11 +4,11 @@ describe "Maven Dependencies" do
   # As a Java developer
   # I want to be able to manage Maven dependencies
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:java_developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
     LicenseFinder::TestingDSL::MavenProject.create
-    user.run_license_finder
-    expect(user).to be_seeing_line 'junit, 4.11, "Common Public License Version 1.0"'
+    java_developer.run_license_finder
+    expect(java_developer).to be_seeing_line 'junit, 4.11, "Common Public License Version 1.0"'
   end
 end

data/features/features/package_managers/npm_spec.rb

@@ -4,11 +4,11 @@ describe "NPM Dependencies" do
   # As a Node developer
   # I want to be able to manage NPM dependencies
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:node_developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
     LicenseFinder::TestingDSL::NpmProject.create
-    user.run_license_finder
-    expect(user).to be_seeing_line "http-server, 0.6.1, MIT"
+    node_developer.run_license_finder
+    expect(node_developer).to be_seeing_line "http-server, 0.6.1, MIT"
   end
 end

data/features/features/package_managers/pip_spec.rb

@@ -4,11 +4,11 @@ describe "Pip Dependencies" do
   # As a Python developer
   # I want to be able to manage Pip dependencies
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:python_developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
     LicenseFinder::TestingDSL::PipProject.create
-    user.run_license_finder
-    expect(user).to be_seeing_line 'argparse, 1.2.1, "Python Software Foundation License"'
+    python_developer.run_license_finder
+    expect(python_developer).to be_seeing_line 'rsa, 3.1.4, "ASL 2"'
   end
 end

data/features/features/report/csv_spec.rb

@@ -1,17 +1,18 @@
 require 'feature_helper'
 
 describe "CSV report" do
-  # As a non-technical application product owner
-  # I want license finder to generate an easy-to-understand text report
-  # So that I can quickly review my application dependencies and licenses
+  # As a non-technical product owner
+  # I want a csv report
+  # So that I can easily review my application's dependencies and licenses
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
+  let(:product_owner) { LicenseFinder::TestingDSL::User.new }
 
   specify "shows dependency data in CSV form" do
-    user.create_empty_project
-    user.execute_command 'license_finder dependencies add info_gem BSD 1.1.1'
+    developer.create_empty_project
+    developer.execute_command 'license_finder dependencies add info_gem BSD 1.1.1'
 
-    user.execute_command('license_finder report --format csv --columns approved name version licenses')
-    expect(user).to be_seeing "Not approved,info_gem,1.1.1,BSD"
+    product_owner.execute_command('license_finder report --format csv --columns approved name version licenses')
+    expect(product_owner).to be_seeing "Not approved,info_gem,1.1.1,BSD"
   end
 end

data/features/features/report/html_spec.rb

@@ -1,11 +1,12 @@
 require 'feature_helper'
 
 describe "HTML report" do
-  # As a non-technical application product owner
-  # I want license finder to generate an easy-to-understand HTML report
-  # So that I can quickly review my application dependencies and licenses
+  # As a non-technical product owner
+  # I want an HTML report
+  # So that I can easily review my application's dependencies and licenses
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
+  let(:product_owner) { LicenseFinder::TestingDSL::User.new }
 
   specify "shows basic dependency data" do
     gem_name = "a_gem"
@@ -18,11 +19,11 @@ describe "HTML report" do
       homepage:    "http://a_gem.github.com"
     }
 
-    project = user.create_ruby_app
-    gem = user.create_gem gem_name, gem_attributes
+    project = developer.create_ruby_app
+    gem = developer.create_gem gem_name, gem_attributes
     project.depend_on gem, groups: [gem_group]
 
-    user.view_html.in_dep(gem_name) do |section|
+    product_owner.view_html.in_dep(gem_name) do |section|
       expect(section.find("a[href='#{gem_attributes[:homepage]}']", text: gem_name)).to be
       expect(section).to have_content gem_attributes[:license]
       expect(section).to have_content gem_attributes[:summary]
@@ -33,12 +34,12 @@ describe "HTML report" do
   end
 
   specify "shows approval status of dependencies" do
-    user.create_empty_project
-    user.execute_command 'license_finder dependencies add gpl_dep GPL'
-    user.execute_command 'license_finder dependencies add mit_dep MIT'
-    user.execute_command 'license_finder whitelist add MIT'
+    developer.create_empty_project
+    developer.execute_command 'license_finder dependencies add gpl_dep GPL'
+    developer.execute_command 'license_finder dependencies add mit_dep MIT'
+    developer.execute_command 'license_finder whitelist add MIT'
 
-    html = user.view_html
+    html = product_owner.view_html
     expect(html).to be_unapproved 'gpl_dep'
     expect(html).to be_approved 'mit_dep'
 

data/features/support/testing_dsl.rb

@@ -79,7 +79,7 @@ module LicenseFinder::TestingDSL
 
   class PipProject < Project
     def add_dep
-      add_to_file("requirements.txt", 'argparse==1.2.1')
+      add_to_file("requirements.txt", 'rsa==3.1.4')
     end
 
     def install

data/lib/license_finder.rb

@@ -6,21 +6,6 @@ module LicenseFinder
   BIN_PATH = ROOT_PATH.join("../../bin")
 end
 
-require 'license_finder/platform'
-require 'license_finder/version'
-require 'license_finder/logger'
-require 'license_finder/configuration'
-
-require 'license_finder/license'
-
-require 'license_finder/possible_license_file'
-require 'license_finder/possible_license_files'
-require 'license_finder/package'
-require 'license_finder/package_manager'
-
-require 'license_finder/decisions'
-require 'license_finder/decision_applier'
-
-require 'license_finder/report'
+require 'license_finder/core'
 
 require 'license_finder/cli'

data/lib/license_finder/cli/approvals.rb

@@ -6,10 +6,9 @@ module LicenseFinder
 
       auditable
       desc "add DEPENDENCY...", "Approve one or more dependencies by name"
-      def add(name, *other_names)
-        names = modify_each(name, *other_names) do |name|
-          decisions.approve(name, txn)
-        end
+      def add(*names)
+        assert_some names
+        modifying { names.each { |name| decisions.approve(name, txn) } }
 
         say "The #{names.join(", ")} dependency has been approved!", :green
       end

data/lib/license_finder/cli/base.rb

@@ -1,3 +1,5 @@
+require 'thor'
+
 module LicenseFinder
   module CLI
     class Base < Thor
@@ -5,14 +7,49 @@ module LicenseFinder
 
       no_commands do
         def decisions
-          @decisions ||= Decisions.saved!(config.decisions_file)
+          license_finder.decisions
         end
       end
 
       private
 
-      def config
-        @config ||= Configuration.with_optional_saved_config(options)
+      def license_finder
+        @lf ||= LicenseFinder::Core.new(license_finder_config)
+      end
+
+      def license_finder_config
+        result = extract_options(:decisions_file, :gradle_command)
+        result[:logger] = logger_config
+        result[:project_path] = Pathname.pwd
+        result
+      end
+
+      def logger_config
+        @logger_config ||= extract_options(:quiet, :debug)
+      end
+
+      def say_each(coll)
+        if coll.any?
+          coll.each do |item|
+            say(block_given? ? yield(item) : item)
+          end
+        else
+          say '(none)'
+        end
+      end
+
+      def assert_some(things)
+        unless things.any?
+          raise ArgumentError, "wrong number of arguments (0 for 1+)", caller
+        end
+      end
+
+      def extract_options(*keys)
+        result = {}
+        keys.each do |key|
+          result[key.to_sym] = options[key.to_s] if options.has_key? key.to_s
+        end
+        result
       end
     end
   end

data/lib/license_finder/cli/dependencies.rb

@@ -9,9 +9,9 @@ module LicenseFinder
       desc "add DEPENDENCY LICENSE [VERSION] [--approve]", "Add a dependency that is not managed by a package manager, optionally approving it at the same time"
       def add(name, license, version = nil)
         modifying {
-          decisions.
-            add_package(name, version, txn).
-            license(name, license, txn)
+          decisions
+            .add_package(name, version, txn)
+            .license(name, license, txn)
           decisions.approve(name, txn) if options[:approve]
         }
         if options[:approve]

data/lib/license_finder/cli/main.rb

@@ -1,3 +1,6 @@
+require 'license_finder/report'
+require 'license_finder/version'
+
 module LicenseFinder
   module CLI
     class Main < Base
@@ -18,7 +21,7 @@ module LicenseFinder
       method_option :debug, type: :boolean, desc: "emit detailed info about what LicenseFinder is doing"
       desc "action_items", "List unapproved dependencies (the default action for `license_finder`)"
       def action_items
-        unapproved = decision_applier.unapproved
+        unapproved = license_finder.unapproved
 
         if unapproved.empty?
           say "All dependencies are approved for use", :green
@@ -33,8 +36,8 @@ module LicenseFinder
 
       desc "report", "Print a report of the project's dependencies to stdout"
       def report
-        dependencies = decision_applier(Logger.new(quiet: true))
-        say report_of(dependencies.acknowledged)
+        logger_config[:quiet] = true
+        say report_of(license_finder.acknowledged)
       end
 
       desc "version", "Print the version of LicenseFinder"
@@ -52,30 +55,9 @@ module LicenseFinder
 
       private
 
-      # The core of the system. The saved decisions are applied to the current
-      # packages.
-      def decision_applier(logger = Logger.new(options))
-        DecisionApplier.new(
-          decisions: decisions,
-          packages: current_packages(logger)
-        )
-      end
-
-      def current_packages(logger)
-        PackageManager.current_packages(
-          logger: logger,
-          gradle_command: config.gradle_command,
-          ignore_groups: decisions.ignored_groups
-        )
-      end
-
       def report_of(content)
         report = FORMATS[options[:format]]
-        report.of(content, columns: options[:columns], project_name: fetch_project_name)
-      end
-
-      def fetch_project_name
-        decisions.project_name || Pathname.pwd.basename.to_s
+        report.of(content, columns: options[:columns], project_name: license_finder.project_name)
       end
     end
   end

data/lib/license_finder/cli/makes_decisions.rb

@@ -14,16 +14,6 @@ module LicenseFinder
 
       private
 
-      def say_each(coll)
-        if coll.any?
-          coll.each do |item|
-            say(block_given? ? yield(item) : item)
-          end
-        else
-          say '(none)'
-        end
-      end
-
       def txn
         @txn ||= {
           who: options[:who],
@@ -32,17 +22,9 @@ module LicenseFinder
         }
       end
 
-      def modifying
-        # decisions = Decisions.saved! # is part of Base
-        yield
-        decisions.save!(config.decisions_file)
-      end
-
-      def modify_each(*things)
-        modifying { things.each { |thing| yield thing } }
-        things
+      def modifying(&block)
+        license_finder.modifying(&block)
       end
     end
   end
 end
-