ruby-graphviz 0.9.11 → 0.9.12

data/AUTHORS

@@ -11,3 +11,4 @@ hipe <http://github.com/hipe>
 Thanks to :
 
 Desmond Dsouza - Windows tests and corrections
+Vidar Hokstad and Ryan Shea - for nothugly.xsl

data/README.rdoc

@@ -1,10 +1,10 @@
 = Ruby/GraphViz
 
-Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Gregoire Lejeune
+Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Gregoire Lejeune
 
 * Doc : http://rdoc.info/projects/glejeune/Ruby-Graphviz
 * Sources : http://github.com/glejeune/Ruby-Graphviz
-* Continuous Integration : http://runcoderun.com/glejeune/Ruby-Graphviz
+* <b>NEW</b> - Mailing List : http://groups.google.com/group/ruby-graphviz
 
 == DESCRIPTION
 
@@ -12,12 +12,21 @@ Interface to the GraphViz graphing tool
 
 == CHANGELOG
 
+=== 0.9.12 :
+* GraphViz::Node#name is deprecated, you must use GraphViz::Node#id (issue #14)
+* Add :nothugly option to GraphViz#output (see sample41.rb and http://www.hokstad.com/making-graphviz-output-pretty-with-xsl.html)
+* Issue #13 : you must now specify a port in GraphViz::Edge.new with a syntax like this : 
+    GraphViz::Edge.new( {nodeOne => :port}, {nodeTwo => :other} )
+* Issue #12 : UTF8 support (see sample38.rb)
+* Move and rename examples + remove maketest.[sh|bat]
+* <b>WARNING</b> : FamilyTree is broken in this version !
+* TODO: GraphViz::Parser support block
+
 === 0.9.11 :
 * Issue #11 : Cygwin PATH
 * Major bugs correction in output
 * Bug correction in find_executable
 * Add tests (by Chip Malice : http://github.com/hipe)
-* TODO: GraphViz::Parser support block
 * TODO: Issue #12
 
 === 0.9.10 :
@@ -90,8 +99,8 @@ Interface to the GraphViz graphing tool
 * 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> )
+    node.<attribut>=<value> or node.<attribut>( <value> )
+    edge.<attribut>=<value> or edge.<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
@@ -174,11 +183,39 @@ Ruby/GraphViz also include :
 
 * ruby2gv, a simple tool that's allow you to create a dependency graph from a ruby script. Example : http://drp.ly/dShaZ
 
-	ruby2gv -Tpng -oruby2gv.png ruby2gv
+  ruby2gv -Tpng -oruby2gv.png ruby2gv
 
 * gem2gv, a tools that's allow you to create a dependency graph between gems. Example : http://drp.ly/dSj9Y
 
-	gem2gv -Tpng -oruby-graphviz.png ruby-graphviz
+  gem2gv -Tpng -oruby-graphviz.png ruby-graphviz
+
+At last, you can create familly tree with GraphViz::FamilyTree (<b>beta</b>) :
+
+  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
+    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" )
+  
+      gregoire.is_maried_with muriel
+    end
+  
+    couple( benoist, nathalie ).kids( charlotte, amelie, clement, gregoire )
+  end
+  
+  tree.graph.save( :png => "#{$0}.png" )
 
 == INSTALLATION
 
@@ -195,3 +232,8 @@ GNU General Public License (see the file 'COPYING').
 
 This program is distributed without any warranty. See the file
 'COPYING' for details.
+
+=== nothugly.xsl
+
+By Vidar Hokstad and Ryan Shea; Contributions by Jonas Tingborn,
+Earl Cummings, Michael Kennedy (Graphviz 2.20.2 compatibility, bug fixes, testing, lots of gradients)

data/bin/ruby2gv

@@ -142,9 +142,9 @@ class Rb2Gv
         end
         
         puts "  + Edge #{xLib} -> #{xRequiredLib}" if DEBUG
-        unless @hxEdge.include?( "#{@hxNodes[xLib].name}-#{@hxNodes[xRequiredLib].name}" )
+        unless @hxEdge.include?( "#{@hxNodes[xLib].id}-#{@hxNodes[xRequiredLib].id}" )
           @oGraph.add_edge( @hxNodes[xLib], @hxNodes[xRequiredLib] )
-          @hxEdge << "#{@hxNodes[xLib].name}-#{@hxNodes[xRequiredLib].name}"
+          @hxEdge << "#{@hxNodes[xLib].id}-#{@hxNodes[xRequiredLib].id}"
         end
       end
     end

data/examples/sample07.rb

@@ -17,7 +17,7 @@ g.add_node( "struct1", "shape" => "record", "label" => "<f0> left|<f1> middle|<f
 g.add_node( "struct2", "shape" => "record", "label" => "<f0> one|<f1> two" )
 g.add_node( "struct3", "shape" => "record", "label" => 'hello\nworld |{ b |{c|<here> d|e}| f}| g | h' )
 
-g.add_edge( "struct1:f1", "struct2:f0" )
-g.add_edge( "struct1:f2", "struct3:here" )
+g.add_edge( { "struct1" => :f1}, {"struct2" => :f0} )
+g.add_edge( {"struct1" => :f2}, {"struct3" => :here} )
 
 g.output( :png => "#{$0}.png", :canon => nil )

data/examples/sample08.rb

@@ -23,12 +23,12 @@ g.add_node( "node5", "label" => "{<n> t20 | 959 |<p> }", "width" => "1.5" )
 g.add_node( "node6", "label" => "{<n> o15 | 794 |<p> }", "width" => "1.5" )
 g.add_node( "node7", "label" => "{<n> s19 | 659 |<p> }", "width" => "1.5" )
 
-g.add_edge( "node0:f0", "node1:n" )
-g.add_edge( "node0:f1", "node2:n" )
-g.add_edge( "node0:f2", "node3:n" )
-g.add_edge( "node0:f5", "node4:n" )
-g.add_edge( "node0:f6", "node5:n" )
-g.add_edge( "node2:p", "node6:n" )
-g.add_edge( "node4:p", "node7:n" )
+g.add_edge( {"node0" => :f0}, {"node1" => :n} )
+g.add_edge( {"node0" => :f1}, {"node2" => :n} )
+g.add_edge( {"node0" => :f2}, {"node3" => :n} )
+g.add_edge( {"node0" => :f5}, {"node4" => :n} )
+g.add_edge( {"node0" => :f6}, {"node5" => :n} )
+g.add_edge( {"node2" => :p}, {"node6" => :n} )
+g.add_edge( {"node4" => :p}, {"node7" => :n} )
 
 g.output( :png => "#{$0}.png" )

data/examples/sample30.rb

@@ -9,4 +9,4 @@ GraphViz.new(:g){ |g|
   b = g.add_node("B", :shape => "sdl_save", :peripheries => 0)
   c = g.add_node("n", :shape => "box", :label => "\\G::\\N\\r")
   a << b << c
-}.save( :ps => "#{$0}.ps", :extlib => "sdlshapes/sdl.ps" )
+}.save( :ps => "#{$0}.ps", :extlib => File.join( File.dirname(__FILE__), "sdlshapes", "sdl.ps" ) )

data/examples/sample39.rb

@@ -0,0 +1,11 @@
+$:.unshift( "../lib" );
+require "graphviz"
+
+g = GraphViz::new( "G", :type => "graph" )
+n1 = g.add_node( "A" )
+n2 = g.add_node( "B" )
+n3 = g.add_node( "C" )
+e1 = g.add_edge( n1, n2 )
+e1[:dir] = 'forward'
+e2 = g.add_edge( n1, n3 )
+g.output( :png => "#{$0}.png" )

data/examples/sample40.rb

@@ -1,46 +1,17 @@
 $:.unshift( "../lib" );
-require 'graphviz/family_tree'
+require "graphviz"
 
-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" )
+graph = GraphViz.new( :G, :type => :digraph )
 
-    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
+node1 = graph.add_node("hello:world", 
+  "shape" => "record", 
+  "label" => "<left>|<f1> 1|<right>" )
 
-tree.graph.save( :png => "#{$0}.png" )
+node2 = graph.add_node("2", 
+  "shape" => "record", 
+  "label" => "<left>|<f1> 2|<right>" )
+
+graph.add_edge( {node1 => :left}, node2 )
+graph.add_edge( {node2 => :right}, node1 )
+
+puts graph.output( :none => String, :png => "#{$0}.png" )

data/examples/sample41.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" )
+require "graphviz"
+
+GraphViz::new( "G" ) { |g|
+  g.hello(:style => :filled, :fillcolor => :lightblue) << g.world(:style => :filled, :fillcolor => :lightgrey)
+}.output( :svg => "#{$0}.svg", :nothugly => true )

data/examples/{p2p.rb → sample42.rb}

@@ -32,4 +32,4 @@ g.add_edge( bp, jv, :color => "red", :label => "Est le beau fils de" ) # Beau fi
 g.add_edge( bp, gr )
 g.add_edge( gr, md )
 
-g.output( :png => "p2p.png" )
+g.output( :png => "#{$0}.png" )

data/examples/{HTML-Labels.rb → sample43.rb}

@@ -19,8 +19,8 @@ g.add_node( "struct1", "html" => '
 g.add_node( "struct2", "html" => '<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">  <TR><TD PORT="f0">one</TD><TD>two</TD></TR> </TABLE>' )
 g.add_node( "struct3", "html" => '<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4">  <TR>  <TD ROWSPAN="3">hello<BR/>world</TD>  <TD COLSPAN="3">b</TD>  <TD ROWSPAN="3">g</TD>  <TD ROWSPAN="3">h</TD>  </TR>  <TR>  <TD>c</TD><TD PORT="here">d</TD><TD>e</TD>  </TR>  <TR>  <TD COLSPAN="3">f</TD>  </TR> </TABLE>' )
 
-g.add_edge( "struct1:f1", "struct2:f0" )
-g.add_edge( "struct1:f2", "struct3:here" )
+g.add_edge( {"struct1" => :f1}, {"struct2" => :f0} )
+g.add_edge( {"struct1" => :f2}, {"struct3" => :here} )
 
 g.add_edge( "HTML", "struct1" )
 

data/examples/{shapes.rb → sample45.rb}

@@ -21,4 +21,4 @@ g.node["shape"] = "ellipse"
   g.add_node( s, "shape" => s )
 }
 
-g.output( :png => "shapes.png")
+g.output( :png => "#{$0}.png")

data/examples/{testxml.rb → sample47.rb}

@@ -3,5 +3,5 @@
 $:.unshift( "../lib" )
 require 'graphviz/xml'
 
-gvxml = GraphViz::XML::new( "test.xml", :text => true, :attrs => true )
+gvxml = GraphViz::XML::new( File.join( File.dirname(__FILE__), "test.xml" ), :text => true, :attrs => true )
 gvxml.output( :png => "#{$0}.png", :use => "dot" )

data/examples/{graphviz.org/cluster.rb → sample48.rb}

@@ -59,4 +59,4 @@ GraphViz.new( :G, :type => :digraph ) { |g|
   g.start[:shape] = :Mdiamond
   g._end[:label] = "end"
   g._end[:shape] = :Mdiamond
-}.output( :png => "cluster.png" )
+}.output( :png => "#{$0}.png" )

data/examples/{graphviz.org/hello_world.rb → sample49.rb}

@@ -7,4 +7,4 @@ require "graphviz"
 
 GraphViz::new( :G, :type => :digraph ) { |g|
   g.world( :label => "World" ) << g.hello( :label => "Hello" )
-}.output( :png => "hello.png" )
+}.output( :png => "#{$0}.png" )

data/examples/{graphviz.org/lion_share.rb → sample50.rb}

@@ -212,4 +212,4 @@ GraphViz::new( "Ped_Lion_Share", :type => :digraph ) { |g|
   (g._026 << g.marr0017).set { |e| e[:dir] = :none; e[:weight] = 1 }
   (g._027 << g.marr0017).set { |e| e[:dir] = :none; e[:weight] = 1 }
   (g.marr0017 << g._028).set { |e| e[:dir] = :none; e[:weight] = 2 }
-}.output( :png => "lion_share.png" )
+}.output( :png => "#{$0}.png" )

data/examples/{graphviz.org/process.rb → sample51.rb}

@@ -34,4 +34,4 @@ GraphViz::new( :G, :type => :graph ) { |g|
   g.runswap << g.runmem
   g._new << g.runmem
   g.sleep << g.runmem
-}.output( :png => "process.png", :use => :fdp )
+}.output( :png => "#{$0}.png", :use => :fdp )

data/examples/{graphviz.org/TrafficLights.rb → sample52.rb}

@@ -59,4 +59,4 @@ GraphViz::new( "TrafficLights", :type => :digraph ) { |g|
   g[:overlap] = :false
   g[:label] = 'PetriNet Model TrafficLights\nExtracted from ConceptBase and layed out by Graphviz'
   g[:fontsize] = 12;
-}.output( :errors => 1, :png => "TrafficLights.png" )
+}.output( :errors => 1, :png => "#{$0}.png" )

data/examples/sample53.rb

@@ -0,0 +1,26 @@
+$:.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
+  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" )
+
+    gregoire.is_maried_with muriel
+  end
+
+  couple( benoist, nathalie ).kids( charlotte, amelie, clement, gregoire )
+  end
+
+tree.graph.save( :png => "#{$0}.png" )

data/examples/sample54.rb

@@ -0,0 +1,26 @@
+$:.unshift( "../lib" )
+require 'graphviz'
+
+class Array
+  def rotate
+    ## Solution #1 by greg
+    # self.push(r = self.shift)
+    # return r
+    
+    ## Solution #2 by madx
+    # shift.tap {|e| push e }
+    
+    ## Solution #3 by greg
+    push(shift)[-1]
+  end
+end
+
+type = ["box", "point"]
+
+GraphViz.graph( :G, :use => :neato ) { |g|
+  (1..5).each do |x|
+    (1..5).each do |y|
+      g.add_node( "n#{x}x#{y}", :pos => "#{x},#{y}!", :shape => type.rotate )
+    end
+  end  
+}.output( :png => "#{$0}.png" )

data/examples/sample99.rb

@@ -0,0 +1,70 @@
+$:.unshift( "../lib" );
+require 'graphviz/family_tree'
+
+tree = GraphViz::FamilyTree.new do
+  generation do
+    chantale.is_a_woman( "Chantale" )
+    jacques.is_a_man( "Jacques" )
+    
+    jacques.is_dead
+    jacques.is_maried_with chantale
+    
+    rose.is_a_woman( "Rose Marie" )
+    andre.is_a_man( "Andre" )
+    
+    andre.is_maried_with rose
+    andre.is_dead
+  end
+   
+  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
+  
+  couple( chantale, jacques ).kids( nathalie )
+  couple( rose, andre ).kids( benoist )
+  
+  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" )
+    
+    morgane.is_a_woman( "Morgane" )
+    gregoire.is_divorced_with morgane
+
+    pascal.is_a_man( "Pascal" )
+    muriel.is_divorced_with pascal
+
+    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
+  
+  couple( gregoire, morgane ).kids( arthur, colyne, benedict )
+  couple( gregoire, muriel ).kids( maia )
+  couple( muriel, pascal ).kids( milo )
+  muriel.kids( enaitz )
+end
+
+tree.graph.save( :png => "#{$0}.png" )

data/lib/graphviz.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Gregoire Lejeune <gregoire.lejeune@free.fr>
+# Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Gregoire Lejeune <gregoire.lejeune@free.fr>
 # 
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -28,6 +28,8 @@ require 'graphviz/parser'
 require 'graphviz/types'
 require 'graphviz/core_ext'
 
+$KCODE = "UTF8"
+
 class GraphViz 
   include Constants
 
@@ -148,7 +150,6 @@ class GraphViz
           add_edge( oNodeOne, nt, hOpts )
         end
       else
-
         oEdge = GraphViz::Edge::new( oNodeOne, oNodeTwo, self )
         
         hOpts.each do |xKey, xValue|
@@ -254,16 +255,16 @@ class GraphViz
       rCod = add_graph( xName, args[0]||{} )
       yield( rCod )
     else
-      # Create a node named '#{xName}' or search for a node, edge or cluster
+      # Create a node named '#{xName}' or search for a node, edge or cluster      
       if @hoNodes.keys.include?( xName )
         if( args[0] )
-          return "#{xName}:#{args[0].to_s}"
+          return { xName => args[0] }
         else
           return( @hoNodes[xName] ) 
         end
       end
       return( @hoGraphs[xName] ) if @hoGraphs.keys.include?( xName )
-      
+            
       rCod = add_node( xName, args[0]||{} )
     end
 
@@ -313,6 +314,7 @@ class GraphViz
     xLastType = nil
     xSeparator = ""
     xData = ""
+    lNotHugly = []
 
     @elements_order.each { |kElement|
       if xLastType.nil? == true or xLastType != kElement["type"]
@@ -414,6 +416,14 @@ class GraphViz
             @errors = xValue
           when "extlib"
             @extlibs = xValue.split( "," ).map{ |x| x.strip }
+          when "nothugly"
+            begin
+              require 'graphviz/nothugly'
+              @nothugly = true
+            rescue
+              warn "You must install ruby-xslt to use nothugly option!"
+              @nothugly = false
+            end
           else
             if FORMATS.index( xKey.to_s ).nil? == true
               raise ArgumentError, "output format '#{xValue}' invalid"
@@ -443,7 +453,7 @@ class GraphViz
       
       if (@format.to_s != "none" and not @format.nil?) or (@output.any? {|format, file| format != "none" } and @output.size > 0)
         ## Act: Save script and send it to dot
-        t = Tempfile::open( File.basename($0) )
+        t = Tempfile::open( File.basename(__FILE__) )
         t.print( xDOTScript )
         t.close
         
@@ -457,6 +467,7 @@ class GraphViz
         xOutputWithFile = ""
         xOutputWithoutFile = ""
         unless @format.nil? or @format == "none"
+          lNotHugly << @filename if @format.to_s == "svg" and @nothugly
           if @filename.nil? or @filename == String
             xOutputWithoutFile = "-T#{@format} "
           else
@@ -464,6 +475,7 @@ class GraphViz
           end
         end
         @output.each_except( :key => ["none"] ) do |format, file|
+          lNotHugly << file if format.to_s == "svg" and @nothugly
           if file.nil? or file == String
             xOutputWithoutFile << "-T#{format} "
           else
@@ -492,7 +504,16 @@ class GraphViz
 
         xOutput << output_from_command( xCmd )
       end
-            
+      
+      # Not Hugly
+      lNotHugly.each do |f|
+        if f.nil? or f == String
+          xOutput = GraphViz.nothugly( xOutput, false )
+        else
+          GraphViz.nothugly( f, true )
+        end
+      end
+      
       if xOutputString
         xOutput
       else
@@ -540,6 +561,7 @@ class GraphViz
   def name 
     @name.clone
   end
+  alias :id :name
   
   # 
   # Create an edge between the current cluster and the node or cluster +oNode+
@@ -669,6 +691,7 @@ class GraphViz
     @errors   = @@errors
     @extlibs  = @@extlibs
     @output   = {}
+    @nothugly = false
     
     @elements_order = Array::new()
 
@@ -731,7 +754,7 @@ class GraphViz
   # Escape a string to be acceptable as a node name in a graphviz input file
   #
   def self.escape(str, force = false ) #:nodoc:
-    if force or str.match( /\A[a-zA-Z_]+[a-zA-Z0-9_:]*\Z/ ).nil?
+    if force or str.match( /\A[a-zA-Z_]+[a-zA-Z0-9_]*\Z/ ).nil?
       '"' + str.gsub('"', '\\"').gsub("\n", '\\\\n').gsub(".","\\.") + '"' 
     #if force or str.match( /\A[a-zA-Z_]+[a-zA-Z0-9_:\.]*\Z/ ).nil?
     #  '"' + str.gsub('"', '\\"').gsub("\n", '\\\\n') + '"'