sequel-schema-dot-generator 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dc716c3f182abf30384a4b32318559291b40415
+  data.tar.gz: f6ddc030b24cc70467aec4957ae63b0362b5f729
+SHA512:
+  metadata.gz: ec1c08f6477d03ae2852a0ee338064c5070c889a987ef563b79d94c24302965ec658ec564d4a6a502cd97ad0440ca7b112e11e0fd333922655b51270c20744e6
+  data.tar.gz: c42c2b2c1b32000e02ff740a1471e24d34735501cddd546a1945588026ced2522b80af54f0e468b9def1216d47461fa3ab0c77ade28e90601a35c8ef414ad12b

data/.ruby-gemset

@@ -0,0 +1 @@
+sequel-schema-dot-generator

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sequel-schema-dot-generator.gemspec
 gemspec

data/README.md

@@ -2,6 +2,8 @@
 
 Sequel database structure Dot language generator
 
+[![Gem Version](https://badge.fury.io/rb/sequel-schema-dot-generator.png)](http://badge.fury.io/rb/sequel-schema-dot-generator)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,8 +29,6 @@ Or install it yourself as:
 
     puts dot_db.generate
 
-    =>
-
 ## Contributing
 
 1. Fork it
@@ -39,7 +39,17 @@ Or install it yourself as:
 
 ## Changelog
 
+### 0.0.4
+- Module structure flattened
+- Dir structure flattened
+- active_support -> activesupport, smaller adjustments
+- Transition to Ruby 2.0 and .ruby-version files for gem development
+
+### 0.0.3
+- Associations detection from model (`params[:schema_source_type] = :model`)
+- New homepage
+
 ### 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
+- columns has written types in diagram

data/lib/sequel_schema_dot_generator.rb

@@ -0,0 +1,113 @@
+require 'sequel_schema_dot_generator/version'
+require 'sequel_schema_dot_generator/schema_source_types/base'
+require 'sequel_schema_dot_generator/schema_source_types/column'
+require 'sequel_schema_dot_generator/schema_source_types/model'
+require 'erb'
+require 'logger'
+require 'sequel'
+require 'active_support/inflector'
+
+# Module for generating Sequel schema structure into Dot language format
+module SequelSchemaDotGenerator
+  class Generator
+    @db     = nil
+    @dot_template_path    = nil
+    @logger = nil
+    @colored_associations = nil
+
+    # @todo Consider write the params as block
+    #
+    # @param [Hash] params Setup of Generator instance
+    #   :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)
+    #   :schema_source_type   [Symbol]            optional How will be data acquired (:column|:model)
+    #
+    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__),
+                                                                        'sequel_schema_dot_generator/diagram.dot.erb')
+      @colored_associations = params[:colored_associations]
+      initialize_ss params[:schema_source_type]
+    end
+
+    def initialize_ss type
+      sst_params = @db, @db.tables
+
+      if type == :model
+        @schema_source = SchemaSourceType::Model.new *sst_params
+      end
+
+      # Column Source as fallback
+      @schema_source ||= SchemaSourceType::Column.new *sst_params
+    end
+
+    # @return [String] Content which can be passed to dot parsing tool
+    def generate
+      tables    = []
+
+      @db.tables.each do |table_name|
+        next if table_name == :schema_info
+        tables << [table_name, @db.schema(table_name)]
+      end
+
+      relations = @schema_source.relations
+
+      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  [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
+        raise 'Database connection is supposed to be Sequel::Database. %s given'%params[:database_connection].class.name
+      end
+      unless  params[:dot_template_path].nil? || params[:dot_template_path].is_a?(String) || File.exist?(params[:dot_template_path])
+        raise 'Template path is supposed to be string with an existing file. %s given'%params[:dot_template_path].inspect
+      end
+      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/schema_source_types/base.rb

@@ -0,0 +1,23 @@
+module SequelSchemaDotGenerator
+  module SchemaSourceType
+    class Base
+      # Initialize Schema Source Type
+      #
+      # Tables could be retrieved from db connection, but there is plan to provide
+      # control over what tables will be in output structure
+      #
+      # @param [Sequel::Database] db     for which should be acquired data
+      # @param [Array]            tables for which should be acquired data
+      def initialize db, tables
+        @tables = tables
+        @db = db
+      end
+
+      # @return [Array] associations for tables given to constructor
+      #   Each item is array of [<foreign_table>, <id>, <table_name>, <foreign_column>]
+      def relations
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/sequel_schema_dot_generator/schema_source_types/column.rb

@@ -0,0 +1,34 @@
+module SequelSchemaDotGenerator
+  module SchemaSourceType
+    class Column < SchemaSourceType::Base
+      def relations
+        relations = []
+
+        @tables.each do |table_name|
+          @db[table_name].columns.select{|cn|cn=~/_id$/}.each do |column_name|
+            foreign_column = column_name.to_s
+            foreign_table = existing_table_name foreign_column.gsub(/_id$/, '')
+            relations << [foreign_table, 'id', table_name, foreign_column]
+          end
+        end
+
+        relations
+      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
+    end
+  end
+end

data/lib/sequel_schema_dot_generator/schema_source_types/model.rb

@@ -0,0 +1,30 @@
+module SequelSchemaDotGenerator
+  module SchemaSourceType
+    class Model < SchemaSourceType::Base
+      def relations
+        relations = {}
+
+        @tables.collect do |table_name|
+          model = table_name.to_s.singularize.classify.constantize
+          model.associations.each do |assoc|
+            assoc_info = model.association_reflection(assoc)
+
+            right_key = assoc_info[:join_table].to_s+assoc_info[:right_key].to_s
+            left_key = assoc_info[:join_table].to_s+assoc_info[:left_key].to_s
+
+            if assoc_info[:type] == :many_to_many
+              relations[right_key] = [assoc_info[:join_table].to_s, assoc_info[:right_key], assoc_info[:class_name].constantize.implicit_table_name, assoc_info[:class_name].constantize.primary_key]
+              relations[left_key] = [assoc_info[:join_table].to_s, assoc_info[:left_key],  assoc_info[:model].implicit_table_name, assoc_info[:model].primary_key]
+            else
+              # one_to_many
+              table_name = assoc_info[:model].implicit_table_name.to_s
+              table_key = assoc_info[:key].to_s
+              relations[right_key] = [table_name, table_key, assoc_info[:class_name].constantize.implicit_table_name, assoc_info[:class_name].constantize.primary_key]
+            end
+          end
+        end
+        relations.values
+      end
+    end
+  end
+end

data/lib/sequel_schema_dot_generator/version.rb

@@ -0,0 +1,3 @@
+module SequelSchemaDotGenerator
+  VERSION = '0.0.4'
+end

data/sequel-schema-dot-generator.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require File.expand_path 'lib/sequel/schema/dot/generator'
+require File.expand_path 'lib/sequel_schema_dot_generator/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'sequel-schema-dot-generator'
-  spec.version       = Sequel::Schema::Dot::Generator::VERSION
+  spec.version       = SequelSchemaDotGenerator::VERSION
   spec.authors       = ['Mailo Svetel']
   spec.email         = %w(development@rooland.cz)
   spec.description   = %q{This gem makes it easier to generate database schema overview image}
@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
 
   spec.add_dependency 'sequel'
-  spec.add_dependency 'active_support'
+  spec.add_dependency 'activesupport'
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sequel-schema-dot-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Mailo Svetel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,49 +27,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sequel
   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'
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: activesupport
   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
@@ -83,47 +74,41 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/sequel/schema/dot/generator.rb
-- lib/sequel/schema/dot/generator/diagram.dot.erb
-- lib/sequel/schema/dot/generator/schema_source_types/base.rb
-- lib/sequel/schema/dot/generator/schema_source_types/column.rb
-- lib/sequel/schema/dot/generator/schema_source_types/model.rb
-- lib/sequel/schema/dot/generator/version.rb
+- lib/sequel_schema_dot_generator.rb
+- lib/sequel_schema_dot_generator/diagram.dot.erb
+- lib/sequel_schema_dot_generator/schema_source_types/base.rb
+- lib/sequel_schema_dot_generator/schema_source_types/column.rb
+- lib/sequel_schema_dot_generator/schema_source_types/model.rb
+- lib/sequel_schema_dot_generator/version.rb
 - sequel-schema-dot-generator.gemspec
 homepage: http://www.rooland.cz/sequel-schema-dot-generator-gem
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3800259323698899955
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3800259323698899955
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Dot language format generator for Sequel schema structure
 test_files: []

data/.rvmrc

@@ -1,34 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p385@sequel-dot-generator"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.18.8 (stable)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi

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

@@ -1,118 +0,0 @@
-require 'sequel/schema/dot/generator/version'
-require 'sequel/schema/dot/generator/schema_source_types/base'
-require 'sequel/schema/dot/generator/schema_source_types/column'
-require 'sequel/schema/dot/generator/schema_source_types/model'
-require 'erb'
-require 'logger'
-require 'sequel'
-require 'active_support/inflector'
-
-module Sequel
-  module Schema
-    module Dot
-      # Module for generating Sequel schema structure into Dot language format
-      module Generator
-        class Generator
-          @db     = nil
-          @dot_template_path    = nil
-          @logger = nil
-          @colored_associations = nil
-
-          # @todo Consider write the params as block
-          #
-          # @param [Hash] params Setup of Generator instance
-          #   :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)
-          #   :schema_source_type   [Symbol]            optional How will be data acquired (:column|:model)
-          #
-          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')
-            @colored_associations = params[:colored_associations]
-            initialize_ss params[:schema_source_type]
-          end
-
-          def initialize_ss type
-            sst_params = @db, @db.tables
-
-            if type == :model
-              @schema_source = SchemaSourceType::Model.new *sst_params
-            end
-
-            # Column Source as fallback
-            @schema_source ||= SchemaSourceType::Column.new *sst_params
-          end
-
-          # @return [String] Content which can be passed to dot parsing tool
-          def generate
-            tables    = []
-
-            @db.tables.each do |table_name|
-              next if table_name == :schema_info
-              tables << [table_name, @db.schema(table_name)]
-            end
-
-            relations = @schema_source.relations
-
-            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  [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
-              raise 'Database connection is supposed to be Sequel::Database. %s given'%params[:database_connection].class.name
-            end
-            unless  params[:dot_template_path].nil? || params[:dot_template_path].is_a?(String) || File.exist?(params[:dot_template_path])
-              raise 'Template path is supposed to be string with an existing file. %s given'%params[:dot_template_path].inspect
-            end
-            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
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-module Sequel
-  module Schema
-    module Dot
-      module Generator
-        module SchemaSourceType
-          class Base
-            # Initialize Schema Source Type
-            #
-            # Tables could be retrieved from db connection, but there is plan to provide
-            # control over what tables will be in output structure
-            #
-            # @param [Sequel::Database] db     for which should be acquired data
-            # @param [Array]            tables for which should be acquired data
-            def initialize db, tables
-              @tables = tables
-              @db = db
-            end
-
-            # @return [Array] associations for tables given to constructor
-            #   Each item is array of [<foreign_table>, <id>, <table_name>, <foreign_column>]
-            def relations
-              raise NotImplementedError
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-module Sequel
-  module Schema
-    module Dot
-      module Generator
-        module SchemaSourceType
-          class Column < SchemaSourceType::Base
-            def relations
-              relations = []
-
-              @tables.each do |table_name|
-                @db[table_name].columns.select{|cn|cn=~/_id$/}.each do |column_name|
-                  foreign_column = column_name.to_s
-                  foreign_table = existing_table_name foreign_column.gsub(/_id$/, '')
-                  relations << [foreign_table, 'id', table_name, foreign_column]
-                end
-              end
-
-              relations
-            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
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-module Sequel
-  module Schema
-    module Dot
-      module Generator
-        module SchemaSourceType
-          class Model < SchemaSourceType::Base
-            def relations
-              relations = {}
-
-              @tables.collect do |table_name|
-                model = table_name.to_s.singularize.classify.constantize
-                model.associations.each do |assoc|
-                  assoc_info = model.association_reflection(assoc)
-
-                  right_key = assoc_info[:join_table].to_s+assoc_info[:right_key].to_s
-                  left_key = assoc_info[:join_table].to_s+assoc_info[:left_key].to_s
-
-                  if assoc_info[:type] == :many_to_many
-                    relations[right_key] = [assoc_info[:join_table].to_s, assoc_info[:right_key], assoc_info[:class_name].constantize.implicit_table_name, assoc_info[:class_name].constantize.primary_key]
-                    relations[left_key] = [assoc_info[:join_table].to_s, assoc_info[:left_key],  assoc_info[:model].implicit_table_name, assoc_info[:model].primary_key]
-                  else
-                    # one_to_many
-                    table_name = assoc_info[:model].implicit_table_name.to_s
-                    table_key = assoc_info[:key].to_s
-                    relations[right_key] = [table_name, table_key, assoc_info[:class_name].constantize.implicit_table_name, assoc_info[:class_name].constantize.primary_key]
-                  end
-                end
-              end
-              relations.values
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Sequel
-  module Schema
-    module Dot
-      module Generator
-        VERSION = '0.0.3'
-      end
-    end
-  end
-end