Home

Gem RailRoady

It is a simple gem for UML diagram generation in rails 3/4/5 projects, capable of analyzing your existing models and controllers. It Rocks!!

Features

• Simple to install and run
• Free an open. No fees ever ever
• Runs on Linus and OS x
• Just want the diagram source code without the .SVG files? No problem! (See the gem README file.)
• Rake tasks generate scalable vector graphics (SVG) files, which can be scaled to any size without quality loss

RailRoady is simple because it doesn't require

• Clicking anything
  No more using OmniGraffle or Vizio for class diagram deliverables! Run the rake task, and out pop your diagrams.
• Configuration
  Reasonable levels of detail provide for thorough diagrams that are not overwhelming to view and understand.
• Manual layout
  Even complicated models are layed out in a space-efficient manner. No more manually drag-and-dropping boxes around the screen every time you add a class.

Usage

The gem is so easy to use. Simply do the following:

• add the gem like so

  group :development, :test do
gem 'railroady'
end

• ...and then run the master rake task
  rake diagram:all

This should generate four doc/*.svg files that can be opened in (most) web browsers as well as dedicated document viewers supporting the Scalable Vector Graphics format.

Where do I view them ?

The four files are created in a folder called doc. Click any of them and view using the browser of your choice