license_finder 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20f8ab76aa0c6a0b12a159a4e177648106c9cd7b
-  data.tar.gz: e4a0d2d69fd8cbaeea45c300b676daa6b2a5399b
+  metadata.gz: 32345e0495c5fa4e7a83dbda58ee6a5143f4373c
+  data.tar.gz: 5507cdcaf0a114673a139c0096162979546c976a
 SHA512:
-  metadata.gz: 822abefcd6d88446a2d178890691ebd0e696cc3572be07d70ff809b1fce088cc2b5eea9b6bfda8e390400f78f8cf69567e702001707696e5d3c55e2c4bb7e175
-  data.tar.gz: 42f08fc6c49d0ff7a408864e5c5fb7d49ca8119d4ec7832c573a1ed6eb59d13f50d02874c30a4baa6e967fdf4de1d59287536a017d48d9c0db411cf62d33c4b1
+  metadata.gz: b316183dfd5bbd79cf034576ff69d596429a688ff202478a0d4a33fce7817c1df6bdf9f25e8a821299f66b8251c622851357d39ffa023ab738b8f36c4ee0bfbb
+  data.tar.gz: b5e87ed9886cdaf35a3a96d645710c1d1bdeac6a3def4de49428a54850e8d73e737861f7c4bdbae479240f3fc982a12300bc0747c34878b9316dfb1df9ddab32

data/.travis.yml

@@ -9,7 +9,6 @@ rvm:
 
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
     - rvm: rbx-19mode
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.rdoc

@@ -2,10 +2,34 @@
 
 * Features
 
-  * Can maintain whitelisted licenses from command line
-  * Improve New BSD license detection
+  * Projects now have a title which can be configured from CLI
+  * JRuby officially supported. Test suite works against jruby, removed 
+    warnings
+  * Internal clean-up of database behavior
+  * Updated documentation with breakdown of HTML report
 
-=== 0.8.2 / 2012-07-09
+* Bugfixes
+
+  * dependencies.db is no longer modified after license_finder runs and finds
+    no changes
+  * Fix more CLI grammar/syntax errors
+  * HTML report now works when served over https (PR #36 - bwalding)
+  * dependencies.txt is now dependencies.csv (It was always a csv in spirit)
+
+=== 0.9.0 / 2013-07-16
+
+* Features
+
+  * Clarify CLI options and commands in help output
+  * Can manage whitelisted licenses from command line
+  * Improved New BSD license detection
+
+* Bugfixes
+
+  * Fix CLI grammar errors
+  * Using license_finder in a non-RVM environment now works (Issue #35)
+
+=== 0.8.2 / 2013-07-09
 
 * Features
 

data/db/migrate/201307250917_add_license_manual_to_dependencies.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:dependencies) do
+      add_column :license_manual, TrueClass
+    end
+  end
+end

data/db/migrate/201307251004_data_fix_manual_licenses.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+  DB << <<EOS
+UPDATE dependencies
+SET license_manual = 1
+WHERE id
+IN
+  (SELECT d.id
+  FROM dependencies d
+  INNER JOIN license_aliases l
+    ON d.license_id = l.id
+  WHERE l.manual = 1)
+EOS
+  end
+end

data/db/migrate/201307251107_reassociate_license.rb

@@ -0,0 +1,23 @@
+Sequel.migration do
+  up do
+  DB << <<EOS
+UPDATE dependencies
+SET license_id =
+(SELECT la.id
+FROM
+  license_aliases la,
+  license_aliases la_orig
+WHERE
+  la.name = la_orig.name AND
+  la_orig.id = license_id
+LIMIT 1)
+EOS
+
+  DB << <<CLEANUP
+DELETE
+FROM license_aliases
+WHERE
+id NOT IN (SELECT license_id FROM dependencies)
+CLEANUP
+  end
+end

data/db/migrate/201307251340_remove_manual_from_license_aliases.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:license_aliases) do
+      drop_column :manual
+    end
+  end
+end

data/features/cli.feature

@@ -16,7 +16,7 @@ Feature: License Finder command line executable
 
   Scenario: Auditing an application with whitelisted licenses
     Given I have an app with license finder that depends on a MIT licensed gem
-    When I whitelist MIT and 'other' and New BSD licenses
+    When I whitelist MIT and 'other' and New BSD and Apache 2.0 licenses
     Then it should exit with status code 0
     And I should see all gems approved for use
 

data/features/html_report.feature

@@ -9,7 +9,8 @@ Feature: HTML Report
   Scenario: Dependency details listed in HTML report
     And my app depends on a gem with specific details
     When I run license_finder
-    Then I should see my specific gem details listed in the html
+    Then I should see the project name my_app in the html
+    And I should see my specific gem details listed in the html
 
   Scenario: Approval status of dependencies indicated in HTML report
     And my app depends on MIT and GPL licensed gems
@@ -19,5 +20,5 @@ Feature: HTML Report
 
   Scenario: Dependency summary
     And my app depends on MIT and GPL licensed gems
-    When I whitelist MIT and 'other' and New BSD licenses
+    When I whitelist MIT and 'other' and New BSD and Apache 2.0 licenses
     Then I should see only see GPL liceneses as unapproved in the html

data/features/project_name.feature

@@ -0,0 +1,10 @@
+Feature: Project names
+  As a developer
+  I want to assign a name for my project
+  So that license audit reports indicate their associated project
+
+  Scenario: Specifying a project name
+    Given I have an app with license finder
+    When I set the project name to new_project
+    And I run license_finder
+    Then I should see the project name new_project in the html

data/features/set_license.feature

@@ -7,3 +7,4 @@ Feature: Set a dependency's license through a command line interface
     Given I have an app with license finder that depends on an other licensed gem
     When I set that gems license to MIT from the command line
     Then I should see that other gems license set to MIT
+    And I see other licensed gems have not changed licenses

data/features/step_definitions/cli_steps.rb

@@ -23,7 +23,7 @@ Given(/^I have a project that depends on mime\-types with a manual license type$
 end
 
 When(/^I run license_finder help on a specific command$/) do
-  @output = @user.execute_command "license_finder dependencies help add"
+  @output = @user.execute_command "license_finder ignored_bundler_groups help add"
 end
 
 When(/^I run license_finder help$/) do
@@ -32,7 +32,7 @@ end
 
 Then(/^it creates a config directory with the license_finder config$/) do
   File.should be_exists(@user.app_path('config'))
-  text = "---\nwhitelist:\n#- MIT\n#- Apache 2.0\nignore_groups:\n#- test\n#- development\ndependencies_file_dir: './doc/'\n"
+  text = "---\nwhitelist:\n#- MIT\n#- Apache 2.0\nignore_groups:\n#- test\n#- development\ndependencies_file_dir: './doc/'\nproject_name: # project name\n"
   File.read(@user.app_path('config/license_finder.yml')).should == text.gsub(/^\s+/, "")
 end
 
@@ -53,7 +53,7 @@ Then(/^the mime\-types license remains set with my manual license type$/) do
 end
 
 Then(/^I should see the correct subcommand usage instructions$/) do
-  @output.should include 'license_finder dependencies add LICENSE'
+  @output.should include 'license_finder ignored_bundler_groups add GROUP'
 end
 
 Then(/^I should the correct default usage instructions$/) do

data/features/step_definitions/project_name_steps.rb

@@ -0,0 +1,3 @@
+When(/^I set the project name to (\w+)$/) do |project_name|
+  @user.execute_command "license_finder project_name set #{project_name}"
+end

data/features/step_definitions/set_license_steps.rb

@@ -2,15 +2,20 @@ Given(/^I have an app with license finder that depends on an other licensed gem$
   @user = ::DSL::User.new
   @user.create_nonrails_app
   @user.add_license_finder_to_rakefile
-  @user.add_dependency_to_app 'other_gem', :license => 'other'
+  @user.add_dependency_to_app 'other_gem', version: '1.0', license: 'other'
+  @user.add_dependency_to_app 'control_gem', version: '1.0', license: 'other'
 end
 
 When(/^I set that gems license to MIT from the command line$/) do
-  @output = @user.execute_command 'license_finder --quiet'
-  @output = @user.execute_command 'license_finder license MIT other_gem'
+  @user.execute_command 'license_finder --quiet'
+  @user.execute_command 'license_finder license MIT other_gem'
   @output = @user.execute_command 'license_finder --quiet'
 end
 
 Then(/^I should see that other gems license set to MIT$/) do
-  @output.should include 'other_gem'
+  @output.should include 'other_gem, 1.0, MIT'
+end
+
+Then(/^I see other licensed gems have not changed licenses$/) do
+  @output.should include 'control_gem, 1.0, other'
 end

data/features/step_definitions/shared_steps.rb

@@ -14,11 +14,20 @@ When(/^I run license_finder$/) do
   @output = @user.execute_command "license_finder --quiet"
 end
 
-When(/^I whitelist MIT and 'other' and New BSD licenses$/) do
-  @user.configure_license_finder_whitelist ["MIT","other","New BSD"]
+When(/^I whitelist MIT and 'other' and New BSD and Apache 2.0 licenses$/) do
+  @user.configure_license_finder_whitelist ["MIT","other","New BSD","Apache 2.0"]
   @output = @user.execute_command "license_finder --quiet"
 end
 
+Then(/^I should see the project name (\w+) in the html$/) do |project_name|
+  html = File.read(@user.dependencies_html_path)
+  page = Capybara.string(html)
+  title = page.find("h1")
+
+  title.should have_content project_name
+end
+
+
 module DSL
   class User
     def create_nonrails_app

data/features/step_definitions/text_report_steps.rb

@@ -4,6 +4,16 @@ Given(/^I have an app with license finder that depends on a gem with license and
   @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"
+Given(/^I have a dependencies\.txt file$/) do
+  Dir.mkdir(@user.app_path("doc"))
+  File.open(@user.app_path("doc/dependencies.txt"), 'w+') { |file| file.puts("Legacy text file") }
+end
+
+Then(/^I should see those version and license details in the dependencies\.csv file$/) do
+  File.read(@user.app_path("doc/dependencies.csv")).should include "info_gem, 1.1.1, MIT"
+end
+
+Then(/^I should see dependencies\.txt replaced by dependencies\.csv$/) do
+  File.exists?(@user.app_path("doc/dependencies.txt")).should be_false
+  File.exists?(@user.app_path("doc/dependencies.csv")).should be_true
 end

data/features/text_report.feature

@@ -6,4 +6,10 @@ Feature: Text Report
   Scenario: Viewing dependencies
     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
+    Then I should see those version and license details in the dependencies.csv file
+
+  Scenario: Cleaning up old versions of text report
+    Given I have an app with license finder
+    And I have a dependencies.txt file
+    When I run license_finder
+    Then I should see dependencies.txt replaced by dependencies.csv

data/files/license_finder.yml

@@ -6,3 +6,4 @@ ignore_groups:
 #- test
 #- development
 dependencies_file_dir: './doc/'
+project_name: # project name

data/lib/license_finder.rb

@@ -34,10 +34,6 @@ module LicenseFinder
     @config ||= Configuration.ensure_default
   end
 
-  def self.current_gems
-    @current_gems ||= Bundle.current_gems
-  end
-
   def self.load_rake_tasks
     load 'tasks/license_finder.rake'
   end
@@ -45,5 +41,4 @@ end
 
 require 'license_finder/railtie' if defined?(Rails)
 require 'license_finder/tables'
-
 LicenseFinder::YmlToSql.convert_if_required

data/lib/license_finder/bundle.rb

@@ -4,23 +4,33 @@ module LicenseFinder
   class Bundle
     attr_writer :ignore_groups
 
-    def self.current_gems(bundler_definition=nil)
-      new(bundler_definition).gems
+    def self.current_gems(config, bundler_definition=nil)
+      new(config, bundler_definition).gems
     end
 
-    def initialize(bundler_definition=nil)
+    def initialize(config=nil, bundler_definition=nil)
       @definition = bundler_definition || Bundler::Definition.build(gemfile_path, lockfile_path, nil)
+      @config ||= config
     end
 
     def gems
       return @gems if @gems
 
+      gem_names_cache = {}
+
       @gems ||= definition.specs_for(included_groups).map do |spec|
         dependency = dependencies.detect { |dep| dep.name == spec.name }
 
+        formatted_name = format_name(spec)
+        gem_names_cache[format_name(spec)] = true
+
         BundledGem.new(spec, dependency)
       end
 
+      @gems.each do |gem|
+        gem.children = children_for(gem, gem_names_cache)
+      end
+
       @gems
     end
 
@@ -28,7 +38,7 @@ module LicenseFinder
     attr_reader :definition
 
     def ignore_groups
-      @ignore_groups ||= LicenseFinder.config.ignore_groups
+      @ignore_groups ||= @config.ignore_groups
     end
 
     def dependencies
@@ -46,5 +56,13 @@ module LicenseFinder
     def lockfile_path
       gemfile_path.dirname.join('Gemfile.lock')
     end
+
+    def children_for(gem, cache)
+      gem.spec.dependencies.map(&:name).select { |name| cache[name] }
+    end
+
+    def format_name(gem)
+      gem.name.split(" ")[0]
+    end
   end
 end

data/lib/license_finder/bundled_gem.rb

@@ -1,10 +1,11 @@
 module LicenseFinder
   class BundledGem
-    attr_reader :parents, :spec, :bundler_dependency
+    attr_reader :parents, :spec, :bundler_dependency, :children
 
     def initialize(spec, bundler_dependency = nil)
       @spec = spec
       @bundler_dependency = bundler_dependency
+      @children = []
     end
 
     def name
@@ -23,26 +24,32 @@ module LicenseFinder
       @spec.version.to_s
     end
 
-    def children
-      @children ||= @spec.dependencies.collect(&:name)
+    def groups
+      @groups ||= bundler_dependency ? bundler_dependency.groups : []
     end
 
-    def determine_license
-      return @spec.license if @spec.license
+    def license
+      @license ||= determine_license
+    end
 
-      license_files.map(&:license).compact.first || 'other'
+    def sort_order
+      dependency_name.downcase
     end
 
     def license_files
       PossibleLicenseFiles.new(@spec.full_gem_path).find
     end
 
-    def sort_order
-      dependency_name.downcase
+    def children=(childs)
+      @children = childs
     end
 
-    def save_as_dependency
-      BundledGemSaver.find_or_create_by_name(@spec.name, self).save
+    private
+
+    def determine_license
+      return @spec.license if @spec.license
+
+      license_files.map(&:license).compact.first || 'other'
     end
   end
 end

data/lib/license_finder/bundled_gem_saver.rb

@@ -2,15 +2,21 @@ module LicenseFinder
   class BundledGemSaver
     extend Forwardable
     def_delegators :spec, :name, :version, :summary, :description, :homepage
-    def_delegators :bundled_gem, :bundler_dependency, :determine_license, :children
+    def_delegators :bundled_gem, :bundler_dependency, :license, :children, :groups
 
     attr_reader :dependency, :bundled_gem
 
-    def self.find_or_create_by_name(name, bundled_gem)
-      dependency = Dependency.named(name)
+    def self.find_or_create_by_name(bundled_gem)
+      dependency = Dependency.named(bundled_gem.spec.name)
       new(dependency, bundled_gem)
     end
 
+    def self.save_gems(current_gems)
+      current_gems.map do |bundled_gem|
+        BundledGemSaver.find_or_create_by_name(bundled_gem).save
+      end
+    end
+
     def initialize(dependency, bundled_gem)
       @bundled_gem = bundled_gem
       @dependency = dependency
@@ -19,8 +25,8 @@ module LicenseFinder
     def save
       DB.transaction do
         apply_dependency_definition
-        refresh_bundler_groups
-        refresh_children
+        sync_bundler_groups
+        sync_children
         apply_better_license
       end
       dependency
@@ -38,7 +44,6 @@ module LicenseFinder
         dependency.summary = summary
         dependency.description = description
         dependency.homepage = homepage
-        dependency.license ||= LicenseAlias.create(name: determine_license)
         dependency.save
       end
     end
@@ -47,42 +52,49 @@ module LicenseFinder
       return dependency.version != version.to_s ||
         dependency.summary != summary ||
         dependency.description != description ||
-        dependency.homepage != homepage ||
-        dependency.license.name != determine_license
+        dependency.homepage != homepage
     end
 
-    def refresh_bundler_groups
-      dependency.remove_all_bundler_groups
-      if bundler_dependency
-        bundler_dependency.groups.each { |group|
-          dependency.add_bundler_group BundlerGroup.find_or_create(name: group.to_s)
-        }
+    def sync_bundler_groups
+      existing_groups = dependency.bundler_groups
+      new_groups = groups.map(&:to_s)
+
+      existing_groups.reverse.each do |group|
+        unless new_groups.include?(group.name)
+          dependency.remove_bundler_group(group)
+        end
       end
-    end
 
-    def refresh_children
-      dependency.remove_all_children
-      children.each do |child|
-        if child_required?(child)
-          dependency.add_child Dependency.named(child)
+      new_groups.each do |group|
+        unless existing_groups.map(&:name).include? group
+          dependency.add_bundler_group BundlerGroup.find_or_create(name: group)
         end
       end
     end
 
-    def child_required?(child)
-      current_gem_names.include?(child)
-    end
+    def sync_children
+      existing_children = dependency.children
+      new_children = children
+
+      existing_children.reverse.each do |child|
+        unless new_children.include?(child.name)
+          dependency.remove_child(child)
+        end
+      end
 
-    def current_gem_names
-      @current_gem_names ||= LicenseFinder.current_gems.map { |gem| gem.name.split(" ")[0] }
+      new_children.each do |child|
+        unless existing_children.map(&:name).include?(child)
+          dependency.add_child Dependency.named(child)
+        end
+      end
     end
 
     def apply_better_license
-      if dependency.license && !dependency.license.manual && determine_license != 'other'
-        new_name = determine_license
-        unless new_name == dependency.license.name
-          dependency.license.name = new_name
-          dependency.license.save
+      if !dependency.license_manual
+        bundled_license = license
+        if dependency.license.nil? || bundled_license != dependency.license.name
+          dependency.license = LicenseAlias.find_or_create(name: bundled_license)
+          dependency.save
         end
       end
     end