ruby-graphviz 0.9.9 → 0.9.10

data/README.rdoc

@@ -10,6 +10,118 @@ Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Gregoire Lejeune
 
 Interface to the GraphViz graphing tool
 
+== CHANGELOG
+
+=== 0.9.11 :
+* TODO: GraphViz::Parser support block
+
+=== 0.9.10 :
+* Move ChangeLog in README
+* Add GraphViz::FamilyTree (alpha). See examples/sample33.rb
+* Major bugs corrections in GraphViz::Parser
+* Issue #10 : Anonymous graph (see Subgraphs and Clusters at http://www.graphviz.org/doc/info/lang.html). See examples/sample34.rb
+* GraphViz#add_graph can now take a block parameter. See example/sample34.rb
+* Add GraphViz.digraph and GraphViz.graph (same as GraphViz.new( ..., :type => "digraph" ) and GraphViz.new( ..., :type => "graph" )). See examples/sample35.rb
+* Add GraphViz#subgraph. See examples/sample35.rb
+* GraphViz::Parser support anonymous graph
+* Add lage node example. See examples/sample36.rb
+
+=== 0.9.9 :
+* Add graph as an accessor to allow you to set global graph attributs (like edge and node)
+* Add each_node, each_edge, each_graph (thanks to @metellius) and graph_count
+* Issue #9 (partial) - Solution : by default, a node will have his label set with the node ID)
+
+=== 0.9.8 :
+* Update graph and node posibility to set properties (see sample28.rb)
+* Issue #7: Path option is never being used to find the executable
+* Adding classes to check if the attributes are in the correct type
+* Issue #8: dots in href are escaped with backslash, which corrupts the URL (see sample29.rb)
+* Add posibility to use external libraries (see sample30.rb)
+* Add options -u and -s to ruby2gv
+* Add gem2gv
+
+=== 0.9.7 :
+* Issue #2: Small bug correction in escape_path_containing_blanks (by Andreas Ronge)
+* Issue #4: New find_executable (by reactive)
+* Issue #3: Tempfiles created in current working directory only in Windows
+* Issue #6: Respect "none" format in output options hash and respect String output-filename when the "none" format is selected. See examples/sample27.rb (by Dave Burt)
+
+=== 0.9.6 :
+* jRuby support (by obruening)
+* Issue #1 : STDOUT in binmode
+
+=== 0.9.5 :
+* Remove 'mkmf' dependency
+* GraphViz::Edge#[] modification
+* Small correction to escape the dot ('.') character (by Miguel Cabrera)
+
+=== 0.9.4 :
+* Escape nodes and edges attributs
+* GraphViz::escape corrections (by Dave Burt)
+* Add :errors option to set level of message suppression (default : suppress warning messages)
+
+=== 0.9.3 :
+* Minor bug correction for Windows
+* Use Open3.popen3 if installed, else use IO.popen (by Dave Burt)
+* Add '-', '>' and '>>' has aliases of '<<' to create an edge.
+
+=== 0.9.2 :
+* Escape nodes (by Dave Burt)
+* Handle errors from graphviz command (by Dave Burt)
+* Output as string (if String class is passed as file i.e. output(:pdf => String)) (by Dave Burt)
+
+=== 0.9.1 :
+* Bugs corrections
+* Add the ability to create edge like that : node1 << node2 << node3 ...
+* Complete README
+* Add a DOT parser. This parser has a lot of limitations. So don't use it in a production context !
+* :output and :file options are deprecated, please use :<format> => :<file>
+* You can now specify multiple outputs via :<format> => :<file> (see sample 22).
+
+=== 0.9.0 :
+* Add fdp example (sample 15)
+* Add edge between cluster and node and cluster and cluster support
+* GraphViz.add_node now support array (sample 16)
+* Bug correction in GraphViz.output (sample 19)
+* Add GraphViz#default to set default options (:use, :path and :output)
+* Add possibility to set node or edge attribut via :
+		node.<attribut>=<value> or node.<attribut>( <value> )
+		adge.<attribut>=<value> or adge.<attribut>( <value> )
+* Add GraphViz::Edge.set and GraphViz::Node.set
+* Add sample 20
+* Add GraphViz.node_count and GraphViz.edge_count by Daniel Cadenas Nión
+
+=== 0.8.2 : 
+* Update Node, Edge and Graph Attributes (see http://www.graphviz.org/doc/info/attrs.html)
+* Bugs corrections
+
+=== 0.8.1 :
+* Documentation
+
+=== 0.8.0 :
+* Add all the features of the current graphviz version
+
+=== 0.7.0 :
+* Add option "path" to output
+
+=== 0.6.0 :
+* Add undirected graph support
+
+=== 0.5.0 :
+* Preserve the original order of creation of nodes and edges
+
+=== 0.4.0 :
+* Add HTML-Labels
+
+=== 0.3.0 :
+* Bugs corrections
+
+=== 0.2.0 :
+* Pure ruby
+
+=== 0.1.0 :
+* Initial version
+
 == SYNOPSIS
 
 A basic example

data/examples/dot/dotgraph.dot

@@ -0,0 +1,28 @@
+digraph G {
+	graph [truecolor=true, bgcolor=transparent];
+	rankdir="LR";
+	subgraph {
+		rank = same;
+		mygraph [label = "# mygraph.dot\ldigraph G {\l  Hello -> World;\l}\l", shape = note, fontname = "Courier", fontsize=10];
+		image [image = "./hello.png", label = "", shape = note];
+	}
+	subgraph {
+		rank = same;
+		mysite [label = "\nexample.com\n ", shape = "component", fontname = "Arial"];
+		dotgraph [label = "\ndotgraph.net\n ", shape = "component", fontname = "Arial"];
+	}
+	subgraph cluster_0 {
+		label = "my_page.html";
+		fontname = "Courier";
+		fontsize = 10;
+		color = black;
+		zeimage [image = "./hello.png", label = "", shape = note]
+	}
+	
+	mygraph -> mysite [color = blue];
+	dotgraph -> image [color = red];
+	dotgraph -> mysite [color = red];
+	mysite -> dotgraph [color = blue];
+	image -> dotgraph [color = red];
+	mysite -> zeimage [color = red];
+}

data/examples/dot/rank.dot

@@ -0,0 +1,6 @@
+digraph G {
+	subgraph { rank = same; "node1"; "node2"; }
+	subgraph { rank = same; "nodeA"; "nodeB"; }
+	node1 -> nodeA;
+	node2 -> nodeB;
+}

data/examples/dot/test_parse.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../../lib" );
+require "graphviz"
+
+Dir.glob( "*.dot" ) { |f|
+  print "#{f} : "
+  begin
+    puts GraphViz.parse(f)
+  rescue => e
+    puts "Error #{e.message}"
+  end
+}

data/examples/maketest.bat

@@ -69,6 +69,8 @@
 @ruby sample31.rb
 @echo "sample32.rb"
 @ruby sample32.rb
+@echo "sample33.rb"
+@ruby sample33.rb
 
 
 @echo "shapes.rb"
@@ -82,6 +84,9 @@
 @pwd
 @echo "dot/hello_test.rb"
 @ruby hello_test.rb
+@echo "dot/test_parse.rb"
+@ruby test_parse.rb
+
 @cd ..
 
 @cd graphviz.org

data/examples/maketest.sh

@@ -71,6 +71,8 @@ echo "sample31.rb"
 ruby sample31.rb
 echo "sample32.rb"
 ruby sample32.rb
+echo "sample33.rb"
+ruby sample33.rb
 
 echo "shapes.rb"
 ruby shapes.rb 
@@ -83,6 +85,8 @@ cd dot
 pwd
 echo "dot/hello_test.rb"
 ruby hello_test.rb
+echo "dot/test_parse.rb"
+ruby test_parse.rb
 cd ..
 
 cd graphviz.org

data/examples/sample13b.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" );
+require "graphviz"
+
+puts GraphViz::new( "G" ) { |graph|
+  graph.node[:shape] = "ellipse"
+  graph.node[:color] = "black"
+  
+  graph[:color] = "black"
+  
+  graph.cluster0( ) do |cluster|
+    cluster[:label] = "process #1"
+    cluster[:style] = "filled"
+    cluster[:color] = "lightgrey"
+    
+    cluster.a0 :style => "filled", :color => "white"
+    cluster.a1 :style => "filled", :color => "white"
+    cluster.a2 :style => "filled", :color => "white"
+    cluster.a3 :style => "filled", :color => "white"
+    
+    cluster.a0 << cluster.a1
+    cluster.a1 << cluster.a2
+    cluster.a2 << cluster.a3
+  end
+  
+  graph.cluster1( :label => "process #2" ) do |cluster|
+    cluster.b0 :style => "filled", :color => "blue"
+    cluster.b1 :style => "filled", :color => "blue"
+    cluster.b2 :style => "filled", :color => "blue"
+    cluster.b3 :style => "filled", :color => "blue"
+    
+    cluster.b0 << cluster.b1
+    cluster.b1 << cluster.b2
+    cluster.b2 << cluster.b3
+  end
+  
+  graph.start :shape => "Mdiamond"
+  graph.endn :shape => "Msquare", :label => "end"
+  
+  graph.start << graph.cluster0.a0
+  graph.start << graph.cluster1.b0
+  graph.cluster0.a1 << graph.cluster1.b3
+  graph.cluster1.b2 << graph.cluster0.a3
+  graph.cluster0.a3 << graph.cluster0.a0
+  graph.cluster0.a3 << graph.endn
+  graph.cluster1.b3 << graph.endn
+}.output( :path => '/usr/local/bin/', :none => String )

data/examples/sample33.rb

@@ -0,0 +1,43 @@
+$:.unshift( "../lib" );
+require 'graphviz/family_tree'
+
+tree = GraphViz::FamilyTree.new do
+  generation do
+    abraham.is_a_man( "Abraham" )
+    mona.is_a_woman( "Mona" )
+    
+    abraham.is_maried_with mona
+    
+    clancy.is_a_man( "Clancy" )
+    jackeline.is_a_woman( "Jackeline" )
+    
+    clancy.is_maried_with jackeline
+  end
+  
+  generation do
+    herb.is_a_man( "Herb" )
+    homer.is_a_man( "Homer" )
+    
+    marge.is_a_woman( "Marge" )
+    patty.is_a_woman( "Patty" )
+    selma.is_a_woman( "Selma" )    
+
+    homer.is_maried_with marge
+  end
+  
+  couple( abraham, mona ).kids( herb, homer )
+  couple( clancy, jackeline ).kids( marge, patty, selma )
+  
+  generation do
+    bart.is_a_boy( "Bart" )
+    lisa.is_a_girl( "Lisa" )
+    maggie.is_a_girl( "Maggie" )
+    ling.is_a_boy( "Ling" )
+  end
+  
+  couple( homer, marge ).kids( bart, lisa, maggie )
+  
+  ling.kids( selma )
+end
+
+puts tree.graph.save( :none => String )

data/examples/sample34.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" )
+require "graphviz"
+
+GraphViz.new(:G) { |g|
+  g[:color] = "black"
+  
+  g.one :label => "1"
+
+  # This is an anonymous graph
+  c = g.add_graph( :rank => "same" ) { |c|
+    c.two :label => "2"
+    c.three :label => "3"
+    c.two << c.three
+  }
+
+  # And this is not!
+  k = g.add_graph( "Hello" ) { |k|
+    k.four :label => "4"
+    k.five :label => "5"
+    k.four << k.five
+  }
+
+  g.one << c.two
+  g.one << c.three
+  c.two << k.four
+  c.three << k.five
+}.output( :canon => String )

data/examples/sample35.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" )
+require "graphviz"
+
+GraphViz.digraph( :G ) { |g|
+  g[:truecolor => true, :bgcolor => "transparent", :rankdir => "LR"]
+  g.node[:label => "\N"]
+  
+  c1 = g.subgraph { |c|
+    c[:rank => "same"]
+    c.mygraph[
+      :label => '# mygraph.dot\ldigraph G {\l  Hello -> World\l}\l', 
+      :shape => "note", 
+      :fontname => "Courier", 
+      :fontsize => 10
+    ]
+    c.image[ :label => "", :shape => "note", :image => "./hello.png"]
+  }
+  
+  c2 = g.subgraph { |c|
+    c[:rank => "same"]
+    c.mysite[:label => "\nexample.com\n ", :shape => "component", :fontname => "Arial"]
+    c.dotgraph[:label => "\ndotgraph.net\n ", :shape => "component", :fontname => "Arial"]
+  }
+  
+  g.cluster_0 { |c|
+    c[
+      :label => "my_page.html",
+      :fontname => "Courier",
+      :fontsize => 10,
+      :color => "black"
+    ]
+    c.zeimage[:label => "", :shape => "note", :image => "./hello.png"]
+  }
+  
+  (c1.mygraph << c2.mysite)[:color => "blue"]
+  (c2.dotgraph << c1.image)[:color => "red"]
+  (c2.dotgraph << c2.mysite)[:color => "red"]
+  (c2.mysite << c2.dotgraph)[:color => "blue"]
+  (c1.image << c2.dotgraph)[:color => "red"]
+  (c2.mysite << g.cluster_0.zeimage)[:color => "red"]
+}.output( :png => "#{$0}.png" )

data/examples/sample36.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" )
+require "graphviz"
+
+GraphViz.graph( :G ) { |g|
+  last_line = []
+  node_number = 0
+  
+  100.times do |j|
+    # New_Line
+    new_line = []
+    c = g.subgraph( :rank => "same" )
+    
+    100.times do |i|
+      current_node = c.add_node( "N#{node_number}", :shape => "point", :label => "" )
+      last_node = new_line[-1]
+      unless last_node.nil?
+        c.add_edge( last_node, current_node )
+      end
+      new_line << current_node
+      top_first_node = last_line.shift
+      unless top_first_node.nil?
+        g.add_edge( top_first_node, current_node )
+        top_second_node = last_line.shift
+        unless top_second_node.nil?
+          g.add_edge( top_second_node, current_node )
+          last_line.unshift( top_second_node )
+        end
+      end
+      node_number = node_number + 1
+    end
+    last_line = new_line
+  end
+}.output( :png => "#{$0}.png" )

data/examples/sample40.rb

@@ -0,0 +1,46 @@
+$:.unshift( "../lib" );
+require 'graphviz/family_tree'
+
+tree = GraphViz::FamilyTree.new do
+  generation do
+    benoist.is_a_man( "Benoist" )
+    nathalie.is_a_woman( "Nathalie" )
+    
+    benoist.is_maried_with nathalie
+    
+    michel.is_a_man( "Michel" )
+    brigitte.is_a_woman( "Brigitte" )
+    
+    michel.is_maried_with brigitte
+  end
+  
+  generation do
+    charlotte.is_a_woman( "Charlotte" )
+    amelie.is_a_woman( "Amelie" )
+    clement.is_a_man( "Clement" )
+    gregoire.is_a_man( "Gregoire" )
+    
+    muriel.is_a_woman( "Muriel" )
+    gilles.is_a_man( "Gilles" )
+
+    gregoire.is_maried_with muriel
+  end
+  
+  couple( michel, brigitte ).kids( muriel, gilles )
+  couple( benoist, nathalie ).kids( charlotte, amelie, clement, gregoire )
+  
+  generation do
+    arthur.is_a_boy( "Arthur" )
+    colyne.is_a_girl( "Colyne" )
+    benedict.is_a_boy( "Benedict" )
+    maia.is_a_girl( "Maia" )
+    enaitz.is_a_boy( "Enaitz" )
+    milo.is_a_boy( "Milo" )
+  end
+  
+  gregoire.kids( arthur, colyne, benedict )
+  couple( gregoire, muriel ).kids( maia )
+  muriel.kids( enaitz, milo )
+end
+
+tree.graph.save( :png => "#{$0}.png" )

data/examples/simpsons.gv

@@ -0,0 +1,69 @@
+digraph FamilyTree {
+subgraph Generation0 {
+  rank = "same";
+  abraham [label = "Abraham", shape = "box", color = "blue"];
+  mona [label = "Mona", shape = "box", color = "pink"];
+  abrahamAndmona [shape = "point"];
+  abraham -> abrahamAndmona [dir = "none"]
+  abrahamAndmona -> mona [dir = "none"]
+  clancy [label = "Clancy", shape = "box", color = "blue"];
+  jackeline [label = "Jackeline", shape = "box", color = "pink"];
+  clancyAndjackeline [shape = "point"];
+  clancy -> clancyAndjackeline [dir = "none"]
+  clancyAndjackeline -> jackeline [dir = "none"]
+}
+subgraph Generation1 {
+  rank = "same";
+  herb [label = "Herb", shape = "box", color = "blue"];
+  homer [label = "Homer", shape = "box", color = "blue"];
+  homerAndmarge [shape = "point"];
+  marge [label = "Marge", shape = "box", color = "pink"];
+  patty [label = "Patty", shape = "box", color = "pink"];
+  selma [label = "Selma", shape = "box", color = "pink"];
+  homer -> homerAndmarge [dir = "none"]
+  homerAndmarge -> marge [dir = "none"]
+}
+subgraph abrahamAndmonaKids {
+  rank = "same";
+  herbKid [label = "herbKid", shape = "point"];
+  abrahamAndmonaKids [label = "abrahamAndmonaKids", shape = "point"];
+  herbKid -> abrahamAndmonaKids [dir = "none"]
+  homerKid [label = "homerKid", shape = "point"];
+  abrahamAndmonaKids -> homerKid [dir = "none"]
+}
+  herbKid -> herb [dir = "none"]
+  abrahamAndmona -> abrahamAndmonaKids [dir = "none"]
+  homerKid -> homer [dir = "none"]
+subgraph clancyAndjackelineKids {
+  rank = "same";
+  margeKid [label = "margeKid", shape = "point"];
+  pattyKid [label = "pattyKid", shape = "point"];
+  margeKid -> pattyKid [dir = "none"]
+  selmaKid [label = "selmaKid", shape = "point"];
+  pattyKid -> selmaKid [dir = "none"]
+}
+  margeKid -> marge [dir = "none"]
+  pattyKid -> patty [dir = "none"]
+  clancyAndjackeline -> pattyKid [dir = "none"]
+  selmaKid -> selma [dir = "none"]
+subgraph Generation2 {
+  rank = "same";
+  bart [label = "Bart", shape = "box", color = "blue"];
+  lisa [label = "Lisa", shape = "box", color = "pink"];
+  maggie [label = "Maggie", shape = "box", color = "pink"];
+  ling [label = "Ling", shape = "box", color = "blue"];
+}
+subgraph homerAndmargeKids {
+  rank = "same";
+  bartKid [label = "bartKid", shape = "point"];
+  lisaKid [label = "lisaKid", shape = "point"];
+  bartKid -> lisaKid [dir = "none"]
+  maggieKid [label = "maggieKid", shape = "point"];
+  lisaKid -> maggieKid [dir = "none"]
+}
+  bartKid -> bart [dir = "none"]
+  lisaKid -> lisa [dir = "none"]
+  homerAndmarge -> lisaKid [dir = "none"]
+  maggieKid -> maggie [dir = "none"]
+  ling -> selma [dir = "none"]
+}

data/lib/graphviz/constants.rb

@@ -40,7 +40,7 @@
 #   C => cluster
 #
 module Constants
-  RGV_VERSION = "0.9.9"
+  RGV_VERSION = "0.9.10"
   
   ## Const: Output formats
   FORMATS = [
@@ -242,7 +242,7 @@ module Constants
     "shapefile"           => { :usedBy => "N",    :type => :EscString },
     "showboxes"           => { :usedBy => "ENG",  :type => :EscString },
     "sides"               => { :usedBy => "N",    :type => :EscString },
-    "size"                => { :usedBy => "G",    :type => :EscString },
+    "size"                => { :usedBy => "NG",   :type => :EscString },
     "skew"                => { :usedBy => "N",    :type => :EscString },
     "smoothing"           => { :usedBy => "G",    :type => :EscString },
     "sortv"               => { :usedBy => "GCN",  :type => :EscString },

data/lib/graphviz/core_ext.rb

@@ -0,0 +1,20 @@
+class String
+  def self.random(size)
+    s = ""
+    d = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
+    size.times {
+      s << d[rand(d.size)]
+    }
+    return s
+  end
+end
+
+# From : http://www.geekmade.co.uk/2008/09/ruby-tip-normalizing-hash-keys-as-symbols/
+class Hash
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+end

data/lib/graphviz/dot.treetop

@@ -44,9 +44,17 @@ grammar Dot
 	end
 	
 	rule subgraph
+		named_subgraph / anonymous_subgraph
+	end
+	
+	rule named_subgraph
 	  space "subgraph" blank name:string space cluster:cluster space <GraphViz::Parser::Subgraph>
 	end
 	
+	rule anonymous_subgraph
+	  space "subgraph" space cluster:cluster space <GraphViz::Parser::AnonymousSubgraph>
+	end
+	
 	rule options
 		"[" space (name blank "=" blank string comma space)* name blank "=" blank string space "]" <GraphViz::Parser::Options>
 	end

data/lib/graphviz/family_tree/couple.rb

@@ -0,0 +1,52 @@
+class GraphViz
+  class FamilyTree
+    class Couple
+      def initialize( g, n )
+        @graph = g
+        @node = n
+      end
+      
+      def node
+        @node
+      end
+      
+      def kids( *z )
+        if z.size == 1
+          @graph.add_edge( @node, z[0].node, "dir" => "none" )
+        else
+          cluster = @graph.add_graph( "#{@node.name}Kids" )
+          cluster["rank"] = "same"
+
+          last = nil
+          count = 0
+          add = (z.size-1)%2 * z.size/2 + (z.size-1)%2
+          link = (z.size/2)+1 
+
+          z.each do |person|
+            count = count + 1
+            if count == add
+              middle = cluster.add_node( "#{@node.name}Kids", "shape" => "point" )
+              @graph.add_edge( @node, middle, "dir" => "none" )
+              unless last.nil?
+                cluster.add_edge( last, middle, "dir" => "none" )
+              end              
+              last = middle
+            end
+            
+            kid = cluster.add_node( "#{person.node.name}Kid", "shape" => "point" )
+            @graph.add_edge( kid, person.node, "dir" => "none" )
+            
+            if add == 0 and count == link
+              @graph.add_edge( @node, kid, "dir" => "none" )
+            end
+            
+            unless last.nil?
+              cluster.add_edge( last, kid, "dir" => "none" )
+            end
+            last = kid
+          end
+        end        
+      end
+    end
+  end
+end

data/lib/graphviz/family_tree/generation.rb

@@ -0,0 +1,25 @@
+class GraphViz
+  class FamilyTree
+    class Generation
+      def initialize( graph, persons, tree, gen_number )
+        @graph = graph
+        @persons = persons
+        @cluster = @graph.add_graph( "Generation#{gen_number}" )
+        @cluster["rank"] = "same"
+        @tree = tree
+      end
+      
+      def persons
+        @persons
+      end
+      
+      def make( &block )
+        instance_eval(&block) if block
+      end
+      
+      def method_missing(sym, *args, &block)
+        persons[sym.to_s] ||= GraphViz::FamilyTree::Person.new( @graph, @cluster, @tree, sym.to_s )
+      end
+    end
+  end
+end