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 Gem Bundler.
  • Generates GraphViz diagrams for a project.
    • Provides Rake tasks for both Ruby libraries and Rails3 apps.
  • Supports both DataMapper 0.10.2 and 1.0.0.

Examples

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

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

Add the db:doc:graphviz rake task to a Rails3 / dm-rails app:

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

Requirements

Install

$ sudo gem install dm-visualizer

License

See LICENSE for license information.