license_finder 0.8.0-java

data/.gitignore

@@ -0,0 +1,12 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+.rvmrc
+.idea/*
+tmp/
+dependencies.*
+doc/dependencies.*
+db/schema.rb
+config/
+.pairs

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012 Pivotal Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+desc "Run all specs in spec/"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = true
+  t.pattern = "./spec/**/*_spec.rb"
+  t.rspec_opts = %w[--color]
+end
+
+
+desc "Run all cukes in features/"
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features]

data/bin/license_finder

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+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]"
+
+  opts.on("-a", "--approve", "Approve a gem by name.") do |gem_name|
+    options[:approve] = true
+  end
+
+  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
+
+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

@@ -0,0 +1,14 @@
+Feature: Approving non-whitelisted Dependencies
+  So that I can track the dependencies of my application which my business has approved
+  As an application developer using license finder
+  I want to be able to manually approve dependencies that have licenses which fall outside of my whitelist
+
+  Scenario: Approving a non-whitelisted dependency via the `license_finder` command
+    Given I have an app with license finder
+    And my app depends on a gem "gpl_gem" licensed with "GPL"
+    When I run "license_finder"
+    Then I should see "gpl_gem" in its output
+    When I run "license_finder -a gpl_gem"
+    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"

data/features/html_report.feature

@@ -0,0 +1,38 @@
+Feature: HTML Report
+  So that I can easily view a report outlining my application dependencies and licenses
+  As a non-technical application product owner
+  I want license finder to generate an easy-to-understand HTML report
+
+  Background:
+    Given I have an app with license finder
+
+  Scenario: Dependency details listed in HTML report
+    Given my application depends on a gem "mit_licensed_gem" with:
+      | license | summary     | description | version | homepage                           | bundler_groups |
+      | MIT     | mit is cool | seriously   | 0.0.1   | http://mit_licensed_gem.github.com | test           |
+    When I run "license_finder"
+    And I should see the "mit_licensed_gem" in the html with the following details:
+      | license | summary     | description | name                    | bundler_groups |
+      | MIT     | mit is cool | seriously   | mit_licensed_gem v0.0.1 | test           |
+    And the text "MIT" should link to "http://opensource.org/licenses/mit-license"
+    And the text "mit_licensed_gem" should link to "http://mit_licensed_gem.github.com"
+
+  Scenario: Approval status of dependencies indicated in HTML report
+    Given my app depends on a gem "gpl_licensed_gem" licensed with "GPL"
+    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
+    And I whitelist the "MIT" license
+    When I run "license_finder"
+    Then I should see the "gpl_licensed_gem" in the html flagged as "unapproved"
+    And I should see the "mit_licensed_gem" in the html flagged as "approved"
+
+  Scenario: Dependency summary
+    Given my app depends on a gem "gpl_licensed_gem" licensed with "GPL"
+    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
+    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 "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

data/features/ignore_bundle_groups.feature

@@ -0,0 +1,11 @@
+Feature: Ignore Bundle Groups
+  As a developer
+  I want to ignore certain bundler groups
+  So that any gems I use in development, or for testing, are automatically approved for use
+
+  Scenario:
+    Given I have an app with license finder
+    And my application depends on a gem "gpl_gem" licensed with "GPL" in the "test" bundler groups
+    And I whitelist the "test" bundler group
+    When I run "license_finder"
+    Then I should not see "gpl_gem" in its output

data/features/license_finder.feature

@@ -0,0 +1,47 @@
+Feature: License Finder command line executable
+  So that I can report and manage my application's dependencies and licenses to my business
+  As an application developer
+  I want a command-line interface
+
+  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 -q"
+    Then I should see a "config" directory
+    And I should see the file "config/license_finder.yml" with the following content:
+      """
+      ---
+      whitelist:
+      #- MIT
+      #- Apache 2.0
+      ignore_groups:
+      #- test
+      #- development
+      dependencies_file_dir: './doc/'
+
+      """
+
+  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 -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 -q"
+    Then I should see "mit_licensed_gem" in its output
+    When I whitelist the following licenses: "MIT, other"
+    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: 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

@@ -0,0 +1,37 @@
+Feature: License Finder rake task
+  So that I can break my build suite if someone adds a dependency to the application with a non-whitelisted license
+  As an application developer
+  I want a rake task that exit's with a non-zero exit status if there are any action items
+
+  Scenario: Running without a configuration file
+    Given I have an app with rake and license finder
+    And my app does not have a "config" directory
+    When I run "rake license_finder"
+    Then I should see a "config" directory
+    And I should see the file "config/license_finder.yml" with the following content:
+      """
+      ---
+      whitelist:
+      #- MIT
+      #- Apache 2.0
+      ignore_groups:
+      #- test
+      #- development
+      dependencies_file_dir: './doc/'
+
+      """
+
+  Scenario: Auditing an application with non-whitelisted licenses
+    Given I have an app with rake and license finder
+    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
+    When I run "rake 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 whitelisted licenses
+    Given I have an app with rake and license finder
+    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
+    And I whitelist the following licenses: "MIT, other"
+    When I run "rake license_finder"
+    Then it should exit with status code 0
+    And I should see "All gems are approved for use" in its output

data/features/rails_rake.feature

@@ -0,0 +1,9 @@
+Feature: The rake task is automatically made available in Rails project
+  So that I do not have to modify the Rails rakefile
+  As an application developer
+  I want the license_finder rake task automatically loaded for me in a rails project
+
+  Scenario: The application is a Rails app
+    Given I have a rails app with license finder
+    When I run "rake license_finder"
+    Then I should see "Dependencies that need approval:" in its output

data/features/set_license.feature

@@ -0,0 +1,12 @@
+Feature: Set a dependency's license through a command line interface
+  So that my dependencies all have the correct licenses
+  As an application developer
+  I want a command line interface to set licenses for specific dependencies
+
+  Scenario: Setting a license for a dependency
+    Given I have an app with license finder
+    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"
+    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