railroady 1.3.0 → 1.3.1

data/lib/railroady/models_diagram.rb

@@ -17,36 +17,33 @@ class ModelsDiagram < AppDiagram
 
   # Process model files
   def generate
-    STDERR.puts "Generating models diagram" if @options.verbose
+    STDERR.puts 'Generating models diagram' if @options.verbose
     get_files.each do |f|
       begin
         process_class extract_class_name(f).constantize
       rescue Exception
-        STDERR.puts "Warning: exception #{$!} raised while trying to load model class #{f}"
+        STDERR.puts "Warning: exception #{$ERROR_INFO} raised while trying to load model class #{f}"
       end
-      
     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
-    files += get_engine_files if @options.engine_models
+  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 += engine_files if @options.engine_models
     files -= Dir.glob(@options.exclude)
     files
   end
 
-  def get_engine_files
-    engines.collect { |engine| Dir.glob("#{engine.root.to_s}/app/models/**/*.rb")}.flatten
+  def engine_files
+    engines.collect { |engine| Dir.glob("#{engine.root}/app/models/**/*.rb") }.flatten
   end
 
-
   def extract_class_name(filename)
-    filename.split('/').last.camelize.chomp(".rb")
+    filename.match(/.*\/models\/(.*).rb$/)[1].camelize
   end
 
-  
   # Process a model class
   def process_class(current_class)
     STDERR.puts "Processing #{current_class}" if @options.verbose
@@ -58,7 +55,7 @@ class ModelsDiagram < AppDiagram
         process_mongoid_model(current_class)
       elsif defined?(DataMapper::Resource) && current_class.new.is_a?(DataMapper::Resource)
         process_datamapper_model(current_class)
-      elsif current_class.respond_to?'reflect_on_all_associations'
+      elsif current_class.respond_to? 'reflect_on_all_associations'
         process_active_record_model(current_class)
       elsif @options.all && (current_class.is_a? Class)
         process_basic_class(current_class)
@@ -69,14 +66,13 @@ class ModelsDiagram < AppDiagram
     if @options.inheritance && generated && include_inheritance?(current_class)
       @graph.add_edge ['is-a', current_class.superclass.name, current_class.name]
     end
-
   end # process_class
 
   def include_inheritance?(current_class)
     STDERR.puts current_class.superclass if @options.verbose
     (defined?(ActiveRecord::Base) && current_class.superclass != ActiveRecord::Base) ||
-    (defined?(CouchRest::Model::Base) && current_class.superclass != CouchRest::Model::Base) ||
-    (current_class.superclass != Object)
+      (defined?(CouchRest::Model::Base) && current_class.superclass != CouchRest::Model::Base) ||
+      (current_class.superclass != Object)
   end
 
   def process_basic_class(current_class)
@@ -98,18 +94,14 @@ class ModelsDiagram < AppDiagram
       node_type = 'model'
 
       # Collect model's content columns
-      #content_columns = current_class.content_columns
+      # 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}
+        magic_fields = %w(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.columns
       end
@@ -127,7 +119,7 @@ class ModelsDiagram < AppDiagram
     if @options.inheritance && ! @options.transitive
       superclass_associations = current_class.superclass.reflect_on_all_associations
 
-      associations = associations.select{|a| ! superclass_associations.include? a}
+      associations = associations.select { |a| !superclass_associations.include? a }
       # This doesn't works!
       # associations -= current_class.superclass.reflect_on_all_associations
     end
@@ -141,7 +133,7 @@ class ModelsDiagram < AppDiagram
 
   def process_datamapper_model(current_class)
     node_attribs = []
-    if @options.brief #|| current_class.abstract_class?
+    if @options.brief # || current_class.abstract_class?
       node_type = 'model-brief'
     else
       node_type = 'model'
@@ -153,9 +145,8 @@ class ModelsDiagram < AppDiagram
         # 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"]
-        props = props.select {|c| !magic_fields.include?(c.name.to_s) }
+          %w(created_at created_on updated_at updated_on lock_version _type _id position parent_id lft rgt quote template)
+        props = props.select { |c| !magic_fields.include?(c.name.to_s) }
       end
 
       props.each do |a|
@@ -192,12 +183,8 @@ class ModelsDiagram < AppDiagram
       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"
-        ]
-        content_columns = content_columns.select {|c| !magic_fields.include?(c.name) }
+        magic_fields = %w(created_at created_on updated_at updated_on lock_version _type _id position parent_id lft rgt quote template)
+        content_columns = content_columns.select { |c| !magic_fields.include?(c.name) }
       end
 
       content_columns.each do |a|
@@ -213,7 +200,7 @@ class ModelsDiagram < AppDiagram
     associations = current_class.relations.values
 
     if @options.inheritance && !@options.transitive &&
-      current_class.superclass.respond_to?(:relations)
+       current_class.superclass.respond_to?(:relations)
       associations -= current_class.superclass.relations.values
     end
 
@@ -242,11 +229,8 @@ class ModelsDiagram < AppDiagram
       content_columns = current_class.properties
 
       if @options.hide_magic
-        magic_fields = [
-          "created_at", "updated_at",
-          "type", "_id", "_rev"
-        ]
-        content_columns = content_columns.select {|c| !magic_fields.include?(c.name) }
+        magic_fields = %w(created_at updated_at type _id _rev)
+        content_columns = content_columns.select { |c| !magic_fields.include?(c.name) }
       end
 
       content_columns.each do |a|
@@ -263,17 +247,17 @@ class ModelsDiagram < AppDiagram
 
   # Process a model association
   def process_association(class_name, assoc)
-    STDERR.puts "- Processing model association #{assoc.name.to_s}" if @options.verbose
+    STDERR.puts "- Processing model association #{assoc.name}" if @options.verbose
 
     # Skip "belongs_to" associations
     macro = assoc.macro.to_s
-    return if %w[belongs_to referenced_in].include?(macro) && !@options.show_belongs_to
+    return if %w(belongs_to referenced_in).include?(macro) && !@options.show_belongs_to
 
     # Skip "through" associations
     through = assoc.options.include?(:through)
     return if through && @options.hide_through
 
-    #TODO:
+    # TODO:
     # FAIL: assoc.methods.include?(:class_name)
     # FAIL: assoc.responds_to?(:class_name)
     assoc_class_name = assoc.class_name rescue nil
@@ -290,15 +274,15 @@ class ModelsDiagram < AppDiagram
     end
 
     # Patch from "alpack" to support classes in a non-root module namespace. See: http://disq.us/yxl1v
-    if class_name.include?("::") && !assoc_class_name.include?("::")
-      assoc_class_name = class_name.split("::")[0..-2].push(assoc_class_name).join("::")
+    if class_name.include?('::') && !assoc_class_name.include?('::')
+      assoc_class_name = class_name.split('::')[0..-2].push(assoc_class_name).join('::')
     end
-    assoc_class_name.gsub!(%r{^::}, '')
+    assoc_class_name.gsub!(/^::/, '')
 
-    if %w[has_one references_one embeds_one].include?(macro)
+    if %w(has_one references_one embeds_one).include?(macro)
       assoc_type = 'one-one'
     elsif macro == 'has_many' && (!assoc.options[:through]) ||
-          %w[references_many embeds_many].include?(macro)
+          %w(references_many embeds_many).include?(macro)
       assoc_type = 'one-many'
     else # habtm or has_many, :through
       # Add FAKE associations too in order to understand mistakes
@@ -313,7 +297,7 @@ class ModelsDiagram < AppDiagram
 
   # Process a DataMapper relationship
   def process_datamapper_relationship(class_name, relation)
-    STDERR.puts "- Processing DataMapper model relationship #{relation.name.to_s}" if @options.verbose
+    STDERR.puts "- Processing DataMapper model relationship #{relation.name}" if @options.verbose
 
     # Skip "belongs_to" relationships
     dm_type = relation.class.to_s.split('::')[-2]
@@ -332,7 +316,7 @@ class ModelsDiagram < AppDiagram
 
     # Only non standard association names needs a label
     assoc_name = ''
-    if !(relation.name.to_s.singularize.camelize.eql?(assoc_class_name.split('::').last))
+    unless relation.name.to_s.singularize.camelize.eql?(assoc_class_name.split('::').last)
       assoc_name = relation.name.to_s
     end
 
@@ -344,9 +328,6 @@ class ModelsDiagram < AppDiagram
       rel_type = 'one-many'
     end
 
-    @graph.add_edge [rel_type, class_name, assoc_class_name, assoc_name ]
+    @graph.add_edge [rel_type, class_name, assoc_class_name, assoc_name]
   end
-
 end # class ModelsDiagram
-
-

data/lib/railroady/options_struct.rb

@@ -8,201 +8,197 @@ require 'ostruct'
 
 # RailRoady command line options parser
 class OptionsStruct < OpenStruct
-
   require 'optparse'
 
-  def initialize(args={})
-    init_options = { :all => false,
-                     :brief => false,
-                     :specify => [],
-                     :exclude => [],
-                     :inheritance => false,
-                     :join => false,
-                     :label => false,
-                     :modules => false,
-                     :all_columns => false,
-                     :hide_magic => false,
-                     :hide_types => false,
-                     :hide_public => false,
-                     :hide_protected => false,
-                     :hide_private => false,
-                     :plugins_models => false,
-                     :engine_models => false,
-                     :engine_controllers => false, 
-		     :include_concerns => false,
-                     :root => '',
-                     :show_belongs_to => false,
-                     :hide_through => false,
-                     :transitive => false,
-                     :verbose => false,
-                     :alphabetize => false,
-                     :xmi => false,
-                     :command => '',
-                     :config_file => 'config/environment',
-                     :app_name => 'railroady', :app_human_name => 'Railroady', :app_version =>'', :copyright =>'' }
+  def initialize(args = {})
+    init_options = { all: false,
+                     brief: false,
+                     specify: [],
+                     exclude: [],
+                     inheritance: false,
+                     join: false,
+                     label: false,
+                     modules: false,
+                     all_columns: false,
+                     hide_magic: false,
+                     hide_types: false,
+                     hide_public: false,
+                     hide_protected: false,
+                     hide_private: false,
+                     plugins_models: false,
+                     engine_models: false,
+                     engine_controllers: false,
+                     include_concerns: false,
+                     root: '',
+                     show_belongs_to: false,
+                     hide_through: false,
+                     transitive: false,
+                     verbose: false,
+                     alphabetize: false,
+                     xmi: false,
+                     command: '',
+                     config_file: 'config/environment',
+                     app_name: 'railroady', app_human_name: 'Railroady', app_version: '', copyright: '' }
     super(init_options.merge(args))
   end # initialize
 
   def parse(args)
     @opt_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: #{self.app_name} [options] command"
-      opts.separator ""
-      opts.separator "Common options:"
-      opts.on("-b", "--brief", "Generate compact diagram", 
-              "  (no attributes nor methods)") do |b|
+      opts.banner = "Usage: #{app_name} [options] command"
+      opts.separator ''
+      opts.separator 'Common options:'
+      opts.on('-b', '--brief', 'Generate compact diagram',
+              '  (no attributes nor methods)') do |b|
         self.brief = b
       end
-      opts.on("-s", "--specify file1[,fileN]", Array, "Specify only given files") do |list|
+      opts.on('-s', '--specify file1[,fileN]', Array, 'Specify only given files') do |list|
         self.specify = list
       end
-      opts.on("-e", "--exclude file1[,fileN]", Array, "Exclude given files") 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|
+      opts.on('-i', '--inheritance', 'Include inheritance relations') do |i|
         self.inheritance = i
       end
-      opts.on("-l", "--label", "Add a label with diagram information", 
-              "  (type, date, migration, version)") do |l|
+      opts.on('-l', '--label', 'Add a label with diagram information',
+              '  (type, date, migration, version)') do |l|
         self.label = l
       end
-      opts.on("-o", "--output FILE", "Write diagram to file FILE") do |f|
+      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|
+      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|
+      opts.on('-v', '--verbose', 'Enable verbose output',
+              '  (produce messages to STDOUT)') do |v|
         self.verbose = v
       end
-      opts.on("-x", "--xmi", "Produce XMI instead of DOT", 
-              "  (for UML tools)") do |x|
+      opts.on('-x', '--xmi', 'Produce XMI instead of DOT',
+              '  (for UML tools)') do |x|
         self.xmi = x
       end
-      opts.on("--alphabetize", "Sort methods alphabetically") do |a|
+      opts.on('--alphabetize', 'Sort methods alphabetically') do |a|
         self.alphabetize = a
       end
-      opts.separator ""
-      opts.separator "Models diagram options:"
-      opts.on("-a", "--all", "Include all models", 
-              "  (not only ActiveRecord::Base derived)") do |a|
+      opts.separator ''
+      opts.separator 'Models diagram options:'
+      opts.on('-a', '--all', 'Include all models',
+              '  (not only ActiveRecord::Base derived)') do |a|
         self.all = a
       end
-      opts.on("--show-belongs_to", "Show belongs_to associations") do |s|
+      opts.on('--show-belongs_to', 'Show belongs_to associations') do |s|
         self.show_belongs_to = s
       end
-      opts.on("--hide-through", "Hide through associations") do |h|
+      opts.on('--hide-through', 'Hide through associations') do |h|
         self.hide_through = h
       end
-      opts.on("--all-columns", "Show all columns (not just content columns)") do |h|
+      opts.on('--all-columns', 'Show all columns (not just content columns)') do |h|
         self.all_columns = h
       end
-      opts.on("--hide-magic", "Hide magic field names") do |h|
+      opts.on('--hide-magic', 'Hide magic field names') do |h|
         self.hide_magic = h
       end
-      opts.on("--hide-types", "Hide attributes type") do |h|
+      opts.on('--hide-types', 'Hide attributes type') do |h|
         self.hide_types = h
       end
-      opts.on("-j", "--join", "Concentrate edges") do |j|
+      opts.on('-j', '--join', 'Concentrate edges') do |j|
         self.join = j
       end
-      opts.on("-m", "--modules", "Include modules") do |m|
+      opts.on('-m', '--modules', 'Include modules') do |m|
         self.modules = m
       end
-      opts.on("-p", "--plugins-models", "Include plugins models") do |p|
+      opts.on('-p', '--plugins-models', 'Include plugins models') do |p|
         self.plugins_models = p
       end
-      opts.on("-z", "--engine-models", "Include engine models") do |em|
+      opts.on('-z', '--engine-models', 'Include engine models') do |em|
         self.engine_models = em
       end
-      opts.on("--include-concerns", "Include models in concerns subdirectory") do |c|
+      opts.on('--include-concerns', 'Include models in concerns subdirectory') do |c|
         self.include_concerns = c
       end
-      opts.on("-t", "--transitive", "Include transitive associations",
-              "(through inheritance)") do |t|
+      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|
+      opts.separator ''
+      opts.separator 'Controllers diagram options:'
+      opts.on('--hide-public', 'Hide public methods') do |h|
         self.hide_public = h
       end
-      opts.on("--hide-protected", "Hide protected methods") do |h|
+      opts.on('--hide-protected', 'Hide protected methods') do |h|
         self.hide_protected = h
       end
-      opts.on("--hide-private", "Hide private methods") do |h|
+      opts.on('--hide-private', 'Hide private methods') do |h|
         self.hide_private = h
       end
-      opts.on("--engine-controllers", "Include engine controllers") do |ec|
+      opts.on('--engine-controllers', 'Include engine controllers') do |ec|
         self.engine_controllers = ec
       end
-      opts.separator ""
-      opts.separator "Other options:"
-      opts.on("-h", "--help", "Show this message") do
+      opts.separator ''
+      opts.separator 'Other options:'
+      opts.on('-h', '--help', 'Show this message') do
         STDOUT.print "#{opts}\n"
         exit
       end
-      opts.on("--version", "Show version and copyright") do 
-        STDOUT.print"#{self.app_human_name} version #{self.app_version}\n\n" +
-                     "#{self.copyright}\nThis is free software; see the source " +
+      opts.on('--version', 'Show version and copyright') do
+        STDOUT.print "#{app_human_name} version #{app_version}\n\n" \
+                     "#{copyright}\nThis is free software; see the source " \
                      "for copying conditions.\n\n"
         exit
       end
-      opts.separator ""
-      opts.on("-c", "--config FILE", "File to load environment (defaults to config/environment)") do |c|
-        if c && c != ''
-          self.config_file = c
-        end
+      opts.separator ''
+      opts.on('-c', '--config FILE', 'File to load environment (defaults to config/environment)') do |c|
+        self.config_file = c if c && c != ''
       end
-      opts.separator "Commands (you must supply one of these):"
-      opts.on("-M", "--models", "Generate models diagram") do |c|
-        if self.command != ''
+      opts.separator 'Commands (you must supply one of these):'
+      opts.on('-M', '--models', 'Generate models diagram') do |_c|
+        if command != ''
           STDERR.print "Error: Can only generate one diagram type\n\n"
           exit 1
-        else 
-          self.command = 'models'        
+        else
+          self.command = 'models'
         end
-      end 
-      opts.on("-C", "--controllers", "Generate controllers diagram") do |c|
-        if self.command != ''
+      end
+      opts.on('-C', '--controllers', 'Generate controllers diagram') do |_c|
+        if command != ''
           STDERR.print "Error: Can only generate one diagram type\n\n"
           exit 1
-        else 
-          self.command = 'controllers'        
+        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'
+      opts.on('-A', '--aasm', "Generate \"acts as state machine\" diagram") do |_c|
+        if command == 'controllers'
           STDERR.print "Error: Can only generate one diagram type\n\n"
           exit 1
-        else    
+        else
           self.command = 'aasm'
         end
-      end        
-      opts.separator ""
-      opts.separator "For bug reporting and additional information, please see:"
-      opts.separator "http://railroad.rubyforge.org/"
+      end
+      opts.separator ''
+      opts.separator 'For bug reporting and additional information, please see:'
+      opts.separator 'http://railroad.rubyforge.org/'
     end # do
 
     begin
       @opt_parser.parse!(args)
     rescue OptionParser::AmbiguousOption
-      option_error "Ambiguous option"
+      option_error 'Ambiguous option'
     rescue OptionParser::InvalidOption
-      option_error "Invalid option"
+      option_error 'Invalid option'
     rescue OptionParser::InvalidArgument
-      option_error "Invalid argument"
+      option_error 'Invalid argument'
     rescue OptionParser::MissingArgument
-      option_error "Missing argument"
+      option_error 'Missing argument'
     end
   end  # parse
 
-  private 
+  private
 
   def option_error(msg)
     STDERR.print "Error: #{msg}\n\n #{@opt_parser}\n"
     exit 1
   end
-
 end  # class OptionsStruct