license_finder 0.8.0-java → 0.8.1-java

data/features/step_definitions/shared_steps.rb

@@ -0,0 +1,203 @@
+require 'fileutils'
+require 'pathname'
+require 'bundler'
+require 'capybara'
+
+########## COMMON STEPS ##########
+
+When(/^I run license_finder$/) do
+  @output = @user.execute_command "license_finder -q"
+end
+
+When(/^I whitelist MIT and 'other' licenses$/) do
+  @user.configure_license_finder_whitelist ["MIT","other"]
+  @output = @user.execute_command "license_finder -q"
+end
+
+module DSL
+  class User
+    def create_nonrails_app
+      reset_projects!
+
+      `cd #{projects_path} && bundle gem #{app_name}`
+
+      add_gem_dependency('rake')
+      add_gem_dependency('license_finder', :path => root_path)
+
+      bundle_app
+    end
+
+    def create_rails_app
+      reset_projects!
+
+      `bundle exec rails new #{app_path} --skip-bundle`
+
+      add_gem_dependency('license_finder', :path => root_path)
+
+      bundle_app
+    end
+
+    def add_license_finder_to_rakefile
+      add_to_rakefile <<-RUBY
+        require 'bundler/setup'
+        require 'license_finder'
+        LicenseFinder.load_rake_tasks
+      RUBY
+    end
+
+    def update_gem(name, attrs)
+      file_contents = YAML.load(File.read(dependencies_file_path))
+
+      index = file_contents.index { |gem| gem['name'] == name }
+      file_contents[index].merge!(attrs)
+
+      File.open(dependencies_file_path, "w") do |f|
+        f.puts file_contents.to_yaml
+      end
+    end
+
+    def append_to_file(filename, text)
+      File.open(File.join(app_path, filename), "a") do |f|
+        f.puts text
+      end
+    end
+
+    def add_dependency_to_app(gem_name, options={})
+      license = options.fetch(:license)
+      summary = options.fetch(:summary, "")
+      description = options.fetch(:description, "")
+      bundler_groups = options.fetch(:bundler_groups, "").to_s.split(',').map(&:strip)
+      version = options[:version] || "0.0.0"
+      homepage = options[:homepage]
+
+      gem_dir = File.join(projects_path, gem_name)
+
+      FileUtils.mkdir(gem_dir)
+      File.open(File.join(gem_dir, "#{gem_name}.gemspec"), 'w') do |file|
+        file.write <<-GEMSPEC
+          Gem::Specification.new do |s|
+            s.name = "#{gem_name}"
+            s.version = "#{version}"
+            s.author = "Cucumber"
+            s.summary = "#{summary}"
+            s.license = "#{license}"
+            s.description = "#{description}"
+            s.homepage = "#{homepage}"
+          end
+        GEMSPEC
+      end
+
+      gem_options = {}
+      gem_options[:path] = File.join(projects_path, gem_name)
+      gem_options[:groups] = bundler_groups unless bundler_groups.empty?
+
+      add_gem_dependency(gem_name, gem_options)
+
+      bundle_app
+    end
+
+    def configure_license_finder_whitelist(whitelisted_licenses=[])
+      FileUtils.mkdir_p(config_path)
+      File.open(File.join(config_path, "license_finder.yml"), "w") do |f|
+        f.write({'whitelist' => whitelisted_licenses}.to_yaml)
+      end
+    end
+
+    def configure_license_finder_bundler_whitelist(whitelisted_groups=[])
+      whitelisted_groups = Array whitelisted_groups
+      FileUtils.mkdir_p(config_path)
+      File.open(File.join(config_path, "license_finder.yml"), "w") do |f|
+        f.write({'ignore_groups' => whitelisted_groups}.to_yaml)
+      end
+    end
+
+    def execute_command(command)
+      Bundler.with_clean_env do
+        @output = `cd #{app_path} && bundle exec #{command}`
+      end
+
+      @output
+    end
+
+    def app_path(sub_directory = nil)
+      path = app_path = Pathname.new(File.join(projects_path, app_name)).cleanpath.to_s
+
+      if sub_directory
+        path = Pathname.new(File.join(app_path, sub_directory)).cleanpath.to_s
+
+        raise "#{name} is outside of the app" unless path =~ %r{^#{app_path}/}
+      end
+
+      path
+    end
+
+    def config_path
+      File.join(app_path, 'config')
+    end
+
+    def doc_path
+      File.join(app_path, 'doc')
+    end
+
+    def dependencies_file_path
+      File.join(doc_path, 'dependencies.yml')
+    end
+
+    def dependencies_html_path
+      File.join(doc_path, 'dependencies.html')
+    end
+
+    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
+        `bundle install --gemfile=#{File.join(app_path, "Gemfile")} --path=#{bundle_path}`
+      end
+    end
+
+    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
+
+    def add_to_rakefile(line)
+      `echo #{line.inspect} >> #{File.join(app_path, "Rakefile")}`
+    end
+
+    def app_name
+      "my_app"
+    end
+
+    def sandbox_path
+      File.join(root_path, "tmp")
+    end
+
+    def projects_path
+      File.join(sandbox_path, "projects")
+    end
+
+    def bundle_path
+      File.join(sandbox_path, "bundle")
+    end
+
+    def reset_projects!
+      `rm -rf #{projects_path}`
+      `mkdir -p #{projects_path}`
+    end
+
+    def root_path
+      Pathname.new(File.join(File.dirname(__FILE__), "..", "..")).realpath.to_s
+    end
+  end
+end

data/features/step_definitions/text_report_steps.rb

@@ -0,0 +1,9 @@
+Given(/^I have an app with license finder that depends on a gem with license and version details$/) do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+  @user.add_dependency_to_app('info_gem', license: 'MIT', version: '1.1.1')
+end
+
+Then(/^I should see those version and license details in the dependencies\.txt file$/) do
+  File.read(@user.app_path("doc/dependencies.txt")).should include "info_gem, 1.1.1, MIT"
+end

data/features/step_definitions/whitelist_steps.rb

@@ -0,0 +1,14 @@
+Given(/^I have an app with license finder that depends on an MIT license$/) do
+  @user = ::DSL::User.new
+  @user.create_nonrails_app
+  @user.add_dependency_to_app 'mit_gem', :license => 'MIT'
+end
+
+When(/^I whitelist the Expat license$/) do
+  @user.configure_license_finder_whitelist ["Expat"]
+  @output = @user.execute_command 'license_finder -q'
+end
+
+Then(/^I should not see a MIT licensed gem unapproved$/) do
+  @output.should_not include 'mit_gem'
+end

data/features/text_report.feature

@@ -4,24 +4,6 @@ Feature: Text Report
   I want license finder to generate an easy-to-understand text report
 
   Scenario: Viewing dependencies
-    Given I have an app with license finder
-    And my application depends on a gem "descriptive_gem" with:
-      | license | version |
-      | MIT     | 1.1.1   |
-    When I run "license_finder"
-    Then I should see the file "doc/dependencies.txt" containing:
-      """
-      descriptive_gem, 1.1.1, MIT
-      """
-
-  Scenario: Viewing dependencies after multiple runs
-    Given I have an app with license finder
-    And my application depends on a gem "descriptive_gem" with:
-      | license | version |
-      | MIT     | 1.1.1   |
-    When I run "license_finder"
-    And I run "license_finder"
-    Then I should see the file "doc/dependencies.txt" containing:
-      """
-      descriptive_gem, 1.1.1, MIT
-      """
+    Given I have an app with license finder that depends on a gem with license and version details
+    When I run license_finder
+    Then I should see those version and license details in the dependencies.txt file

data/features/whitelist.feature

@@ -3,22 +3,7 @@ Feature: Whitelist licenses
   I want to whitelist certain OSS licenses that my business has pre-approved
   So that any dependencies with those licenses do not show up as action items
 
-  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"
-    Then I should see "mit_licensed_gem" in its output
-    When I whitelist the following licenses: "MIT, other"
-    And I run "license_finder"
-    Then I should see "All gems are approved for use" in its output
-    And it should exit with status code 0
-
   Scenario: Whitelist with MIT License alternative name "Expat" should whitelist "MIT" licenses
-    Given I have an app with license finder
-    And "Expat" is an alternative name for the "MIT" license
-    And my app depends on a gem "mit_licensed_gem" licensed with "MIT"
-    When I run "license_finder"
-    Then I should see "mit_licensed_gem" in its output
-    When I whitelist the "Expat" license
-    And I run "license_finder"
-    Then I should not see "mit_licensed_gem" in its output
+    Given I have an app with license finder that depends on an MIT license
+    When I whitelist the Expat license
+    Then I should not see a MIT licensed gem unapproved

data/license_finder.gemspec

@@ -2,7 +2,7 @@ require './lib/license_finder/platform'
 
 Gem::Specification.new do |s|
   s.name        = "license_finder"
-  s.version     = "0.8.0"
+  s.version     = "0.8.1"
   s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "David Tengdin"]
   s.email       = ["licensefinder@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
@@ -22,10 +22,11 @@ Gem::Specification.new do |s|
   s.add_dependency "sequel"
   s.add_dependency LicenseFinder::Platform.sqlite_gem
 
-  %w(rspec rake xpath capybara cucumber database_cleaner).each do |gem|
+  %w(rspec rake xpath cucumber database_cleaner).each do |gem|
     s.add_development_dependency gem
   end
 
+  s.add_development_dependency "capybara", "~> 2.0.0"
   s.add_development_dependency "rails", "~> 3.2.0"
 
   s.files         = `git ls-files`.split("\n")

data/readme.md

@@ -93,6 +93,16 @@ $ license_finder -a awesome_gpl_gem
 
 If you rerun `license_finder`, you should no longer see `awesome_gpl_gem` in the output.
 
+## Upgrade for pre 0.8.0 users
+
+If you wish to cleanup your root directory you can run:
+
+```sh
+$ license_finder -m
+```
+
+This will move your dependencies.* files to the /doc directory and update the config.
+
 ## Compatibility
 
 license_finder is compatible with ruby 1.9, and ruby 2.0. There is also experimental support for jruby.

data/release.md

@@ -0,0 +1,17 @@
+## Tips on releasing
+
+Build the gem for both ruby and jruby (use a later version of each ruby, if desired)
+
+```sh
+$ rvm use jruby-1.7.3-d19
+$ rake build
+$ rvm use ruby-1.9.3-p392
+$ rake build
+```
+
+Push both versions of the gem
+
+```sh
+$ rake release # will push default MRI build of gem, and importantly, tag the gem
+$ gem push pkg/license_finder-LATEST_VERSION_HERE-java.gem
+```

metadata

@@ -2,7 +2,7 @@
 name: license_finder
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.8.0
+  version: 0.8.1
 platform: java
 authors:
 - Jacob Maine
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,7 +126,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: cucumber
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -144,7 +144,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: database_cleaner
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -162,20 +162,18 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: capybara
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: 2.0.0
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: 2.0.0
     none: false
   prerelease: false
   type: :development
@@ -211,6 +209,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE
 - Rakefile
@@ -225,14 +224,20 @@ files:
 - db/migrate/201304011027_allow_null_dependency_version.rb
 - db/migrate/201304020947_change_table_name_licenses_to_license_aliases.rb
 - features/approve_dependencies.feature
+- features/cli.feature
 - features/html_report.feature
 - features/ignore_bundle_groups.feature
-- features/license_finder.feature
-- features/license_finder_rake_task.feature
 - features/rails_rake.feature
 - features/set_license.feature
-- features/step_definitions/license_finder_steps.rb
-- features/step_definitions/steps.rb
+- features/step_definitions/approve_dependencies_steps.rb
+- features/step_definitions/cli_steps.rb
+- features/step_definitions/html_report_steps.rb
+- features/step_definitions/ignore_bundle_groups_steps.rb
+- features/step_definitions/rails_rake_steps.rb
+- features/step_definitions/set_license_steps.rb
+- features/step_definitions/shared_steps.rb
+- features/step_definitions/text_report_steps.rb
+- features/step_definitions/whitelist_steps.rb
 - features/text_report.feature
 - features/whitelist.feature
 - files/license_finder.yml
@@ -282,6 +287,7 @@ files:
 - lib/templates/text_report.erb
 - license_finder.gemspec
 - readme.md
+- release.md
 - spec/fixtures/APACHE-2-LICENSE
 - spec/fixtures/GPLv2
 - spec/fixtures/ISC-LICENSE
@@ -370,14 +376,20 @@ specification_version: 3
 summary: Audit the OSS licenses of your application's dependencies.
 test_files:
 - features/approve_dependencies.feature
+- features/cli.feature
 - features/html_report.feature
 - features/ignore_bundle_groups.feature
-- features/license_finder.feature
-- features/license_finder_rake_task.feature
 - features/rails_rake.feature
 - features/set_license.feature
-- features/step_definitions/license_finder_steps.rb
-- features/step_definitions/steps.rb
+- features/step_definitions/approve_dependencies_steps.rb
+- features/step_definitions/cli_steps.rb
+- features/step_definitions/html_report_steps.rb
+- features/step_definitions/ignore_bundle_groups_steps.rb
+- features/step_definitions/rails_rake_steps.rb
+- features/step_definitions/set_license_steps.rb
+- features/step_definitions/shared_steps.rb
+- features/step_definitions/text_report_steps.rb
+- features/step_definitions/whitelist_steps.rb
 - features/text_report.feature
 - features/whitelist.feature
 - spec/fixtures/APACHE-2-LICENSE