prailroady 1.5.3

data/lib/prailroady/models_diagram.rb

@@ -0,0 +1,357 @@
+# PrailRoady - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+require 'prailroady/app_diagram'
+
+# PrailRoady models diagram
+class ModelsDiagram < AppDiagram
+  def initialize(options = OptionsStruct.new)
+    super options
+    @graph.diagram_type = 'Models'
+    # Processed habtm associations
+    @habtm = []
+  end
+
+  # Process model files
+  def generate
+    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 #{$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 += engine_files if @options.engine_models
+    files -= Dir.glob(@options.exclude)
+    files
+  end
+
+  def engine_files
+    engines.collect { |engine| Dir.glob("#{engine.root}/app/models/**/*.rb") }.flatten
+  end
+
+  def extract_class_name(filename)
+    filename_was, class_name = filename, nil
+
+    filename = "app/models/#{filename.split('app/models')[1]}"
+
+    while filename.split('/').length > 2
+      begin
+        class_name = filename.match(/.*\/models\/(.*).rb$/)[1].camelize
+        class_name.constantize
+
+        break
+      rescue Exception
+        class_name = nil
+        filename_end = filename.split('/')[2..-1]
+        filename_end.shift
+        filename = "#{filename.split('/')[0, 2].join('/')}/#{filename_end.join('/')}"
+      end
+    end
+
+    if class_name.nil?
+      filename_was.match(/.*\/models\/(.*).rb$/)[1].camelize
+    else
+      class_name
+    end
+  end
+
+  # Process a model class
+  def process_class(current_class)
+    STDERR.puts "Processing #{current_class}" if @options.verbose
+
+    generated =
+      if defined?(CouchRest::Model::Base) && current_class.new.is_a?(CouchRest::Model::Base)
+        process_couchrest_model(current_class)
+      elsif defined?(Mongoid::Document) && current_class.new.is_a?(Mongoid::Document)
+        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'
+        process_active_record_model(current_class)
+      elsif @options.all && (current_class.is_a? Class)
+        process_basic_class(current_class)
+      elsif @options.modules && (current_class.is_a? Module)
+        process_basic_module(current_class)
+      end
+
+    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 : true) &&
+      (defined?(CouchRest::Model::Base) ? current_class.superclass != CouchRest::Model::Base : true) &&
+      (current_class.superclass != Object)
+  end
+
+  def process_basic_class(current_class)
+    node_type = @options.brief ? 'class-brief' : 'class'
+    @graph.add_node [node_type, current_class.name]
+    true
+  end
+
+  def process_basic_module(current_class)
+    @graph.add_node ['module', current_class.name]
+    false
+  end
+
+  def process_active_record_model(current_class)
+    node_attribs = []
+    if @options.brief || current_class.abstract_class?
+      node_type = 'model-brief'
+    else
+      node_type = 'model'
+
+      # Collect model's content columns
+      # content_columns = current_class.content_columns
+
+      if @options.hide_magic
+        # From patch #13351
+        # http://wiki.rubyonrails.org/rails/pages/MagicFieldNames
+        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
+
+      content_columns.each do |a|
+        content_column = a.name
+        content_column += ' :' + a.sql_type.to_s unless @options.hide_types
+        node_attribs << content_column
+      end
+    end
+    @graph.add_node [node_type, current_class.name, node_attribs]
+
+    # Process class associations
+    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
+
+    true
+  end
+
+  def process_datamapper_model(current_class)
+    node_attribs = []
+    if @options.brief # || current_class.abstract_class?
+      node_type = 'model-brief'
+    else
+      node_type = 'model'
+
+      # Collect model's properties
+      props = current_class.properties.sort_by(&:name)
+
+      if @options.hide_magic
+        # From patch #13351
+        # http://wiki.rubyonrails.org/rails/pages/MagicFieldNames
+        magic_fields =
+          %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|
+        prop = a.name.to_s
+        prop += ' :' + a.class.name.split('::').last unless @options.hide_types
+        node_attribs << prop
+      end
+    end
+    @graph.add_node [node_type, current_class.name, node_attribs]
+
+    # Process relationships
+    relationships = current_class.relationships
+
+    # TODO: Manage inheritance
+
+    relationships.each do |a|
+      process_datamapper_relationship current_class.name, a
+    end
+
+    true
+  end
+
+  def process_mongoid_model(current_class)
+    node_attribs = []
+
+    if @options.brief
+      node_type = 'model-brief'
+    else
+      node_type = 'model'
+
+      # Collect model's content columns
+      content_columns = current_class.fields.values.sort_by(&:name)
+
+      if @options.hide_magic
+        # From patch #13351
+        # http://wiki.rubyonrails.org/rails/pages/MagicFieldNames
+        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|
+        content_column = a.name
+        content_column += " :#{a.type}" unless @options.hide_types
+        node_attribs << content_column
+      end
+    end
+
+    @graph.add_node [node_type, current_class.name, node_attribs]
+
+    # Process class associations
+    associations = current_class.relations.values
+
+    if @options.inheritance && !@options.transitive &&
+       current_class.superclass.respond_to?(:relations)
+      associations -= current_class.superclass.relations.values
+    end
+
+    associations.each do |a|
+      process_association current_class.name, a
+    end
+
+    true
+  end
+
+  ##
+  # Some very basic CouchRest::Model support
+  #
+  # Field types note: the field's type is rendered only if it's explicitly
+  # specified in a model.
+  #
+  def process_couchrest_model(current_class)
+    node_attribs = []
+
+    if @options.brief
+      node_type = 'model-brief'
+    else
+      node_type = 'model'
+
+      # Collect model's content columns
+      content_columns = current_class.properties
+
+      if @options.hide_magic
+        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|
+        content_column = a.name
+        content_column += " :#{a.type}" unless @options.hide_types || a.type.nil?
+        node_attribs << content_column
+      end
+    end
+
+    @graph.add_node [node_type, current_class.name, node_attribs]
+
+    true
+  end
+
+  # Process a model association
+  def process_association(class_name, assoc)
+    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
+
+    # Skip "through" associations
+    through = assoc.options.include?(:through)
+    return if through && @options.hide_through
+
+    # TODO:
+    # FAIL: assoc.methods.include?(:class_name)
+    # FAIL: assoc.responds_to?(:class_name)
+    assoc_class_name = assoc.class_name rescue nil
+    assoc_class_name ||= assoc.name.to_s.underscore.singularize.camelize
+
+    # Only non standard association names needs a label
+
+    # from patch #12384
+    # if assoc.class_name == assoc.name.to_s.singularize.camelize
+    if assoc_class_name == assoc.name.to_s.singularize.camelize
+      assoc_name = ''
+    else
+      assoc_name = assoc.name.to_s
+    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('::')
+    end
+    assoc_class_name.gsub!(/^::/, '')
+
+    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)
+      assoc_type = 'one-many'
+    elsif macro == 'belongs_to'
+      assoc_type = 'belongs-to'
+    else # habtm or has_many, :through
+      # Add FAKE associations too in order to understand mistakes
+      return if @habtm.include? [assoc_class_name, class_name, assoc_name]
+      assoc_type = 'many-many'
+      @habtm << [class_name, assoc_class_name, assoc_name]
+    end
+    # from patch #12384
+    # @graph.add_edge [assoc_type, class_name, assoc.class_name, assoc_name]
+    @graph.add_edge [assoc_type, class_name, assoc_class_name, assoc_name]
+  end # process_association
+
+  # Process a DataMapper relationship
+  def process_datamapper_relationship(class_name, relation)
+    STDERR.puts "- Processing DataMapper model relationship #{relation.name}" if @options.verbose
+
+    # Skip "belongs_to" relationships
+    dm_type = relation.class.to_s.split('::')[-2]
+    return if dm_type == 'ManyToOne' && !@options.show_belongs_to
+
+    dm_parent_model = relation.parent_model.to_s
+    dm_child_model = relation.child_model.to_s
+
+    assoc_class_name = ''
+    # Get the assoc_class_name
+    if dm_parent_model.eql?(class_name)
+      assoc_class_name = dm_child_model
+    else
+      assoc_class_name = dm_parent_model
+    end
+
+    # Only non standard association names needs a label
+    assoc_name = ''
+    unless relation.name.to_s.singularize.camelize.eql?(assoc_class_name.split('::').last)
+      assoc_name = relation.name.to_s
+    end
+
+    # TO BE IMPROVED
+    rel_type = 'many-many' # default value for ManyToOne and ManyToMany
+    if dm_type == 'OneToOne'
+      rel_type = 'one-one'
+    elsif dm_type == 'OneToMany'
+      rel_type = 'one-many'
+    end
+
+    @graph.add_edge [rel_type, class_name, assoc_class_name, assoc_name]
+  end
+end # class ModelsDiagram

data/lib/prailroady/options_struct.rb

@@ -0,0 +1,204 @@
+# PrailRoady - RoR diagrams generator
+# http://railroad.rubyforge.org
+#
+# Copyright 2007-2008 - Javier Smaldone (http://www.smaldone.com.ar)
+# See COPYING for more details
+
+require 'ostruct'
+
+# PrailRoady 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: 'orailroady', app_human_name: 'PrailRoady', app_version: '', copyright: '' }
+    super(init_options.merge(args))
+  end # initialize
+
+  def parse(args)
+    @opt_parser = OptionParser.new do |opts|
+      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|
+        self.specify = list
+      end
+      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|
+        self.inheritance = i
+      end
+      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|
+        self.output = f
+      end
+      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|
+        self.verbose = v
+      end
+      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|
+        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|
+        self.all = a
+      end
+      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|
+        self.hide_through = h
+      end
+      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|
+        self.hide_magic = h
+      end
+      opts.on('--hide-types', 'Hide attributes type') do |h|
+        self.hide_types = h
+      end
+      opts.on('-j', '--join', 'Concentrate edges') do |j|
+        self.join = j
+      end
+      opts.on('-m', '--modules', 'Include modules') do |m|
+        self.modules = m
+      end
+      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|
+        self.engine_models = em
+      end
+      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|
+        self.transitive = t
+      end
+      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|
+        self.hide_protected = h
+      end
+      opts.on('--hide-private', 'Hide private methods') do |h|
+        self.hide_private = h
+      end
+      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
+        STDOUT.print "#{opts}\n"
+        exit
+      end
+      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|
+        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 command != ''
+          STDERR.print "Error: Can only generate one diagram type\n\n"
+          exit 1
+        else
+          self.command = 'models'
+        end
+      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'
+        end
+      end
+      # From Ana Nelson's patch
+      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
+          self.command = 'aasm'
+        end
+      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'
+    rescue OptionParser::InvalidOption
+      option_error 'Invalid option'
+    rescue OptionParser::InvalidArgument
+      option_error 'Invalid argument'
+    rescue OptionParser::MissingArgument
+      option_error 'Missing argument'
+    end
+  end  # parse
+
+  private
+
+  def option_error(msg)
+    STDERR.print "Error: #{msg}\n\n #{@opt_parser}\n"
+    exit 1
+  end
+end  # class OptionsStruct