ddollar-railroad 0.7.3 → 0.7.6

data/Manifest.txt

@@ -13,5 +13,6 @@ lib/railroad/controllers_diagram.rb
 lib/railroad/diagram_graph.rb
 lib/railroad/models_diagram.rb
 lib/railroad/options_struct.rb
+lib/railroad/tasks/diagrams.rake
+lib/railroad/tasks/diagrams.rb
 railroad.gemspec
-tasks/diagrams.rake

data/README.txt

@@ -103,7 +103,10 @@ also use Omnigraffle (on Mac OS X).
 
 = RailRoad as a rake task
 
-See tasks/diagrams.rake
+See lib/railroad/tasks/diagrams.rake
+
+You can also add the following line in the Rakefile in your project:
+require 'railroad/tasks/diagrams' if RAILS_ENV == 'development'
 
 = Requirements
 
@@ -136,3 +139,5 @@ Tien Dung           http://github.com/tiendung
 Factory Design Labs http://github.com/factorylabs
 Mike Mondragon      http://github.com/monde
 Tero Tilus          http://github.com/terotil
+Bruno Michel        http://github.com/nono
+

data/lib/railroad.rb

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

data/lib/railroad/aasm_diagram.rb

@@ -28,7 +28,7 @@ class AasmDiagram < AppDiagram
     end
   end
   
-  private
+private
   
   # Load model classes
   def load_classes
@@ -37,7 +37,7 @@ class AasmDiagram < AppDiagram
       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 }
+      files.each {|file| get_model_class(file) }
       enable_stdout
     rescue LoadError
       enable_stdout
@@ -46,25 +46,56 @@ class AasmDiagram < AppDiagram
     end
   end  # load_classes
 
+  # This method is taken from the annotate models gem
+  # http://github.com/ctran/annotate_models/tree/master
+  #
+  # Retrieve the classes belonging to the model names we're asked to process
+  # Check for namespaced models in subdirectories as well as models
+  # in subdirectories without namespacing.
+  def get_model_class(file)
+    model = file.sub(/^.*app\/models\//, '').sub(/\.rb$/, '').camelize
+    parts = model.split('::')
+    begin
+      parts.inject(Object) {|klass, part| klass.const_get(part) }
+    rescue LoadError
+      Object.const_get(parts.last)
+    end
+  end
+
   # Process a model class
   def process_class(current_class)
     
     STDERR.print "\tProcessing #{current_class}\n" if @options.verbose
-    
+
+    states = nil
+    if current_class.respond_to? 'states'
+      states  = current_class.states
+      initial = current_class.initial_state
+      events  = current_class.read_inheritable_attribute(:transition_table)
+    elsif current_class.respond_to? 'aasm_states'
+      states  = current_class.aasm_states.map { |s| s.name }
+      initial = current_class.aasm_initial_state
+      events  = current_class.aasm_events
+    end
+
     # Only interested in acts_as_state_machine models.
-    return unless current_class.respond_to?'states'
-    
+    return if states.nil? || states.empty?
+
     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" : ""
+
+    states.each do |state_name|
+      node_shape = (initial === 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|
+    events.each do |event_name, event|
+      if !event.respond_to?('each')
+        def event.each(&blk)
+          @transitions.each { |t| blk.call(t) }
+        end
+      end
       event.each do |transition|
         @graph.add_edge [
           'event', 

data/lib/railroad/controllers_diagram.rb

@@ -30,10 +30,8 @@ class ControllersDiagram < AppDiagram
   def load_classes
     begin
       disable_stdout
-      # ApplicationController must be loaded first
-      require "app/controllers/application_controller.rb"
       files = Dir.glob("app/controllers/**/*_controller.rb") - @options.exclude
-      files.each {|c| require c }
+      files.each {|file| get_controller_class(file) }
       enable_stdout
     rescue LoadError
       enable_stdout
@@ -42,6 +40,22 @@ class ControllersDiagram < AppDiagram
     end
   end # load_classes
 
+  # This method is taken from the annotate models gem
+  # http://github.com/ctran/annotate_models/tree/master
+  #
+  # Retrieve the classes belonging to the controller names we're asked to process
+  # Check for namespaced controllers in subdirectories as well as controllers
+  # in subdirectories without namespacing.
+  def get_controller_class(file)
+    model = file.sub(/^.*app\/controllers\//, '').sub(/\.rb$/, '').camelize
+    parts = model.split('::')
+    begin
+      parts.inject(Object) {|klass, part| klass.const_get(part) }
+    rescue LoadError
+      Object.const_get(parts.last)
+    end
+  end
+
   # Proccess a controller class
   def process_class(current_class)
 

data/lib/railroad/models_diagram.rb

@@ -63,9 +63,7 @@ class ModelsDiagram < AppDiagram
       files = Dir.glob("app/models/**/*.rb")
       files += Dir.glob("vendor/plugins/**/app/models/*.rb") if @options.plugins_models
       files -= @options.exclude
-      files.each do |m|
-        require m
-      end
+      files.each {|file| get_model_class(file) }
       enable_stdout
     rescue LoadError
       enable_stdout
@@ -74,6 +72,22 @@ class ModelsDiagram < AppDiagram
     end
   end  # load_classes
 
+  # This method is taken from the annotate models gem
+  # http://github.com/ctran/annotate_models/tree/master
+  #
+  # Retrieve the classes belonging to the model names we're asked to process
+  # Check for namespaced models in subdirectories as well as models
+  # in subdirectories without namespacing.
+  def get_model_class(file)
+    model = file.sub(/^.*app\/models\//, '').sub(/\.rb$/, '').camelize
+    parts = model.split('::')
+    begin
+      parts.inject(Object) {|klass, part| klass.const_get(part) }
+    rescue LoadError
+      Object.const_get(parts.last)
+    end
+  end
+
   # Process a model class
   def process_class(current_class)
 

data/lib/railroad/tasks/diagrams.rake

@@ -0,0 +1,35 @@
+namespace :doc do
+  namespace :diagrams do
+    desc "Draw model diagrams"
+    task :models do
+      doc_diagrams_generate('models', '-a -m -M', 'neato')
+    end
+
+    desc "Draw controller diagrams"
+    task :controllers do
+      doc_diagrams_generate('controllers', '-C', 'neato')
+    end
+
+    desc "Draw states diagrams"
+    task :states do
+      doc_diagrams_generate('states', '-A', 'dot')
+    end
+  end
+
+  desc "Draw controllers, models & states diagrams"
+  task :diagrams => %w(diagrams:models diagrams:controllers diagrams:states)
+end
+
+
+def doc_diagrams_generate(type, options, dot_cmd)
+  railroad = "railroad" # or "./vendor/plugins/railroad/bin/railroad"
+  options = "-v -j -l -i #{options}"
+  output_dir = "doc/diagrams"
+
+  FileUtils.mkdir(output_dir) unless File.exist?(output_dir)
+
+  sh "#{railroad} -o #{output_dir}/#{type}.dot #{options}"
+  sh "#{dot_cmd} -Tpng #{output_dir}/#{type}.dot -o #{output_dir}/#{type}.png"
+  sh "#{dot_cmd} -Tsvg #{output_dir}/#{type}.dot | sed 's/font-size:14.00/font-size:11px/g' > #{output_dir}/#{type}.svg"
+end
+

data/lib/railroad/tasks/diagrams.rb

@@ -0,0 +1 @@
+load 'railroad/tasks/diagrams.rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ddollar-railroad
 version: !ruby/object:Gem::Version 
-  version: 0.7.3
+  version: 0.7.6
 platform: ruby
 authors: 
 - Javier Smaldone
@@ -11,11 +11,12 @@ authors:
 - Mike Mondragon
 - Tero Tilus
 - David Dollar
+- Bruno Michel
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-18 00:00:00 -08:00
+date: 2009-03-14 00:00:00 -07:00
 default_executable: railroad
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.7.0
     version: 
-description: ""
+description: RailRoad is a class diagrams generator for Ruby on Rails applications.
 email: javier@smaldone.com.ar
 executables: 
 - railroad
@@ -54,7 +55,8 @@ files:
 - lib/railroad/diagram_graph.rb
 - lib/railroad/models_diagram.rb
 - lib/railroad/options_struct.rb
-- tasks/diagrams.rake
+- lib/railroad/tasks/diagrams.rb
+- lib/railroad/tasks/diagrams.rake
 has_rdoc: true
 homepage: http://railroad.rubyforge.org
 post_install_message: 

data/tasks/diagrams.rake

@@ -1,35 +0,0 @@
-namespace :doc do
-  namespace :diagram do
-    desc "Draw model diagram"
-    task :models do
-      classmap = {
-#        'app/models/model_with_nasty_name' => 'ModelWithNastyNAME',
-      }.to_a.join(',')
-      exclude =
-        [
-#         'app/models/model_to_exclude.rb',
-        ].join(',')
-      opts =
-        [
-         '--models',
-         '--inheritance',
-         '--label',
-         '--all',
-         '--modules',
-#         '--libraries',
-#         '--verbose',
-        ].join(' ')
-      FileUtils.mkdir('doc/app') unless File.exist?('doc/app')
-      sh "railroad #{opts} --class-map=#{classmap} --exclude=#{exclude} | dot -Tsvg | sed 's/font-size:14.00/font-size:11px/g' > doc/app/models.svg"
-    end
-
-    desc "Draw controller diagram"
-    task :controllers do
-      FileUtils.mkdir('doc/app') unless File.exist?('doc/app')
-      sh "railroad -i -C | neato -Tsvg | sed 's/font-size:14.00/font-size:11px/g' > doc/app/controllers.svg"
-    end
-  end
-
-  desc "Draw model & controller diagrams"
-  task :diagrams => %w(diagram:models diagram:controllers)
-end