license_finder 0.5.0 → 0.6.0

data/features/text_report.feature

@@ -0,0 +1,27 @@
+Feature: Text 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 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 "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 "dependencies.txt" containing:
+      """
+      descriptive_gem, 1.1.1, MIT
+      """

data/lib/license_finder.rb

@@ -4,30 +4,17 @@ require 'yaml'
 module LicenseFinder
   ROOT_PATH = Pathname.new(__FILE__).dirname
 
-  class Configuration
-    attr_reader :whitelist, :ignore_groups, :dependencies_dir
-
-    def initialize
-      config = {}
-
-      if File.exists?('./config/license_finder.yml')
-        yaml = File.open('./config/license_finder.yml').readlines.join
-        config = YAML.load(yaml)
-      end
-
-      @whitelist = config['whitelist'] || []
-      @ignore_groups = (config["ignore_groups"] || []).map(&:to_sym)
-      @dependencies_dir = config['dependencies_file_dir'] || '.'
-    end
-
-    def dependencies_yaml
-      File.join(dependencies_dir, "dependencies.yml")
-    end
-
-    def dependencies_text
-      File.join(dependencies_dir, "dependencies.txt")
-    end
-  end
+  autoload :Bundle, 'license_finder/bundle'
+  autoload :BundledGem, 'license_finder/bundled_gem'
+  autoload :CLI, 'license_finder/cli'
+  autoload :Configuration, 'license_finder/configuration'
+  autoload :Dependency, 'license_finder/dependency'
+  autoload :DependencyList, 'license_finder/dependency_list'
+  autoload :License, 'license_finder/license'
+  autoload :LicenseUrl, 'license_finder/license_url'
+  autoload :PossibleLicenseFile, 'license_finder/possible_license_file'
+  autoload :Reporter, 'license_finder/reporter'
+  autoload :Viewable, 'license_finder/viewable'
 
   def self.config
     @config ||= Configuration.new
@@ -39,11 +26,3 @@ module LicenseFinder
 end
 
 require 'license_finder/railtie' if defined?(Rails)
-require 'license_finder/bundler_dependency_query'
-require 'license_finder/finder'
-require 'license_finder/bundled_gem'
-require 'license_finder/license'
-require 'license_finder/possible_license_file'
-require 'license_finder/dependency'
-require 'license_finder/dependency_list'
-require 'license_finder/cli'

data/lib/license_finder/bundle.rb

@@ -0,0 +1,33 @@
+module LicenseFinder
+  class Bundle
+    def gems
+      definition.specs_for(included_groups).map do |spec|
+        dependency = dependencies.detect { |dep| dep.name == spec.name }
+
+        BundledGem.new(spec, dependency)
+      end
+    end
+
+    private
+
+    def definition
+      @definition ||= Bundler::Definition.build(gemfile_path, lockfile_path, nil)
+    end
+
+    def dependencies
+      @dependencies ||= definition.dependencies
+    end
+
+    def included_groups
+      definition.groups - LicenseFinder.config.ignore_groups
+    end
+
+    def gemfile_path
+      Pathname.new("Gemfile").expand_path
+    end
+
+    def lockfile_path
+      gemfile_path.dirname.join('Gemfile.lock')
+    end
+  end
+end

data/lib/license_finder/bundled_gem.rb

@@ -1,36 +1,38 @@
 module LicenseFinder
   class BundledGem
-    LICENSE_FILE_NAMES = '*{LICENSE,License,Licence,COPYING,README,Readme,ReadMe}*' # follows Dir.glob format
-    README_FILE_NAMES = '*{README,Readme,ReadMe}*' # follows Dir.glob format
+    LICENSE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
+    README_FILE_NAMES = %w(README Readme ReadMe)
 
-    def initialize(spec)
+    def initialize(spec, bundler_dependency = nil)
       @spec = spec
+      @bundler_dependency = bundler_dependency
     end
 
-    attr_reader :spec
-
     def name
       "#{dependency_name} #{dependency_version}"
     end
 
     def dependency_name
-      spec.name
+      @spec.name
     end
 
     def dependency_version
-      spec.version.to_s
+      @spec.version.to_s
     end
 
-    def dependency
-      @dependency ||= Dependency.new(
+    def to_dependency
+      @dependency ||= LicenseFinder::Dependency.new(
         'name' => @spec.name,
         'version' => @spec.version.to_s,
         'license' => determine_license,
         'license_files' => license_files.map(&:full_file_path),
         'readme_files' => readme_files.map(&:full_file_path),
         'source' => 'bundle',
+        'bundler_groups' => (@bundler_dependency.groups if @bundler_dependency),
         'summary' => @spec.summary,
-        'description' => @spec.description
+        'description' => @spec.description,
+        'homepage' => @spec.homepage,
+        'children' => @spec.dependencies
       )
     end
 
@@ -41,7 +43,7 @@ module LicenseFinder
     end
 
     def license_files
-      paths_with_license_names = Dir.glob(File.join(install_path, '**', LICENSE_FILE_NAMES))
+      paths_with_license_names = find_matching_files(LICENSE_FILE_NAMES)
       paths_for_license_files = paths_with_license_names.map do |path|
         File.directory?(path) ? paths_for_files_in_license_directory(path) : path
       end.flatten.uniq
@@ -49,13 +51,13 @@ module LicenseFinder
     end
 
     def readme_files
-      Dir.glob(File.join(install_path, '**', README_FILE_NAMES)).map do |path|
-        get_file_for_path path
+      find_matching_files(README_FILE_NAMES).map do |path|
+        get_file_for_path(path)
       end
     end
 
     def install_path
-      spec.full_gem_path
+      @spec.full_gem_path
     end
 
     def sort_order
@@ -64,6 +66,10 @@ module LicenseFinder
 
     private
 
+    def find_matching_files(names)
+      Dir.glob(File.join(install_path, '**', "*{#{names.join(',')}}*"))
+    end
+
     def get_file_for_path(path)
       PossibleLicenseFile.new(install_path, path)
     end

data/lib/license_finder/cli.rb

@@ -1,11 +1,12 @@
 module LicenseFinder
-  class CLI
+  module CLI
+    extend self
+
     def check_for_action_items
-      found = LicenseFinder::Finder.new.action_items
+      found = LicenseFinder::Reporter.new.action_items
 
       if found.size == 0
         puts "All gems are approved for use"
-        exit 0
       else
         puts "Dependencies that need approval:"
         puts found

data/lib/license_finder/configuration.rb

@@ -0,0 +1,34 @@
+module LicenseFinder
+  class Configuration
+    attr_reader :whitelist, :ignore_groups, :dependencies_dir
+
+    def initialize
+      config = {}
+
+      if File.exists?(config_file_path)
+        yaml = File.open(config_file_path).readlines.join
+        config = YAML.load(yaml)
+      end
+
+      @whitelist = config['whitelist'] || []
+      @ignore_groups = (config["ignore_groups"] || []).map(&:to_sym)
+      @dependencies_dir = config['dependencies_file_dir'] || '.'
+    end
+
+    def config_file_path
+      File.join('.', 'config', 'license_finder.yml')
+    end
+
+    def dependencies_yaml
+      File.join(dependencies_dir, "dependencies.yml")
+    end
+
+    def dependencies_text
+      File.join(dependencies_dir, "dependencies.txt")
+    end
+
+    def dependencies_html
+      File.join(dependencies_dir, "dependencies.html")
+    end
+  end
+end

data/lib/license_finder/dependency.rb

@@ -3,8 +3,10 @@ require "erb"
 
 module LicenseFinder
   class Dependency
+    include Viewable
+
     attr_accessor :name, :version, :license, :approved, :license_url, :notes, :license_files,
-      :readme_files, :source, :bundler_groups
+      :readme_files, :source, :bundler_groups, :homepage, :children, :parents
 
     attr_reader :summary, :description
 
@@ -21,13 +23,19 @@ module LicenseFinder
       @version = attributes['version']
       @license = attributes['license']
       @approved = attributes['approved'] || LicenseFinder.config.whitelist.include?(attributes['license'])
-      @license_url = attributes['license_url'] || ''
       @notes = attributes['notes'] || ''
       @license_files = attributes['license_files'] || []
       @readme_files = attributes['readme_files'] || []
       @bundler_groups = attributes['bundler_groups'] || []
       @summary = attributes['summary']
       @description = attributes['description']
+      @homepage = attributes['homepage']
+      @children = attributes.fetch('children', [])
+      @parents = attributes.fetch('parents', [])
+    end
+
+    def license_url
+      LicenseFinder::LicenseUrl.find_by_name license
     end
 
     def merge(other)
@@ -44,6 +52,9 @@ module LicenseFinder
         'summary' => other.summary,
         'description' => other.description,
         'bundler_groups' => other.bundler_groups,
+        'homepage' => other.homepage,
+        'children' => other.children,
+        'parents' => other.parents
       )
 
       case other.license
@@ -66,6 +77,7 @@ module LicenseFinder
         'approved' => approved,
         'source' => source,
         'license_url' => license_url,
+        'homepage' => homepage,
         'notes' => notes,
         'license_files' => nil,
         'readme_files' => nil
@@ -86,28 +98,21 @@ module LicenseFinder
       attrs
     end
 
-    def to_yaml
-      as_yaml.to_yaml
+    def to_s
+      [name, version, license].join ", "
     end
 
-    def to_s
-      template = ERB.new <<-TEMPLATE
-<%= attributes.join(", ") %>
-<% if license == 'other' %>
-  <% unless license_files.empty? %>
-  license files:
-    <%= license_files.join("\n    ") %>
-  <% end %>
-  <% unless readme_files.empty? %>
-  readme files:
-    <%= readme_files.join("\n    ") %>
-  <% end %>
-<% end%>
-TEMPLATE
-
-      attributes = ["#{name} #{version}".strip, license, license_url, summary, description, bundler_groups].flatten.compact.reject {|a| a == ""}
-
-      template.result(binding).gsub(/(^|\n)\s*(\n|$)/, '\1')
+    private
+
+    def constantize(string)
+      names = string.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name, false) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
     end
   end
 end

data/lib/license_finder/dependency_list.rb

@@ -1,19 +1,38 @@
+# encoding: utf-8
+
 module LicenseFinder
   class DependencyList
+    include Viewable
 
     attr_reader :dependencies
 
     def self.from_bundler
-      new(BundlerDependencyQuery.new.dependencies)
+      dep_list = new(Bundle.new.gems.map(&:to_dependency))
+      setup_parents_of_dependencies(dep_list)
+      dep_list
     end
 
-    def initialize(dependencies)
-      @dependencies = dependencies
+    def self.setup_parents_of_dependencies(dep_list)
+      dependency_index = {}
+      dep_list.dependencies.each do |dep|
+        dependency_index[dep.name] = dep
+      end
+
+      dep_list.dependencies.each do |dep|
+        dep.children.each do |child_dep|
+          license_finder_dependency = dependency_index[child_dep.name]
+          license_finder_dependency.parents << dep if license_finder_dependency
+        end
+      end
+    end
+
+    def self.from_yaml(yaml)
+      deps = YAML.load(yaml)
+      new(deps.map { |attrs| Dependency.from_hash(attrs) })
     end
 
-    def self.from_yaml(yml)
-      deps = YAML.load(yml)
-      new(deps.map { |dhash| Dependency.from_hash(dhash) })
+    def initialize(dependencies)
+      @dependencies = dependencies
     end
 
     def merge(new_list)
@@ -36,23 +55,26 @@ module LicenseFinder
       sorted_dependencies.map(&:as_yaml)
     end
 
-    def to_yaml
-      as_yaml.to_yaml
-    end
-
     def to_s
-      sorted_dependencies.map(&:to_s).join
+      sorted_dependencies.map(&:to_s).join("\n")
     end
 
     def action_items
-      sorted_dependencies.reject(&:approved).map(&:to_s).join
+      sorted_dependencies.reject(&:approved).map(&:to_s).join "\n"
     end
 
     private
 
+    def unapproved_dependencies
+      dependencies.reject(&:approved)
+    end
+
     def sorted_dependencies
       dependencies.sort_by(&:name)
     end
+
+    def grouped_dependencies
+      dependencies.group_by(&:license).sort_by { |_, group| group.size }.reverse
+    end
   end
 end
-