mongoid-erd 0.0.3

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'rviz'
+gem 'term-ansicolor'
+

data/README.rdoc

@@ -0,0 +1,60 @@
+= Mongoid-ERD 
+
+Create model-diagram (ERD graph) via Graphviz using the mongoid's model source code.
+
+Export a executable <tt>merd</tt>:
+
+    $ merd | dot -Tpng > docs/erd.png
+
+or:
+
+    $ merd --model_dir=other/models | dot -Tpng > docs/erd.png
+
+You can also create only a subset of models by:
+
+    $ merd --include=Class1,Class2
+
+or 
+
+    $ merd --exclude=Class4,Class5
+
+You need to add <tt>dot</tt> executable in your PATH.
+
+= Class, Inherits and Fields
+
+- <tt>class xxx:yyy</tt>: a record xxx inherit from yyy. The first class that contains <tt>include Mongoid::Document</tt> on the file will be tracked. yyy will be created as a <tt>box</tt> node if no corresponding file found.
+
+- <tt>field :xxx, type:yyy</tt>: a field xxx with type yyy. <tt>type</tt> and <tt>default</tt> will be tracked.
+
+- <tt>embeds_many/embeds_one/has_many/has_one :xxx, :as => :yyy</tt>: field and a belong_to/embeds_many/embeds_one/has_one link to xxx
+
+- <tt>belongs_to/embedded_in :xxx</tt>: a field without link.
+
+Methods before <tt>:private</tt> keyword will also be tracked.
+
+= Special Markers
+
+<tt>erd_tag user.core</tt> tag name of the current class (see configuration files below)
+
+<tt>erd{}</tt>
+
+<tt>class xxx:yyy # erd{fillcolor:xxx} yyy</tt>: yyy will become the label of the current class.
+
+<tt>field ... # erd{...} xxx</tt>: xxx will become the label of that field.
+
+<tt>embeds_many ... # erd{...} yyy</tt>: yyy will become the label of that edge.
+
+<tt>erd -> node_name{color:yyy} label</tt>: arbitrage edge with attributes.
+
+= Configuration Files
+
+<tt>config/mongoid_erd.yml</tt>:
+
+    user: {shape: Mrecord}
+    user.core: {fillcolor: blue}
+
+<tt>user.core</tt> attributes will be merged to <tt>user</tt>, then should be merged into <tt>class ... # erd{attrs}</tt>. Those attributes will passed to dot language as the attributes associate to the class node.
+
+An other will to use tag is restrict output contains only classes with specific tag:
+
+    $ merd --tag=user

data/bin/merd

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# vim :set syn=ruby
+
+$: << 'lib'
+
+require "mongoid_erd"
+require "optparse"
+require "active_support/core_ext/string/inflections"
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: merd [options]"
+
+  # configuration file
+  options[:conf_file] = "config/mongoid_erd.yml"
+  opts.on('-c', '--conf_file FILE', 'use configuration file other than config/mongoid_erd.yml' ) do |file|
+    options[:conf_file] = file
+  end
+
+  # directory contains model files
+  options[:model_dir] = "app/models"
+  opts.on('-d', '--model_dir DIR', 'parse model directory other than app/models') do |dir|
+    options[:model_dir] = dir
+  end
+
+  # include/exclude model list
+  options[:include] = []
+  opts.on('-i', '--include CLASS,LIST', 'include only specified models') do |list|
+    options[:include] = list.split(/\s*,\s*/).map{|s| s.underscore}
+  end
+
+  options[:exclude] = []
+  opts.on('-e', '--exclude CLASS,LIST', 'exclude those specified models') do |list|
+    options[:exclude] = list.split(/\s*,\s*/).map{|s| s.underscore}
+  end
+
+  # restrict output for models with those tag only
+  options[:tag] = []
+  opts.on('-t', '--tag TAG,LIST', 'restrict output for models with those tag only') do |list|
+    options[:tag] = list.split(/\s*,\s*/)
+  end
+
+  # output file for dot source
+  options[:output] = ''
+  opts.on('-o', '--output FILE', 'save dot language source to a file other than STDOUT') do |output|
+    options[:output] = output
+  end
+
+  opts.on_tail( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!(ARGV)
+config = options.select {|k,v| %w[tag conf_file model_dir exclude include output].include? k.to_s}
+
+MongoidErd.new(config).parse.output()

data/examples/models/hello.rb

@@ -0,0 +1,10 @@
+
+# erd_tag user.core
+class Hello # erd{color: red} Hello Class
+  field :name, type:String # erd Name Field
+  field :link, type:String # -> World
+
+  def say # erd say hello world
+
+  end
+end

data/examples/models/world.rb

@@ -0,0 +1,6 @@
+
+# erd_tag: user
+class World # erd: Hi!
+
+	belongs_to :hello
+end

data/examples/mongoid_erd.yml

@@ -0,0 +1,6 @@
+title: Model Diagrams
+tags:
+  _default: {shape: record, fillcolor: yellow, style: filled, color: blue}
+  user: {fillcolor: gold, color: black}
+  user.core: {color: red}
+  pix: {style: pix}

data/lib/mongoid_erd.rb

@@ -0,0 +1,211 @@
+require "rviz"
+require "yaml"
+require "active_support/core_ext/string/inflections"
+
+class Fields
+  attr_accessor :name, :erd_label, :type, :edge
+  def as_row
+    str = type == "function" ? '+ ' + name : '- ' + name
+    str += ":" + type unless type == "function"
+    str += ", #{erd_label}" if erd_label and erd_label.size > 0
+    str
+  end
+end
+
+class Model
+  attr_accessor :name, :erd_label, :attrs, :fields, :tag, :parent
+  def initialize 
+    @attrs = Hash.new
+    @fields = Array.new 
+  end
+
+  def title
+    "- [#{name}:#{erd_label}] -"
+  end
+end
+
+class MongoidErd
+  
+  def initialize config = {}
+    @config = config
+      # tag: [], tags: {}, include = [], exclude = [], model_dir = ""
+    
+    # parse the option file
+    if @config[:conf_file] and File.exists? @config[:conf_file]
+      yml = YAML.load(File.open(@config[:conf_file], 'r:utf-8').read)
+      @config[:tags] = yml["tags"]
+      @config[:title] = yml["title"]
+    else
+      raise "#{@config[:conf_file]} does not exists" if @config[:conf_file]
+    end
+    
+    # merge tag attributes recursively
+    @config[:tags].each do |t,v|
+      tv = @config[:tags]["_default"].clone || {} 
+      p = nil
+      t.split('.').each do |pt|
+        p = p ? [p, pt].join('.') : pt # merge in order: tv < a < a.b < a.b.c, ...
+        # puts "merge from #{p} to #{t}"
+        tv.merge! @config[:tags][p] if @config[:tags][p]
+      end
+      @config[:tags][t] = tv
+    end
+
+    @models = Hash.new
+  end
+
+  def set key, value
+    @config[key] = value
+  end
+
+  def get key
+    @config[key]
+  end
+
+  def parse_erd o, line
+    if /erd\{(?<yml_>.+?)\}:?/ =~ line
+      o.attrs.merge! YAML.load(yml_) if yml_
+    end
+    if /erd(\{.+?\})?\s*:?\s+(?<label_>.+)/ =~ line
+      o.erd_label = label_ if label_
+    end
+  end
+
+  # parse the fold contains mongoid source
+  def parse
+    raise "directory #{@config[:model_dir]} not exists" unless File.directory? @config[:model_dir]
+    Dir["#{@config[:model_dir]}/*.rb"].each do |file|
+      crt_model = Model.new
+      model_attrs_ = Hash.new
+      in_public = true
+      File.open(file, 'r:utf-8').each do |line|
+        line.chomp!
+
+        # erd_tag and attr
+        if /^[\#\s]*erd_tag\:?\s*(?<tag_>[\w\.]+)/ =~ line
+          crt_model.tag = tag_ 
+          crt_model.attrs = @config[:tags][tag_]
+        end
+
+        # catch class definition
+        if /^\s*class\s+(?<name_>\w+)/ =~ line
+          crt_model.name = name_.underscore 
+          self.parse_erd crt_model, line
+          if /^\s*class\s+\w+\s+\<\s+(?<parent_>\w+)/ =~ line
+            crt_model.parent = parent_.underscore if parent_
+          end
+        end
+        
+        # catch functions
+        in_public = true if /public\:/ =~ line
+        in_public = false if /private\:/ =~ line
+
+        if /^\s*def\s+(?<func_>[^#]+)\s*/ =~ line
+          field_ = Fields.new
+          field_.name, field_.type = func_, 'function'
+          self.parse_erd field_, line # parse erd attr and label
+          # arbitrage link
+          if /\-\>\s*(?<name_>\w+)(\{(?<attrs_>.+)\})?/ =~ line
+            attrs = {}
+            attrs = YAML.load(attrs_) if attrs_
+            field_.edge = [name_, '', attrs]
+          end
+          crt_model.fields << field_ 
+        end
+
+        # catch field
+        if /^\s*field\s+\:(?<name_>\w+)\s*\,.*\:?type\:?\s*(?<type_>[A-Za-z_0-9\:]+)/ =~ line
+          field_ = Fields.new
+          field_.name, field_.type = name_, type_
+          self.parse_erd field_, line # parse erd attr and label
+          # arbitrage link
+          if /\-\>\s*(?<name_>\w+)(\{(?<attrs_>.+)\})?/ =~ line
+            attrs = {}
+            attrs = YAML.load(attrs_) if attrs_
+            field_.edge = [name_, '', attrs]
+          end
+          crt_model.fields << field_ 
+        end
+
+        # catch relations
+        if /^\s*(?<rel_>embeds_many|embeds_one|has_many|has_one|belongs_to|embedded_in)\s+\:(?<name_>\w+)\s*(\,.*\:?as\:?\s*(?<as_>\w+))?/ =~ line
+          field_ = Fields.new
+          field_.name, field_.type = rel_, name_
+          field_.name = "#{rel_} (as #{as_})" if as_
+          self.parse_erd field_, line # parse erd attr and label
+          crt_model.fields << field_ 
+          unless %w[belongs_to embedded_in].include? rel_
+            field_.edge = [name_, '', {label: rel_}]
+          end
+        end
+        
+        # common extension field
+        if /^\s*symbolize\s+\:(?<name>\w+)\s*\,.*\:?in\:?.*(?<in_>\[.+\])/ =~ line
+          field_ = Fields.new
+          field_.name, field_.type = name_, "symbolized in #{in_}"
+          self.parse_erd field_, line # parse erd attr and label
+          crt_model.fields << field_ 
+        end
+
+        if /^\s*state_machine\s+\:(?<state_>\w+)/ =~ line
+          field_ = Fields.new
+          field_.name = state_ == "initial" ? "state" : state_
+          field_.type = "state_machine"
+          self.parse_erd field_, line # parse erd attr and label
+          crt_model.fields << field_ 
+        end
+      end # open and parse one file
+
+      # assign attributes at the last moment
+      crt_model.attrs.merge! model_attrs_
+
+      # if config.include/tag, default to exclude_it = true
+      if @config[:include].size > 0 or @config[:tag].size > 0
+        include_it = false
+      else
+        include_it = true
+      end
+
+      # if in the include list, include it
+      include_it = true if @config[:include] and @config[:include].include? crt_model.name
+      @config[:tag].each do |t|
+        include_it = true if t == crt_model.tag or /^#{t}(\..+)?/.match(crt_model.tag)
+      end
+
+      include_it = false if @config[:exclude].include? crt_model.name
+      @models[crt_model.name] = crt_model if include_it
+    end # open directory
+    self
+  end
+
+  def output 
+    g = Rviz::Graph.new @config[:title], {rankdir: 'LR', dpi: 300}
+
+    @models.each do |mname, model|
+      g.add_record(model.name, model.attrs)
+      g.node(model.name).add_row(model.title, true)
+      model.fields.each do |field|
+        g.node(model.name).add_row(field.as_row, true, 'l')
+        if field.edge
+          to_node, to_anchor, attrs = field.edge[0].underscore, field.edge[1], field.edge[2]
+          unless @models[to_node]
+            g.add(to_node, 'oval', {style:'filled', fillcolor:'grey', color:'grey'})
+            to_anchor = ''
+          end
+          g.link(model.name, field.as_row, to_node, to_anchor, attrs)
+        end
+      end
+
+      # relations
+      if model.parent
+        unless @models[model.parent]
+          g.add(model.parent, 'oval', {style:'filled', fillcolor:'grey', color:'grey'})
+        end
+        g.link(model.name, model.title, model.parent, '', {arrowhead: 'onormal'})
+      end
+    end
+
+    g.output
+  end
+
+end

data/mongoid-erd.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new 'mongoid-erd', '0.0.3' do |s|
+  s.executables       << "merd"
+  s.description       = "Create model diagram graph (ERD graph) in graphviz's dot language"
+  s.summary           = "Mongoid ERD diagram creator"
+  s.authors           = ["Huang Wei"]
+  s.email             = "huangw@pe-po.com"
+  s.homepage          = "https://github.com/huangw/mongoid-erd-gem"
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore]
+  s.test_files        = Dir.glob("{spec,test}/**/*.rb")
+  s.rdoc_options      = %w[--line-numbers --inline-source --title Rviz --main README.rdoc --encoding=UTF-8]
+
+  s.add_dependency 'rviz'
+  s.add_dependency 'active_support'
+  # s.add_development_dependency 'rspec', '~> 2.5'
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-erd
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Huang Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rviz
+  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
+  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: Create model diagram graph (ERD graph) in graphviz's dot language
+email: huangw@pe-po.com
+executables:
+- merd
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.rdoc
+- bin/merd
+- examples/models/hello.rb
+- examples/models/world.rb
+- examples/mongoid_erd.yml
+- lib/mongoid_erd.rb
+- mongoid-erd.gemspec
+homepage: https://github.com/huangw/mongoid-erd-gem
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Rviz
+- --main
+- README.rdoc
+- --encoding=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Mongoid ERD diagram creator
+test_files: []