doterd 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjU4MTQ3NzhkMjA5NzJlMGE4ZGI2NWNmNmI2MGZiYjdjYzNhMTZmZA==
+  data.tar.gz: !binary |-
+    YjVmNDgxMjgzOWU3OGEyMGExODUyZDA5NDdjYTA3NzM1Yzc0OTk3MA==
+SHA512:
+  metadata.gz: !binary |-
+    ZmU3Y2Q4YTA0NjIzMGUyYzcxMjJlMGQ2MjA5MmMwMTk5YzcyYTNkMmM4ODU4
+    YTViOGU3MzExYmJkNzZlY2E2ZmM2MDcyM2MwMDNhZWQ3NmJiZWU4NTIyYjll
+    ZTEzMTFmZjIyMGVmYmY2ZTY1NTM0ODc3ZWZiYzA3NmNmZTBkNjE=
+  data.tar.gz: !binary |-
+    NjIzMWI2ZDYzNjEwODVjYzYwMGQ3MmU3ZjdmMTYxNDkxZjE4NDNjZjcwYmI0
+    ZGNlZmExMWM3ZjdmNTUxZTk2ZDc5ZjQ2YTBlM2U2MjY2ZGExMDViZjUwMmU0
+    OGI4ZjY3YTllNGZhZGViYzQ0ODQyNjFiOTAxZmNmMWU2YTRhMTk=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doterd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 wenjun.yan
+
+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,29 @@
+# Doterd
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doterd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doterd
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/doterd/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/doterd.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doterd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doterd"
+  spec.version       = Doterd::VERSION
+  spec.authors       = ["wenjun.yan"]
+  spec.email         = ["mylastnameisyan@gmail.com"]
+  spec.summary       = %q{ruby dsl for ERD }
+  spec.description   = %q{ruby dsl for ERD }
+  spec.homepage      = "https://github.com/v2e4lisp/doterd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/doterd.rb

@@ -0,0 +1,214 @@
+require "doterd/version"
+
+module Doterd
+
+  # auto draw erd at the end of current script
+  #
+  # Exmaple:
+  #
+  #   include Doterd::Autodraw
+  #
+  # this will also include the default erd dsl
+  module Autodraw
+    def self.included(base)
+      base.send(:include, Doterd::DSL)
+
+      at_exit {
+        next if $! and not ($!.kind_of? SystemExit and $!.success?)
+        Doterd.viz
+      }
+    end
+  end
+
+  # Configuration
+  #
+  # table_renderer should respond to call(table_name, columns)
+  # relation_renderer should respond to call(relation, table_name_1, table_name_2)
+  def self.config
+    @config ||= {
+      table_renderer: Renderer::Table,
+      relation_renderer: Renderer::Relation,
+      dot_filename: "/tmp/test.dot",
+      output_type: :png,
+      column_description: true,
+
+      graph_attributes: {
+        concentrate: true,
+        labelloc: :t,
+        nodesep: 0.5,
+        ratio: 1.0,
+        fontsize: 13,
+        pad: "0.4,0.4",
+        rankdir: :LR,
+        margin: "0,0",
+      },
+      node_attributes:{
+        shape: "Mrecord",
+        fontsize: 15,
+        margin: "0.07,0.05",
+        penwidth: 1.0,
+      },
+      edge_attributes: {
+        fontsize: 8,
+        dir: :both,
+        arrowsize: 1.4,
+        penwidth: 1.0,
+        labelangle: 32,
+        labeldistance: 1.8,
+        fontsize: 7,
+      },
+    }
+  end
+
+  # A table has the following structure
+  #
+  #   [
+  #     table_name,
+  #     {
+  #       col_name_1 => [type, description]
+  #       col_name_2 => [type]
+  #       col_name_3 => []
+  #       ...
+  #     }
+  #   ]
+  def self.tables
+    @tables ||= []
+  end
+
+  # A relation has the following structure
+  #
+  #   [relation_name, table_name_1, table_name_2]
+  #
+  # Available relation_name:
+  #
+  #   [:_1_N, :_1_1, :_N_1, :_N_N]
+  #
+  # table may or may not exist in self.tables
+  def self.relations
+    @relations ||= []
+  end
+
+  # Create erd image
+  #
+  # generate a dot source code, save it to a file
+  # and create a erd image out of it.
+  def self.viz(dot_filename=nil)
+    dot_filename ||= Doterd.config[:dot_filename]
+    File.open(dot_filename, 'w') { |f| f.write dot }
+    system("dot -O -T#{Doterd.config[:output_type]} #{dot_filename}")
+  end
+
+  # Generate dot source code
+  def self.dot
+    gattr = Doterd.config[:graph_attributes].map {|k, v| "#{k}=\"#{v}\";\n" }.join
+    nattr = Doterd.config[:node_attributes].map {|k, v| "#{k}=\"#{v}\"" }.join ','
+    eattr = Doterd.config[:edge_attributes].map {|k, v| "#{k}=\"#{v}\"" }.join ','
+    nodes = Doterd.tables.map {|t| Doterd.config[:table_renderer].call *t }
+    edges = Doterd.relations.map {|r| Doterd.config[:relation_renderer].call *r }
+
+    dot = %Q{
+        digraph adlantis_sp {
+          #{gattr}
+          node [#{nattr}];
+          edge [#{eattr}];
+          #{(nodes << '').join(";\n")}
+          #{(edges << '').join(";\n")}
+        }
+    }
+  end
+
+  # Default renderers
+  module Renderer
+    class Table
+      def self.call(tbl_name, columns)
+        "#{tbl_name} [label=\"TABLE #{tbl_name}|#{dot_columns columns}\"]"
+      end
+
+      def self.dot_columns(columns)
+        labels = columns.map {|name, opts| "#{name} #{column_label opts}"}.join("|") + "| "
+      end
+
+      def self.column_label options
+        case options.size
+        when 0
+          ''
+        when 1
+          "[#{options.first}]"
+        else
+          desc = options.pop
+          desc = '' unless ::Doterd.config[:column_description]
+          "[#{options.join(', ')}]" + '\n' + desc
+        end
+      end
+    end
+
+    class Relation
+      def self.call(relation, from, to)
+        "#{from} -> #{to} #{label relation}"
+      end
+
+      def self.label(relation)
+        case relation
+        when :_1_1
+          "[arrowhead=odot, arrowtail=odot, dir=both]"
+        when :_1_N
+          "[arrowhead=inv, arrowtail=odot, dir=both]"
+        when :_N_1
+          "[arrowhead=odot, arrowtail=inv, dir=both]"
+        when :_N_N
+          "[arrowhead=inv, arrowtail=inv, dir=both]"
+        else
+          raise "Relation not found for #{relation}"
+        end
+      end
+    end
+  end
+
+  # Default erd dsl
+  #
+  # Examples:
+  #
+  #   # creats tables
+  #   table(:t1) {
+  #     col_1 Integer, "some comments"
+  #     col_2 String,  "some comments"
+  #     col_3 "String, Not Null", "some comments"
+  #   }
+  #
+  #   table(:t2) {
+  #     id
+  #     t1_id
+  #   }
+  #
+  #   # create table relations
+  #   _1_1 :t1, :t2
+  #
+  module DSL
+
+    def config(&block)
+      yield Doterd.config
+    end
+
+    def table(name, &block)
+      Table.new(name, &block)
+    end
+
+    [:_1_N, :_N_1, :_N_N, :_1_1].each {|rel|
+      define_method(rel) {|from, to| Doterd.relations << [rel, from, to]}
+    }
+
+    class Table < ::BasicObject
+      def initialize(name, &block)
+        @name = name
+        @columns = {}
+        instance_eval &block
+        ::Doterd.tables << [@name, @columns]
+      end
+
+      def method_missing(col, *options)
+        @columns[col] = options
+      end
+    end
+  end
+
+end

data/lib/doterd/version.rb

@@ -0,0 +1,3 @@
+module Doterd
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: doterd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- wenjun.yan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'ruby dsl for ERD '
+email:
+- mylastnameisyan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doterd.gemspec
+- examples/.gitkeep
+- lib/doterd.rb
+- lib/doterd/version.rb
+homepage: https://github.com/v2e4lisp/doterd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ruby dsl for ERD
+test_files: []