GraphvizR 0.3.2 → 0.4.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.4.0 / 2007-02-26
+
+* default attributes for edge can be specified
+* specify consective edges in one line
+* speciry node rank
+
 == 0.3.2 / 2007-02-21
 
 * add rdoc comments

data/README.txt

@@ -86,8 +86,6 @@ To know more detail, please see test/test_graphviz_r.rb
 
 == TODO:
 
-* cover all specification for graphviz
-
 == INSTALL:
 
 * sudo gem install graphviz_r

data/lib/graphviz_r.rb

@@ -33,7 +33,7 @@
 #   gvr = GraphvizR.new 'sample'
 #   gvr.alpha >> gvr.beta
 # generates
-#   diagraph sample {
+#   digraph sample {
 #     alpla -> beta
 #   }
 # while
@@ -44,6 +44,28 @@
 #     alpla -- beta
 #   }
 #
+# == Grouping Nodes
+#
+# When one node is the root of some nodes, you can aggregate the children by using an array.
+# For example,
+#   gvr = GraphvizR.new 'sample'
+#   gvr.alpha >> [gvr.beta, gvr.gamma, gvr.delta]
+# generates
+#   digraph sample {
+#     alpha -> {beta; gamma; delta;}
+#   }
+#
+# == Consective Edges
+#
+# You can write:
+#   gvr = GraphvizR.new 'sample'
+#   gvr.alpha >> gvr.beta >> gvr.gamma >> gvr.delta
+# instead of doing:
+#   gvr = GraphvizR.new 'sample'
+#   gvr.alpha >> gvr.beta
+#   gvr.beta >> gvr.gamma
+#   gvr.gamma >> gvr.delta
+#
 # == Graph Attributes
 # 
 # Attributes are specified by Hash in []. Thus, to set the fillcolor of a node abc, one would use
@@ -74,10 +96,17 @@
 #   (gvr.node2 >> gvr.node1(:p_right)) [:label => 'record']
 #   gvr.to_dot
 #
-# == Subgraph
+# == Rank
+#
+# Ranks of nodes can be set as the same value for other nodes.
+#   gvr.rank :same, [gvr.a, gvr.b, gvr.c]
+# means node a, b, and c has same rank value and generages:
+#   {rank = same; a; b; c;};
 #
-# Subgraph is a way to construct hierarchical graph in graphviz. GraphvizR allows you to use 
-# subgraphs by means of method calling with a block which has one argument. For example,
+# == Clusters
+#
+# Cluster is a way to construct hierarchical graph in graphviz. GraphvizR allows you to use 
+# clusters by means of method calling with a block which has one argument. For example,
 #   gvr = GraphvizR.new 'sample'
 #   gvr.cluster0 do |c0|
 #     c0.graph [:color => :blue, :label => 'area 0', :style => :bold]
@@ -112,7 +141,7 @@
 #     c -> f [lhead = cluster1];
 #
 class GraphvizR
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
   INDENT_UNIT = '  '
 
   # This represents graphviz attributes.
@@ -122,20 +151,20 @@ class GraphvizR
       @dot = dot
     end
 
-    def [](prop)
-      @dot.send :"#{@name}=", prop
+    def [](attr)
+      @dot.send :"#{@name}=", attr
     end
   end
 
   # This represents graphviz node.
   class Node
-    attr_reader :prop, :name
+    attr_reader :attr, :name
 
     def initialize(name, port, dot)
       @name = name
       @port = port || []
       @dot = dot
-      @prop = {}
+      @attr = {}
 
       if !@port.empty? and @port[0].is_a? Array and @port[0][0].is_a? Hash
         @dot[@name] = @port[0][0]
@@ -155,15 +184,21 @@ class GraphvizR
     end
 
     def add_edge_on_dot(node)
-      prop = @prop.merge node.prop
-      edge = Edge.new(self, node, @dot, prop)
+      attr = nil
+      if node.is_a? Array
+        node = NodeGroup.new node
+        attr = @attr
+      else
+        attr = @attr.merge node.attr
+      end
+      edge = Edge.new([self, node], @dot, attr)
       @dot.add_edge edge
       edge
     end
 
-    def [](prop)
-      @dot[@name] = prop
-      @prop.merge! prop
+    def [](attr)
+      @dot[@name] = attr
+      @attr.merge! attr
       self
     end
 
@@ -181,18 +216,43 @@ class GraphvizR
       name.map{|e| e.to_dot}.join(':')
     end
   end
+  
+  # Aggregate some nodes.
+  class NodeGroup
+    def initialize(nodes, attr={})
+      @nodes = nodes
+      @attributes = attr
+    end
+
+    def to_sym
+      to_dot.to_sym
+    end
+
+    def to_dot
+      dot = "{"
+      dot += @attributes.to_a.map{|e| "#{e[0]} = #{e[1]};"}.join(' ') unless @attributes.empty?
+      dot += ' ' unless @attributes.empty?
+      dot += @nodes.map{|e| "#{e.to_dot};"}.join(' ')
+      dot += "}"
+    end
+  end
 
   # This represents a graphviz edge.
   class Edge
-    def initialize(from, to, dot, prop={})
-      @from = from
-      @to = to
+    def initialize(nodes, dot, attr={})
+      @nodes = nodes
       @dot = dot
-      @property = prop
+      @attribute = attr
     end
-    
-    def [](prop)
-      @property.merge! prop
+
+    def [](attr)
+      @attribute.merge! attr
+    end
+
+    def >>(node, attr={})
+      @nodes << node
+      self[attr]
+      self
     end
 
     def node_to_dot(node)
@@ -200,8 +260,8 @@ class GraphvizR
     end
 
     def to_dot
-      dot = "#{node_to_dot @from} #{@dot.directed? ? '->' : '--'} #{node_to_dot @to}"
-      dot += " #{@property.to_dot}" unless @property.empty?
+      dot = @nodes.map{|e| node_to_dot e}.join " #{@dot.arrow} "
+      dot += " #{@attribute.to_dot}" unless @attribute.empty?
       dot
     end
 
@@ -210,20 +270,20 @@ class GraphvizR
     end
   end
 
-  # This returns dot formatted string from given properties. To know more about <tt>prop</tt>,
+  # This returns dot formatted string from given attributes. To know more about <tt>attr</tt>,
   # please see GraphvizR.new .
-  def self.dot(name, prop)
-    GraphvizR.new(name, prop).to_dot
+  def self.dot(name, attr)
+    GraphvizR.new(name, attr).to_dot
   end
 
   # This initialzes a GraphvizR instance.
   # +name+:: the name of the graph
-  # +prop+:: <b>!deprecated!</b> all properties for a graph can be given as a hash instance.
+  # +attr+:: <b>!deprecated!</b> all attributes for a graph can be given as a hash instance.
   #          Please guess the contents of the hash from the test or examples below:
   #            gvr = GraphvizR.dot(:sample, 
   #              :graph => {:size => "1.5, 2.5"},
   #              :label => 'example',
-  #              :node_properties => {
+  #              :node_attributes => {
   #                :beta => {:shape => :box},
   #              },
   #              :alpha => :beta,
@@ -235,7 +295,7 @@ class GraphvizR
   #      gvr = GraphvizR.dot(:sample, 
   #              :graph => {:size => "1.5, 2.5"},
   #              :node => {:shape => :record},
-  #              :node_properties => {
+  #              :node_attributes => {
   #                :node1 => {:label => "<p_left> left|<p_center>center|<p_right> right"},
   #                :node2 => {:label => "left|center|right"}
   #              },
@@ -269,34 +329,38 @@ class GraphvizR
   #            )
   # +parent+:: a parent graph is given when this graph is a subgraph.
   # +indent+:: indent level when this instance is converted to rdot.
-  def initialize(name, prop={}, parent=nil, indent=0)
+  def initialize(name, attr={}, parent=nil, indent=0)
     if name.is_a? Array
       initialize(*name)
     else
       @name = name
+      @default_graph_attributes = {}
+      @default_node_attributes = {}
+      @default_edge_attributes = {}
+      @node_attributes = {}
       @edges = []
-      @default_node_properties = {}
-      @node_properties = {}
-      @graph_properties = {}
       @subgraphs = []
+      @node_groups = []
       @indent = indent + 1
       @parent = parent
       @directed = true
-      interprete prop
+      interprete attr
     end
   end
 
-  def interprete(prop) #:nodoc:
-    prop.each do |k, v|
+  def interprete(attr) #:nodoc:
+    attr.each do |k, v|
       case k
-      when :node_property, :node_properties
-        add_node_properties v
+      when :node_attribute, :node_attributes
+        add_node_attributes v
       when :graph
-        @graph_properties.merge! v
+        @default_graph_attributes.merge! v
       when :label, :size, :color, :fillcolor, :style
-        @graph_properties[k] = v
+        @default_graph_attributes[k] = v
       when :node
-        @default_node_properties[k] = v
+        @default_node_attributes[k] = v
+      when :edge
+        @default_edge_attributes[k] = v
       when :subgraphs
         add_subgraph(v)
       else
@@ -305,9 +369,9 @@ class GraphvizR
     end
   end
 
-  # add properties for nodes
-  def add_node_properties(props)
-    @node_properties = props
+  # add attributes for nodes
+  def add_node_attributes(attrs)
+    @node_attributes = attrs
   end
 
   # add an edge to the graph
@@ -316,19 +380,19 @@ class GraphvizR
       f = from.keys[0]
       t = from[f]
       p = to
-      @edges << Edge.new(f, t, self, p)
+      @edges << Edge.new([f, t], self, p)
     elsif to.nil? 
       # from is Edge instance
       @edges << from 
     else
-      @edges << Edge.new(from, to, self)
+      @edges << Edge.new([from, to], self)
     end
   end
 
   # add subgraph
   def add_subgraph(graphs)
-    graphs.to_a.sort.each do |key_prop|
-      @subgraphs << self.class.new(key_prop[0], key_prop[1], self, @indent)
+    graphs.to_a.sort.each do |key_attr|
+      @subgraphs << self.class.new(key_attr[0], key_attr[1], self, @indent)
     end
   end
   
@@ -373,6 +437,10 @@ class GraphvizR
     end
   end
 
+  def arrow
+    directed? ? '->' : '--'
+  end
+
   # When block is given, create new subgraph. Otherwise, create new node.
   def [](key, *args, &block)
     if block
@@ -384,18 +452,18 @@ class GraphvizR
     end
   end
 
-  # set properties for a node
+  # set attributes for a node
   def []=(key, *args, &block)
-    @node_properties[key] = args[0]
+    @node_attributes[key] = args[0]
   end
 
   [:label, :size, :color, :fillcolor, :style].each do |method|
     define_method :"#{method}=" do |v|
-      @graph_properties[method] = v
+      @default_graph_attributes[method] = v
     end
   end
 
-  # set graph properties
+  # set graph attributes
   def graph(*args)
     if args.empty?
       Attributes.new :graph, self
@@ -404,20 +472,26 @@ class GraphvizR
     end
   end
 
-  # set graph properties
-  def graph=(prop)
-    @graph_properties.merge! prop
+  # set graph attributes
+  def graph=(attr)
+    @default_graph_attributes.merge! attr
+  end
+
+  def rank(same, nodes) 
+    @node_groups << (NodeGroup.new nodes, {:rank => same})
   end
 
   # convert this instance to dot
   def to_dot
     graph_type = if subgraph?; 'subgraph'elsif directed?; 'digraph' else 'graph' end
     dot = indent_enter("#{graph_type} #{@name} {", true)
-    dot += indent_enter("graph #{@graph_properties.to_dot};") unless @graph_properties.empty?
+    dot += indent_enter("graph #{@default_graph_attributes.to_dot};") unless @default_graph_attributes.empty?
     dot += @subgraphs.map{|e| e.to_dot}.join('') unless @subgraphs.empty?
-    dot += properties_to_dot(@default_node_properties) unless @default_node_properties.empty?
-    dot += properties_to_dot(@node_properties) unless @node_properties.empty?
+    dot += attributes_to_dot(@default_node_attributes) unless @default_node_attributes.empty?
+    dot += attributes_to_dot(@default_edge_attributes) unless @default_edge_attributes.empty?
+    dot += attributes_to_dot(@node_attributes) unless @node_attributes.empty?
     dot += @edges.sort.map{|e| indent_enter("#{e.to_dot};")}.join("")
+    dot += @node_groups.map{|e| indent_enter("#{e.to_dot};")}.join("")
     dot += indent_enter("}", true)
     dot
   end
@@ -466,12 +540,12 @@ class GraphvizR
 
 protected
 
-  def properties_to_dot(hash) #:nodoc:
+  def attributes_to_dot(hash) #:nodoc:
     hash.to_a.sort.map{|e| indent_enter "#{e[0]} #{e[1].to_dot};"}.join()
   end
 end
 
-class Number #:nodoc:
+class Numeric #:nodoc:
   def to_dot
     to_s
   end

data/test/test_graphviz_r.rb

@@ -20,7 +20,7 @@ class TestGraphvizR < Test::Unit::TestCase
     gvr = GraphvizR.dot(:sample, 
                         :graph => {:size => "1.5, 2.5"},
                         :label => 'example',
-                        :node_properties => {
+                        :node_attributes => {
                           :beta => {:shape => :box},
                         },
                         :alpha => :beta,
@@ -70,7 +70,8 @@ digraph sample {
     gvr = GraphvizR.dot(:sample, 
                         :graph => {:size => "1.5, 2.5"},
                         :node => {:shape => :record},
-                        :node_properties => {
+                        :edge => {:fontsize => 24},
+                        :node_attributes => {
                           :node1 => {:label => "<p_left> left|<p_center>center|<p_right> right"},
                           :node2 => {:label => "left|center|right"}
                         },
@@ -84,6 +85,7 @@ digraph sample {
 digraph sample {
   graph [size = "1.5, 2.5"];
   node [shape = record];
+  edge [fontsize = 24];
   node1 [label = "<p_left> left|<p_center>center|<p_right> right"];
   node2 [label = "left|center|right"];
   node1 -> node2;
@@ -296,6 +298,70 @@ digraph sample {
     assert_equal <<-end_of_string, gvr.data(:dot)
 digraph sample {
   "alpha" -> "beta" [label = "label1"];
+}
+    end_of_string
+  end
+
+  def test_consective_edges
+    gvr = GraphvizR.new 'sample'
+    gvr.alpha >> gvr.beta
+    gvr.alpha >> gvr.beta >> gvr.gamma
+    gvr.alpha >> gvr.beta >> gvr.gamma >> gvr.delta
+
+    assert_equal <<-end_of_string, gvr.to_dot
+digraph sample {
+  alpha -> beta;
+  alpha -> beta -> gamma;
+  alpha -> beta -> gamma -> delta;
+}
+    end_of_string
+  end
+
+  def test_node_group
+    gvr = GraphvizR.new 'sample'
+#    gvr.a >> gvr.grouping(){gvr.b, gvr.c, gvr.d}
+#    gvr.aa >> gvr.grouping(gvr.bb, gvr.cc, gvr.dd)
+#  a -> {b c d};
+#  aa -> {bb cc dd};
+    gvr.aaa >> [gvr.bbb, gvr.ccc, gvr.ddd]
+
+    assert_equal <<-end_of_string, gvr.to_dot
+digraph sample {
+  aaa -> {bbb; ccc; ddd;};
+}
+    end_of_string
+  end
+
+  def test_rank
+    gvr = GraphvizR.new 'sample'
+    gvr.graph [:size => "3, 3"]
+    gvr.Level_1 >> gvr.Level_2 >> gvr.Level_3
+    gvr.a >> gvr.b
+    gvr.a >> gvr.c
+    gvr.a >> gvr.d
+    gvr.b >> gvr.c
+    gvr.b >> gvr.e
+    gvr.d >> gvr.e
+    gvr.d >> gvr.f
+    #gvr.grouping(:rank => :same) {gvr.Level_1; gvr.a}
+    gvr.rank :same, [gvr.Level_1, gvr.a]
+    gvr.rank :same, [gvr.Level_2, gvr.c, gvr.b, gvr.d]
+    gvr.rank :same, [gvr.Level_3, gvr.e, gvr.f]
+
+    assert_equal <<-end_of_string, gvr.to_dot
+digraph sample {
+  graph [size = "3, 3"];
+  Level_1 -> Level_2 -> Level_3;
+  a -> b;
+  a -> c;
+  a -> d;
+  b -> c;
+  b -> e;
+  d -> e;
+  d -> f;
+  {rank = same; Level_1; a;};
+  {rank = same; Level_2; c; b; d;};
+  {rank = same; Level_3; e; f;};
 }
     end_of_string
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: GraphvizR
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
-date: 2007-02-21 00:00:00 +09:00
+  version: 0.4.0
+date: 2007-02-26 00:00:00 +09:00
 summary: Graphviz wrapper for Ruby and Rails
 require_paths: 
   - lib
@@ -35,8 +35,8 @@ description: "Graphviz wrapper for Ruby. This can be used as a common library, a
   node1 [:label => @label1] node2 [:label => @label2] node1 >> node2
   node1(:p_left) >> node2 node2 >> node1(:p_center) (node2 >> node1(:p_right))
   [:label => 'record']  == DEPENDENCIES:  * Graphviz (http://www.graphviz.org)  ==
-  TODO:  * cover all specification for graphviz  == INSTALL:  * sudo gem install
-  graphviz_r * if you want to use this in ruby on rails * script/plugin install
+  TODO:  == INSTALL:  * sudo gem install graphviz_r * if you want to use this in
+  ruby on rails * script/plugin install
   http://technohippy.net/svn/repos/graphviz_r/trunk/vendor/plugins/rdot   ==
   LICENSE:  (The MIT License)"
 autorequire: 
@@ -92,5 +92,5 @@ dependencies:
         - 
           - ">="
           - !ruby/object:Gem::Version 
-            version: 1.1.6
+            version: 1.2.0
       version: