license_finder 0.7.3 → 0.8.0

data/lib/license_finder/license_files.rb

@@ -0,0 +1,36 @@
+module LicenseFinder
+  class LicenseFiles
+    LICENSE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
+
+    def initialize(install_path)
+      @install_path = install_path
+    end
+
+    attr_reader :install_path
+
+    def files
+      paths_for_license_files.map do |path|
+        get_file_for_path(path)
+      end
+    end
+
+    def paths_for_license_files
+      find_matching_files.map do |path|
+        File.directory?(path) ? paths_for_files_in_license_directory(path) : path
+      end.flatten.uniq
+    end
+
+    def find_matching_files
+      Dir.glob(File.join(install_path, '**', "*{#{LICENSE_FILE_NAMES.join(',')}}*"))
+    end
+
+    def paths_for_files_in_license_directory(path)
+      entries_in_directory = Dir::entries(path).reject { |p| p.match(/^(\.){1,2}$/) }
+      entries_in_directory.map { |entry_name| File.join(path, entry_name) }
+    end
+
+    def get_file_for_path(path)
+      PossibleLicenseFile.new(install_path, path)
+    end
+  end
+end

data/lib/license_finder/license_url.rb

@@ -1,10 +1,12 @@
-module LicenseFinder::LicenseUrl
-  extend self
+module LicenseFinder
+  module LicenseUrl
+    extend self
 
-  def find_by_name(name)
-    name = name.to_s
+    def find_by_name(name)
+      name = name.to_s
 
-    license = LicenseFinder::License.find_by_name(name)
-    license.license_url if license
+      license = License.find_by_name(name)
+      license.license_url if license
+    end
   end
 end

data/lib/license_finder/platform.rb

@@ -0,0 +1,32 @@
+module LicenseFinder
+  module Platform
+    def self.sqlite_adapter
+      if java?
+        'jdbc:sqlite'
+      else
+        'sqlite'
+      end
+    end
+
+    def self.sqlite_gem
+      if java?
+        'jdbc-sqlite3'
+      else
+        'sqlite3'
+      end
+    end
+
+    def self.sqlite_load_path
+      if java?
+        'jdbc/sqlite3'
+      else
+        'sqlite3'
+      end
+    end
+
+    def self.java?
+      RUBY_PLATFORM =~ /java/
+    end
+  end
+end
+

data/lib/license_finder/possible_license_file.rb

@@ -22,7 +22,7 @@ module LicenseFinder
     end
 
     def license
-      license = LicenseFinder::License.all.detect do |klass|
+      license = License.all.detect do |klass|
         klass.new(text).matches?
       end
 

data/lib/license_finder/tables.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'sequel'
+require LicenseFinder::Platform.sqlite_load_path
+
+DB = Sequel.connect("#{LicenseFinder::Platform.sqlite_adapter}://#{LicenseFinder.config.database_path}")
+Sequel.extension :migration, :core_extensions
+Sequel::Migrator.run(DB, LicenseFinder::ROOT_PATH.join('../db/migrate'))

data/lib/license_finder/tables/approval.rb

@@ -0,0 +1,4 @@
+module LicenseFinder
+  class Approval < Sequel::Model
+  end
+end

data/lib/license_finder/tables/bundler_group.rb

@@ -0,0 +1,4 @@
+module LicenseFinder
+  class BundlerGroup < Sequel::Model
+  end
+end

data/lib/license_finder/tables/dependency.rb

@@ -0,0 +1,31 @@
+module LicenseFinder
+  class Dependency < Sequel::Model
+    many_to_one :license, class: LicenseAlias
+    many_to_one :approval
+    many_to_many :children, join_table: :ancestries, left_key: :parent_dependency_id, right_key: :child_dependency_id, class: self
+    many_to_many :parents, join_table: :ancestries, left_key: :child_dependency_id, right_key: :parent_dependency_id, class: self
+    many_to_many :bundler_groups
+
+    def self.destroy_obsolete(current_dependencies)
+      exclude(id: current_dependencies.map(&:id)).each(&:destroy)
+    end
+
+    def self.unapproved
+      all.reject(&:approved?)
+    end
+
+    def approve!
+      approval.state = true
+      approval.save
+    end
+
+    def approved?
+      (license && license.whitelisted?) || (approval && approval.state)
+    end
+
+    def set_license_manually(name)
+      license.set_manually(name)
+    end
+  end
+end
+

data/lib/license_finder/tables/license_alias.rb

@@ -0,0 +1,22 @@
+module LicenseFinder
+  class LicenseAlias < Sequel::Model
+    def initialize(*args)
+      super
+      self.url = LicenseUrl.find_by_name name
+    end
+
+    def whitelisted?
+      !!(config.whitelisted?(name))
+    end
+
+    def set_manually(name)
+      update('name' => name, 'manual' => true)
+    end
+
+    private
+
+    def config
+      LicenseFinder.config
+    end
+  end
+end

data/lib/license_finder/yml_to_sql.rb

@@ -0,0 +1,127 @@
+module LicenseFinder
+  class YmlToSql
+    def self.convert_if_required
+      if needs_conversion?
+        convert_all(load_yml)
+        remove_yml
+      end
+    end
+
+    def self.load_yml
+      YAML.load File.read(yml_path)
+    end
+
+    def self.convert_all(all_legacy_attrs)
+      converters = all_legacy_attrs.map do |attrs|
+        new(attrs)
+      end
+      converters.each(&:convert)
+      converters.each(&:associate_children)
+    end
+
+    def self.needs_conversion?
+      File.exists?(yml_path)
+    end
+
+    def self.remove_yml
+      File.delete(yml_path)
+    end
+
+    def self.yml_path
+      LicenseFinder.config.dependencies_yaml
+    end
+
+    def initialize(attrs)
+      @legacy_attrs = attrs
+    end
+
+    attr_reader :legacy_attrs
+
+    def convert
+      @dep = create_dependency
+      @dep.license = create_license
+      @dep.approval = create_approval
+      associate_bundler_groups
+      @dep.save
+    end
+
+    def associate_children
+      find_children.each do |child|
+        @dep.add_child(child)
+      end
+    end
+
+    def associate_bundler_groups
+      find_bundler_groups.each do |group|
+        @dep.add_bundler_group(group)
+      end
+    end
+
+    def create_dependency
+      Sql::Dependency.convert(legacy_attrs)
+    end
+
+    def create_license
+      Sql::LicenseAlias.convert(legacy_attrs)
+    end
+
+    def create_approval
+      Sql::Approval.convert(legacy_attrs)
+    end
+
+    def find_children
+      Sql::Dependency.where(name: legacy_attrs['children'])
+    end
+
+    def find_bundler_groups
+      (legacy_attrs['bundler_groups'] || []).map do |name|
+        Sql::BundlerGroup.find_or_create(name: name.to_s)
+      end
+    end
+
+    module Sql
+      module Convertable
+        def convert(attrs)
+          create remap_attrs(attrs)
+        end
+
+        def remap_attrs(legacy_attrs)
+          self::VALID_ATTRIBUTES.each_with_object({}) do |(legacy_key, new_key), new_attrs|
+            new_attrs[new_key] = legacy_attrs[legacy_key]
+          end
+        end
+      end
+
+      class Dependency < Sequel::Model
+        extend Convertable
+        VALID_ATTRIBUTES = Hash[*%w[name version summary description homepage].map { |k| [k, k] }.flatten]
+
+        many_to_one :license, class: LicenseAlias
+        many_to_one :approval
+        many_to_many :children, join_table: :ancestries, left_key: :parent_dependency_id, right_key: :child_dependency_id, class: self
+        many_to_many :bundler_groups
+      end
+
+      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
+
+        VALID_ATTRIBUTES = {
+          'approved' => 'state'
+        }
+      end
+    end
+  end
+end

data/lib/tasks/license_finder.rake

@@ -1,4 +1,7 @@
 desc 'Audit your Gemfile for software licenses. This is the same as running `license_finder` in the terminal.'
 task :license_finder do
+  puts "DEPRECATION WARNING: 'rake license_finder' is going to be removed 
+  for the 1.0.0 release. Please instead use the command line utility 'license_finder'
+  or refer to the README for avalible command line utilities"
   LicenseFinder::CLI.check_for_action_items
 end

data/lib/templates/html_report.erb

@@ -9,6 +9,9 @@
     .unapproved h2, .unapproved h2 a {
       color: red;
     }
+    .unapproved h2:after {
+      content: " (unapproved)"
+    }
   </style>
 </head>
 <body>
@@ -16,33 +19,51 @@
   <div class="summary hero-unit">
     <h1>Dependencies</h1>
 
+    <p>As of <%= Time.now.strftime("%B %e, %Y %l:%M%P") %></p>
+
     <h4>
       <%= dependencies.size %> total
 
-      <% if unapproved_dependencies.any? %>
+      <% if unapproved_dependencies.any? -%>
         <span class="badge badge-important"><%= unapproved_dependencies.size %> unapproved</span>
-      <% end %>
+      <% end -%>
     </h4>
 
     <ul>
-      <% grouped_dependencies.each do |license, group| %>
-        <li><%= group.size %> <%= license %></li>
-      <% end %>
+      <% grouped_dependencies.each do |license_name, group| -%>
+        <li><%= group.size %> <%= license_name %></li>
+      <% end -%>
     </ul>
   </div>
+  <% if unapproved_dependencies.any? -%>
+    <div class="action-items hero-unit">
+      <h1>Action Items</h1>
+      <h4><%= unapproved_dependencies.size %> unapproved dependencies</h4>
+      <ul>
+        <% unapproved_dependencies.each do |dependency| -%>
+          <li>
+          <a href='#<%= dependency.name %>'>
+            <%= dependency.name %>
+          </a>
+          (<%= dependency.license.name %>)
+          </li>
+        <% end -%>
+      </ul>
+    </div>
+  <% end -%>
   <div class="dependencies">
-    <% sorted_dependencies.each do |dependency| %>
-      <div id="<%= dependency.name %>" class="<%= dependency.approved ? "approved" : "unapproved" %>">
+    <% sorted_dependencies.each do |dependency| -%>
+      <div id="<%= dependency.name %>" class="<%= dependency.approved? ? "approved" : "unapproved" %>">
         <h2>
-          <% if dependency.homepage && !dependency.homepage.empty? %>
+          <% if dependency.homepage && !dependency.homepage.empty? -%>
             <a href="<%= dependency.homepage %>"><%= dependency.name %></a>
-          <% else %>
+          <% else -%>
             <%= dependency.name %>
-          <% end %>
+          <% end -%>
           v<%= dependency.version %>
-          <% if dependency.bundler_groups.any? %>
-            (<%= dependency.bundler_groups.join(", ") %>)
-          <% end %>
+          <% if dependency.bundler_groups.any? -%>
+            (<%= dependency.bundler_groups.map(&:name).join(", ") %>)
+          <% end -%>
         </h2>
         <table class="table table-striped table-bordered">
           <thead>
@@ -57,36 +78,33 @@
             <td><%= dependency.summary %></td>
             <td><%= dependency.description %></td>
             <td>
-              <% if dependency.license_url && !dependency.license_url.empty? %>
-                <a href="<%= dependency.license_url %>"><%= dependency.license %></a>
-              <% else %>
-                <%= dependency.license %>
-              <% end %>
-            </td>
+              <% if dependency.license.url && !dependency.license.url.empty? -%>
+                <a href="<%= dependency.license.url %>"><%= dependency.license.name %></a>
+              <% else -%>
+                <%= dependency.license.name %>
+              <% end -%>
             </td>
           </tr>
           </tbody>
         </table>
-
-        <% if dependency.parents.any? %>
+        <% if dependency.parents.any? -%>
           <dl>
             <dt>Parents</dt>
-            <% dependency.parents.each do |parent| %>
-              <dd><%= parent %></dd>
-            <% end %>
+            <% dependency.parents.each do |parent| -%>
+              <dd><%= parent.name %></dd>
+            <% end -%>
           </dl>
-        <% end %>
-
-        <% if dependency.children.any? %>
+        <% end -%>
+        <% if dependency.children.any? -%>
           <dl>
             <dt>Children</dt>
-            <% dependency.children.each do |child| %>
-              <dd><%= child %></dd>
-            <% end %>
+            <% dependency.children.each do |child| -%>
+              <dd><%= child.name %></dd>
+            <% end -%>
           </dl>
-        <% end %>
+        <% end -%>
       </div>
-    <% end %>
+    <% end -%>
   </div>
 </div>
 </body>

data/lib/templates/text_report.erb

@@ -1,2 +1,3 @@
-<% sorted_dependencies.each do |s| %><%=s.name %>, <%=s.version %>, <%=s.license%>
-<% end %>
+<% sorted_dependencies.each do |s| -%>
+<%=s.name %>, <%=s.version %>, <%=s.license.name%>
+<% end -%>

data/license_finder.gemspec

@@ -1,7 +1,9 @@
+require './lib/license_finder/platform'
+
 Gem::Specification.new do |s|
   s.name        = "license_finder"
-  s.version     = "0.7.3"
-  s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers"]
+  s.version     = "0.8.0"
+  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"
   s.summary     = "Audit the OSS licenses of your application's dependencies."
@@ -9,19 +11,26 @@ Gem::Specification.new do |s|
   s.description = <<-DESCRIPTION
   Do you know the licenses of all your application's dependencies? What open source software licenses will your business accept?
 
-  LicenseFinder culls your Gemfile, detects the licenses of the gems in it, and gives you a report that you can act on. If you already know 
-  what licenses your business is comfortable with, you can whitelist them, leaving you with an action report of only those dependencies that have 
+  LicenseFinder culls your Gemfile, detects the licenses of the gems in it, and gives you a report that you can act on. If you already know
+  what licenses your business is comfortable with, you can whitelist them, leaving you with an action report of only those dependencies that have
   licenses that fall outside of the whitelist.
   DESCRIPTION
 
   s.license     = "MIT"
 
   s.add_dependency "bundler"
-  %w(rspec rake cucumber rails pry xpath capybara).each do |gem|
+  s.add_dependency "sequel"
+  s.add_dependency LicenseFinder::Platform.sqlite_gem
+
+  %w(rspec rake xpath capybara cucumber database_cleaner).each do |gem|
     s.add_development_dependency gem
   end
 
+  s.add_development_dependency "rails", "~> 3.2.0"
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.platform = "java" if LicenseFinder::Platform.java?
 end