Visualizes the Models, Properties and Relationships defined in a DataMapper based Ruby project.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib Added a Padrino::Task. Jul 10, 2015
spec
.gitignore
.rspec
.yardopts
ChangeLog.md
Gemfile
LICENSE.txt
README.md Missed a link. Jul 10, 2015
Rakefile
dm-visualizer.gemspec
gemspec.yml

README.md

dm-visualizer

Description

DataMapper Visualizer is both a library and a command-line utility for visualizing the Models, Properties and Relationships defined in a DataMapper based Ruby project.

Features

  • Safely loads the models of a project.
  • Supports using Bundler.
  • Generates GraphViz diagrams for a project:
    • Supports generating Relational and Schema diagrams.
    • Provides PNG and SVG output.
    • Provides Rake tasks for both Ruby libraries and dm-rails apps.
  • Supports DataMapper >= 1.0.0.

Examples

Add the dm:doc:graphviz rake tasks to a Ruby library:

require 'dm-visualizer/rake/graphviz_task'
DataMapper::Visualizer::Rake::GraphVizTask.new(
  :include => ['lib'],
  :require => ['my_library/models']
)

Add the dm:doc:graphviz rake tasks to a Padrino app:

require 'dm-visualizer/rake/padrino/graphviz_task'
DataMapper::Visualizer::Rake::Padrino::GraphVizTask.new

Add the dm:doc:graphviz rake tasks to a dm-rails app:

require 'dm-visualizer/rake/rails/graphviz_task'
DataMapper::Visualizer::Rake::Rails::GraphVizTask.new

Requirements

Install

$ gem install dm-visualizer

License

Copyright (c) 2010-2012 Hal Brodigan

See {file:LICENSE.txt} for license information.