railroady 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f5ab1921e48623ca0993f9c7ca08186802204b3
-  data.tar.gz: eb23360fc687b72eddcba86d3eba896a2b3d791c
+  metadata.gz: 2c445e74b5659404f61ab558a1bf02f496d7b34c
+  data.tar.gz: f5a44d738815114e732b44c650129ff6870a710f
 SHA512:
-  metadata.gz: 5956104262321ebcde50f24d5eee2b6a043f9a7972b613a041270d55851b811cc169ee32d8ef5fecbbe67a1e3d5a8abc86ae78efa0e8cd35a456b76289d24841
-  data.tar.gz: c64b8551d6d1824a01193862f1b188166197b3825d12576aa08eba471d7e6ea0df8f1c25747d592a29c32fc6c5d7b0fcb557728f39edfb232d3c6ef70500369d
+  metadata.gz: 7fe0e9ecb631a4482179083fd47cbe75316ea3cfa39c48e6df315a802108336d6dba8b9ff94670125be8cc2486a7846a00d8e50b75aa8b7a0aa24b2f83fe6751
+  data.tar.gz: 4df37c87884a01dca2859f2ba244652c4c58099abddc9907d30d31dddfcd0ece044fd05c8a3de07497a8a9c8b93bb95f7e938b607599823196434d1f5a1c484b

data/Guardfile

@@ -46,5 +46,4 @@ guard :minitest do
   # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
   # watch(%r{^test/.+_test\.rb$})
   # watch(%r{^test/test_helper\.rb$}) { 'test' }
-
 end

data/Rakefile

@@ -1,12 +1,12 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
- 
+require 'bundler/gem_tasks'
+
 require 'rake/testtask'
- 
+
 Rake::TestTask.new do |t|
   t.libs << 'lib/railroady'
   t.test_files = FileList['test/lib/railroady/*_spec.rb']
   t.verbose = true
 end
- 
-task :default => :test
+
+task default: :test

data/bin/railroady

@@ -19,13 +19,13 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'railroady'
 
-APP_NAME       = "railroady"
-APP_HUMAN_NAME = "RailRoady"
+APP_NAME       = 'railroady'
+APP_HUMAN_NAME = 'RailRoady'
 # APP_VERSION    = [RailRoady::VERSION::MAJOR, RailRoady::VERSION::MINOR, RailRoady::VERSION::PATCH]
 APP_VERSION    = RailRoady::VERSION
-COPYRIGHT      = "Copyright (C) 2007-2008 Javier Smaldone, 2009 Peter Hoeg, 2010 Preston Lee"
+COPYRIGHT      = 'Copyright (C) 2007-2008 Javier Smaldone, 2009 Peter Hoeg, 2010 Preston Lee'
 
-options = OptionsStruct.new({:app_name => APP_NAME, :app_human_name => APP_HUMAN_NAME, :app_version =>APP_VERSION, :copyright =>COPYRIGHT})
+options = OptionsStruct.new(app_name: APP_NAME, app_human_name: APP_HUMAN_NAME, app_version: APP_VERSION, copyright: COPYRIGHT)
 
 options.parse ARGV
 
@@ -44,8 +44,8 @@ when 'controllers'
 when 'aasm'
   diagram = AasmDiagram.new(options)
 else
-  STDERR.print "#{APP_HUMAN_NAME} v#{APP_VERSION}\n" +
-    "Error: You must supply a command\n" +
+  STDERR.print "#{APP_HUMAN_NAME} v#{APP_VERSION}\n" \
+    "Error: You must supply a command\n" \
     "  (try #{APP_NAME} -h)\n\n"
   exit 1
 end
@@ -56,4 +56,3 @@ diagram.generate
 Dir.chdir(old_dir)
 
 diagram.print
-

data/lib/railroady.rb

@@ -1,5 +1,5 @@
-['version', 'options_struct', 'models_diagram', 'controllers_diagram', 'aasm_diagram'].each { |f| require "railroady/#{f}" }
+%w(version options_struct models_diagram controllers_diagram aasm_diagram).each { |f| require "railroady/#{f}" }
 
 module RailRoady
   require 'railroady/railtie' if defined?(Rails)
-end
+end

data/lib/railroady/aasm_diagram.rb

@@ -10,9 +10,8 @@ require 'railroady/app_diagram'
 
 # Diagram for Acts As State Machine
 class AasmDiagram < AppDiagram
-
   def initialize(options = OptionsStruct.new)
-    #options.exclude.map! {|e| e = "app/models/" + e}
+    # options.exclude.map! {|e| e = "app/models/" + e}
     super options
     @graph.diagram_type = 'Models'
     # Processed habtm associations
@@ -27,10 +26,10 @@ class AasmDiagram < AppDiagram
     end
   end
 
-  def get_files(prefix ='')
-    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix + "app/models/**/*.rb")
-    files += Dir.glob("vendor/plugins/**/app/models/*.rb") if @options.plugins_models
-    files -= Dir.glob(prefix + "app/models/concerns/**/*.rb") unless @options.include_concerns
+  def get_files(prefix = '')
+    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix + 'app/models/**/*.rb')
+    files += Dir.glob('vendor/plugins/**/app/models/*.rb') if @options.plugins_models
+    files -= Dir.glob(prefix + 'app/models/concerns/**/*.rb') unless @options.include_concerns
     files -= Dir.glob(@options.exclude)
     files
   end
@@ -39,20 +38,17 @@ class AasmDiagram < AppDiagram
 
   # Load model classes
   def load_classes
-    begin
-      disable_stdout
-      get_files.each {|m| require m }
-      enable_stdout
-    rescue LoadError
-      enable_stdout
-      print_error "model classes"
-      raise
-    end
+    disable_stdout
+    get_files.each { |m| require m }
+    enable_stdout
+  rescue LoadError
+    enable_stdout
+    print_error 'model classes'
+    raise
   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.
@@ -67,7 +63,7 @@ class AasmDiagram < AppDiagram
     STDERR.print "\t\tprocessing as acts_as_state_machine\n" if @options.verbose
     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_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]
@@ -75,11 +71,11 @@ class AasmDiagram < AppDiagram
     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
-                        ]
+          'event',
+          current_class.name.downcase + '_' + transition.from.to_s,
+          current_class.name.downcase + '_' + transition.to.to_s,
+          event_name.to_s
+        ]
       end
     end
   end
@@ -90,7 +86,7 @@ class AasmDiagram < AppDiagram
 
     STDERR.print "\t\tprocessing as aasm\n" if @options.verbose
     current_class.aasm.states.each do |state|
-      node_shape = (current_class.aasm.initial_state === state.name) ? ", peripheries = 2" : ""
+      node_shape = (current_class.aasm.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]
@@ -98,13 +94,12 @@ class AasmDiagram < AppDiagram
     current_class.aasm.events.each do |event_name, event|
       event.transitions.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
-                        ]
+          'event',
+          current_class.name.downcase + '_' + transition.from.to_s,
+          current_class.name.downcase + '_' + transition.to.to_s,
+          event_name.to_s
+        ]
       end
     end
   end
-
 end # class AasmDiagram

data/lib/railroady/app_diagram.rb

@@ -8,14 +8,12 @@ require 'railroady/diagram_graph'
 
 # Root class for RailRoady diagrams
 class AppDiagram
-
   def initialize(options = OptionsStruct.new)
     @options = options
     @graph = DiagramGraph.new
     @graph.show_label = @options.label
     @graph.alphabetize = @options.alphabetize
   end
-  
 
   # Print diagram
   def print
@@ -28,18 +26,16 @@ class AppDiagram
         exit 2
       end
     end
-    
-    if @options.xmi 
-        STDERR.print "Generating XMI diagram\n" if @options.verbose
-    	STDOUT.print @graph.to_xmi
+
+    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 
+      STDERR.print "Generating DOT graph\n" if @options.verbose
+      STDOUT.print @graph.to_dot
     end
 
-    if @options.output
-      STDOUT.reopen(old_stdout)
-    end
+    STDOUT.reopen(old_stdout) if @options.output
   end # print
 
   def process
@@ -49,7 +45,7 @@ class AppDiagram
   # get all engines
   def engines
     engines = []
-    
+
     if defined?(Rails)
       engines = if Rails::Application::Railties.respond_to?(:engines)
                   Rails::Application::Railties.engines
@@ -61,9 +57,8 @@ class AppDiagram
     engines
   end
 
+  private
 
-  private 
-  
   # Load Rails application's environment
   def load_environment
     STDERR.print "Loading application environment\n" if @options.verbose
@@ -74,7 +69,7 @@ class AppDiagram
       enable_stdout
     rescue LoadError
       enable_stdout
-      print_error "application environment"
+      print_error 'application environment'
       raise
     end
     STDERR.print "Loading application classes as we go\n" if @options.verbose
@@ -83,28 +78,26 @@ class AppDiagram
   # Prevents Rails application from writing to STDOUT
   def disable_stdout
     @old_stdout = STDOUT.dup
-    #via  Tomas Matousek, http://www.ruby-forum.com/topic/205887
-    STDOUT.reopen(::RUBY_PLATFORM =~ /djgpp|(cyg|ms|bcc)win|mingw/? "NUL" : "/dev/null")
+    # via  Tomas Matousek, http://www.ruby-forum.com/topic/205887
+    STDOUT.reopen(::RUBY_PLATFORM =~ /djgpp|(cyg|ms|bcc)win|mingw/ ? 'NUL' : '/dev/null')
   end
 
-  # Restore STDOUT  
+  # 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 " +
+    STDERR.print "Error loading #{type}.\n  (Are you running " \
                  "#{@options.app_name} on the aplication's root directory?)\n\n"
   end
 
   # 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
-    filename.split('/')[2..-1].collect { |i| i.camelize }.join('::').chomp(".rb")
+    filename.split('/')[2..-1].collect(&:camelize).join('::').chomp('.rb')
   end
-
 end # class AppDiagram

data/lib/railroady/controllers_diagram.rb

@@ -8,13 +8,12 @@ require 'railroady/app_diagram'
 
 # RailRoady 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 = OptionsStruct.new)
-    #options.exclude.map! {|e| "app/controllers/" + e}
+    # options.exclude.map! {|e| "app/controllers/" + e}
     super options
     @graph.diagram_type = 'Controllers'
   end
@@ -32,66 +31,61 @@ class ControllersDiagram < AppDiagram
       begin
         process_class class_name.constantize
       rescue Exception
-        STDERR.print "Warning: exception #{$!} raised while trying to load controller class #{f}"
+        STDERR.print "Warning: exception #{$ERROR_INFO} raised while trying to load controller class #{f}"
       end
-    end 
+    end
   end # generate
 
-  def get_files(prefix ='')
-    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/controllers/**/*_controller.rb")
-    files += get_engine_files if @options.engine_controllers
+  def get_files(prefix = '')
+    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << 'app/controllers/**/*_controller.rb')
+    files += engine_files if @options.engine_controllers
     files -= Dir.glob(@options.exclude)
     files
   end
-  
-  def get_engine_files
-    engines.collect { |engine| Dir.glob("#{engine.root.to_s}/app/controllers/**/*_controller.rb")}.flatten
+
+  def engine_files
+    engines.collect { |engine| Dir.glob("#{engine.root}/app/controllers/**/*_controller.rb") }.flatten
   end
-  
+
   def extract_class_name(filename)
-    controller_index = filename.split('/').index("controllers") + 1
-    filename.split('/')[controller_index..-1].collect { |i| i.camelize }.join('::').chomp(".rb")
+    filename.match(/.*\/controllers\/(.*).rb$/)[1].camelize
   end
 
-
-  
   private
+
   # Load controller classes
   def load_classes
-    begin
-      disable_stdout
-      # ApplicationController must be loaded first
-      require APP_CONTROLLER
-      get_files.each {|c| require "./#{c}" }
-      enable_stdout
-    rescue LoadError
-      enable_stdout
-      print_error "controller classes"
-      raise
-    end
+    disable_stdout
+    # ApplicationController must be loaded first
+    require APP_CONTROLLER
+    get_files.each { |c| require "./#{c}" }
+    enable_stdout
+  rescue LoadError
+    enable_stdout
+    print_error 'controller classes'
+    raise
   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 
+    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: [],
+                       protected: [],
+                       private: [] }
+      current_class.public_instance_methods(false).sort.each do |m|
         node_attribs[:public] << m
-      } unless @options.hide_public
-      current_class.protected_instance_methods(false).sort.each { |m|
+      end unless @options.hide_public
+      current_class.protected_instance_methods(false).sort.each do |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
+      end unless @options.hide_protected
+      current_class.private_instance_methods(false).sort.each do |m|
+        node_attribs[:private] << m
+      end 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]
@@ -104,7 +98,6 @@ class ControllersDiagram < AppDiagram
   end # process_class
 
   def transitive_subclasses_of(klass)
-    klass.subclasses | klass.subclasses.map {|subklass| transitive_subclasses_of(subklass)}.flatten
+    klass.subclasses | klass.subclasses.map { |subklass| transitive_subclasses_of(subklass) }.flatten
   end
-
 end # class ControllersDiagram

data/lib/railroady/diagram_graph.rb

@@ -4,10 +4,8 @@
 # Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
 # See COPYING for more details
 
-
 # RailRoady diagram structure
 class DiagramGraph
-
   def initialize
     @diagram_type = ''
     @show_label   = false
@@ -24,90 +22,83 @@ class DiagramGraph
     @edges << edge
   end
 
-  def diagram_type= (type)
-    @diagram_type = type
-  end
+  attr_writer :diagram_type
 
-  def show_label= (value)
-    @show_label = value
-  end
-
-  def alphabetize= (flag)
-    @alphabetize = flag
-  end
+  attr_writer :show_label
 
+  attr_writer :alphabetize
 
   # 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
+    dot_header +
+      @nodes.map { |n| dot_node n[0], n[1], n[2], n[3] }.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 ""
+    STDERR.print "Sorry. XMI output not yet implemented.\n\n"
+    ''
   end
 
   private
 
   # Build DOT diagram header
   def dot_header
-    result = "digraph #{@diagram_type.downcase}_diagram {\n" +
-             "\tgraph[overlap=false, splines=true]\n"
+    result = "digraph #{@diagram_type.downcase}_diagram {\n" \
+             "\tgraph[overlap=false, splines=true, bgcolor=\"none\"]\n"
     result += dot_label if @show_label
-    return result
+    result
   end
 
   # Build DOT diagram footer
   def dot_footer
-    return "}\n"
+    "}\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" +
-           (defined?(ActiveRecord::Migrator) ? "Migration version: " +
-            "#{ActiveRecord::Migrator.current_version}\\l" : "") +
-           "Generated by #{APP_HUMAN_NAME} #{APP_VERSION}\\l"+
-		   "http://railroady.prestonlee.com" +
+    "\t_diagram_info [shape=\"plaintext\", " \
+           "label=\"#{@diagram_type} diagram\\l" \
+           "Date: #{Time.now.strftime '%b %d %Y - %H:%M'}\\l" +
+      (defined?(ActiveRecord::Migrator) ? 'Migration version: ' \
+       "#{ActiveRecord::Migrator.current_version}\\l" : '') +
+      "Generated by #{APP_HUMAN_NAME} #{APP_VERSION}\\l" + 'http://railroady.prestonlee.com' \
            "\\l\", fontsize=13]\n"
   end
 
   # Build a DOT graph node
-  def dot_node(type, name, attributes=nil)
+  def dot_node(type, name, attributes = nil, custom_options = '')
     case type
       when 'model'
-           options = 'shape=Mrecord, label="{' + name + '|'
-           options += attributes.sort_by { |s| @alphabetize ? s : nil }.join('\l')
-           options += '\l}"'
+        options = 'shape=Mrecord, label="{' + name + '|'
+        options += attributes.sort_by { |s| @alphabetize ? s : nil }.join('\l')
+        options += '\l}"'
       when 'model-brief'
-           options = ''
+        options = ''
       when 'class'
-           options = 'shape=record, label="{' + name + '|}"'
+        options = 'shape=record, label="{' + name + '|}"'
       when 'class-brief'
-           options = 'shape=box'
+        options = 'shape=box'
       when 'controller'
-           options = 'shape=Mrecord, label="{' + name + '|'
-           public_methods    = attributes[:public].sort_by    { |s| @alphabetize ? s : nil }.join('\l')
-           protected_methods = attributes[:protected].sort_by { |s| @alphabetize ? s : nil }.join('\l')
-           private_methods   = attributes[:private].sort_by   { |s| @alphabetize ? s : nil }.join('\l')
-           options += public_methods + '\l|' + protected_methods + '\l|' +
-                      private_methods + '\l'
-           options += '}"'
+        options = 'shape=Mrecord, label="{' + name + '|'
+        public_methods    = attributes[:public].sort_by    { |s| @alphabetize ? s : nil }.join('\l')
+        protected_methods = attributes[:protected].sort_by { |s| @alphabetize ? s : nil }.join('\l')
+        private_methods   = attributes[:private].sort_by   { |s| @alphabetize ? s : nil }.join('\l')
+        options += public_methods + '\l|' + protected_methods + '\l|' +
+                   private_methods + '\l'
+        options += '}"'
       when 'controller-brief'
-           options = ''
+        options = ''
       when 'module'
-           options = 'shape=box, style=dotted, label="' + name + '"'
+        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  ")}}"
+        # 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"
+    options = [options, custom_options].compact.join(', ')
+    "\t#{quote(name)} [#{options}]\n"
   end # dot_node
 
   # Build a DOT graph edge
@@ -117,22 +108,21 @@ class DiagramGraph
     suffix = ", dir=both color=#{edge_color}"
     case type
       when 'one-one'
-           options += "arrowtail=odot, arrowhead=dot" + suffix
+        options += 'arrowtail=odot, arrowhead=dot' + suffix
       when 'one-many'
-           options += "arrowtail=odot, arrowhead=crow" + suffix
+        options += 'arrowtail=odot, arrowhead=crow' + suffix
       when 'many-many'
-           options += "arrowtail=crow, arrowhead=crow" + suffix
+        options += 'arrowtail=crow, arrowhead=crow' + suffix
       when 'is-a'
-           options += 'arrowhead="none", arrowtail="onormal"'
+        options += 'arrowhead="none", arrowtail="onormal"'
       when 'event'
-           options += "fontsize=10"
+        options += 'fontsize=10'
     end
-    return "\t#{quote(from)} -> #{quote(to)} [#{options}]\n"
+    "\t#{quote(from)} -> #{quote(to)} [#{options}]\n"
   end # dot_edge
 
   # Quotes a class name
   def quote(name)
     '"' + name.to_s + '"'
   end
-
 end # class DiagramGraph