model_graph 0.1.2 → 0.1.3

data/bin/model_graph

@@ -1,4 +1,5 @@
 #!/usr/local/bin/ruby
+# -*- ruby -*-
 
 # When run from the trunk of a Rails project, produces
 # {DOT}[http://www.graphviz.org/doc/info/lang.html] output which can be
@@ -22,12 +23,12 @@
 #
 # === Usage:
 #
-#   model_graph.rb [options]
+#   model_graph [options]
 #
-# then open tmp/model_graph.dot with a viewer.  Using 'model_graph.rb
-# --debug' will write a bunch of the raw information obtained from reflecting
-# on the ActiveRecord model classes into the output as comments (including
-# some things that don't actually affect the final graph).
+# then open tmp/model_graph.dot with a viewer.  Using 'model_graph --debug'
+# will write a bunch of the raw information obtained from reflecting on the
+# ActiveRecord model classes into the output as comments (including some
+# things that don't actually affect the final graph).
 #
 # See the documentation for ModelGraph#do_graph for some additional options.
 #
@@ -81,12 +82,15 @@ require 'config/environment'
 
 require 'optparse'
 require 'ostruct'
+require File.expand_path(File.dirname(__FILE__)+'/../lib/model_graph.rb')
 
 class Hash                      # :nodoc:
   def inspect(options={})
     out = ''
     sep = '['
-    self.each { |k,v| unless ! options[:label] && k =~ /(?:head|tail)label/; out << sep << "#{k}=#{v}"; sep=', '; end }
+    self.each { |k,v| unless ! options[:label] && k =~ /(?:head|tail)label/
+                        out << sep << "#{k}=#{v}"; sep=', '
+                      end }
     out << ']' unless sep == '['
     out
   end
@@ -111,77 +115,7 @@ module ModelGraph
     :has_and_belongs_to_many => 'crowodot'
   }
 
-  # An internal class to collect abstract nodes and edges and deliver them
-  # back when needed.
-  class Graph
-    attr_reader :name
-
-    # Holds information about nodes and edges that should be depicted on the
-    # UML-ish graph of the ActiveRecord model classes.  The +name+ is optional
-    # and only serves to give the graph an internal name.  If you had an
-    # application to combine model graphs from multiple applications, this
-    # might be useful.
-    def initialize(name="model_graph")
-      @name = name
-      @nodes = Hash.new          # holds simple strings
-      @edges = Hash.new { |h,k| h[k] = Hash.new { |h2,k2| h2[k2] = Hash.new } }
-
-      # A hm B :as => Y    gives edge A->B and implies B bt A
-      # C hm B :as => Y    gives edge C->B and implies B bt A
-      # B bt Y :polymorphic => true       no new information
-    end
-
-    # Create an unattached node in this graph.
-    def add_node(nodename, options="")
-      @nodes[nodename] = options
-    end
-
-    # Iterates over all the nodes previously added to this graph.
-    def nodes                   # :yields: nodestring
-      @nodes.each do |name,options|
-        yield "#{name} #{options}"
-      end
-    end
-
-    # Create a directed edge from one node to another.  If an edge between
-    # nodes already exists in the opposite direction, the arrow will be
-    # attached to the other end of the existing edge.
-    def add_edge(fromnode, tonode, options={})
-      unless @edges[tonode].has_key? fromnode
-        options.each do |k,v|
-          @edges[fromnode][tonode][case k.to_s
-                                   when 'label' : 'taillabel'
-                                   when 'midlabel' : 'label'
-                                   when /^arrow(?:head|tail)?$/ : 'arrowhead'
-                                   else k
-                                   end] = v
-        end
-      else
-        # reverse sense and overload existing edge
-        options.each do |k,v|
-          @edges[tonode][fromnode][case k.to_s
-                                   when 'label' : 'headlabel'
-                                   when 'midlabel' : 'label'
-                                   when /^arrow(?:head|tail)?$/ : 'arrowtail'
-                                   else k
-                                   end] = v
-        end
-      end
-    end
-
-    # Iterates over all the DOT formatted edges with nodes having the most
-    # edges first and the edges without a constraint attribute before those
-    # that do.
-    def edges(options={}) # :yields: edgestring
-      @edges.sort { |a,b| b[1].length <=> a[1].length }.each do |(fromnode,nh)|
-        nh.sort_by { |(t,a)| (a.has_key?('constraint') ^ options[:constraints_first]) ? 1 : 0 }.each do |tonode,eh|
-          e = "#{fromnode} -> #{tonode} "
-          e << eh.inspect(options) unless eh.nil?
-          yield e
-        end
-      end
-    end
-  end
+  RC_FILE = '.model_graph_rc'
 
   # classes that should not be graphed, but are subclasses of
   # ActiveRecord::Base
@@ -198,7 +132,7 @@ module ModelGraph
   #
   # If called with:
   #
-  #  model_graph.rb --edges=Author-Book
+  #  model_graph --edges=Author-Book
   #
   # will cause an edge between, for example, Author and Book which can alter
   # the relative hierarchical rank of the two nodes (placing the first above
@@ -210,7 +144,7 @@ module ModelGraph
   #
   # If called with:
   #
-  #  model_graph.rb --nodes=Author
+  #  model_graph --nodes=Author
   #
   # will cause a node to be placed into the output early.  This tends to make
   # a node appear further to the left in the resulting graph and can be used
@@ -222,14 +156,18 @@ module ModelGraph
   #
   # ===== Options
   #
-  # <tt>--name=<em>name</em>:: Change the name of the file into which the
+  # <tt>--name=<em>name</em></tt>:: Change the name of the file into which the
   #             graph is written and the internal name that is assigned.
   # <tt>--debug</tt>:: When set to _any_ value, causes comments describing the
   #             ActiveRecord models to be included in the DOT output.
   # <tt>--edges=<em>edges</em></tt>:: With a value of <tt>N1-N2</tt>
   #             [<em>/N3-N4</em>...] adds a relationship between <tt>N1</tt>
   #             and <tt>N2</tt> (and <tt>N3</tt> and <tt>N4</tt>, etc.) as
-  #             described above.
+  #             described above.  When separated by a '+' as in <tt>N1+N2</tt>,
+  #             the relative placement of the nodes will not be constrained
+  #             (this is sometimes useful for allowing nodes to share a 'rank'
+  #             and be rendered horizontally if there are no other
+  #             relationships).
   # <tt>--nodes=<em>nodes</em></tt>:: Adds extra +nodes+ early in the DOT
   #             output to influence placement.
   # <tt>--test</tt>:: Graphs an internal set of model classes rather than
@@ -238,14 +176,37 @@ module ModelGraph
   #             in the graph from +plaintext+ to any
   #             {valid DOT value}[http://www.graphviz.org/doc/info/shapes.html] is
   #             acceptable (try +rectangle+ or +ellipse+)
+  # <tt>--label</tt>:: Show edge labels
+  # <tt>--constraints-first</tt>:: (or '--cf') Output constrained edges first
+  #             (normally last).  This may improve the overall layout when
+  #             there are has_and_belongs_to_many relationships.
+  #
+  # ===== Persistent Options
   #
+  # Any of the options can be specified in a file named .model_graph_rc in the
+  # RAILS_ROOT directory which will be used to initialize the options prior to
+  # processing the command-line.
+  #
+  # Note that options on the command line supercede the contents of the
+  # .model_graph_rc file rather than add to it.  For 'edges=...' and
+  # 'nodes=...', this might be considered unfortunate when trying to influence
+  # the resulting layout after your models change.
+  #
+  # Sure it's a hack, but this special rc file can set or override the default
+  # options.  I use this for long "edges=..." lines mostly.  If model_graph
+  # was a bit smarter about the implicit layout, then perhaps this would be
+  # unnecessary.  However, the DOT documentation also mentions that this
+  # technique of influencing the layout by tweaking the order of nodes and
+  # edges is fragile anyway and may (should!) change in the future.
   def self.do_graph(options)
     output = ""
-    graph = Graph.new(options.name)
+    graph = ::Graph.new(options.name)
 
     if options.edges
-      options.edges.scan(%r{(\w+)-(\w+)/?}) do |f,t|
-        graph.add_edge(f, t, 'style' => 'solid')
+      options.edges.scan(%r{(\w+)([-+])(\w+)/?}) do |f,kind,t|
+        eopts = { 'style' => 'solid' }
+        eopts.merge!('constraint' => 'false') if kind == '+'
+        graph.add_edge(f, t, eopts)
       end
     end
 
@@ -290,17 +251,23 @@ module ModelGraph
           output << "\n"
         end
 
-        next unless a.class_name == a.name.to_s.camelize.singularize
+# Why was I skipping these?
+#         next unless a.class_name == a.name.to_s.camelize.singularize
+
         next if a.options[:polymorphic]
 
         opts = { 'label' => a.macro.to_s, 'arrow' => ARROW_FOR[a.macro] }
         opts.merge!('style' => 'dotted', 'constraint' => 'false') if a.through_reflection
         opts.merge!('color' => 'blue', 'midlabel' => a.options[:as].to_s.camelize.singularize) if a.options[:as]
+        opts.merge!('style' => 'dashed', 'color' => 'green', 'fontsize' => '8',
+                    'midlabel' => a.options[:foreign_key] || "#{a.name.to_s.singularize.underscore}_id"
+                    )  unless a.class_name == a.name.to_s.camelize.singularize
 
         opts.merge!('color' => 'red') if a.options[:finder_sql]
 
         fromnodename = klass.name
-        tonodename = a.name.to_s.camelize.singularize
+        #tonodename = a.name.to_s.camelize.singularize
+        tonodename = a.class_name
 
         if a.macro == :has_and_belongs_to_many
           tonodename = [fromnodename, tonodename].sort.join('_')
@@ -310,16 +277,17 @@ module ModelGraph
           graph.add_edge(tonodename, fromnodename, myopts)
           standalone = false
         end
-        if klass.name == klass.class_name
+        # Was this part of the polymorphic thing?
+        #if klass.name == klass.class_name
           graph.add_edge(fromnodename, tonodename, opts)
           if a.options[:as]
             graph.add_edge(tonodename, fromnodename,
                            'arrow' => ARROW_FOR[:belongs_to], 'fontcolor' => 'blue')
           end
           standalone = false
-        elsif options.debug
-          output << " // !! skipping edge #{fromnodename} -> #{tonodename} #{opts.inspect}\n"
-        end
+#         elsif options.debug
+#           output << " // !! skipping edge #{fromnodename} -> #{tonodename} #{opts.inspect}\n"
+#         end
       end
       graph.add_node(klass.name, %{[color=red, fontcolor=red]}) if standalone
     end
@@ -349,11 +317,25 @@ module ModelGraph
                            :label => false,
                            :constraints_first => false)
 
+  # Sure it's a hack, but a special rc file can set or override the
+  # default options.  I use this for long "edges=..." lines mostly.  If
+  # model_graph was a bit smarter about the implicit layout, then perhaps this
+  # would be unnecessary.  However, the DOT documentation also mentions that
+  # this technique of influencing the layout by tweaking the order of nodes
+  # and edges is fragile anyway and may (should!) change in the future.
+  File.open(RC_FILE, 'r') do |rc|
+    for line in rc
+      next if line =~ /\A\s*#/
+      var, value = line.split(/=/, 2)
+      options.send("#{var}=", value)
+    end
+  end if File.exists?(RC_FILE)
+
   OptionParser.new do |opts|
     opts.on("-t[=FILE]", "--test[=FILE]", String) do |val|
-      puts "test: #{val}"
+      puts "test: #{val}" if options.debug
       if val && File.exists?(val)
-        puts "getting #{val}..."
+        puts "getting #{val}..." if options.debug
         require val
         options.test = val
       else
@@ -362,13 +344,13 @@ module ModelGraph
     end
 
     opts.on("--sample=WHICH", String) do |val|
-      puts "sample: #{val}"
-      puts "__FILE__ = #{__FILE__}"
+      puts "sample: #{val}" if options.debug
+      puts "__FILE__ = #{__FILE__}" if options.debug
 
       sample = File.join(File.dirname(__FILE__), '..', 'examples',
                          File.basename(val, ".rb") + '.rb')
       if File.exists?(sample)
-        puts "getting #{sample} ..."
+        puts "getting #{sample} ..." if options.debug
         require sample
         options.test = sample
         options.name = File.basename(val, ".rb") if options.name == 'model'
@@ -382,21 +364,21 @@ module ModelGraph
     end
     opts.on("--nodes=NODELIST",
             "Add named nodes to graph") do |val|
-      puts "nodes: #{val}"
+      puts "nodes: #{val}" if options.debug
       options.nodes = val
     end
     opts.on("--edges=EDGELIST",
             "Add edges to graph (to affect node rank)") do |val|
-      puts "edges: #{val}"
+      puts "edges: #{val}" if options.debug
       options.edges = val
     end
     opts.on("--name=NAME",
             "Give the graph an internal name and use tmp/NAME.dot for the output") do |val|
-      puts "name: #{val}"
+      puts "name: #{val}" if options.debug
       options.name = val
     end
     opts.on("--shape=KIND", "override the shape of a node with a valid DOT shape") do |val|
-      puts "shape: #{val}"
+      puts "shape: #{val}" if options.debug
       options.shape = val
     end
     opts.on("--label", "-l", "show edge labels") { |val| options.label = true }
@@ -406,11 +388,11 @@ module ModelGraph
 
   end.parse!
 
-  puts options.to_s
+  puts options.to_s if options.debug
 
   unless options.test
     for f in Dir.glob(File.join(RAILS_ROOT || '.', "app/models", "*.rb"))
-      puts "getting #{f}..."
+      puts "getting #{f}..." if options.debug
       require f
     end
   else
@@ -449,10 +431,11 @@ module ModelGraph
           has_many :selfishes, :foreign_key => :solo_id
         end
         SAMPLE
-      puts 'doing the SAMPLE'
+      puts 'doing the SAMPLE' if options.debug
     end
   end
 
   do_graph(options)
 
 end
+__END__

data/lib/graph.rb

@@ -0,0 +1,71 @@
+# An internal class to collect abstract nodes and edges and deliver them
+# back when needed.
+class Graph
+  attr_reader :name
+
+  # Holds information about nodes and edges that should be depicted on the
+  # UML-ish graph of the ActiveRecord model classes.  The +name+ is optional
+  # and only serves to give the graph an internal name.  If you had an
+  # application to combine model graphs from multiple applications, this
+  # might be useful.
+  def initialize(name="model_graph")
+    @name = name
+    @nodes = Hash.new          # holds simple strings
+    @edges = Hash.new { |h,k| h[k] = Hash.new { |h2,k2| h2[k2] = Hash.new } }
+
+    # A hm B :as => Y    gives edge A->B and implies B bt A
+    # C hm B :as => Y    gives edge C->B and implies B bt A
+    # B bt Y :polymorphic => true       no new information
+  end
+
+  # Create an unattached node in this graph.
+  def add_node(nodename, options="")
+    @nodes[nodename] = options
+  end
+
+  # Iterates over all the nodes previously added to this graph.
+  def nodes                   # :yields: nodestring
+    @nodes.each do |name,options|
+      yield "#{name} #{options}"
+    end
+  end
+
+  # Create a directed edge from one node to another.  If an edge between
+  # nodes already exists in the opposite direction, the arrow will be
+  # attached to the other end of the existing edge.
+  def add_edge(fromnode, tonode, options={})
+    unless @edges[tonode].has_key? fromnode
+      options.each do |k,v|
+        @edges[fromnode][tonode][case k.to_s
+                                 when 'label' : 'taillabel'
+                                 when 'midlabel' : 'label'
+                                 when /^arrow(?:head|tail)?$/ : 'arrowhead'
+                                 else k
+                                 end] = v
+      end
+    else
+      # reverse sense and overload existing edge
+      options.each do |k,v|
+        @edges[tonode][fromnode][case k.to_s
+                                 when 'label' : 'headlabel'
+                                 when 'midlabel' : 'label'
+                                 when /^arrow(?:head|tail)?$/ : 'arrowtail'
+                                 else k
+                                 end] = v
+      end
+    end
+  end
+
+  # Iterates over all the DOT formatted edges with nodes having the most
+  # edges first and the edges without a constraint attribute before those
+  # that do.
+  def edges(options={}) # :yields: edgestring
+    @edges.sort { |a,b| b[1].length <=> a[1].length }.each do |(fromnode,nh)|
+      nh.sort_by { |(t,a)| (a.has_key?('constraint') ^ options[:constraints_first]) ? 1 : 0 }.each do |tonode,eh|
+        e = "#{fromnode} -> #{tonode} "
+        e << eh.inspect(options) unless eh.nil?
+        yield e
+      end
+    end
+  end
+end

data/lib/model_graph.rb

@@ -1 +1 @@
-Dir[File.join(File.dirname(__FILE__), 'model_graph/**/*.rb')].sort.each { |lib| require lib }
+Dir[File.join(File.dirname(__FILE__), '**/*.rb')].sort.each { |lib| require lib }

data/lib/model_graph/version.rb

@@ -2,7 +2,7 @@ module ModelGraph
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.3
 specification_version: 1
 name: model_graph
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2006-11-22 00:00:00 -05:00
+  version: 0.1.3
+date: 2007-05-23 00:00:00 -04:00
 summary: "When run from the trunk of a Rails project, produces # {DOT}[http://www.graphviz.org/doc/info/lang.html] output which can be # rendered into a graph by programs such as dot and neato and viewed with # Graphviz (an {Open Source}[http://www.graphviz.org/License.php] viewer)."
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Rob Biedenharn
 files: 
@@ -61,6 +62,7 @@ files:
 - doc/files/model_graph_rb.html
 - test/model_graph_test.rb
 - test/test_helper.rb
+- lib/graph.rb
 - lib/model_graph
 - lib/model_graph.rb
 - lib/model_graph/version.rb