license_finder 1.2 → 2.0.0.rc2

data/lib/license_finder/reports/text_report.rb

@@ -1,7 +1,9 @@
 module LicenseFinder
-  class TextReport < DependencyReport
-    def to_s
-      super.strip
+  class TextReport < CsvReport
+    COMMA_SEP =  ", "
+
+    def initialize(dependencies, options={})
+      super(dependencies, options.merge(columns: %w[name version licenses]))
     end
   end
 end

data/lib/license_finder/version.rb

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

data/license_finder.gemspec

@@ -1,9 +1,10 @@
 require './lib/license_finder/platform'
+require './lib/license_finder/version'
 
 Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   s.name        = "license_finder"
-  s.version     = "1.2"
+  s.version     = LicenseFinder::VERSION
 
   s.authors = [
     "Jacob Maine",
@@ -35,16 +36,13 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
 
   s.add_dependency "bundler"
-  s.add_dependency "sequel"
   s.add_dependency "thor"
   s.add_dependency "httparty"
   s.add_dependency "xml-simple"
-  s.add_dependency LicenseFinder::Platform.sqlite_gem
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "xpath"
-  s.add_development_dependency "cucumber"
   s.add_development_dependency "pry"
   s.add_development_dependency "rspec", "~> 3"
   s.add_development_dependency "capybara", "~> 2.0.0"
@@ -54,6 +52,4 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-
-  s.platform = "java" if LicenseFinder::Platform.java?
 end

data/release/instructions.md

@@ -0,0 +1,8 @@
+## Release
+
+Releasing involves building a package, tagging its version on github and
+pushing it to http://rubygems.org.
+
+Like other gems, you can build, tag and release `license_finder` with `rake
+release`.  You may want to run `rake -T` before releasing to confirm you are
+releasing the correct version.

data/spec/feature_helper.rb

@@ -0,0 +1,11 @@
+# These are integration tests, so reaching directly into LicenseFinder is forbidden
+# DO NOT:
+# require 'rubygems'
+# require 'bundler/setup'
+# require 'license_finder'
+
+require './features/support/testing_dsl'
+
+RSpec.configure do |rspec|
+  rspec.default_formatter = 'doc'
+end

data/spec/fixtures/config/license_finder.yml

@@ -0,0 +1,3 @@
+---
+decisions_file: './some_path/'
+gradle_command: 'gradlew'

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

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe Approvals do
+      let(:decisions) { Decisions.new }
+
+      before do
+        allow(Decisions).to receive(:saved!) { decisions }
+      end
+
+      describe "#add" do
+        it "approves the requested gem" do
+          silence_stdout do
+            subject.add 'foo'
+          end
+          expect(subject.decisions).to be_approved "foo"
+        end
+
+        it "approves multiple dependencies" do
+          silence_stdout do
+            subject.add 'foo', 'bar'
+          end
+          expect(subject.decisions).to be_approved "foo"
+          expect(subject.decisions).to be_approved "bar"
+        end
+
+        it "raises a warning if no dependency was specified" do
+          silence_stdout do
+            expect { subject.add }.to raise_error(ArgumentError)
+          end
+        end
+
+        it "sets approver and approval message" do
+          expect(decisions).to receive(:approve).with("foo", hash_including(who: "Julian", why:  "We really need this"))
+
+          silence_stdout do
+            Main.start(["approval", "add", "--who", "Julian", "--why", "We really need this", "foo"])
+          end
+        end
+      end
+
+      describe "remove" do
+        it "unapproves the specified dependency" do
+          silence_stdout do
+            subject.add("test")
+            subject.remove("test")
+          end
+          expect(subject.decisions).not_to be_approved "test"
+        end
+
+        it "is cumulative" do
+          silence_stdout do
+            subject.add("test")
+            subject.remove("test")
+            subject.add("test")
+          end
+          expect(subject.decisions).to be_approved "test"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe Dependencies do
+      let(:decisions) { Decisions.new }
+
+      before do
+        allow(Decisions).to receive(:saved!) { decisions }
+      end
+
+      describe "add" do
+        it "adds a dependency" do
+          silence_stdout do
+            subject.add("js_dep", "MIT", "1.2.3")
+          end
+
+          expect(subject.decisions.packages.size).to eq 1
+          package = subject.decisions.packages.first
+          expect(package.name).to eq "js_dep"
+          expect(package.version).to eq "1.2.3"
+          expect(subject.decisions.licenses_of("js_dep")).to eq [License.find_by_name("MIT")].to_set
+        end
+
+        it "does not require a version" do
+          silence_stdout do
+            subject.add("js_dep", "MIT")
+          end
+          package = subject.decisions.packages.first
+          expect(package.version).to be_nil
+        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"))
+          silence_stdout do
+            Main.start(["dependencies", "add", "--approve", "--who", "Julian", "--why", "We really need this", "js_dep", "MIT", "1.2.3"])
+          end
+        end
+      end
+
+      describe "remove" do
+        it "removes a dependency" do
+          silence_stdout do
+            subject.add("js_dep", "MIT")
+            subject.remove("js_dep")
+          end
+          expect(subject.decisions.packages).to be_empty
+        end
+      end
+
+      describe "list" do
+        it "lists manually added dependencies" do
+          decisions.add_package("custom", nil)
+          expect(capture_stdout { subject.list }).to match /custom/
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe IgnoredDependencies do
+      let(:decisions) { Decisions.new }
+
+      before do
+        allow(Decisions).to receive(:saved!) { decisions }
+      end
+
+      describe "list" do
+        context "when there is at least one ignored dependency" do
+          it "shows the ignored dependencies" do
+            decisions.ignore("bundler")
+            expect(capture_stdout { subject.list }).to match /bundler/
+          end
+        end
+
+        context "when there are no ignored dependencies" do
+          it "prints '(none)'" do
+            expect(capture_stdout { subject.list }).to match /\(none\)/
+          end
+        end
+      end
+
+      describe "add" do
+        it "adds the specified group to the ignored groups list" do
+          silence_stdout do
+            subject.add("test")
+          end
+          expect(subject.decisions.ignored).to eq ["test"].to_set
+        end
+      end
+
+      describe "remove" do
+        it "removes the specified group from the ignored groups list" do
+          silence_stdout do
+            subject.add("test")
+            subject.remove("test")
+          end
+          expect(subject.decisions.ignored).to be_empty
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe IgnoredGroups do
+      let(:decisions) { Decisions.new }
+
+      before do
+        allow(Decisions).to receive(:saved!) { decisions }
+      end
+
+      describe "list" do
+        it "shows the ignored groups in the standard output" do
+          decisions.ignore_group("development")
+
+          expect(capture_stdout { subject.list }).to match /development/
+        end
+      end
+
+      describe "add" do
+        it "adds the specified group to the ignored groups list" do
+          silence_stdout do
+            subject.add("test")
+          end
+          expect(subject.decisions.ignored_groups).to eq ["test"].to_set
+        end
+      end
+
+      describe "remove" do
+        it "removes the specified group from the ignored groups list" do
+          silence_stdout do
+            subject.add("test")
+            subject.remove("test")
+          end
+          expect(subject.decisions.ignored_groups).to be_empty
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe Licenses do
+      let(:decisions) { Decisions.new }
+
+      before do
+        allow(Decisions).to receive(:saved!) { decisions }
+      end
+
+      describe "add" do
+        it "updates the license on the requested gem" do
+          silence_stdout do
+            subject.add 'foo_gem', 'foo_license'
+          end
+          expect(subject.decisions.licenses_of("foo_gem").first.name).to eq "foo_license"
+        end
+
+        it "allows multiple licenses" do
+          silence_stdout do
+            subject.add 'foo_gem', 'one'
+            subject.add 'foo_gem', 'two'
+          end
+          licenses = subject.decisions.licenses_of("foo_gem")
+          expect(licenses.map(&:name)).to match_array %w[one two]
+        end
+      end
+
+      describe "remove" do
+        it "removes the license from the dependency" do
+          silence_stdout do
+            subject.add("test", "lic")
+            subject.remove("test", "lic")
+          end
+          expect(subject.decisions.licenses_of("test")).to be_empty
+        end
+
+        it "removes just one license from the dependency" do
+          silence_stdout do
+            subject.add("test", "one")
+            subject.add("test", "two")
+            subject.remove("test", "one")
+          end
+          licenses = subject.decisions.licenses_of("test")
+          expect(licenses.map(&:name)).to eq ["two"]
+        end
+
+        it "is cumulative" do
+          silence_stdout do
+            subject.add("test", "lic")
+            subject.remove("test", "lic")
+            subject.add("test", "lic")
+          end
+          expect(subject.decisions.licenses_of("test").first.name).to eq "lic"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+require "spec_helper"
+
+module LicenseFinder
+  module CLI
+    describe Main do
+      let(:decisions) { Decisions.new }
+      let(:packages) { [] }
+      let!(:decision_applier) do
+        DecisionApplier.new(
+          decisions: decisions,
+          packages: packages
+        )
+      end
+
+      before do
+        allow(Decisions).to receive(:saved!) { decisions }
+        allow(DecisionApplier).to receive(:new) { decision_applier }
+      end
+
+      describe "default" do
+        it "checks for action items" do
+          decisions.add_package("a dependency", nil)
+
+          silence_stdout do
+            expect { described_class.start(["--quiet"]) }.to raise_error(SystemExit)
+          end
+        end
+      end
+
+      describe "#report" do
+        let(:packages) { [Package.new('one dependency', "1.1")] }
+
+        it "reports acknowleged dependencies" do
+          result = capture_stdout do
+            Main.start(["report"])
+          end
+          expect(result).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
+
+          expect(result).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
+
+          expect(result).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"
+          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"
+            end
+          end
+
+          context "when the project has no name" do
+            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"
+            end
+          end
+        end
+      end
+
+      describe "#action_items" do
+        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)
+            end
+            expect(result).to match /dependencies/i
+            expect(result).to match /one dependency/
+          end
+        end
+
+        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
+          end
+          expect(result).to match /approved/i
+        end
+      end
+    end
+  end
+end