license_finder 0.6.0 → 0.7.0

data/lib/license_finder/dependency_report.rb

@@ -0,0 +1,30 @@
+module LicenseFinder
+  class DependencyReport
+    def self.underscored_name
+      @underscored_name ||= begin
+        str = name.dup
+        str.sub!(/.*::/, '')
+        str.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+        str.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        str.downcase!
+      end
+    end
+
+    def initialize(dependencies=[])
+      @dependencies = Array dependencies
+    end
+
+    def to_s
+      filename = File.join(File.dirname(__FILE__), '..', 'templates', "#{self.class.underscored_name}.erb")
+      template = ERB.new(File.read(filename))
+      template.result(binding)
+    end
+
+    private
+    attr_reader :dependencies
+
+    def sorted_dependencies
+      dependencies.sort_by(&:name)
+    end
+  end
+end

data/lib/license_finder/html_report.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+module LicenseFinder
+  class HtmlReport < DependencyReport
+    private
+    def unapproved_dependencies
+      dependencies.reject(&:approved)
+    end
+
+    def grouped_dependencies
+      dependencies.group_by(&:license).sort_by { |_, group| group.size }.reverse
+    end
+  end
+end

data/lib/license_finder/persistence.rb

@@ -0,0 +1 @@
+

data/lib/license_finder/persistence/yaml.rb

@@ -0,0 +1,7 @@
+module LicenseFinder
+  module Persistence
+    autoload :Dependency, 'license_finder/persistence/yaml/dependency'
+    autoload :Configuration, 'license_finder/persistence/yaml/configuration'
+  end
+end
+

data/lib/license_finder/persistence/yaml/configuration.rb

@@ -0,0 +1,34 @@
+module LicenseFinder
+  module Persistence
+    class Configuration
+      attr_reader :whitelist, :ignore_groups, :dependencies_dir
+
+      def initialize(config={})
+        if File.exists?(config_file_path)
+          yaml = File.read(config_file_path)
+          config = YAML.load(yaml).merge config
+        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
+end

data/lib/license_finder/persistence/yaml/dependency.rb

@@ -0,0 +1,127 @@
+module LicenseFinder
+  module Persistence
+    class Dependency
+      class Database
+        def initialize
+          @dependency_attributes = YAML.load File.read(LicenseFinder.config.dependencies_yaml) if File.exists?(LicenseFinder.config.dependencies_yaml)
+        end
+
+        def find(&block)
+          dependency_attributes.detect &block
+        end
+
+        def update(dependency_hash)
+          destroy_by_name_without_saving dependency_hash['name']
+          dependency_attributes << dependency_hash
+          persist!
+        end
+
+        def delete_all
+          File.delete(LicenseFinder.config.dependencies_yaml) if File.exists?(LicenseFinder.config.dependencies_yaml)
+          @dependency_attributes = nil
+        end
+
+        def destroy_by_name(name)
+          destroy_by_name_without_saving name
+          persist!
+        end
+
+        def persist!
+          File.open(LicenseFinder.config.dependencies_yaml, 'w+') do |f|
+            f.write dependency_attributes.to_yaml
+          end
+        end
+
+        def all
+          dependency_attributes
+        end
+
+        private
+        def destroy_by_name_without_saving(name)
+          dependency_attributes.reject! { |a| a['name'] == name }
+        end
+
+        def dependency_attributes
+          @dependency_attributes ||= []
+        end
+      end
+
+      attr_accessor *LicenseFinder::DEPENDENCY_ATTRIBUTES
+
+      class << self
+        def find_by_name(name)
+          attributes = database.find { |a| a['name'] == name }
+          new(attributes) if attributes
+        end
+
+        def delete_all
+          database.delete_all
+        end
+
+        def all
+          database.all.map { |attributes| new(attributes) }
+        end
+
+        def unapproved
+          all.select {|d| d.approved == false }
+        end
+
+        def update(attributes)
+          database.update attributes
+        end
+
+        def destroy_by_name(name)
+          database.destroy_by_name name
+        end
+
+        private
+        def database
+          @database ||= Database.new
+        end
+      end
+
+      def initialize(attributes = {})
+        update_attributes_without_saving attributes
+      end
+
+      def config
+        LicenseFinder.config
+      end
+
+      def update_attributes new_values
+        update_attributes_without_saving(new_values)
+        save
+      end
+
+      def approved?
+        !!approved
+      end
+
+      def save
+        self.class.update(attributes)
+      end
+
+      def destroy
+        self.class.destroy_by_name(name)
+      end
+
+      def attributes
+        attributes = {}
+
+        LicenseFinder::DEPENDENCY_ATTRIBUTES.each do |attrib|
+          attributes[attrib] = send attrib
+        end
+
+        attributes
+      end
+
+      private
+      def update_attributes_without_saving(new_values)
+        new_values.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+    end
+  end
+end
+

data/lib/license_finder/reporter.rb

@@ -1,51 +1,20 @@
 module LicenseFinder
-  class Reporter
-    def self.create_default_configuration
-      unless File.exists?(LicenseFinder.config.config_file_path)
-        FileUtils.mkdir_p(File.join('.', 'config'))
-        FileUtils.cp(
-          File.join(File.dirname(__FILE__), '..', '..', 'files', 'license_finder.yml'),
-          LicenseFinder.config.config_file_path
-        )
-      end
-    end
+  module Reporter
+    extend self
 
-    def initialize
-      self.class.create_default_configuration
-      @dependency_list = generate_list
-      save_reports
-    end
+    def write_reports
+      dependencies = Dependency.all
 
-    def action_items
-      dependency_list.action_items
+      write_file LicenseFinder.config.dependencies_text, TextReport.new(dependencies).to_s
+      write_file LicenseFinder.config.dependencies_html, HtmlReport.new(dependencies).to_s
     end
 
     private
-
-    attr_reader :dependency_list
-
-    def save_reports
-      write_file LicenseFinder.config.dependencies_yaml, dependency_list.to_yaml
-      write_file LicenseFinder.config.dependencies_text, dependency_list.to_s
-      write_file LicenseFinder.config.dependencies_html, dependency_list.to_html
-    end
-
     def write_file(file_path, content)
       File.open(file_path, 'w+') do |f|
         f.puts content
       end
     end
-
-    def generate_list
-      bundler_list = DependencyList.from_bundler
-
-      if File.exists?(LicenseFinder.config.dependencies_yaml)
-        yml = File.open(LicenseFinder.config.dependencies_yaml).readlines.join
-        existing_list = DependencyList.from_yaml(yml)
-        existing_list.merge(bundler_list)
-      else
-        bundler_list
-      end
-    end
   end
 end
+

data/lib/license_finder/source_syncer.rb

@@ -0,0 +1,40 @@
+module LicenseFinder
+  class SourceSyncer
+    def initialize(source_dependencies, dependencies)
+      @source_dependencies = Array source_dependencies
+      @dependencies = dependencies
+    end
+
+    def sync!
+      destroy_obsolete_dependencies
+      update_existing_dependencies
+      create_new_dependencies
+      dependencies
+    end
+
+    protected
+    attr_accessor :dependencies, :source_dependencies
+
+    def destroy_obsolete_dependencies
+      obsolete_dependencies = dependencies.select {|d| !source_dependencies.detect {|s| s.name == d.name }}
+      obsolete_dependencies.map &:destroy
+      
+      self.dependencies -= obsolete_dependencies
+    end
+
+    def update_existing_dependencies
+      dependencies.each do |d|
+        source_dep = source_dependencies.detect { |s| s.name == d.name }
+        d.merge(source_dep)
+        self.source_dependencies -= [source_dep]
+      end
+    end
+
+    def create_new_dependencies
+      source_dependencies.each do |d|
+        dependencies << d
+        d.save
+      end
+    end
+  end
+end

data/lib/license_finder/text_report.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module LicenseFinder
+  class TextReport < DependencyReport
+    def to_s
+      super.strip
+    end
+  end
+end

data/lib/templates/dependency.html.erb

@@ -38,7 +38,7 @@
     <dl>
       <dt>Parents</dt>
       <% parents.each do |parent| %>
-        <dd><%= parent.name %></dd>
+        <dd><%= parent %></dd>
       <% end %>
     </dl>
   <% end %>
@@ -47,7 +47,7 @@
     <dl>
       <dt>Children</dt>
       <% children.each do |child| %>
-        <dd><%= child.name %></dd>
+        <dd><%= child %></dd>
       <% end %>
     </dl>
   <% end %>

data/lib/templates/html_report.erb

@@ -0,0 +1,93 @@
+<html>
+<head>
+  <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.1.1/css/bootstrap.min.css" rel="stylesheet">
+  <style type="text/css">
+    body {
+      margin: 50px;
+    }
+
+    .unapproved h2, .unapproved h2 a {
+      color: red;
+    }
+  </style>
+</head>
+<body>
+<div class="container">
+  <div class="summary hero-unit">
+    <h1>Dependencies</h1>
+
+    <h4>
+      <%= dependencies.size %> total
+
+      <% if unapproved_dependencies.any? %>
+        <span class="badge badge-important"><%= unapproved_dependencies.size %> unapproved</span>
+      <% end %>
+    </h4>
+
+    <ul>
+      <% grouped_dependencies.each do |license, group| %>
+        <li><%= group.size %> <%= license %></li>
+      <% end %>
+    </ul>
+  </div>
+  <div class="dependencies">
+    <% sorted_dependencies.each do |dependency| %>
+      <div id="<%= dependency.name %>" class="<%= dependency.approved ? "approved" : "unapproved" %>">
+        <h2>
+          <% if dependency.homepage && !dependency.homepage.empty? %>
+            <a href="<%= dependency.homepage %>"><%= dependency.name %></a>
+          <% else %>
+            <%= dependency.name %>
+          <% end %>
+          v<%= dependency.version %>
+          <% if dependency.bundler_groups.any? %>
+            (<%= dependency.bundler_groups.join(", ") %>)
+          <% end %>
+        </h2>
+        <table class="table table-striped table-bordered">
+          <thead>
+          <tr>
+            <th>Summary</th>
+            <th>Description</th>
+            <th>License</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <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>
+            </td>
+          </tr>
+          </tbody>
+        </table>
+
+        <% if dependency.parents.any? %>
+          <dl>
+            <dt>Parents</dt>
+            <% dependency.parents.each do |parent| %>
+              <dd><%= parent %></dd>
+            <% end %>
+          </dl>
+        <% end %>
+
+        <% if dependency.children.any? %>
+          <dl>
+            <dt>Children</dt>
+            <% dependency.children.each do |child| %>
+              <dd><%= child %></dd>
+            <% end %>
+          </dl>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+</div>
+</body>
+</html>

data/lib/templates/text_report.erb

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