railroad 0.3.4 → 0.4.0

data/ChangeLog

@@ -1,3 +1,13 @@
+Version 0.4.0 (apr 25 2007)
+- Draw inheritance edges in reverse way
+  (from superclass to subclass, with an arrow in the tail)
+  This improves how 'dot' renders the graph
+- By default, don't draw transitive inherited associations
+- Added --transitive flag to draw transitive inherited associations
+- Added --exclude flag for ommiting classes (this may help to produce
+  diagrams for applications with broken classes)
+
+
 Version 0.3.4 (apr 12 2007)
 - Add support for model abstract classes.
   (don't try to get content columns, bug #10033)

data/README

@@ -18,6 +18,9 @@ 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/')
     -i, --inheritance                Include inheritance relations
     -l, --label                      Add a label with diagram information
                                        (type, date, migration, version)
@@ -31,6 +34,8 @@ Models diagram options:
         --hide-types                 Hide attributes type
     -j, --join                       Concentrate edges
     -m, --modules                    Include modules
+    -t, --transitive                 Include transitive associations
+                                     (through inheritance)
 
 Controllers diagram options:
         --hide-public                Hide public methods
@@ -82,12 +87,36 @@ the following:
 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;".
+"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
 

data/bin/railroad

@@ -16,7 +16,7 @@
 
 APP_NAME       = "railroad"
 APP_HUMAN_NAME = "RailRoad"
-APP_VERSION    = [0,3,4]
+APP_VERSION    = [0,4,0]
 COPYRIGHT      = "Copyright (C) 2007 Javier Smaldone"
 
 require 'railroad/options_struct'

data/lib/railroad/controllers_diagram.rb

@@ -10,6 +10,7 @@ require 'railroad/app_diagram'
 class ControllersDiagram < AppDiagram
  
   def initialize(options)
+    options.exclude.map! {|e| e = "app/controllers/" + e}
     super options
     @graph.diagram_type = 'Controllers'
   end
@@ -18,7 +19,7 @@ class ControllersDiagram < AppDiagram
   def generate
     STDERR.print "Generating controllers diagram\n" if @options.verbose
 
-    files = Dir.glob("app/controllers/**/*_controller.rb")
+    files = Dir.glob("app/controllers/**/*_controller.rb") - @options.exclude
     files << 'app/controllers/application.rb'
     files.each do |f|
       class_name = extract_class_name(f)
@@ -36,7 +37,8 @@ class ControllersDiagram < AppDiagram
       disable_stdout
       # ApplicationController must be loaded first
       require "app/controllers/application.rb" 
-      Dir.glob("app/controllers/**/*_controller.rb") {|c| require c }
+      files = Dir.glob("app/controllers/**/*_controller.rb") - @options.exclude
+      files.each {|c| require c }
       enable_stdout
     rescue LoadError
       enable_stdout
@@ -74,7 +76,8 @@ class ControllersDiagram < AppDiagram
     # Generate the inheritance edge (only for ApplicationControllers)
     if @options.inheritance && 
        (ApplicationController.subclasses.include? current_class.name)
-      @graph.add_edge ['is-a', current_class.name, current_class.superclass.name]
+       # REVERSE INHERITANCE (CHECK)
+      @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
     end
   end # process_class
 

data/lib/railroad/diagram_graph.rb

@@ -106,7 +106,9 @@ class DiagramGraph
       when 'many-many'
            options += 'taillabel="n", headlabel="n", arrowtail="normal"'
       when 'is-a'
-           options += 'arrowhead="onormal"'
+# REVERSE INHERITANCE (CHECK)
+#           options += 'arrowhead="onormal"'
+           options += 'arrowhead="none", arrowtail="onormal"'
     end
     return "\t#{quote(from)} -> #{quote(to)} [#{options}]\n"
   end # dot_edge

data/lib/railroad/models_diagram.rb

@@ -10,6 +10,7 @@ require 'railroad/app_diagram'
 class ModelsDiagram < AppDiagram
 
   def initialize(options)
+    options.exclude.map! {|e| e = "app/models/" + e}
     super options 
     @graph.diagram_type = 'Models'
     # Processed habtm associations
@@ -19,7 +20,7 @@ class ModelsDiagram < AppDiagram
   # Process model files
   def generate
     STDERR.print "Generating models diagram\n" if @options.verbose
-    files = Dir.glob("app/models/**/*.rb")
+    files = Dir.glob("app/models/**/*.rb") - @options.exclude
     files.each do |f| 
       process_class extract_class_name(f).constantize
     end
@@ -31,7 +32,8 @@ class ModelsDiagram < AppDiagram
   def load_classes
     begin
       disable_stdout
-      Dir.glob("app/models/**/*.rb") {|m| require m }
+      files = Dir.glob("app/models/**/*.rb") - @options.exclude
+      files.each {|m| require m }
       enable_stdout
     rescue LoadError
       enable_stdout
@@ -64,7 +66,15 @@ class ModelsDiagram < AppDiagram
       @graph.add_node [node_type, current_class.name, node_attribs]
       generated = true
       # Process class associations
-      current_class.reflect_on_all_associations.each do |a|
+      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)
@@ -80,7 +90,8 @@ class ModelsDiagram < AppDiagram
     if @options.inheritance && generated && 
        (current_class.superclass != ActiveRecord::Base) &&
        (current_class.superclass != Object)
-      @graph.add_edge ['is-a', current_class.name, current_class.superclass.name]
+       # REVERSE INHERITANCE (CHECK)
+      @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
     end      
 
   end # process_class

data/lib/railroad/options_struct.rb

@@ -14,6 +14,7 @@ class OptionsStruct < OpenStruct
   def initialize
     init_options = { :all => false,
                      :brief => false,
+                     :exclude => [],
                      :inheritance => false,
                      :join => false,
                      :label => false,
@@ -22,7 +23,9 @@ class OptionsStruct < OpenStruct
                      :hide_public => false,
                      :hide_protected => false,
                      :hide_private => false,
+                     :transitive => false,
                      :verbose => false,
+                     # :xmi => false,
                      :command => '' }
     super(init_options)
   end # initialize
@@ -36,6 +39,10 @@ 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|
+        self.exclude = list
+      end
       opts.on("-i", "--inheritance", "Include inheritance relations") do |i|
         self.inheritance = i
       end
@@ -50,6 +57,11 @@ class OptionsStruct < OpenStruct
               "  (produce messages to STDOUT)") do |v|
         self.verbose = v
       end
+      # TODO: Add XMI output.
+      # opts.on("-x", "--xmi", "Produce XMI instead of DOT", 
+      #         "  (for UML tools)") do |x|
+      #   self.xmi = x
+      # end
       opts.separator ""
       opts.separator "Models diagram options:"
       opts.on("-a", "--all", "Include all models", 
@@ -65,6 +77,10 @@ class OptionsStruct < OpenStruct
       opts.on("-m", "--modules", "Include modules") do |m|
         self.modules = m
       end
+      opts.on("-t", "--transitive", "Include transitive associations",
+              "(through inheritance)") do |t|
+        self.transitive = t
+      end
       opts.separator ""
       opts.separator "Controllers diagram options:"
       opts.on("--hide-public", "Hide public methods") do |h|
@@ -123,8 +139,6 @@ class OptionsStruct < OpenStruct
       option_error "Invalid argument"
     rescue OptionParser::MissingArgument
       option_error "Missing argument"
-    rescue
-      option_error "Unknown error"
     end
   end  # parse
 

data/rake.gemspec

@@ -1,7 +1,7 @@
 require 'rubygems'
 SPEC = Gem::Specification.new do |s|
   s.name         = "railroad"
-  s.version      = "0.3.4"
+  s.version      = "0.4.0"
   s.author       = "Javier Smaldone"
   s.email        = "javier@smaldone.com.ar"
   s.homepage     = "http://railroad.rubyforge.org"

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: railroad
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
-date: 2007-04-12 00:00:00 -03:00
+  version: 0.4.0
+date: 2007-04-25 00:00:00 -03:00
 summary: A DOT diagram generator for Ruby on Rail applications
 require_paths: 
 - lib