GraphvizR 0.0.1 → 0.1.0

data/History.txt

@@ -1,4 +1,10 @@
-== 1.0.0 / 2007-02-11
+== 0.1.0 / 2007-02-15
+
+* some feature is added
+  * undirected graph is available
+  * generate more sophisticated dot file
+
+== 0.0.1 / 2007-02-11
 
 * 1 major enhancement
   * Birthday!

data/README.txt

@@ -1,4 +1,4 @@
-GraphvizR
+= GraphvizR
     by ANDO Yasushi
     http://blog.technohippy.net
 
@@ -39,9 +39,13 @@ replies the dot code:
 
 To know more detail, please see test/test_graphviz_r.rb
 
-== REQUIREMENTS:
+== DEPENDENCIES:
 
-* Check Graphviz specification
+* Graphviz (http://www.graphviz.org/)
+
+== TODO:
+
+* rails plugin
 
 == INSTALL:
 

data/lib/graphviz_r.rb

@@ -1,5 +1,6 @@
 class GraphvizR
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
+  INDENT_UNIT = '  '
 
   class Attributes
     def initialize(name, dot)
@@ -27,8 +28,18 @@ class GraphvizR
     end
 
     def >>(node)
+      @dot.directed!
+      add_edge_on_dot node
+    end
+
+    def -(node)
+      @dot.undirected!
+      add_edge_on_dot node
+    end
+
+    def add_edge_on_dot(node)
       prop = @prop.merge node.prop
-      edge = Edge.new(self, node, prop)
+      edge = Edge.new(self, node, @dot, prop)
       @dot.add_edge edge
       edge
     end
@@ -51,14 +62,14 @@ class GraphvizR
       name = @port.dup
       name.unshift @name
       name.map{|e| e.to_dot}.join(':')
-      #@name.to_dot
     end
   end
 
   class Edge
-    def initialize(from, to, prop={})
+    def initialize(from, to, dot, prop={})
       @from = from
       @to = to
+      @dot = dot
       @property = prop
     end
     
@@ -71,7 +82,7 @@ class GraphvizR
     end
 
     def to_dot
-      dot = "#{node_to_dot @from} -> #{node_to_dot @to}"
+      dot = "#{node_to_dot @from} #{@dot.directed? ? '->' : '--'} #{node_to_dot @to}"
       dot += " #{@property.to_dot}" unless @property.empty?
       dot
     end
@@ -85,7 +96,7 @@ class GraphvizR
     GraphvizR.new(name, prop).to_dot
   end
 
-  def initialize(name, prop={}, graph_type='digraph')
+  def initialize(name, prop={}, parent=nil, indent=0)
     if name.is_a? Array
       initialize(*name)
     else
@@ -95,7 +106,9 @@ class GraphvizR
       @node_properties = {}
       @graph_properties = {}
       @subgraphs = []
-      @graph_type = graph_type
+      @indent = indent + 1
+      @parent = parent
+      @directed = true
       interprete prop
     end
   end
@@ -128,24 +141,60 @@ class GraphvizR
       f = from.keys[0]
       t = from[f]
       p = to
-      @edges << Edge.new(f, t, p)
+      @edges << Edge.new(f, t, self, p)
     elsif to.nil? 
       # from is Edge instance
       @edges << from 
     else
-      @edges << Edge.new(from, to)
+      @edges << Edge.new(from, to, self)
     end
   end
 
   def add_subgraph(graphs)
     graphs.to_a.sort.each do |key_prop|
-      @subgraphs << self.class.new(key_prop[0], key_prop[1], 'subgraph')
+      @subgraphs << self.class.new(key_prop[0], key_prop[1], self, @indent)
+    end
+  end
+  
+  def subgraph?
+    not @parent.nil?
+  end
+
+  def directed!
+    if subgraph?
+      @parent.directed!
+    else
+      @directed = true
+    end
+  end
+
+  def undirected!
+    if subgraph?
+      @parent.undirected!
+    else
+      @directed = false
+    end
+  end
+
+  def directed?
+    if subgraph?
+      @parent.directed?
+    else
+      @directed
+    end
+  end
+
+  def undirected?
+    if subgraph?
+      @parent.undirected?
+    else
+      !@directed
     end
   end
 
   def [](key, *args, &block)
     if block
-      subgraph = self.class.new(key, {}, 'subgraph')
+      subgraph = self.class.new key, {}, self, @indent
       block.call subgraph
       @subgraphs << subgraph
     else
@@ -176,16 +225,28 @@ class GraphvizR
   end
 
   def to_dot
-    dot = "#{@graph_type} #{@name} {"
-    dot += "graph #{@graph_properties.to_dot};" unless @graph_properties.empty?
-    dot += @subgraphs.map{|e| e.to_dot}.join("\n") unless @subgraphs.empty?
+    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(@subgraphs.map{|e| e.to_dot}.join("\n")) unless @subgraphs.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 += @edges.sort.map{|e| "#{e.to_dot};"}.join("\n")
-    dot += "}"
+    dot += @edges.sort.map{|e| indent_enter("#{e.to_dot};")}.join("")
+    dot += indent_enter("}", true)
     dot
   end
 
+  def indent_enter(str, is_first=false)
+    "#{INDENT_UNIT * (@indent - (is_first ? 1 : 0))}#{str}\n"
+  end
+
   def data(format='png')
     gv = IO.popen "dot -q -T#{format || 'png'}", "w+"
     gv.puts to_dot
@@ -216,7 +277,7 @@ class GraphvizR
 protected
 
   def properties_to_dot(hash)
-    hash.to_a.sort.map{|e| "#{e[0]} #{e[1].to_dot};"}.join("\n")
+    hash.to_a.sort.map{|e| indent_enter "#{e[0]} #{e[1].to_dot};"}.join()
   end
 end
 

data/test/test_graphviz_r.rb

@@ -17,7 +17,7 @@ class TestGraphvizR < Test::Unit::TestCase
   end
 
   def test_basic
-    dot = GraphvizR.dot(:sample, 
+    gvr = GraphvizR.dot(:sample, 
                         :graph => {:size => "1.5, 2.5"},
                         :label => 'example',
                         :node_properties => {
@@ -28,7 +28,8 @@ class TestGraphvizR < Test::Unit::TestCase
                         :beta => :delta,
                         :delta => 'size'
                         )
-    assert_equal <<-end_of_string.gsub(/\s/, ''), dot.gsub(/\s/, '')
+    #assert_equal <<-end_of_string.gsub(/\s/, ''), gvr.gsub(/\s/, '')
+    assert_equal <<-end_of_string, gvr
 digraph sample {
   graph [label = "example", size = "1.5, 2.5"];
   beta [shape = box];
@@ -40,20 +41,20 @@ digraph sample {
     end_of_string
   end
 
-  #dot.graph = {:label => 'example', :size => '1.5, 2.5'}
-  #dot.beta = {:shape => :box}
-  #dot.graph[:label => 'example', :size => '1.5, 2.5']
-  #dot.beta[:shape => :box]
+  #gvr.graph = {:label => 'example', :size => '1.5, 2.5'}
+  #gvr.beta = {:shape => :box}
+  #gvr.graph[:label => 'example', :size => '1.5, 2.5']
+  #gvr.beta[:shape => :box]
   def test_basic_dynamic
-    dot = GraphvizR.new 'sample'
-    dot.graph [:label => 'example', :size => '1.5, 2.5'] 
-    dot.beta [:shape => :box]                            
-    dot.alpha >> dot.beta
-    (dot.alpha >> dot.gamma) [:label => 'label1']
-    (dot.beta >> dot.delta) [:label => 'label2']
-    dot.delta >> dot[:size]
-
-    assert_equal <<-end_of_string.gsub(/\s/, ''), dot.to_dot.gsub(/\s/, '')
+    gvr = GraphvizR.new 'sample'
+    gvr.graph [:label => 'example', :size => '1.5, 2.5'] 
+    gvr.beta [:shape => :box]                            
+    gvr.alpha >> gvr.beta
+    (gvr.alpha >> gvr.gamma) [:label => 'label1']
+    (gvr.beta >> gvr.delta) [:label => 'label2']
+    gvr.delta >> gvr[:size]
+
+    assert_equal <<-end_of_string, gvr.to_dot
 digraph sample {
   graph [label = "example", size = "1.5, 2.5"];
   beta [shape = box];
@@ -66,7 +67,7 @@ digraph sample {
   end
 
   def test_record
-    dot = GraphvizR.dot(:sample, 
+    gvr = GraphvizR.dot(:sample, 
                         :graph => {:size => "1.5, 2.5"},
                         :node => {:shape => :record},
                         :node_properties => {
@@ -78,7 +79,8 @@ digraph sample {
                         :node2 => [:node1, :p_center],
                         {:node2 => [:node1, :p_right]} => {:label => 'record'}
                         )
-    assert_equal <<-end_of_string.gsub(/\s/, ''), dot.gsub(/\s/, '')
+    #assert_equal <<-end_of_string.gsub(/\s/, ''), gvr.gsub(/\s/, '')
+    assert_equal <<-end_of_string, gvr
 digraph sample {
   graph [size = "1.5, 2.5"];
   node [shape = record];
@@ -92,22 +94,22 @@ digraph sample {
     end_of_string
   end
 
-  #dot.size = '1.5, 2.5'
-  #dot.node = {:shape => :record}
-  #d dot.node1 = {:label => "<p_left> left|<p_center>center|<p_right> right"}
-  #dot.node2 = {:label => "left|center|right"}
+  #gvr.size = '1.5, 2.5'
+  #gvr.node = {:shape => :record}
+  #d gvr.node1 = {:label => "<p_left> left|<p_center>center|<p_right> right"}
+  #gvr.node2 = {:label => "left|center|right"}
   def test_record_dynamic
-    dot = GraphvizR.new 'sample'
-    dot.graph [:size => '1.5, 2.5']
-    dot.node [:shape => :record]
-    dot.node1 [:label => "<p_left> left|<p_center>center|<p_right> right"]
-    dot.node2 [:label => "left|center|right"]
-    dot.node1 >> dot.node2
-    dot.node1(:p_left) >> dot.node2
-    dot.node2 >> dot.node1(:p_center)
-    (dot.node2 >> dot.node1(:p_right)) [:label => 'record']
-
-    assert_equal <<-end_of_string.gsub(/\s/, ''), dot.to_dot.gsub(/\s/, '')
+    gvr = GraphvizR.new 'sample'
+    gvr.graph [:size => '1.5, 2.5']
+    gvr.node [:shape => :record]
+    gvr.node1 [:label => "<p_left> left|<p_center>center|<p_right> right"]
+    gvr.node2 [:label => "left|center|right"]
+    gvr.node1 >> gvr.node2
+    gvr.node1(:p_left) >> gvr.node2
+    gvr.node2 >> gvr.node1(:p_center)
+    (gvr.node2 >> gvr.node1(:p_right)) [:label => 'record']
+
+    assert_equal <<-end_of_string, gvr.to_dot
 digraph sample {
   graph [size = "1.5, 2.5"];
   node [shape = record];
@@ -122,7 +124,7 @@ digraph sample {
   end
 
   def test_subgraph
-    dot = GraphvizR.dot(:sample, 
+    gvr = GraphvizR.dot(:sample, 
                         :subgraphs => {
                           :cluster0 => {
                             :color => :blue,
@@ -144,10 +146,11 @@ digraph sample {
                         {:c => :f} => {:lhead => :cluster1},
                         {:a => :f} => {:ltail => :cluster0, :lhead => :cluster1}
                         )
-    assert_equal <<-end_of_string.gsub(/\s/, ''), dot.gsub(/\s/, '')
+    #assert_equal <<-end_of_string.gsub(/\s/, ''), gvr.gsub(/\s/, '')
+    assert_equal <<-end_of_string, gvr
 digraph sample {
   subgraph cluster0 {
-    graph [color = blue, label ="area 0", style = bold];
+    graph [color = blue, label = "area 0", style = bold];
     a -> b;
     a -> c;
   }
@@ -171,26 +174,26 @@ digraph sample {
   #c1.label = 'area 1'
   #c1.style = :filled
   def test_subgrpah_dynamic
-    dot = GraphvizR.new 'sample'
-    dot.cluster0 do |c0|
+    gvr = GraphvizR.new 'sample'
+    gvr.cluster0 do |c0|
       c0.graph [:color => :blue, :label => 'area 0', :style => :bold]
       c0.a >> c0.b
       c0.a >> c0.c
     end
-    dot.cluster1 do |c1|
+    gvr.cluster1 do |c1|
       c1.graph [:fillcolor => '#cc9966', :label => 'area 1', :style => :filled]
       c1.d >> c1.e
       c1.d >> c1.f
     end
-    (dot.a >> dot.f) [:lhead => :cluster1, :ltail => :cluster0]
-    dot.b >> dot.d
-    (dot.c >> dot.d) [:ltail => :cluster0]
-    (dot.c >> dot.f) [:lhead => :cluster1]
+    (gvr.a >> gvr.f) [:lhead => :cluster1, :ltail => :cluster0]
+    gvr.b >> gvr.d
+    (gvr.c >> gvr.d) [:ltail => :cluster0]
+    (gvr.c >> gvr.f) [:lhead => :cluster1]
 
-    assert_equal <<-end_of_string.gsub(/\s/, ''), dot.to_dot.gsub(/\s/, '')
+    assert_equal <<-end_of_string, gvr.to_dot
 digraph sample {
   subgraph cluster0 {
-    graph [color = blue, label ="area 0", style = bold];
+    graph [color = blue, label = "area 0", style = bold];
     a -> b;
     a -> c;
   }
@@ -203,6 +206,66 @@ digraph sample {
   b -> d;
   c -> d [ltail = cluster0];
   c -> f [lhead = cluster1];
+}
+    end_of_string
+  end
+
+  def test_undirected_graph
+    gvr = GraphvizR.new 'sample'
+    gvr.graph [:label => 'example', :size => '1.5, 2.5'] 
+    gvr.beta [:shape => :box]                            
+    gvr.alpha - gvr.beta
+    (gvr.alpha - gvr.gamma) [:label => 'label1']
+    (gvr.beta - gvr.delta) [:label => 'label2']
+    gvr.delta - gvr[:size]
+
+    #assert_equal <<-end_of_string.gsub(/\s/, ''), gvr.to_dot.gsub(/\s/, '')
+    assert_equal <<-end_of_string, gvr.to_dot
+graph sample {
+  graph [label = "example", size = "1.5, 2.5"];
+  beta [shape = box];
+  alpha -- beta;
+  alpha -- gamma [label = "label1"];
+  beta -- delta [label = "label2"];
+  delta -- size;
+}
+    end_of_string
+  end
+
+  def test_undirected_subgrpah
+    gvr = GraphvizR.new 'sample'
+    gvr.cluster0 do |c0|
+      c0.graph [:color => :blue, :label => 'area 0', :style => :bold]
+      c0.a - c0.b
+      c0.a - c0.c
+    end
+    gvr.cluster1 do |c1|
+      c1.graph [:fillcolor => '#cc9966', :label => 'area 1', :style => :filled]
+      c1.d - c1.e
+      c1.d - c1.f
+    end
+    (gvr.a - gvr.f) [:lhead => :cluster1, :ltail => :cluster0]
+    gvr.b - gvr.d
+    (gvr.c - gvr.d) [:ltail => :cluster0]
+    (gvr.c - gvr.f) [:lhead => :cluster1]
+
+    #assert_equal <<-end_of_string.gsub(/\s/, ''), gvr.to_dot.gsub(/\s/, '')
+    assert_equal <<-end_of_string, gvr.to_dot
+graph sample {
+  subgraph cluster0 {
+    graph [color = blue, label = "area 0", style = bold];
+    a -- b;
+    a -- c;
+  }
+  subgraph cluster1 {
+    graph [fillcolor = "#cc9966", label = "area 1", style = filled];
+    d -- e;
+    d -- f;
+  }
+  a -- f [lhead = cluster1, ltail = cluster0];
+  b -- d;
+  c -- d [ltail = cluster0];
+  c -- f [lhead = cluster1];
 }
     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.0.1
-date: 2007-02-14 00:00:00 +09:00
+  version: 0.1.0
+date: 2007-02-15 00:00:00 +09:00
 summary: The author was too lazy to write a summary
 require_paths: 
   - lib