sequel-schema-dot-generator 0.0.1 → 0.0.2

data/README.md

@@ -36,3 +36,10 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Changelog
+
+### 0.0.2
+- optional colored association edges to distinguish them in big intersections (`params[:colored_associations]`)
+- multiple foreign table support
+- columns has written types in diagram

data/lib/sequel/schema/dot/generator.rb

@@ -2,6 +2,7 @@ require 'sequel/schema/dot/generator/version'
 require 'erb'
 require 'logger'
 require 'sequel'
+require 'active_support/inflector'
 
 module Sequel
   module Schema
@@ -9,9 +10,10 @@ module Sequel
       # Module for generating Sequel schema structure into Dot language format
       module Generator
         class Generator
-          @db = nil
-          @dot_template_path = nil
+          @db     = nil
+          @dot_template_path    = nil
           @logger = nil
+          @colored_associations = nil
 
           # @todo Consider write the params as block
           #
@@ -19,39 +21,85 @@ module Sequel
           #   :db                   [Sequel::Database]  required From this one will be generated the diagram
           #   :logger               [Logger]            optional Will be used for logging
           #   :dot_template_path    [String]            optional Template is supposed to be ERB template. Will be used as template for resulting Dot file
+          #   :colored_associations [Boolean]           optional Whether lines representing associations will be draw in color (=False)
           #
           def initialize params
             check_params params
 
             @db     = params[:db]
             @logger = params[:logger] || Logger.new(STDERR)
-            @dot_template_path = params[:dot_template_path] || File.join(File.dirname(__FILE__), 'generator/diagram.dot.erb')
+            @dot_template_path    = params[:dot_template_path] || File.join(File.dirname(__FILE__), 'generator/diagram.dot.erb')
+            @colored_associations = params[:colored_associations]
           end
 
           # @return [String] Content which can be passed to dot parsing tool
           def generate
             relations = []
             tables    = []
-  
+
             @db.tables.each do |table_name|
               next if table_name == :schema_info
-              tables << [table_name, @db[table_name]]
+              tables << [table_name, @db.schema(table_name)]
 
               # foreign keys by <table>_id name format
               # @todo Read it from model
-              @db[table_name].columns.each do |column_name|
-                next unless column_name =~ /_id$/
+              @db[table_name].columns.select{|cn|cn=~/_id$/}.each do |column_name|
                 foreign_column = column_name.to_s
-                foreign_table = foreign_column.gsub(/_id$/, '')
+                foreign_table = existing_table_name foreign_column.gsub(/_id$/, '')
                 relations << [foreign_table, 'id', table_name, foreign_column]
               end
             end
 
+            if @colored_associations
+              edge_colors = random_color_set relations.count
+            else
+              edge_colors = Array.new relations.count, '000000'
+            end
+
             ERB.new( File.read(@dot_template_path),nil,'>' ).result(binding)
           end
 
           private
 
+          # @param  [String] name
+          #
+          # @return [String] form of name param in which it is name of existing table
+          def existing_table_name name
+            tables = @db.tables.map(&:to_s)
+            table_name = name if tables.include? name
+            table_name ||= name.pluralize if tables.include? name.pluralize
+            table_name ||= name.singularize if tables.include? name.singularize
+            table_name ||= 'association_table_not_found'
+
+            table_name
+          end
+
+          # @param  [Integer] number of colors we want to generate
+          #
+          # @return [Array]   of random and unique colors
+          def random_color_set number
+            raise 'Number of colors must be greater than 0' if number < 1
+            colors = []
+            (1..number).each do
+              colors << random_unique_hex_color(colors)
+            end
+
+            colors
+          end
+
+
+          # @param [Array] existing colors which should be avoided
+          #
+          # @return [String] Random color which is not presented in existing param
+          def random_unique_hex_color existing
+            color = '%06x' % (rand * 0xffffff)
+            if existing.include?(color)
+              random_unique_hex_color existing
+            else
+              color
+            end
+          end
+
           # Checks if all parameters for new Object are alright
           def check_params params
             unless  params[:db].is_a?Sequel::Database
@@ -63,6 +111,9 @@ module Sequel
             unless  params[:logger].nil? || params[:logger].is_a?(Logger)
               raise 'Logger is supposed to be... Logger, know. %s given'%params[:logger].inspect
             end
+            unless  params[:colored_associations].nil? || !!params[:colored_associations] == params[:colored_associations]
+              raise 'Colored association is supposed to be boolean. %s given'%params[:colored_associations].inspect
+            end
           end
         end
       end

data/lib/sequel/schema/dot/generator/diagram.dot.erb

@@ -1,18 +1,18 @@
 digraph G {
   node [shape=none,fontname="DejaVu Sans"];
-  <% tables.each do |table_name, table| %>
+  <% tables.each do |table_name, table_schema| %>
     <%= table_name %> [label=<
       <table border="0" cellborder="1" cellspacing="0" cellpadding="4">
         <tr><td bgcolor="lightgrey" PORT="users"><b><%= table_name %></b></td></tr>
-        <% table.columns.each do |column_name| %>
-        <tr><td PORT="<%= column_name %>"><%= column_name %></td></tr>
+        <% table_schema.each do |column_name, column_schema| %>
+        <tr><td PORT="<%= column_name %>"><%= column_name %><font color="gray">(<%= column_schema[:type] %>)</font></td></tr>
         <% end %>
       </table>
     >]
   <% end %>
 
-  <% relations.each do |from_tab, from_col, to_tab, to_col| %>
-    <%= '"%s":"%s" -> "%s":"%s"'%[from_tab, from_col, to_tab, to_col] %>
+  <% relations.each_with_index do |(from_tab, from_col, to_tab, to_col), index| %>
+    <%= '"%s":"%s" -> "%s":"%s" [color="#%s"];'%[from_tab, from_col, to_tab, to_col, edge_colors[index]] %>
 
   <% end %>
 }

data/lib/sequel/schema/dot/generator/version.rb

@@ -2,7 +2,7 @@ module Sequel
   module Schema
     module Dot
       module Generator
-        VERSION = '0.0.1'
+        VERSION = '0.0.2'
       end
     end
   end

data/sequel-schema-dot-generator.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
 
   spec.add_dependency 'sequel'
+  spec.add_dependency 'active_support'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-schema-dot-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem makes it easier to generate database schema overview image
 email:
 - development@rooland.cz
@@ -91,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2048490745226108490
+      hash: -3561675813469084963
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2048490745226108490
+      hash: -3561675813469084963
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25