factorylabs-railroad 0.6.0.1

data/README.txt

@@ -0,0 +1,145 @@
+= RailRoad 
+
+RailRoad generates models and controllers diagrams in DOT language for a 
+Rails application.
+
+
+= Usage
+
+Run RailRoad on the Rails application's root directory. You can redirect its
+output to a .dot file or pipe it to the dot or neato utilities to produce a
+graphic. Model diagrams are intended to be processed using dot and
+controller diagrams are best processed using neato.
+
+    railroad [options] command
+ 
+== Options
+
+Common options:
+    -b, --brief                      Generate compact diagram
+                                       (no attributes nor methods)
+    -e, --exclude file1[,fileN]      Exclude given files
+    -i, --inheritance                Include inheritance relations
+    -l, --label                      Add a label with diagram information
+                                       (type, date, migration, version)
+    -o, --output FILE                Write diagram to file FILE
+    -v, --verbose                    Enable verbose output
+                                       (produce messages to STDOUT)
+
+Models diagram options:
+    -a, --all                        Include all models
+                                       (not only ActiveRecord::Base derived)
+        --hide-magic                 Hide magic field names
+        --hide-types                 Hide attributes type
+    -j, --join                       Concentrate edges
+    -m, --modules                    Include modules
+    -p, --plugins-models             Include plugins models
+    -t, --transitive                 Include transitive associations
+                                     (through inheritance)
+
+Controllers diagram options:
+        --hide-public                Hide public methods
+        --hide-protected             Hide protected methods
+        --hide-private               Hide private methods
+
+Other options:
+    -h, --help                       Show this message
+        --version                    Show version and copyright
+
+== Commands
+
+    -M, --models                     Generate models diagram
+    -C, --controllers                Generate controllers diagram
+    -A, --aasm                       Generate "acts as state machine" diagram
+
+
+== Examples
+
+    railroad -o models.dot -M 
+      Produces a models diagram to the file 'models.dot'
+    railroad -a -i -o full_models.dot -M 
+      Models diagram with all classes showing inheritance relations
+    railroad -M | dot -Tsvg > models.svg
+      Model diagram in SVG format
+    railroad -C | neato -Tpng > controllers.png
+      Controller diagram in PNG format
+    railroad -h
+      Shows usage help
+
+
+= Processing DOT files
+
+To produce a PNG image from model diagram generated by RailRoad you can
+issue the following command:
+
+    dot -Tpng models.dot > models.png
+
+If you want to do the same with a controller diagram, use neato instead of
+dot:
+
+    neato -Tpng controllers.dot > controllers.png
+
+If you want to produce SVG (vectorial, scalable, editable) files, you can do
+the following:
+
+    dot -Tsvg models.dot > models.svg
+    neato -Tsvg controllers.dot > controllers.svg
+
+Important: There is a bug in Graphviz tools when generating SVG files that
+cause a text overflow. You can solve this problem editing (with a text
+editor, not a graphical SVG editor) the file and replacing around line 12
+"font-size:14.00;" by "font-size:11.00;", or by issuing the following command 
+(see "man sed"):
+
+    sed -i 's/font-size:14.00/font-size:11.00/g' file.svg
+
+Note: For viewing and editing SVG there is an excellent opensource tool
+called Inkscape (similar to Adobe Illustrator. For DOT processing you can
+also use Omnigraffle (on Mac OS X).
+
+= RailRoad as a rake task
+
+(Thanks to Thomas Ritz, http://www.galaxy-ritz.de ,for the code.)
+
+In your Rails application, put the following rake tasks into 'lib/task/diagrams.rake':
+
+  namespace :doc do
+    namespace :diagram do
+      task :models do
+        sh "railroad -i -l -a -m -M | dot -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/models.svg"
+      end
+  
+      task :controllers do
+        sh "railroad -i -l -C | neato -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/controllers.svg"
+      end
+    end
+  
+    task :diagrams => %w(diagram:models diagram:controllers)
+  end
+  
+Then, 'rake doc:diagrams' produces 'doc/models.svg' and 'doc/controllers.svg'.
+
+= Requirements
+
+RailRoad has been tested with Ruby 1.8.5 and Rails 1.1.6 to 1.2.3
+applications. There is no additional requirements (nevertheless, all your
+Rails application requirements must be installed).
+
+In order to view/export the DOT diagrams, you'll need the processing tools
+from Graphviz.
+
+= Website and Project Home
+
+http://railroad.rubyforge.org
+
+= License
+
+RailRoad is distributed  under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2 of the 
+License, or (at your option) any later version.
+
+= Author
+
+Javier Smaldone 
+(javier -at- smaldone -dot- com -dot- ar, http://blog.smaldone.com.ar )
+

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/railroad.rb'
+
+Hoe.new('railroad', APP_VERSION.join('.')) do |p|
+  p.rubyforge_name = 'railroad'
+  p.author       = "Javier Smaldone"
+  p.email        = "javier@smaldone.com.ar"
+  p.url          = "http://railroad.rubyforge.org"
+  p.summary      = "A DOT diagram generator for Ruby on Rail applications"
+end
+
+# vim: syntax=Ruby

data/bin/railroad

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+#   RailRoad generates models and controllers diagrams in DOT language
+#   for a Rails application.
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+
+$: << File.join(File.dirname(__FILE__), '../lib/')
+require 'railroad'
+
+options = OptionsStruct.new
+
+options.parse ARGV
+
+old_dir = Dir.pwd
+
+Dir.chdir(options.root) if options.root != ''
+
+if options.command == 'models'
+  diagram = ModelsDiagram.new options
+elsif options.command == 'controllers'
+  diagram = ControllersDiagram.new options
+elsif options.command == 'aasm'
+  diagram = AasmDiagram.new options
+else
+  STDERR.print "Error: You must supply a command\n" +
+               "  (try #{APP_NAME} -h)\n\n"
+  exit 1
+end
+
+diagram.generate
+
+Dir.chdir(old_dir)
+
+diagram.print
+

data/lib/railroad.rb

@@ -0,0 +1,11 @@
+APP_NAME       = "railroad"
+APP_HUMAN_NAME = "RailRoad"
+APP_VERSION    = [0,6,0]
+COPYRIGHT      = "Copyright (C) 2007-2008 Javier Smaldone"
+
+require 'railroad/options_struct'
+require 'railroad/diagram_graph'
+require 'railroad/app_diagram'
+require 'railroad/models_diagram'
+require 'railroad/controllers_diagram'
+require 'railroad/aasm_diagram'

data/lib/railroad/aasm_diagram.rb

@@ -0,0 +1,79 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+# AASM code provided by Ana Nelson (http://ananelson.com/)
+
+# Diagram for Acts As State Machine
+class AasmDiagram < AppDiagram
+
+  def initialize(options)
+    #options.exclude.map! {|e| e = "app/models/" + e}
+    super options 
+    @graph.diagram_type = 'Models'
+    # Processed habtm associations
+    @habtm = []
+  end
+
+  # Process model files
+  def generate
+    STDERR.print "Generating AASM diagram\n" if @options.verbose
+    files = Dir.glob("app/models/*.rb") 
+    files += Dir.glob("vendor/plugins/**/app/models/*.rb") if @options.plugins_models
+    files -= @options.exclude
+    files.each do |f| 
+      process_class extract_class_name('app/models/', f).constantize
+    end
+  end
+  
+  private
+  
+  # Load model classes
+  def load_classes
+    begin
+      disable_stdout
+      files = Dir.glob("app/models/**/*.rb")
+      files += Dir.glob("vendor/plugins/**/app/models/*.rb") if @options.plugins_models
+      files -= @options.exclude                  
+      files.each {|m| require m }
+      enable_stdout
+    rescue LoadError
+      enable_stdout
+      print_error "model classes"
+      raise
+    end
+  end  # load_classes
+
+  # Process a model class
+  def process_class(current_class)
+    
+    STDERR.print "\tProcessing #{current_class}\n" if @options.verbose
+    
+    # Only interested in acts_as_state_machine models.
+    return unless current_class.respond_to?'states'
+    
+    node_attribs = []
+    node_type = 'aasm'
+    
+    current_class.states.each do |state_name|
+      state = current_class.read_inheritable_attribute(:states)[state_name]
+      node_shape = (current_class.initial_state === state_name) ? ", peripheries = 2" : ""
+      node_attribs << "#{current_class.name.downcase}_#{state_name} [label=#{state_name} #{node_shape}];"
+    end
+    @graph.add_node [node_type, current_class.name, node_attribs]
+    
+    current_class.read_inheritable_attribute(:transition_table).each do |event_name, event|
+      event.each do |transition|
+        @graph.add_edge [
+          'event', 
+          current_class.name.downcase + "_" + transition.from.to_s, 
+          current_class.name.downcase + "_" + transition.to.to_s, 
+          event_name.to_s
+        ]
+      end
+    end
+  end # process_class
+
+end # class AasmDiagram

data/lib/railroad/app_diagram.rb

@@ -0,0 +1,86 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+# Root class for RailRoad diagrams
+class AppDiagram
+
+  def initialize(options)
+    @options = options
+    @graph = DiagramGraph.new
+    @graph.show_label = @options.label
+
+    STDERR.print "Loading application environment\n" if @options.verbose
+    load_environment
+
+    STDERR.print "Loading application classes\n" if @options.verbose
+    load_classes
+  end
+
+  # Print diagram
+  def print
+    if @options.output
+      old_stdout = STDOUT.dup
+      begin
+        STDOUT.reopen(@options.output)
+      rescue
+        STDERR.print "Error: Cannot write diagram to #{@options.output}\n\n"
+        exit 2
+      end
+    end
+    
+    if @options.xmi 
+        STDERR.print "Generating XMI diagram\n" if @options.verbose
+    	STDOUT.print @graph.to_xmi
+    else
+        STDERR.print "Generating DOT graph\n" if @options.verbose
+        STDOUT.print @graph.to_dot 
+    end
+
+    if @options.output
+      STDOUT.reopen(old_stdout)
+    end
+  end # print
+
+  private 
+
+  # Prevents Rails application from writing to STDOUT
+  def disable_stdout
+    @old_stdout = STDOUT.dup
+    STDOUT.reopen(PLATFORM =~ /mswin/ ? "NUL" : "/dev/null")
+  end
+
+  # Restore STDOUT  
+  def enable_stdout
+    STDOUT.reopen(@old_stdout)
+  end
+
+
+  # Print error when loading Rails application
+  def print_error(type)
+    STDERR.print "Error loading #{type}.\n  (Are you running " +
+                 "#{APP_NAME} on the aplication's root directory?)\n\n"
+  end
+
+  # Load Rails application's environment
+  def load_environment
+    begin
+      disable_stdout
+      require "config/environment"
+      enable_stdout
+    rescue LoadError
+      enable_stdout
+      print_error "application environment"
+      raise
+    end
+  end
+
+  # Extract class name from filename
+  def extract_class_name(base, filename)
+    # this is will handle directory names as namespace names
+    filename.reverse.chomp(base.reverse).reverse.chomp(".rb").camelize
+  end
+
+end # class AppDiagram

data/lib/railroad/controllers_diagram.rb

@@ -0,0 +1,81 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+# RailRoad controllers diagram
+class ControllersDiagram < AppDiagram
+ 
+  def initialize(options)
+    #options.exclude.map! {|e| "app/controllers/" + e}
+    super options
+    @graph.diagram_type = 'Controllers'
+  end
+
+  # Process controller files
+  def generate
+    STDERR.print "Generating controllers diagram\n" if @options.verbose
+
+    files = Dir.glob("app/controllers/**/*_controller.rb") - @options.exclude
+    files << 'app/controllers/application.rb'
+    files.each do |f|
+      class_name = extract_class_name('app/controllers/', f)
+      # ApplicationController's file is 'application.rb'
+      class_name += 'Controller' if class_name == 'Application'
+      process_class class_name.constantize
+    end 
+  end # generate
+
+  private
+
+  # Load controller classes
+  def load_classes
+    begin
+      disable_stdout
+      # ApplicationController must be loaded first
+      require "app/controllers/application.rb" 
+      files = Dir.glob("app/controllers/**/*_controller.rb") - @options.exclude
+      files.each {|c| require c }
+      enable_stdout
+    rescue LoadError
+      enable_stdout
+      print_error "controller classes"
+      raise
+    end
+  end # load_classes
+
+  # Proccess a controller class
+  def process_class(current_class)
+
+    STDERR.print "\tProcessing #{current_class}\n" if @options.verbose
+
+    if @options.brief
+      @graph.add_node ['controller-brief', current_class.name]
+    elsif current_class.is_a? Class 
+      # Collect controller's methods
+      node_attribs = {:public    => [], 
+                      :protected => [], 
+                      :private   => []}
+      current_class.public_instance_methods(false).sort.each { |m|
+        node_attribs[:public] << m
+      } unless @options.hide_public
+      current_class.protected_instance_methods(false).sort.each { |m|
+        node_attribs[:protected] << m
+      } unless @options.hide_protected
+      current_class.private_instance_methods(false).sort.each { |m|
+        node_attribs[:private] << m 
+      } unless @options.hide_private
+      @graph.add_node ['controller', current_class.name, node_attribs]
+    elsif @options.modules && current_class.is_a?(Module)
+      @graph.add_node ['module', current_class.name]
+    end
+
+    # Generate the inheritance edge (only for ApplicationControllers)
+    if @options.inheritance && 
+       (ApplicationController.subclasses.include? current_class.name)
+      @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
+    end
+  end # process_class
+
+end # class ControllersDiagram