license_finder 0.9.0 → 0.9.1

data/lib/license_finder/cli.rb

@@ -24,7 +24,17 @@ module LicenseFinder
       # Hack to override the help message produced by Thor.
       # https://github.com/wycats/thor/issues/261#issuecomment-16880836
       def self.banner(command, namespace = nil, subcommand = nil)
-        "#{basename} #{name.split("::").last.downcase} #{command.usage}"
+        "#{basename} #{underscore_name(name)} #{command.usage}"
+      end
+
+      protected
+
+      def self.underscore_name(name)
+        underscored = name.split("::").last
+        underscored.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        underscored.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        underscored.tr!("-", "_")
+        underscored.downcase
       end
     end
 
@@ -64,25 +74,42 @@ module LicenseFinder
         end
       end
 
-      desc "add", "Add a license to the whitelist"
+      desc "add LICENSE", "Add a license to the whitelist"
       def add(license)
         die_on_error {
           LicenseFinder.config.whitelist.push(license)
           LicenseFinder.config.save
+
+          Reporter.write_reports
         }
         say "Added #{license} to the license whitelist"
       end
 
-      desc "remove", "Remove a license from the whitelist"
+      desc "remove LICENSE", "Remove a license from the whitelist"
       def remove(license)
         die_on_error {
           LicenseFinder.config.whitelist.delete(license)
           LicenseFinder.config.save
+
+          Reporter.write_reports
         }
         say "Removed #{license} from the license whitelist"
       end
     end
 
+    class ProjectName < Subcommand
+      desc "set NAME", "Set the project name"
+      def set(name)
+        die_on_error {
+          LicenseFinder.config.project_name = name
+          LicenseFinder.config.save
+
+          Reporter.write_reports
+        }
+        say "Set the project name to #{name}", :green
+      end
+    end
+
     class IgnoredBundlerGroups < Subcommand
       desc "list", "List all the ignored bundler groups"
       def list
@@ -94,20 +121,24 @@ module LicenseFinder
         end
       end
 
-      desc "add", "Add a bundler group to be ignored"
+      desc "add GROUP", "Add a bundler group to be ignored"
       def add(group)
         die_on_error {
           LicenseFinder.config.ignore_groups.push(group)
           LicenseFinder.config.save
+
+          Reporter.write_reports
         }
         say "Added #{group} to the ignored bundler groups"
       end
 
-      desc "remove", "Remove a bundler group from the ignored bundler groups"
+      desc "remove GROUP", "Remove a bundler group from the ignored bundler groups"
       def remove(group)
         die_on_error {
           LicenseFinder.config.ignore_groups.delete(group)
           LicenseFinder.config.save
+
+          Reporter.write_reports
         }
         say "Removed #{group} from the ignored bundler groups"
       end
@@ -167,6 +198,7 @@ module LicenseFinder
       subcommand "dependencies", Dependencies, "manage non-Bundler dependencies"
       subcommand "ignored_bundler_groups", IgnoredBundlerGroups, "manage ignored bundler groups"
       subcommand "whitelist", Whitelist, "manage whitelisted licenses"
+      subcommand "project_name", ProjectName, "manage the project name"
 
       private
 

data/lib/license_finder/configuration.rb

@@ -2,7 +2,7 @@ require "rake"
 
 module LicenseFinder
   class Configuration
-    attr_accessor :whitelist, :ignore_groups, :dependencies_dir
+    attr_accessor :whitelist, :ignore_groups, :dependencies_dir, :project_name
 
     def self.config_file_path
       File.join('.', 'config', 'license_finder.yml')
@@ -45,6 +45,7 @@ module LicenseFinder
       @whitelist = config['whitelist'] || []
       @ignore_groups = (config["ignore_groups"] || [])
       @dependencies_dir = config['dependencies_file_dir'] || './doc/'
+      @project_name = config['project_name'] || determine_project_name
       FileUtils.mkdir_p(@dependencies_dir)
     end
 
@@ -57,6 +58,10 @@ module LicenseFinder
     end
 
     def dependencies_text
+      File.join(dependencies_dir, "dependencies.csv")
+    end
+
+    def dependencies_legacy_text
       File.join(dependencies_dir, "dependencies.txt")
     end
 
@@ -73,7 +78,9 @@ module LicenseFinder
       File.open(Configuration.config_file_path, 'w') do |file|
         file.write({
           'whitelist' => @whitelist.uniq,
-          'ignore_groups' => @ignore_groups.uniq
+          'ignore_groups' => @ignore_groups.uniq,
+          'dependencies_file_dir' => @dependencies_dir,
+          'project_name' => @project_name
         }.to_yaml)
       end
     end
@@ -85,5 +92,9 @@ module LicenseFinder
         License.find_by_name(license_name) || license_name
       end.compact
     end
+
+    def determine_project_name
+      File.basename(Dir.getwd)
+    end
   end
 end

data/lib/license_finder/dependency_manager.rb

@@ -1,8 +1,10 @@
+require 'digest'
+
 module LicenseFinder
   module DependencyManager
     def self.sync_with_bundler
       modifying {
-        current_dependencies = LicenseFinder.current_gems.map(&:save_as_dependency)
+        current_dependencies = BundledGemSaver.save_gems(Bundle.current_gems(LicenseFinder.config))
         Dependency.bundler.obsolete(current_dependencies).each(&:destroy)
       }
     end
@@ -23,13 +25,30 @@ module LicenseFinder
     end
 
     def self.license!(name, license)
-      modifying { find_by_name(name).license.set_manually(license) }
+      modifying { find_by_name(name).set_license_manually!(license) }
     end
 
     def self.approve!(name)
       modifying { find_by_name(name).approve!  }
     end
 
+    def self.modifying
+      checksum_before_modifying = if File.exists? LicenseFinder.config.database_uri
+                                    Digest::SHA2.file(LicenseFinder.config.database_uri).hexdigest
+                                  end
+      result = yield
+      checksum_after_modifying = Digest::SHA2.file(LicenseFinder.config.database_uri).hexdigest
+
+      unless checksum_after_modifying == checksum_before_modifying
+        Reporter.write_reports
+      end
+      unless File.exists? LicenseFinder.config.dependencies_html
+        Reporter.write_reports
+      end
+
+      result
+    end
+
     private # not really private, but it looks like it is!
 
     def self.find_by_name(name, scope = Dependency)
@@ -37,12 +56,6 @@ module LicenseFinder
       raise Error.new("could not find dependency named #{name}") unless dep
       dep
     end
-
-    def self.modifying
-      result = yield
-      Reporter.write_reports
-      result
-    end
   end
 end
 

data/lib/license_finder/reports/dependency_report.rb

@@ -16,7 +16,7 @@ module LicenseFinder
 
     def to_s
       filename = ROOT_PATH.join('templates', "#{self.class.underscored_name}.erb")
-      template = ERB.new(File.read(filename), 0, '-')
+      template = ERB.new(File.read(filename), nil, '-')
       template.result(binding)
     end
 

data/lib/license_finder/reports/reporter.rb

@@ -7,6 +7,10 @@ module LicenseFinder
 
       write_file LicenseFinder.config.dependencies_text, TextReport.new(dependencies).to_s
       write_file LicenseFinder.config.dependencies_html, HtmlReport.new(dependencies).to_s
+
+      if File.exists?(LicenseFinder.config.dependencies_legacy_text)
+        File.delete(LicenseFinder.config.dependencies_legacy_text)
+      end
     end
 
     private

data/lib/license_finder/tables/dependency.rb

@@ -37,7 +37,15 @@ module LicenseFinder
     end
 
     def approved?
-      (license && license.whitelisted?) || approval.state
+      # jruby adapter receives approval.state as Fixnum '0', which ruby evaluates
+      # as truthy, so we catch this here for jruby support.
+      (license && license.whitelisted?) || (approval.state && approval.state != 0)
+    end
+
+    def set_license_manually!(license_name)
+      self.license = LicenseAlias.find_or_create(name: license_name)
+      self.license_manual = true
+      save
     end
 
     def ensure_approval_exists!

data/lib/license_finder/tables/license_alias.rb

@@ -9,10 +9,6 @@ module LicenseFinder
       !!(config.whitelisted?(name))
     end
 
-    def set_manually(name)
-      update('name' => name, 'manual' => true)
-    end
-
     private
 
     def config

data/lib/license_finder/yml_to_sql.rb

@@ -67,7 +67,7 @@ module LicenseFinder
     end
 
     def create_license
-      Sql::LicenseAlias.convert(legacy_attrs)
+      LicenseAlias.find_or_create(name: legacy_attrs['license'])
     end
 
     def create_approval
@@ -110,16 +110,6 @@ module LicenseFinder
       class BundlerGroup < Sequel::Model
       end
 
-      class LicenseAlias < Sequel::Model
-        extend Convertable
-
-        VALID_ATTRIBUTES = {
-          'license' => 'name',
-          'license_url' => 'url',
-          'manual' => 'manual'
-        }
-      end
-
       class Approval < Sequel::Model
         extend Convertable
 

data/lib/templates/html_report.erb

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.1.1/css/bootstrap.min.css" rel="stylesheet">
+  <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.1.1/css/bootstrap.min.css" rel="stylesheet">
   <style type="text/css">
     body {
       margin: 50px;
@@ -13,11 +13,21 @@
       content: " (unapproved)"
     }
   </style>
+  <script>
+    // Loads stylesheet when viewing file locally.
+    if (location.protocol === "file:") {
+      var link = document.querySelector('head link')
+        , href = link.href.replace(/file/, "http");
+
+      link.href = href;
+    }
+  </script>
 </head>
 <body>
 <div class="container">
+  <h1><%= LicenseFinder.config.project_name %></h1>
   <div class="summary hero-unit">
-    <h1>Dependencies</h1>
+    <h2>Dependencies</h2>
 
     <p>As of <%= Time.now.strftime("%B %e, %Y %l:%M%P") %></p>
 
@@ -37,7 +47,7 @@
   </div>
   <% if unapproved_dependencies.any? -%>
     <div class="action-items hero-unit">
-      <h1>Action Items</h1>
+      <h2>Action Items</h2>
       <h4><%= unapproved_dependencies.size %> unapproved dependencies</h4>
       <ul>
         <% unapproved_dependencies.each do |dependency| -%>

data/license_finder.gemspec

@@ -2,8 +2,8 @@ require './lib/license_finder/platform'
 
 Gem::Specification.new do |s|
   s.name        = "license_finder"
-  s.version     = "0.9.0"
-  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "David Tengdin", "William Ramsey"]
+  s.version     = "0.9.1"
+  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "Trevor John", "David Tengdin", "William Ramsey"]
   s.email       = ["licensefinder@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
   s.summary     = "Audit the OSS licenses of your application's dependencies."
@@ -24,11 +24,10 @@ Gem::Specification.new do |s|
   s.add_dependency "rake"
   s.add_dependency LicenseFinder::Platform.sqlite_gem
 
-  %w(rspec xpath cucumber).each do |gem|
+  %w(rspec xpath cucumber pry).each do |gem|
     s.add_development_dependency gem
   end
 
-  s.add_development_dependency "database_cleaner", "0.9.1"
   s.add_development_dependency "capybara", "~> 2.0.0"
   s.add_development_dependency "rails", "~> 3.2.0"
 

data/readme.md

@@ -28,7 +28,7 @@ $ license_finder
 On a brand new Rails project, you could expect `license_finder` to output something like the following
 (assuming you whitelisted the MIT license -- see [Configuration](#configuration)):
 
-```yaml
+```
 Dependencies that need approval:
 
 highline, 1.6.14, ruby
@@ -40,7 +40,7 @@ rubyzip, 0.9.9, ruby
 xml-simple, 1.1.1, other
 ```
 
-The executable task will also write out a dependencies.db, dependencies.txt, and dependencies.html file in the doc/
+The executable task will also write out a dependencies.db, dependencies.csv, and dependencies.html file in the doc/
 directory (by default -- see [Configuration](#configuration)).
 
 The latter two files are human readable reports that you could send to your non-technical business partners, lawyers, etc.
@@ -73,7 +73,7 @@ whitelisted the "MIT" license in your `config/license_finder.yml`. You then add
 which we'll assume is licensed with the `GPL` license. You then run `license_finder` and see
 the gem listed in the output:
 
-```txt
+```sh
 awesome_gpl_gem, 1.0.0, GPL
 ```
 
@@ -156,6 +156,17 @@ project, so you can use:
 $ license_finder dependencies remove my_js_dep
 ```
 
+### Managing project name
+
+The HTML report generated by license_finder will have the name of your project at the top. By default, this is set to the name of your working directory. However, this can be changed using the command line:
+
+```sh
+$ license_finder project_name set 'My Project Name'
+```
+
+The changes will be reflected in the report the next time you run license_finder.
+
+
 ## Configuration
 
 The first time you run `license_finder` it will create a default configuration file `./config/license_finder.yml`:
@@ -169,6 +180,7 @@ ignore_groups:
 #- test
 #- development
 dependencies_file_dir: './doc/'
+project_name: My Project Name
 ```
 
 By modifying this file, you can configure license_finder's behavior. `Whitelisted` licenses will be automatically approved
@@ -176,6 +188,16 @@ and `ignore_groups` will limit which dependencies are included in your license r
 and text files in another directory by changing `dependencies_file_dir`.
 
 
+## HTML Report
+
+The HTML report generated by license_finder has two sections, an overview at the top, and then a series of dependency summaries afterwards.
+
+![HTML Report](files/report_breakdown.png)
+
+The individual dependency summary follows a pattern like this:
+
+![HTML Report](files/dependency_breakdown.png)
+
 ## Upgrade for pre 0.8.0 users
 
 If you wish to cleanup your root directory you can run:

data/release/gem_version.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+
+puts Bundler.load_gemspec('license_finder.gemspec').version

data/{release.md → release/manual_instructions.md}

@@ -20,3 +20,9 @@ Push both versions of the gem
 $ rake release # will push default MRI build of gem, and importantly, tag the gem
 $ gem push pkg/license_finder-LATEST_VERSION_HERE-java.gem
 ```
+
+
+## Release Script
+
+There is now a release bash script that automates this process. You will need the necessary
+rubies installed before performing the script in `release/publish.sh`

data/release/publish.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash -l
+
+export LF_GEM_VERSION=`ruby release/gem_version.rb`
+
+read -p "This will build and release license_finder $LF_GEM_VERSION -- are you sure you wish to continue? [Y/n] " -n 1 -r
+if [[ ! $REPLY =~ ^[Yy]$ ]]
+then
+  printf "\nAborted!"
+  exit
+fi
+
+function perform {
+  printf "\n> $1\n"
+  $1
+}
+
+printf "\nBuilding jruby... (1.7.4)"
+perform "rvm use jruby-1.7.4"
+perform "rake build"
+
+printf "\nBuilding ruby... (2.0.0)"
+perform "rvm use ruby-2.0.0"
+perform "rake build"
+
+printf "\nPublishing to rubygems..."
+perform "rake release"
+perform "gem push pkg/license_finder-$LF_GEM_VERSION-java.gem"
+
+printf "\nRelease finished."