dotr 0.2 → 0.3

data/lib/dotr.rb

@@ -1,4 +1,22 @@
 module DotR
+  module Styled # :nodoc:
+    def method_missing(method, *args)
+      return super unless /^(\w+)=$/ =~ method.to_s && args.size == 1
+      style_attrs()[$1.to_sym] = args.first
+    end
+
+    def style
+      return '' if style_attrs.empty?
+      " [" + style_attrs.keys.sort_by { |k| k.to_s }.map { |k| "#{k}=\"#{style_attrs[k]}\"" }.join(',') + "]"
+    end
+
+    private
+
+    def style_attrs
+      @style_attrs ||= {}
+    end
+  end
+
   # This class represents a directed graph that can be rendered to a graphics
   # image using its #diagram method.
   #
@@ -14,12 +32,20 @@ module DotR
   #   end
   #   File.open('diagram.png', 'w') { |f| f.write(d.diagram(:png)) }
   class Digraph
+    include Styled
     attr_accessor :name
+
     # Create a new Digraph.  If a block is provided it will be called with
     # the graph as a parameter.
-    def initialize(name="diagram", &block)
+    #
+    # Specify styles on this object by setting instance attributes.
+    # Possible attributes include 'label' and 'fontsize'; the attribute names and
+    # possible values correspond to the style attributes described in the 'dot' manual.
+    def initialize(name="diagram", style={}, &block)
       @name = name
       @nodes = []
+      @subgraphs = []
+      style_attrs.update(style)
       yield self if block
     end
 
@@ -31,7 +57,7 @@ module DotR
     end
 
     # Create a connection in the graph between two nodes with the given names.
-    # If a block is provided # it will be called with the connection as a parameter,
+    # If a block is provided it will be called with the connection as a parameter,
     # for convenient specification of styles.
     #
     # Nodes with the given names are implicitly created if they have not
@@ -42,10 +68,24 @@ module DotR
       end
     end
 
+    # Create a subgraph of the same type, which can have distinct formatting
+    # and its own nodes.
+    #
+    # Example:
+    #
+    #   d = DotR::Digraph.new('myname') do |g|
+    #     g.subgraph('subg', :color => "lightgrey") do |s|
+    #       s.connection("foo", "bar")
+    #     end
+    #   end
+    def subgraph(name, style={}, &block)
+      @subgraphs << self.class.new(name, style, &block)
+    end
+
     # Returns the dot input script equivalent of this digraph
     def to_s
       script = []
-      render_to(script)
+      render_to("digraph", script)
       script.flatten.join("\n") + "\n"
     end
 
@@ -61,35 +101,19 @@ module DotR
       end
     end
 
-    private
-
-    def render_to(output_lines)
-      output_lines << "digraph \"#{name}\" {"
-      @nodes.each { |node| node.render_to(output_lines) }
-      output_lines << '}'
+    def render_to(graph_type, output_lines, indent="")
+      output_lines << "#{indent}#{graph_type} \"#{name}\" {"
+      @subgraphs.each { |node| node.render_to("subgraph", output_lines, indent + "  ") }
+      @nodes.each { |node| node.render_to(output_lines, indent + "  ") }
+      style_attrs.each do |k,v|
+        output_lines << "#{indent}  #{k}=\"#{v}\";"
+      end
+      output_lines << "#{indent}}"
     end
-
   end
 
-  private
-
-  module Styled # :nodoc:
-    def method_missing(method, *args)
-      return super unless /^(\w+)=$/ =~ method.to_s && args.size == 1
-      style_attrs()[$1.to_sym] = args.first
-    end
-
-    def style
-      return '' if style_attrs.empty?
-      " [" + style_attrs.keys.sort_by { |k| k.to_s }.map { |k| "#{k}=\"#{style_attrs[k]}\"" }.join(',') + "]"
-    end
-
-    private
 
-    def style_attrs
-      @style_attrs ||= {}
-    end
-  end
+  private
 
   # Represents a node in a digraph.  Instances of this class are created by calling
   # Digraph#node.
@@ -113,9 +137,9 @@ module DotR
       @connections << Connection.new(self.name, other_node_name, style, &block)
     end
 
-    def render_to(output_lines)  #:nodoc:
-      output_lines << "\"#{self.name}\"" + style + ";"
-      @connections.each { |c| c.render_to(output_lines) }
+    def render_to(output_lines, indent)  #:nodoc:
+      output_lines << "#{indent}\"#{self.name}\"" + style + ";"
+      @connections.each { |c| c.render_to(output_lines, indent) }
     end
   end
 
@@ -137,8 +161,8 @@ module DotR
       yield self if block
     end
 
-    def render_to(output_lines)  # :nodoc:
-      output_lines << "\"#{from_name}\" -> \"#{to_name}\"" + style + ";"
+    def render_to(output_lines, indent)  # :nodoc:
+      output_lines << "#{indent}\"#{from_name}\" -> \"#{to_name}\"" + style + ";"
     end
   end
 end

data/test/dotr_test.rb

@@ -102,10 +102,45 @@ class DotRDigraphTest < Test::Unit::TestCase
     END
   end
 
+  def test_can_style_nodes_independently
+    d = DotR::Digraph.new do |graph|
+      graph.node('foo', :fontsize => 8)
+      graph.node('bar', :fontsize => 5, :label => "Bar")
+    end
+    assert_digraph_equals <<-END, d
+      digraph "diagram" {
+        "foo" [fontsize="8",label="foo"];
+        "bar" [fontsize="5",label="Bar"];
+      }
+    END
+  end
+
+  def test_can_style_empty_graph
+    d = DotR::Digraph.new('myname', :fontsize => 6)
+    assert_digraph_equals <<-END, d
+      digraph "myname" {
+        fontsize="6";
+      }
+    END
+  end
+
+  def test_can_define_empty_subgraph
+    d = DotR::Digraph.new('myname') do |g|
+      g.subgraph('subg')
+    end
+    assert_digraph_equals <<-END, d
+      digraph "myname" {
+        subgraph "subg" {
+        }
+      }
+    END
+  end
+
   private
 
   def assert_digraph_equals expected, digraph
-    assert_equal(expected.strip.gsub(/^\s+/, ''), digraph.to_s.strip)
+    prefix = expected.scan(/^(\s+)/).first
+    assert_equal(expected.strip.gsub(/^#{prefix}/, ''), digraph.to_s.strip)
   end
 
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: dotr
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2006-12-03 00:00:00 +01:00
+  version: "0.3"
+date: 2007-02-11 00:00:00 +01:00
 summary: Produce directed graph images using the 'dot' utility.
 require_paths: 
 - lib