railroad 0.4.1 → 0.5.0

data/ChangeLog

@@ -1,5 +1,20 @@
+Version 0.5.0 (may 10 2008)
+- Changed model relationships representation (feature request #10898)
+- Added support for plugins models (-p) (feature request #12742 by 
+  Chris Richards). Thanks to Elliot Smith.
+- Added support for irregular inflexions (from patch #12384). Thanks 
+  to Juan Ignacio Pumarino.
+- Added hidding of magic fields (--hide-magic) (from patch #13351)
+  Thanks to Hajime Baba.
+- Added -r option to set the application root path (request #12801).
+- The -e flag now requires full path to excluded files.
+- Added support for state machine diagram ("acts as state machine" plugin).
+  Thanks to Ana Nelson (she did all the work!).
+
+
 Version 0.4.1 (may 9 2008)
-- Fix a bug (class name treated as String).
+- Fix bug #17852 (class name treated as String).
+
 
 Version 0.4.0 (apr 25 2007)
 - Draw inheritance edges in reverse way

data/README

@@ -18,9 +18,7 @@ controller diagrams are best processed using neato.
 Common options:
     -b, --brief                      Generate compact diagram
                                        (no attributes nor methods)
-    -e, --exclude file1[,fileN]      Exclude files
-                                       (relative path to 'app/models/' or
-                                        'app/controllers/')
+    -e, --exclude file1[,fileN]      Exclude given files
     -i, --inheritance                Include inheritance relations
     -l, --label                      Add a label with diagram information
                                        (type, date, migration, version)
@@ -31,9 +29,11 @@ Common options:
 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)
 
@@ -50,6 +50,7 @@ Other options:
 
     -M, --models                     Generate models diagram
     -C, --controllers                Generate controllers diagram
+    -A, --aasm                       Generate "acts as state machine" diagram
 
 
 == Examples

data/bin/railroad

@@ -6,7 +6,7 @@
 #   RailRoad generates models and controllers diagrams in DOT language
 #   for a Rails application.
 #
-# Copyright 2007 - Javier Smaldone (http://www.smaldone.com.ar)
+# 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
@@ -16,21 +16,28 @@
 
 APP_NAME       = "railroad"
 APP_HUMAN_NAME = "RailRoad"
-APP_VERSION    = [0,4,1]
-COPYRIGHT      = "Copyright (C) 2007 Javier Smaldone"
+APP_VERSION    = [0,5,0]
+COPYRIGHT      = "Copyright (C) 2007-2008 Javier Smaldone"
 
 require 'railroad/options_struct'
 require 'railroad/models_diagram'
 require 'railroad/controllers_diagram'
+require 'railroad/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"
@@ -38,4 +45,8 @@ else
 end
 
 diagram.generate
+
+Dir.chdir(old_dir)
+
 diagram.print
+

data/lib/railroad/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 'railroad/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/railroad/app_diagram.rb

@@ -1,7 +1,7 @@
 # RailRoad - RoR diagrams generator
 # http://railroad.rubyforge.org
 #
-# Copyright 2007 - Javier Smaldone (http://www.smaldone.com.ar)
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
 # See COPYING for more details
 
 require 'railroad/diagram_graph'
@@ -81,7 +81,9 @@ class AppDiagram
 
   # Extract class name from filename
   def extract_class_name(filename)
-    filename.split('/')[2..-1].join('/').split('.').first.camelize
+    #filename.split('/')[2..-1].join('/').split('.').first.camelize
+    # Fixed by patch from ticket #12742
+    File.basename(filename).chomp(".rb").camelize
   end
 
 end # class AppDiagram

data/lib/railroad/controllers_diagram.rb

@@ -1,7 +1,7 @@
 # RailRoad - RoR diagrams generator
 # http://railroad.rubyforge.org
 #
-# Copyright 2007 - Javier Smaldone (http://www.smaldone.com.ar)
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
 # See COPYING for more details
 
 require 'railroad/app_diagram'
@@ -10,7 +10,7 @@ require 'railroad/app_diagram'
 class ControllersDiagram < AppDiagram
  
   def initialize(options)
-    options.exclude.map! {|e| "app/controllers/" + e}
+    #options.exclude.map! {|e| "app/controllers/" + e}
     super options
     @graph.diagram_type = 'Controllers'
   end

data/lib/railroad/diagram_graph.rb

@@ -1,7 +1,7 @@
 # RailRoad - RoR diagrams generator
 # http://railroad.rubyforge.org
 #
-# Copyright 2007 - Javier Smaldone (http://www.smaldone.com.ar)
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
 # See COPYING for more details
 
 
@@ -97,6 +97,9 @@ class DiagramGraph
            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
@@ -106,13 +109,18 @@ class DiagramGraph
     options =  name != '' ? "label=\"#{name}\", " : ''
     case type
       when 'one-one'
-           options += 'taillabel="1"'
+           #options += 'taillabel="1"'
+           options += 'arrowtail=odot, arrowhead=dot, dir=both'
       when 'one-many'
-           options += 'taillabel="n"'                    
+	   #options += 'taillabel="n"'
+           options += 'arrowtail=crow, arrowhead=dot, dir=both'                    
       when 'many-many'
-           options += 'taillabel="n", headlabel="n", arrowtail="normal"'
+           #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

data/lib/railroad/models_diagram.rb

@@ -1,7 +1,7 @@
 # RailRoad - RoR diagrams generator
 # http://railroad.rubyforge.org
 #
-# Copyright 2007 - Javier Smaldone (http://www.smaldone.com.ar)
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
 # See COPYING for more details
 
 require 'railroad/app_diagram'
@@ -10,7 +10,7 @@ require 'railroad/app_diagram'
 class ModelsDiagram < AppDiagram
 
   def initialize(options)
-    options.exclude.map! {|e| "app/models/" + e}
+    #options.exclude.map! {|e| "app/models/" + e}
     super options 
     @graph.diagram_type = 'Models'
     # Processed habtm associations
@@ -20,7 +20,9 @@ class ModelsDiagram < AppDiagram
   # Process model files
   def generate
     STDERR.print "Generating models diagram\n" if @options.verbose
-    files = Dir.glob("app/models/**/*.rb") - @options.exclude
+    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
@@ -32,7 +34,9 @@ class ModelsDiagram < AppDiagram
   def load_classes
     begin
       disable_stdout
-      files = Dir.glob("app/models/**/*.rb") - @options.exclude
+      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
@@ -48,16 +52,36 @@ class ModelsDiagram < AppDiagram
     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
-        current_class.content_columns.each do |a|
+
+	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
@@ -104,7 +128,11 @@ class ModelsDiagram < AppDiagram
     return if assoc.macro.to_s == 'belongs_to'
 
     # Only non standard association names needs a label
-    if assoc.class_name == assoc.name.to_s.singularize.camelize
+    
+    # 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
@@ -119,7 +147,9 @@ class ModelsDiagram < AppDiagram
       assoc_type = 'many-many'
       @habtm << [class_name, assoc.class_name, assoc_name]
     end  
-    @graph.add_edge [assoc_type, class_name, assoc.class_name, assoc_name]
+    # 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

data/lib/railroad/options_struct.rb

@@ -1,7 +1,7 @@
 # RailRoad - RoR diagrams generator
 # http://railroad.rubyforge.org
 #
-# Copyright 2007 - Javier Smaldone (http://www.smaldone.com.ar)
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
 # See COPYING for more details
 
 require 'ostruct'
@@ -19,10 +19,13 @@ class OptionsStruct < OpenStruct
                      :join => false,
                      :label => false,
                      :modules => false,
+                     :hide_magic => false,
                      :hide_types => false,
                      :hide_public => false,
                      :hide_protected => false,
                      :hide_private => false,
+                     :plugins_models => false,
+                     :root => '',
                      :transitive => false,
                      :verbose => false,
                      :xmi => false,
@@ -39,8 +42,7 @@ class OptionsStruct < OpenStruct
               "  (no attributes nor methods)") do |b|
         self.brief = b
       end
-      opts.on("-e", "--exclude file1[,fileN]", Array, "Exclude files", 
-              "  (relative path to 'app/models/' or", "   'app/controllers/')") do |list|
+      opts.on("-e", "--exclude file1[,fileN]", Array, "Exclude given files") do |list|
         self.exclude = list
       end
       opts.on("-i", "--inheritance", "Include inheritance relations") do |i|
@@ -53,6 +55,9 @@ class OptionsStruct < OpenStruct
       opts.on("-o", "--output FILE", "Write diagram to file FILE") do |f|
         self.output = f
       end
+      opts.on("-r", "--root PATH", "Set PATH as the application root") do |r|
+        self.root = r
+      end
       opts.on("-v", "--verbose", "Enable verbose output", 
               "  (produce messages to STDOUT)") do |v|
         self.verbose = v
@@ -67,6 +72,9 @@ class OptionsStruct < OpenStruct
               "  (not only ActiveRecord::Base derived)") do |a|
         self.all = a
       end
+      opts.on("--hide-magic", "Hide magic field names") do |h|
+        self.hide_magic = h
+      end
       opts.on("--hide-types", "Hide attributes type") do |h|
         self.hide_types = h
       end
@@ -76,6 +84,9 @@ class OptionsStruct < OpenStruct
       opts.on("-m", "--modules", "Include modules") do |m|
         self.modules = m
       end
+      opts.on("-p", "--plugins-models", "Include plugins models") do |p|
+        self.plugins_models = p
+      end
       opts.on("-t", "--transitive", "Include transitive associations",
               "(through inheritance)") do |t|
         self.transitive = t
@@ -106,26 +117,33 @@ class OptionsStruct < OpenStruct
       opts.separator ""
       opts.separator "Commands (you must supply one of these):"
       opts.on("-M", "--models", "Generate models diagram") do |c|
-        if self.command == 'controllers'
-          STDERR.print "Error: Can't generate models AND " + 
-                       "controllers diagram\n\n"
+        if self.command != ''
+          STDERR.print "Error: Can only generate one diagram type\n\n"
           exit 1
         else 
           self.command = 'models'        
         end
       end 
       opts.on("-C", "--controllers", "Generate controllers diagram") do |c|
-        if self.command == 'models'
-          STDERR.print "Error: Can't generate models AND " +
-                       "controllers diagram\n\n"
+        if self.command != ''
+          STDERR.print "Error: Can only generate one diagram type\n\n"
           exit 1
         else 
           self.command = 'controllers'        
         end
       end
+      # From Ana Nelson's patch
+      opts.on("-A", "--aasm", "Generate \"acts as state machine\" diagram") do |c|
+        if self.command == 'controllers'
+          STDERR.print "Error: Can only generate one diagram type\n\n"
+          exit 1
+        else    
+          self.command = 'aasm'
+        end
+      end        
       opts.separator ""
       opts.separator "For bug reporting and additional information, please see:"
-      opts.separator "http://railroad.rubyforge.org"
+      opts.separator "http://railroad.rubyforge.org/"
     end # do
 
     begin

data/rake.gemspec

@@ -1,10 +1,11 @@
 require 'rubygems'
 SPEC = Gem::Specification.new do |s|
   s.name         = "railroad"
-  s.version      = "0.4.1"
+  s.version      = "0.5.0"
   s.author       = "Javier Smaldone"
   s.email        = "javier@smaldone.com.ar"
   s.homepage     = "http://railroad.rubyforge.org"
+  s.rubyforge_project = "railroad"
   s.platform     = Gem::Platform::RUBY
   s.summary      = "A DOT diagram generator for Ruby on Rail applications"
   s.files        = Dir.glob("lib/railroad/*.rb") + 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: railroad
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Javier Smaldone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-09 00:00:00 -03:00
+date: 2008-05-10 00:00:00 -03:00
 default_executable: railroad
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - README
 - COPYING
 files: 
+- lib/railroad/aasm_diagram.rb
 - lib/railroad/models_diagram.rb
 - lib/railroad/app_diagram.rb
 - lib/railroad/controllers_diagram.rb
@@ -53,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: railroad
 rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2