license_finder 0.7.3 → 0.8.0

data/.gitignore

@@ -5,7 +5,8 @@ Gemfile.lock
 .rvmrc
 .idea/*
 tmp/
-dependencies.yml
-dependencies.txt
-dependencies.html
+dependencies.*
+doc/dependencies.*
+db/schema.rb
 config/
+.pairs

data/.travis.yml

@@ -1,22 +1,15 @@
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
   - rbx-19mode
   - ruby-head
   - jruby-head
-  - 1.8.7
-  - ree
 
 matrix:
   allow_failures:
-    - rvm: jruby-18mode
     - rvm: jruby-19mode
-    - rvm: rbx-18mode
     - rvm: rbx-19mode
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: 1.8.7
-    - rvm: ree

data/bin/license_finder

@@ -3,7 +3,31 @@
 require 'license_finder'
 require 'optparse'
 
+module SpinnerStrategy
+  module Spin
+    def self.run
+      thread = Thread.new() {
+        wheel = '\|/-'
+        i = 0
+        while not LicenseFinder::CLI.class_variable_get("@@run_complete") do
+          print "\r ---------- #{wheel[i]} ----------"
+          i = (i + 1) % 4
+        end
+      }
+      yield
+      thread.join
+    end
+  end
+
+  module Noop
+    def self.run
+      yield
+    end
+  end
+end
+
 options = {}
+spinner = SpinnerStrategy::Spin
 
 OptionParser.new do |opts|
   opts.banner = "Usage: license_finder [options] [dependency]"
@@ -15,10 +39,16 @@ OptionParser.new do |opts|
   opts.on("-l", "--license [LICENSE]", "Update a gem's license.") do |license|
     options[:license] = license
   end
+
+  opts.on("-q", "--quiet") do
+    spinner = SpinnerStrategy::Noop
+  end
 end.parse!
 
 unless options.empty?
   options[:dependency] = ARGV.last
 end
 
-LicenseFinder::CLI.execute! options
+spinner.run {
+  LicenseFinder::CLI.execute! options
+}

data/db/migrate/201303290935_create_dependencies.rb

@@ -0,0 +1,14 @@
+# sequel -m db/migrate -E sqlite://doc/dependencies.db
+
+Sequel.migration do
+  change do
+    create_table(:dependencies) do
+      primary_key :id
+      String :name, null: false
+      String :version, null: false
+      String :summary
+      String :description
+      String :homepage
+    end
+  end
+end

data/db/migrate/201303291155_create_licenses.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  change do
+    create_table(:licenses) do
+      primary_key :id
+      String :name, null: false
+      String :url
+    end
+
+    alter_table(:dependencies) do
+      add_column :license_id, Integer
+    end
+  end
+end

data/db/migrate/201303291402_create_approvals.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  change do
+    create_table(:approvals) do
+      primary_key :id
+      Boolean :state
+      String :approval_type
+    end
+
+    alter_table(:dependencies) do
+      add_column :approval_id, Integer
+    end
+  end
+end

data/db/migrate/201303291456_create_ancestries.rb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  change do
+    create_table(:ancestries) do
+      primary_key :id
+      Integer :parent_dependency_id
+      Integer :child_dependency_id
+    end
+  end
+end

data/db/migrate/201303291519_create_bundler_groups.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  change do
+    create_table(:bundler_groups) do
+      primary_key :id
+      String :name
+    end
+
+    create_table(:bundler_groups_dependencies) do
+      Integer :bundler_group_id
+      Integer :dependency_id
+    end
+  end
+end

data/db/migrate/201303291720_move_manual_from_approvals_to_licenses.rb

@@ -0,0 +1,11 @@
+Sequel.migration do
+  change do
+    alter_table(:approvals) do
+      drop_column :approval_type
+    end
+
+    alter_table(:licenses) do
+      add_column :manual, TrueClass # i.e., keep this license eternally
+    end
+  end
+end

data/db/migrate/201303291753_allow_null_license_names.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:licenses) do
+      set_column_allow_null :name
+    end
+  end
+end

data/db/migrate/201304011027_allow_null_dependency_version.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:dependencies) do
+      set_column_allow_null :version
+    end
+  end
+end

data/db/migrate/201304020947_change_table_name_licenses_to_license_aliases.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    rename_table(:licenses, :license_aliases)
+  end
+end

data/features/approve_dependencies.feature

@@ -12,48 +12,3 @@ Feature: Approving non-whitelisted Dependencies
     When I run "license_finder"
     Then I should not see "gpl_gem" in its output
     Then I should see the "gpl_gem" in the html flagged as "approved"
-
-  Scenario: Manually approving a non-whitelisted dependency
-    Given I have an app with license finder
-    And my app depends on a gem "gpl_gem" licensed with "GPL"
-    And I whitelist the "MIT" license
-
-    When I run "license_finder"
-    Then I should see the following settings for "gpl_gem":
-      """
-      version: "0.0.0"
-      license: "GPL"
-      approved: false
-      """
-
-    When I update the settings for "gpl_gem" with the following content:
-      """
-      approved: true
-      """
-    When I run "license_finder"
-    Then I should not see "gpl_gem" in its output
-
-  Scenario: Manually adding a non-bundled dependency
-    Given I have an app with license finder
-    When I run "license_finder"
-    And I add the following content to "dependencies.yml":
-      """
-      - name: "my_javascript_library"
-        version: "0.0.0"
-        license: "GPL"
-        approved: false
-      """
-    Then I should see the following settings for "my_javascript_library":
-      """
-      version: "0.0.0"
-      license: "GPL"
-      approved: false
-      """
-    When I run "license_finder"
-    Then I should see "my_javascript_library" in its output
-    When I update the settings for "my_javascript_library" with the following content:
-      """
-      approved: true
-      """
-    When I run "license_finder"
-    Then I should not see "my_javascript_library" in its output

data/features/html_report.feature

@@ -31,18 +31,8 @@ Feature: HTML Report
     And I whitelist the following licenses: "MIT, other"
     When I run "license_finder"
     # rake, bundler, license_finder, my_app, gpl_licensed_gem, mit_licensed_gem
-    Then I should see "6 total" in the html
+    Then I should see "8 total" in the html
     # gpl_licensed_gem
     And I should see "1 unapproved" in the html
     # gpl_licensed_gem
     And I should see "1 GPL" in the html
-
-  Scenario: Implicit dependencies list their parent dependencies
-    Given I have a rails app with license finder
-    When I run "license_finder"
-    Then I should see the "activerecord" in the html with the following details:
-      | parent |
-      | rails  |
-    And I should see "rails" in the html with the following details:
-      | children     |
-      | activerecord |

data/features/license_finder.feature

@@ -6,7 +6,7 @@ Feature: License Finder command line executable
   Scenario: Running without a configuration file
     Given I have an app with license finder
     And my app does not have a "config" directory
-    When I run "license_finder"
+    When I run "license_finder -q"
     Then I should see a "config" directory
     And I should see the file "config/license_finder.yml" with the following content:
       """
@@ -17,45 +17,31 @@ Feature: License Finder command line executable
       ignore_groups:
       #- test
       #- development
-      dependencies_file_dir: './'
-      """
+      dependencies_file_dir: './doc/'
 
-  Scenario: Running with an empty dependencies.yml
-    Given I have an app with license finder
-    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
-    And I have a truncated dependencies.yml file
-    When I run "license_finder"
-    Then it should exit with status code 1
-    And I should see "mit_licensed_gem" in its output
+      """
 
   Scenario: Auditing an application with non-whitelisted licenses
     Given I have an app with license finder
     And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
-    When I run "license_finder"
+    When I run "license_finder -q"
     Then it should exit with status code 1
     And I should see "mit_licensed_gem" in its output
 
   Scenario: Auditing an application with whitelisted licenses
     Given I have an app with license finder
     And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
-    When I run "license_finder"
+    When I run "license_finder -q"
     Then I should see "mit_licensed_gem" in its output
     When I whitelist the following licenses: "MIT, other"
-    And I run "license_finder"
+    And I run "license_finder -q"
     Then I should see "All gems are approved for use" in its output
     And it should exit with status code 0
 
-  Scenario: Merging a legacy dependencies.yml file
-    Given I have an app with license finder
-    And my app depends on a gem "random_licensed_gem" licensed with "random_license"
-    And I have a legacy dependencies.yml file with "random_licensed_gem" approved with its "random_license" license
-    And I whitelist the following licenses: "MIT, other"
-    When I run "license_finder"
-    Then I should see exactly one entry for "random_licensed_gem" in "dependencies.yml"
-
-  Scenario: Remove readme file paths from legacy dependencies.yml
-    Given I have an app with license finder
-    And my app depends on a gem "random_licensed_gem" licensed with "random_license"
-    And I have a legacy dependencies.yml file with readme_files entry for gem "random_licensed_gem"
-    When I run "license_finder"
-    Then I should not see an entry "readme_files" for gem "random_licensed_gem" in my dependencies.yml
+  Scenario: Keep manually set license dependencies
+    Given I have a project that depends on mime-types
+    And I manually set the license type to Ruby
+    And I run license_finder again
+    Then the mime-types license is set to Ruby
+    When I run license_finder again
+    Then the mime-types license is set to Ruby

data/features/license_finder_rake_task.feature

@@ -17,7 +17,8 @@ Feature: License Finder rake task
       ignore_groups:
       #- test
       #- development
-      dependencies_file_dir: './'
+      dependencies_file_dir: './doc/'
+
       """
 
   Scenario: Auditing an application with non-whitelisted licenses

data/features/set_license.feature

@@ -8,7 +8,5 @@ Feature: Set a dependency's license through a command line interface
     And my app depends on a gem "other_license_gem" licensed with "other"
     When I run "license_finder"
     When I run "license_finder -l MIT other_license_gem"
-    Then I should see the following settings for "other_license_gem":
-      """
-        license: "MIT"
-      """
+    And I run license_finder again
+    Then I should see other_license_gem set to MIT license

data/features/step_definitions/license_finder_steps.rb

@@ -0,0 +1,25 @@
+require 'license_finder'
+require 'fileutils'
+require 'pathname'
+require 'bundler'
+require 'capybara'
+
+Given /^I have a project that depends on mime\-types$/ do
+  @user = ::DSL::User.new
+  @user.create_rails_app
+  @user.add_gem_dependency('mime-types')
+  @user.bundle_app
+  @user.execute_command "license_finder"
+end
+
+Given /^I manually set the license type to Ruby$/ do
+  @output = @user.execute_command "license_finder -l Ruby mime-types"
+end
+
+When /^I run license_finder again$/ do
+  @output = @user.execute_command "license_finder -q"
+end
+
+Then /^the mime\-types license is set to Ruby$/ do
+  @output.should =~ /mime-types.*Ruby/
+end

data/features/step_definitions/steps.rb

@@ -2,7 +2,6 @@ require 'fileutils'
 require 'pathname'
 require 'bundler'
 require 'capybara'
-require 'pry'
 
 Given /^I have a rails app(?:lication)? with license finder$/ do
   @user = ::DSL::User.new
@@ -44,8 +43,8 @@ Given /^I whitelist the following licenses: "([^"]*)"$/ do |licenses|
 end
 
 Given /^I have a legacy dependencies\.yml file with "(.*?)" approved with its "(.*?)" license$/ do |gem_name, license_name|
-  File.open(@user.dependencies_file_path, 'w+') do |f|
-    <<-YAML
+  @user.modifying_dependencies_file do |f|
+    f.write <<-YAML
     - name: #{gem_name}
       version: 1.5.0
       license: #{license_name}
@@ -58,8 +57,8 @@ Given /^I have a legacy dependencies\.yml file with "(.*?)" approved with its "(
 end
 
 And /^I have a legacy dependencies\.yml file with readme_files entry for gem "(.*?)"$/  do |gem_name|
-  File.open(@user.dependencies_file_path, 'w+') do |f|
-    <<-YAML
+  @user.modifying_dependencies_file do |f|
+    f.write <<-YAML
     - name: #{gem_name}
       version: 1.5.0
       license: some_license
@@ -73,6 +72,21 @@ And /^I have a legacy dependencies\.yml file with readme_files entry for gem "(.
   end
 end
 
+Given /^I have a legacy dependencies\.yml file with a blank readme_files entry for gem "(.*?)"$/ do |gem_name|
+  @user.modifying_dependencies_file do |f|
+    f.write(<<-YAML)
+    - name: #{gem_name}
+      version: 1.5.0
+      license: some_license
+      approved: true
+      notes: ''
+      license_files:
+      - path: /some/path/to/files/that/are/rad
+      readme_files:
+    YAML
+  end
+end
+
 When /^I run "(.*?)"$/ do |command|
   @output = @user.execute_command command
 end
@@ -102,12 +116,6 @@ When /^the text "([^"]*)" should link to "([^"]*)"$/ do |text, link|
   html.all(:xpath, "//a[@href='#{link}']").first.text.should == text
 end
 
-When /^I have a truncated dependencies.yml file$/ do
-  File.open(@user.dependencies_file_path, 'w+') do |f|
-    f.puts ""
-  end
-end
-
 When /^"([^"]*)" is an alternative name for the "MIT" license$/ do |alternative_name|
   # this step is simply for readability
 end
@@ -116,6 +124,10 @@ When /^I whitelist the "([^"]*)" bundler group$/ do |group|
   @user.configure_license_finder_bundler_whitelist(group)
 end
 
+Then(/^I should see other_license_gem set to MIT license$/) do
+  @output.should =~ /other_license_gem.*MIT/
+end
+
 Then /^I should see a "([^"]+)" directory$/ do |name|
   File.should be_exists(@user.app_path(name))
 end
@@ -141,13 +153,6 @@ Then /^I should see exactly one entry for "(.*?)" in "(.*?)"$/ do |gem_name, fil
   file_contents.scan(/#{gem_name}/).size.should == 1
 end
 
-Then /^I should see the following settings for "([^"]*)":$/ do |name, yaml|
-  expected_settings = YAML.load(yaml)
-  all_settings = YAML.load(File.read(@user.dependencies_file_path))
-  actual_settings = all_settings.detect { |gem| gem['name'] == name }
-  actual_settings.should include expected_settings
-end
-
 Then /^I should not see an entry "(.*?)" for gem "(.*?)" in my dependencies\.yml$/ do |entry_key, gem_name|
   settings = YAML.load(File.read(@user.dependencies_file_path))
   gem_settings = settings.detect { |gem| gem['name'] == gem_name }
@@ -303,15 +308,24 @@ module DSL
       File.join(app_path, 'config')
     end
 
+    def doc_path
+      File.join(app_path, 'doc')
+    end
+
     def dependencies_file_path
-      File.join(app_path, 'dependencies.yml')
+      File.join(doc_path, 'dependencies.yml')
     end
 
     def dependencies_html_path
-      File.join(app_path, 'dependencies.html')
+      File.join(doc_path, 'dependencies.html')
     end
 
-    private
+    def add_gem_dependency(name, options = {})
+      line = "gem #{name.inspect}"
+      line << ", " + options.inspect unless options.empty?
+
+      add_to_gemfile(line)
+    end
 
     def bundle_app
       Bundler.with_clean_env do
@@ -319,13 +333,13 @@ module DSL
       end
     end
 
-    def add_gem_dependency(name, options = {})
-      line = "gem #{name.inspect}"
-      line << ", " + options.inspect unless options.empty?
-
-      add_to_gemfile(line)
+    def modifying_dependencies_file
+      FileUtils.mkdir_p(File.dirname(dependencies_file_path))
+      File.open(dependencies_file_path, 'w+') { |f| yield f }
     end
 
+    private
+
     def add_to_gemfile(line)
       `echo #{line.inspect} >> #{File.join(app_path, "Gemfile")}`
     end