sequel-schema-dot-generator 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,34 @@
+#!/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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mailo Svetel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Sequel::Schema::Dot::Generator
+
+Sequel database structure Dot language generator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel-schema-dot-generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-schema-dot-generator
+
+## Usage
+
+    require 'sequel/schema/dot/generator'
+
+    dot_db = Sequel::Schema::Dot::Generator::Generator
+      .new({  db:     DB
+           }
+      )
+
+    puts dot_db.generate
+
+    =>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

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

@@ -0,0 +1,71 @@
+require 'sequel/schema/dot/generator/version'
+require 'erb'
+require 'logger'
+require 'sequel'
+
+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
+
+          # @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
+          #
+          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')
+          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]]
+
+              # 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$/
+                foreign_column = column_name.to_s
+                foreign_table = foreign_column.gsub(/_id$/, '')
+                relations << [foreign_table, 'id', table_name, foreign_column]
+              end
+            end
+
+            ERB.new( File.read(@dot_template_path),nil,'>' ).result(binding)
+          end
+
+          private
+
+          # 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+digraph G {
+  node [shape=none,fontname="DejaVu Sans"];
+  <% tables.each do |table_name, table| %>
+    <%= 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>
+        <% 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] %>
+
+  <% end %>
+}

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

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

data/sequel-schema-dot-generator.gemspec

@@ -0,0 +1,25 @@
+# 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'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel-schema-dot-generator'
+  spec.version       = Sequel::Schema::Dot::Generator::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}
+  spec.summary       = %q{Dot language format generator for Sequel schema structure}
+  spec.homepage      = 'https://github.com/roolo/sequel-schema-dot-generator-gem'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'sequel'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: sequel-schema-dot-generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mailo Svetel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: This gem makes it easier to generate database schema overview image
+email:
+- development@rooland.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- 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/version.rb
+- sequel-schema-dot-generator.gemspec
+homepage: https://github.com/roolo/sequel-schema-dot-generator-gem
+licenses:
+- MIT
+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: 2048490745226108490
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2048490745226108490
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Dot language format generator for Sequel schema structure
+test_files: []