ymldot 0.0.1

data/README

@@ -0,0 +1,102 @@
+= ymldot
+
+== Description
+
+ Can describe ERD in a form of ".yml".
+ ERD method use IDEF1X.
+ ".yml" file to ".dot" file. ".dot" is a language used in "graphviz".
+
+== Installation
+(1) if not install graphviz, type following.
+*  $ apt-get install graphviz
+(2) get ymldot.
+*  $ gem install ymldot
+
+== Option
+please see ymldot --help
+
+== Yml format
+
+* config
+  * font
+    * Please set the font name that You want to use.
+* tables
+  * name
+    * table name
+  * columns
+    * enumerate column names
+  * foreginkeys
+    * has_many
+    * has_one
+    * has_many_and_belongs_to
+      * same meaning the relation of ActiveRecord.
+      * enumerate ref table name.
+    * polymorphic
+      * name
+      * type
+      * tables
+        * target table name.
+
+* category
+   * label
+     * category name set. and set frame.
+   * table
+     * nested table.
+
+== Sample
+* in file. "sample/sample.yml"
+
+  tables:
+    - name: customer
+      columns:
+        - name
+        - phone_number
+      foreignkeys:
+        has_many:
+           - order
+    - name:  order
+      columns:
+        - order_num
+    - name:  product
+      columns:
+        - name
+        - amount
+        - tax
+        - product_div
+      foreignkeys:
+        has_many:
+           - order
+    - name:  category
+      columns:
+        - name
+      foreignkeys:
+        has_many:
+           - product
+
+* output dot file. "sample/sample.dot"
+
+  digraph sample {
+    graph[overlap=false, splines=true]
+  
+    "category" [shape=record, label="{category|name\l}"]
+    "customer" [shape=record, label="{customer|name\lphone_number\l}"]
+    "order" [shape=record, label="{order|customerID(FK)\lproductID(FK)\lorder_num\l}"]
+    "product" [shape=record, label="{product|categoryID(FK)\lname\lamount\ltax\lproduct_div\l}"]
+  
+    "category" -> "product" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+    "customer" -> "order" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+    "product" -> "order" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+  
+  }
+
+* please type
+ $ dot -Tpng sample.dot -o sample.png
+
+== Copyright
+
+* Author::    nari <authorNari@gmail.com>
+* Copyright:: Copyright (c) 2008 nari
+* License::   Ruby's
+
+== Link
+* ((<ymldot-project|URL:http://rubyforge.org/projects/ymldot>))

data/bin/ymldot

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -wKU
+
+if File.symlink?(__FILE__)
+  $: << File.join(File.dirname(File.readlink(__FILE__)), '../lib')
+else
+  $: << File.join(File.dirname(__FILE__), '../lib')
+end
+
+require 'ymldot'
+require 'optparse'
+
+Version = "0.0.1"
+is_output = false
+opt = OptionParser.new
+opt.version = Version
+opt.release = "0.0.1"
+opt.on('-o', 'output file to current directory. name is "#{input_filename}.dot"') {|v| is_output = true }
+opt.parse!(ARGV)
+
+if is_output
+  y = Ymldot.new(ARGV[0])
+  open("./#{y.file_name}.dot", "w") do |f|
+    f.write(y.dot_generate)
+  end
+else
+  puts Ymldot.new(ARGV[0]).dot_generate
+end

data/lib/ymldot.rb

@@ -0,0 +1,187 @@
+require 'yaml'
+require 'pp'
+
+class Entity
+  def initialize(name, dependent, columns = [])
+    @name = name
+    @dependent = dependent
+    @columns = columns
+    @foreignkeys = []
+  end
+
+  def dependent?
+    @dependent
+  end
+
+  def to_dot
+    res = ""
+    res << %Q!"#{@name}" [#{@dependent? 'shape=Mrecord, ' : 'shape=record, '}label=\"{#{@name}|!
+    @foreignkeys.each{|f| res << "#{f}\\l"}
+    @columns.each{|c| res << "#{c}\\l"}
+    res << '}"]'
+  end
+
+  attr_accessor :name, :dependent, :columns, :foreignkeys
+end
+
+class Tables
+  def initialize(table_node, label=nil, category=false)
+    @label = label
+    @category = category
+    @table_node = table_node
+    @entity_dict = {}
+    table_node.each {|t| eval_entity(t) }
+  end
+  attr_accessor :entity_dict, :label, :table_node, :category
+
+  def entity_dict_to_dot
+    res = ""
+    s = []
+    @entity_dict.each_value{|e| s << e }
+    if @category
+      res << "label=#{@label}\n" if @label
+      res << "style=invis\n" unless @label
+    end
+    s.sort{|a, b| a.name <=> b.name}.each{|e| res << e.to_dot << "\n"}
+    res
+  end
+
+  private
+  def eval_entity(table)
+    columns = table["columns"]; columns ||= []
+    @entity_dict[table["name"]] ||= Entity.new(table["name"], table["dependent"], columns)
+  end
+
+end
+
+
+class Ymldot
+  attr_accessor :file_name
+
+  def initialize(filepath)
+    open(filepath) do |f|
+      str = f.read
+      @node = YAML.load(str)
+    end
+    @file_name = $1 if filepath[/(\w+).yml\z/]
+    @entity_dict = {}
+    @category = []
+    @one_relations = []
+    @many_relations = []
+    eval_yml
+  end
+
+  def dot_generate
+    code = ""
+    code += <<"EOS"
+digraph #{@file_name} {
+#{add_2_tab(config_to_dot)}
+#{add_2_tab(entity_dict_to_dot)}
+#{add_2_tab(relations_to_dot)}
+}
+EOS
+  end
+
+  private
+  def add_2_tab(str)
+    res = ""
+    str.each_line{|s| res << "  " << s}
+    res
+  end
+
+  def config_to_dot
+    res = ""
+    res << "graph[overlap=false, splines=true]\n"
+    res << %Q!node [fontname="#{@config["font"]}"]! if @config["font"]
+    res
+  end
+
+  def entity_dict_to_dot
+    res = ""
+    unless @category.empty?
+      @category.each_with_index do |c, i|
+        unless c.category
+          res << c.entity_dict_to_dot
+        else
+          res << "subgraph cluster#{i} {\n"
+          res << add_2_tab(c.entity_dict_to_dot)
+          res << "}\n"
+        end
+      end
+    end
+    res
+  end
+
+  def relations_to_dot
+    res = ""
+    @one_relations.sort{|a, b| a[:self].name <=> b[:self].name}.each do |r|
+      res << %Q!"#{r[:self].name}" -> "#{r[:have].name}" [arrowtail=none arrowhead=dot headlabel="1" taillabel="1"]! << "\n"
+    end
+    @many_relations.sort{|a, b| a[:self].name <=> b[:self].name}.each do |r|
+      res << %Q!"#{r[:self].name}" -> "#{r[:have].name}" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]! << "\n"
+    end
+    res
+  end
+
+  def eval_yml
+    @config = @node["config"]? @node["config"] : {}
+    @category << Tables.new(@node["tables"]) if @node["tables"] and !@node["tables"].empty?
+    @node["category"].each{|c| @category << Tables.new(c["tables"], c["label"], true) } if @node["category"]
+    @category.each{|c| c.entity_dict.each_pair{|k, v| @entity_dict[k] = v}}
+    @category.each{|c| c.table_node.each{|e| eval_relation(e) } }
+  end
+
+  def eval_relation(table)
+    foreignkeys = table["foreignkeys"]
+    tname = table["name"]
+    return unless foreignkeys
+    eval_relation_has_many(foreignkeys["has_many"], tname) if foreignkeys["has_many"]
+    eval_relation_has_one(foreignkeys["has_one"], tname) if foreignkeys["has_one"]
+    eval_relation_hmabt(foreignkeys["has_many_and_belongs_to"], tname) if foreignkeys["has_many_and_belongs_to"]
+    eval_relation_polymorphic(foreignkeys["polymorphic"], tname) if foreignkeys["polymorphic"]
+  end
+
+  def eval_relation_has_many(keys, tname)
+    keys.each do |rel|
+      @entity_dict[rel].foreignkeys << "#{tname}ID(FK)"
+      @many_relations << {:self => @entity_dict[tname], :have => @entity_dict[rel]}
+    end
+  end
+
+  def eval_relation_has_one(keys, tname)
+    keys.each do |rel|
+      @entity_dict[rel].foreignkeys << "#{tname}ID(FK)"
+      @one_relations << {:self => @entity_dict[tname], :have => @entity_dict[rel]}
+    end
+  end
+
+  def eval_relation_hmabt(keys, tname)
+    keys.each do |rel|
+      join_tname = "#{rel}_#{tname}"
+      return if @entity_dict.has_key? join_tname
+      join_tname = "#{tname}_#{rel}"
+      @entity_dict[join_tname] ||= Entity.new(join_tname, true)
+      @entity_dict[join_tname].foreignkeys << "#{tname}ID(FK)"
+      @entity_dict[join_tname].foreignkeys << "#{rel}ID(FK)"
+
+      # make new category
+      keys = []
+      keys << "#{tname}ID(FK)"
+      keys << "#{rel}ID(FK)"
+      @category << Tables.new([{"name" => join_tname, "columns" => keys}])
+
+      @many_relations << {:self => @entity_dict[tname], :have => @entity_dict[join_tname]}
+      @many_relations << {:self => @entity_dict[rel], :have => @entity_dict[join_tname]}
+    end
+  end
+
+  def eval_relation_polymorphic(keys, tname)
+    keys.each do |rel|
+      @entity_dict[tname].foreignkeys << "#{rel["name"]}ID(FK)" if key = rel["name"]
+      @entity_dict[tname].columns.unshift "#{rel["type"]}(type)" if key = rel["type"]
+      rel["tables"].each do |t|
+        @one_relations << {:self => @entity_dict[t], :have => @entity_dict[tname] }
+      end
+    end
+  end
+end

data/sample/sample.dot

@@ -0,0 +1,13 @@
+digraph sample {
+  graph[overlap=false, splines=true]
+
+  "category" [shape=record, label="{category|name\l}"]
+  "customer" [shape=record, label="{customer|name\lphone_number\l}"]
+  "order" [shape=record, label="{order|customerID(FK)\lproductID(FK)\lorder_num\l}"]
+  "product" [shape=record, label="{product|categoryID(FK)\lname\lamount\ltax\lproduct_div\l}"]
+
+  "category" -> "product" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+  "customer" -> "order" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+  "product" -> "order" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+
+}

data/sample/sample.yml

@@ -0,0 +1,30 @@
+# reference http://codezine.jp/article/detail/154?p=1
+tables:
+  - name: customer
+    columns:
+      - name
+      - phone_number
+    foreignkeys:
+      has_many:
+        - order
+
+  - name:  order
+    columns:
+      - order_num
+
+  - name:  product
+    columns:
+      - name
+      - amount
+      - tax
+      - product_div
+    foreignkeys:
+      has_many:
+         - order
+
+  - name:  category
+    columns:
+      - name
+    foreignkeys:
+      has_many:
+         - product

data/sample/sample_jp.dot

@@ -0,0 +1,13 @@
+digraph sample_jp {
+  graph[overlap=false, splines=true]
+  node [fontname="MSUIGOTHIC.ttf"]
+  "商品" [shape=record, label="{商品|商品カテゴリID(FK)\l名前\l金額\l税\l商品区分\l}"]
+  "商品カテゴリ" [shape=record, label="{商品カテゴリ|商品カテゴリ名\l}"]
+  "注文" [shape=record, label="{注文|顧客ID(FK)\l商品ID(FK)\l注文数\l}"]
+  "顧客" [shape=record, label="{顧客|名前\l電話番号\l}"]
+
+  "商品" -> "注文" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+  "商品カテゴリ" -> "商品" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+  "顧客" -> "注文" [arrowtail=none arrowhead=dot headlabel="n" taillabel="1"]
+
+}

data/sample/sample_jp.yml

@@ -0,0 +1,34 @@
+# reference http://codezine.jp/article/detail/154?p=1
+config:
+  font: MSUIGOTHIC.ttf
+
+tables:
+  - name: 顧客
+    columns:
+      - 名前
+      - 電話番号
+    foreignkeys:
+      has_many:
+        - 注文
+
+  - name:  注文
+    columns:
+      - 注文数
+
+  - name:  商品
+    columns:
+      - 名前
+      - 金額
+      - 税
+      - 商品区分
+    foreignkeys:
+      has_many:
+         - 注文
+
+  - name:  商品カテゴリ
+    columns:
+      - 商品カテゴリ名
+    foreignkeys:
+      has_many:
+         - 商品
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: ymldot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- nari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-10 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: authornari@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- bin/ymldot
+- lib/ymldot.rb
+- sample/sample.dot
+- sample/sample.png
+- sample/sample.yml
+- sample/sample_jp.dot
+- sample/sample_jp.png
+- sample/sample_jp.yml
+has_rdoc: false
+homepage: http://coderepos.org/share/browser/lang/ruby/ymldot
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ymldot
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Can describe ERD in a from of ".yml"
+test_files: []
+