peterhoeg-railroad 0.5.4

data/bin/railroad

@@ -0,0 +1,52 @@
+#!/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.
+#
+
+APP_NAME       = "railroad"
+APP_HUMAN_NAME = "RailRoad"
+APP_VERSION    = [0,5,3]
+COPYRIGHT      = "Copyright (C) 2007-2008 Javier Smaldone, 2009 Peter Hoeg"
+
+require 'options_struct'
+require 'models_diagram'
+require 'controllers_diagram'
+require 'aasm_diagram'
+
+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/aasm_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
+
+# AASM code provided by Ana Nelson (http://ananelson.com/)
+
+require 'app_diagram'
+
+# 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(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/app_diagram.rb

@@ -0,0 +1,90 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+require 'diagram_graph'
+
+# 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(filename)
+    #filename.split('/')[2..-1].join('/').split('.').first.camelize
+    # Fixed by patch from ticket #12742
+    # File.basename(filename).chomp(".rb").camelize
+    filename.split('/')[2..-1].collect { |i| i.camelize }.join('::').chomp(".rb")
+  end
+
+end # class AppDiagram

data/lib/controllers_diagram.rb

@@ -0,0 +1,88 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+require 'app_diagram'
+
+# RailRoad controllers diagram
+class ControllersDiagram < AppDiagram
+ 
+  # as of Rails 2.3 the file is no longer application.rb but instead
+  # application_controller.rb
+  APP_CONTROLLER = File.exist?('app/controllers/application.rb') ? 'app/controllers/application.rb' : 'app/controllers/application_controller.rb'
+
+  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
+    # only add APP_CONTROLLER if it isn't already included from the glob above
+    files << APP_CONTROLLER unless files.include? APP_CONTROLLER
+    files.each do |f|
+      class_name = extract_class_name(f)
+      # ApplicationController's file is 'application.rb' in Rails < 2.3
+      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_CONTROLLER
+      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

data/lib/diagram_graph.rb

@@ -0,0 +1,133 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+
+# RailRoad diagram structure
+class DiagramGraph
+
+  def initialize
+    @diagram_type = ''
+    @show_label = false
+    @nodes = []
+    @edges = []
+  end 
+
+  def add_node(node)
+    @nodes << node
+  end
+
+  def add_edge(edge)
+    @edges << edge
+  end
+  
+  def diagram_type= (type)
+    @diagram_type = type
+  end
+
+  def show_label= (value)
+    @show_label = value
+  end
+
+
+  # Generate DOT graph
+  def to_dot
+    return dot_header +
+           @nodes.map{|n| dot_node n[0], n[1], n[2]}.join +
+           @edges.map{|e| dot_edge e[0], e[1], e[2], e[3]}.join +
+           dot_footer
+  end
+  
+  # Generate XMI diagram (not yet implemented)
+  def to_xmi
+     STDERR.print "Sorry. XMI output not yet implemented.\n\n"
+     return ""
+  end
+
+  private
+
+  # Build DOT diagram header
+  def dot_header
+    result = "digraph #{@diagram_type.downcase}_diagram {\n" +
+             "\tgraph[overlap=false, splines=true]\n"
+    result += dot_label if @show_label
+    return result
+  end
+
+  # Build DOT diagram footer
+  def dot_footer
+    return "}\n"
+  end
+  
+  # Build diagram label
+  def dot_label
+    return "\t_diagram_info [shape=\"plaintext\", " +
+           "label=\"#{@diagram_type} diagram\\l" +
+           "Date: #{Time.now.strftime "%b %d %Y - %H:%M"}\\l" + 
+           "Migration version: " +
+           "#{ActiveRecord::Migrator.current_version}\\l" +
+           "Generated by #{APP_HUMAN_NAME} #{APP_VERSION.join('.')}"+
+           "\\l\", fontsize=14]\n"
+  end
+
+  # Build a DOT graph node
+  def dot_node(type, name, attributes=nil)
+    case type
+      when 'model'
+           options = 'shape=Mrecord, label="{' + name + '|'
+           options += attributes.join('\l')
+           options += '\l}"'
+      when 'model-brief'
+           options = ''
+      when 'class'
+           options = 'shape=record, label="{' + name + '|}"' 
+      when 'class-brief'
+           options = 'shape=box' 
+      when 'controller'
+           options = 'shape=Mrecord, label="{' + name + '|'
+           public_methods    = attributes[:public].join('\l')
+           protected_methods = attributes[:protected].join('\l')
+           private_methods   = attributes[:private].join('\l')
+           options += public_methods + '\l|' + protected_methods + '\l|' + 
+                      private_methods + '\l'
+           options += '}"'
+      when 'controller-brief'
+           options = '' 
+      when 'module'
+           options = 'shape=box, style=dotted, label="' + name + '"'
+      when 'aasm'
+           # Return subgraph format
+           return "subgraph cluster_#{name.downcase} {\n\tlabel = #{quote(name)}\n\t#{attributes.join("\n  ")}}"
+    end # case
+    return "\t#{quote(name)} [#{options}]\n"
+  end # dot_node
+
+  # Build a DOT graph edge
+  def dot_edge(type, from, to, name = '')
+    options =  name != '' ? "label=\"#{name}\", " : ''
+    case type
+      when 'one-one'
+           #options += 'taillabel="1"'
+           options += 'arrowtail=odot, arrowhead=dot, dir=both'
+      when 'one-many'
+	   #options += 'taillabel="n"'
+           options += 'arrowtail=crow, arrowhead=dot, dir=both'                    
+      when 'many-many'
+           #options += 'taillabel="n", headlabel="n", arrowtail="normal"'
+           options += 'arrowtail=crow, arrowhead=crow, dir=both'
+      when 'is-a'
+           options += 'arrowhead="none", arrowtail="onormal"'
+      when 'event'
+           options += "fontsize=10"
+    end
+    return "\t#{quote(from)} -> #{quote(to)} [#{options}]\n"
+  end # dot_edge
+
+  # Quotes a class name
+  def quote(name)
+    '"' + name.to_s + '"'
+  end
+  
+end # class DiagramGraph

data/lib/models_diagram.rb

@@ -0,0 +1,155 @@
+# RailRoad - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+require 'app_diagram'
+
+# RailRoad models diagram
+class ModelsDiagram < AppDiagram
+
+  def initialize(options)
+    #options.exclude.map! {|e| "app/models/" + e}
+    super options 
+    @graph.diagram_type = 'Models'
+    # Processed habtm associations
+    @habtm = []
+  end
+
+  # Process model files
+  def generate
+    STDERR.print "Generating models 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(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
+
+    generated = false
+        
+    # Is current_clas derived from ActiveRecord::Base?
+    if current_class.respond_to?'reflect_on_all_associations'
+
+
+      node_attribs = []
+      if @options.brief || current_class.abstract_class?
+        node_type = 'model-brief'
+      else 
+        node_type = 'model'
+
+        # Collect model's content columns
+
+	content_columns = current_class.content_columns
+	
+	if @options.hide_magic 
+          # From patch #13351
+          # http://wiki.rubyonrails.org/rails/pages/MagicFieldNames
+          magic_fields = [
+          "created_at", "created_on", "updated_at", "updated_on",
+          "lock_version", "type", "id", "position", "parent_id", "lft", 
+          "rgt", "quote", "template"
+          ]
+          magic_fields << current_class.table_name + "_count" if current_class.respond_to? 'table_name' 
+          content_columns = current_class.content_columns.select {|c| ! magic_fields.include? c.name}
+        else
+          content_columns = current_class.content_columns
+        end
+        
+        content_columns.each do |a|
+          content_column = a.name
+          content_column += ' :' + a.type.to_s unless @options.hide_types
+          node_attribs << content_column
+        end
+      end
+      @graph.add_node [node_type, current_class.name, node_attribs]
+      generated = true
+      # Process class associations
+      associations = current_class.reflect_on_all_associations
+      if @options.inheritance && ! @options.transitive
+        superclass_associations = current_class.superclass.reflect_on_all_associations
+        
+        associations = associations.select{|a| ! superclass_associations.include? a} 
+        # This doesn't works!
+        # associations -= current_class.superclass.reflect_on_all_associations
+      end
+      associations.each do |a|
+        process_association current_class.name, a
+      end
+    elsif @options.all && (current_class.is_a? Class)
+      # Not ActiveRecord::Base model
+      node_type = @options.brief ? 'class-brief' : 'class'
+      @graph.add_node [node_type, current_class.name]
+      generated = true
+    elsif @options.modules && (current_class.is_a? Module)
+        @graph.add_node ['module', current_class.name]
+    end
+
+    # Only consider meaningful inheritance relations for generated classes
+    if @options.inheritance && generated && 
+       (current_class.superclass != ActiveRecord::Base) &&
+       (current_class.superclass != Object)
+      @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
+    end      
+
+  end # process_class
+
+  # Process a model association
+  def process_association(class_name, assoc)
+
+    STDERR.print "\t\tProcessing model association #{assoc.name.to_s}\n" if @options.verbose
+
+    # Skip "belongs_to" associations
+    return if assoc.macro.to_s == 'belongs_to'
+
+    # Only non standard association names needs a label
+    
+    # from patch #12384
+    # if assoc.class_name == assoc.name.to_s.singularize.camelize
+    assoc_class_name = (assoc.class_name.respond_to? 'underscore') ? assoc.class_name.underscore.singularize.camelize : assoc.class_name 
+    if assoc_class_name == assoc.name.to_s.singularize.camelize
+      assoc_name = ''
+    else
+      assoc_name = assoc.name.to_s
+    end 
+
+    if assoc.macro.to_s == 'has_one' 
+      assoc_type = 'one-one'
+    elsif assoc.macro.to_s == 'has_many' && (! assoc.options[:through])
+      assoc_type = 'one-many'
+    else # habtm or has_many, :through
+      return if @habtm.include? [assoc.class_name, class_name, assoc_name]
+      assoc_type = 'many-many'
+      @habtm << [class_name, assoc.class_name, assoc_name]
+    end  
+    # from patch #12384    
+    # @graph.add_edge [assoc_type, class_name, assoc.class_name, assoc_name]
+    @graph.add_edge [assoc_type, class_name, assoc_class_name, assoc_name]    
+  end # process_association
+
+end # class ModelsDiagram