railroady 1.1.2 → 1.6.0

data/lib/railroady/app_diagram.rb

@@ -1,56 +1,61 @@
-# RailRoady - RoR diagrams generator
-# http://railroad.rubyforge.org
-#
-# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
-# See COPYING for more details
-
 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
     if @options.output
-      old_stdout = STDOUT.dup
+      old_stdout = $stdout.dup
       begin
-        STDOUT.reopen(@options.output)
+        $stdout.reopen(@options.output)
       rescue
-        STDERR.print "Error: Cannot write diagram to #{@options.output}\n\n"
+        $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
+
+    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
-  end # print
+    $stdout.reopen(old_stdout) if @options.output
+  end
 
   def process
     load_environment
   end
 
-  private 
-  
+  # get all engines
+  def engines
+    engines = []
+
+    if defined?(Rails)
+      engines = if Rails::Application::Railties.respond_to?(:engines)
+                  Rails::Application::Railties.engines
+                else
+                  # rails 4 way of getting engines
+                  Rails::Engine.subclasses.map(&:instance)
+                end
+    end
+    engines
+  end
+
+  private
+
   # Load Rails application's environment
   def load_environment
-    STDERR.print "Loading application environment\n" if @options.verbose
+    $stderr.print "Loading application environment\n" if @options.verbose
     begin
       disable_stdout
       l = File.join(Dir.pwd.to_s, @options.config_file)
@@ -58,37 +63,35 @@ 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
+    $stderr.print "Loading application classes as we go\n" if @options.verbose
   end
 
   # 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")
+    @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')
   end
 
-  # Restore STDOUT  
+  # Restore STDOUT
   def enable_stdout
-    STDOUT.reopen(@old_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 " +
-                 "#{@options.app_name} on the aplication's root directory?)\n\n"
+    $stderr.print "Error loading #{type}.\n  (Are you running " \
+                 "#{@options.app_name} on the application'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
+end

data/lib/railroady/controllers_diagram.rb

@@ -1,27 +1,20 @@
-# RailRoady - RoR diagrams generator
-# http://railroad.rubyforge.org
-#
-# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
-# See COPYING for more details
-
 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
 
   # Process controller files
   def generate
-    STDERR.print "Generating controllers diagram\n" if @options.verbose
+    $stderr.print "Generating controllers diagram\n" if @options.verbose
     files = get_files
     # only add APP_CONTROLLER if it isn't already included from the glob above
     files << APP_CONTROLLER unless files.include? APP_CONTROLLER
@@ -32,54 +25,67 @@ 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 # generate
+    end
+  end
 
-  def get_files(prefix ='')
-    files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob(prefix << "app/controllers/**/*_controller.rb")
+  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 engine_files
+    engines.collect { |engine| Dir.glob("#{engine.root}/app/controllers/**/*_controller.rb") }.flatten
+  end
+
+  def extract_class_name(filename)
+    filename.match(%r{.*/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
-  end # load_classes
+    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
 
   # Proccess a controller class
   def process_class(current_class)
-
-    STDERR.print "\tProcessing #{current_class}\n" if @options.verbose
+    $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] << 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
+      node_attribs = { public: [],
+                       protected: [],
+                       private: [] }
+      unless @options.hide_public
+        current_class.public_instance_methods(false).sort.each do |m|
+          node_attribs[:public] << m
+        end
+      end
+      unless @options.hide_protected
+        current_class.protected_instance_methods(false).sort.each do |m|
+          node_attribs[:protected] << m
+        end
+      end
+      unless @options.hide_private
+        current_class.private_instance_methods(false).sort.each do |m|
+          node_attribs[:private] << m
+        end
+      end
       @graph.add_node ['controller', current_class.name, node_attribs]
     elsif @options.modules && current_class.is_a?(Module)
       @graph.add_node ['module', current_class.name]
@@ -89,10 +95,9 @@ class ControllersDiagram < AppDiagram
     if @options.inheritance && (transitive_subclasses_of(ApplicationController).include? current_class)
       @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
     end
-  end # process_class
+  end
 
   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
+end

data/lib/railroady/diagram_graph.rb

@@ -1,12 +1,7 @@
-# RailRoady - RoR diagrams generator
-# http://railroad.rubyforge.org
-#
-# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
-# See COPYING for more details
+# frozen_string_literal: true
 
-
-# RailRoady diagram structure
 class DiagramGraph
+  attr_writer :diagram_type, :show_label, :alphabetize
 
   def initialize
     @diagram_type = ''
@@ -24,91 +19,81 @@ class DiagramGraph
     @edges << edge
   end
 
-  def diagram_type= (type)
-    @diagram_type = type
-  end
-
-  def show_label= (value)
-    @show_label = value
-  end
-
-  def alphabetize= (flag)
-    @alphabetize = flag
-  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
+    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" +
+      (if defined?(ActiveRecord::Migrator)
+         'Migration version: ' \
+              "#{Rails.logger.silence { ActiveRecord::Migrator.current_version }}\\l"
+       else
+         ''
+       end) +
+      "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}"'
-      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].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 = ''
-      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
+    when 'model'
+      options = "shape=Mrecord, label=\"{#{name}|"
+      options += attributes.sort_by { |s| @alphabetize ? s : nil }.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].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 = ''
+    when 'module'
+      options = "shape=box, style=dotted, label=\"#{name}\""
+    when 'aasm'
+      # Return subgraph format
+      return "subgraph cluster_#{name.downcase.gsub(/[^a-z0-9\-_]+/i, '_')} {\n\tlabel = #{quote(name)}\n\t#{attributes.join("\n  ")}}"
+    end
+    options = [options, custom_options].compact.reject(&:empty?).join(', ')
+    "\t#{quote(name)} [#{options}]\n"
+  end
 
   # Build a DOT graph edge
   def dot_edge(type, from, to, name = '')
@@ -116,23 +101,25 @@ class DiagramGraph
     edge_color = '"#%02X%02X%02X"' % [rand(255), rand(255), rand(255)]
     suffix = ", dir=both color=#{edge_color}"
     case type
-      when 'one-one'
-           options += "arrowtail=odot, arrowhead=dot" + suffix
-      when 'one-many'
-           options += "arrowtail=odot, arrowhead=crow" + suffix
-      when 'many-many'
-           options += "arrowtail=crow, arrowhead=crow" + suffix
-      when 'is-a'
-           options += 'arrowhead="none", arrowtail="onormal"'
-      when 'event'
-           options += "fontsize=10"
+    when 'one-one'
+      options += "arrowtail=odot, arrowhead=dot#{suffix}"
+    when 'one-many'
+      options += "arrowtail=odot, arrowhead=crow#{suffix}"
+    when 'many-many'
+      options += "arrowtail=crow, arrowhead=crow#{suffix}"
+    when 'belongs-to'
+      # following http://guides.rubyonrails.org/association_basics.html#the-belongs-to-association
+      options += "arrowtail=none, arrowhead=normal#{suffix}"
+    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
+    "\t#{quote(from)} -> #{quote(to)} [#{options}]\n"
+  end
 
   # Quotes a class name
   def quote(name)
-    '"' + name.to_s + '"'
+    "\"#{name}\""
   end
-
-end # class DiagramGraph
+end