ruby-graphviz 0.9.0 → 0.9.1

data/examples/graphviz.org/process.rb

@@ -0,0 +1,37 @@
+# http://www.graphviz.org/Gallery/undirected/process.html
+#
+# graph G {
+# 	run -- intr;
+# 	intr -- runbl;
+# 	runbl -- run;
+# 	run -- kernel;
+# 	kernel -- zombie;
+# 	kernel -- sleep;
+# 	kernel -- runmem;
+# 	sleep -- swap;
+# 	swap -- runswap;
+# 	runswap -- new;
+# 	runswap -- runmem;
+# 	new -- runmem;
+# 	sleep -- runmem;
+# }
+
+$:.unshift( "../../lib" );
+require "graphviz"
+
+GraphViz::new( :G, :type => :graph ) { |g|
+  g._new[:label] = "new"
+  g.run << g.intr
+  g.intr << g.runbl
+  g.runbl << g.run
+  g.run << g.kernel
+  g.kernel << g.zombie
+  g.kernel << g.sleep
+  g.kernel << g.runmem
+  g.sleep << g.swap
+  g.swap << g.runswap
+  g.runswap << g._new
+  g.runswap << g.runmem
+  g._new << g.runmem
+  g.sleep << g.runmem
+}.output( :output => :png, :file => "process.png", :use => :fdp )

data/examples/sample01.rb

@@ -29,4 +29,4 @@ g.add_edge( init, make_string )
 g.add_edge( main, printf )
 g.add_edge( execute, compare )
 
-g.output( :output => "png", :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample02.rb

@@ -5,9 +5,9 @@ require "graphviz"
 
 g = nil
 if ARGV[0]
-  g = GraphViz::new( "G", :output => "png", :path => ARGV[0] )
+  g = GraphViz::new( "G", :path => ARGV[0] )
 else
-  g = GraphViz::new( "G", :output => "png" )
+  g = GraphViz::new( "G" )
 end
 
 g.node[:shape] = "ellipse"
@@ -39,4 +39,4 @@ g.add_edge( init, make_string )
 g.add_edge( main, printf, :color => "red", :style => "bold", :label => "100 times" )
 g.add_edge( execute, compare, :color => "red" )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample03.rb

@@ -5,9 +5,9 @@ require "graphviz"
 
 g = nil
 if ARGV[0]
-  g = GraphViz::new( "G", "output" => "png", "path" => ARGV[0] )
+  g = GraphViz::new( "G", "path" => ARGV[0] )
 else
-  g = GraphViz::new( "G", "output" => "png" )
+  g = GraphViz::new( "G" )
 end
 
 g.node["shape"] = "ellipse"
@@ -28,4 +28,4 @@ g.add_edge( a, b )
 g.add_edge( b, c )
 g.add_edge( b, d )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample04.rb

@@ -5,9 +5,9 @@ require "graphviz"
 
 g = nil
 if ARGV[0]
-  g = GraphViz::new( "structs", "output" => "png", "path" => ARGV[0] )
+  g = GraphViz::new( "structs", "path" => ARGV[0] )
 else
-  g = GraphViz::new( "structs", "output" => "png" )
+  g = GraphViz::new( "structs" )
 end
 
 g.node["shape"] = "record"
@@ -19,4 +19,4 @@ struct3 = g.add_node( "struct3", "shape" => "record", "label" => 'hello\nworld |
 g.add_edge( struct1, struct2 )
 g.add_edge( struct1, struct3 )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample05.rb

@@ -29,4 +29,4 @@ g.add_edge( init, make_string )
 g.add_edge( main, printf )
 g.add_edge( execute, compare )
 
-g.output( "output" => "png", :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample06.rb

@@ -0,0 +1,46 @@
+$:.unshift( "../lib" );
+require "graphviz"
+
+GraphViz::new( "G", :rankdir => "LR", :type => "graph" ) { |graph|
+  graph.cluster0 { |cluster|
+    cluster[:label] = "Back Office"
+    
+    cluster.fatman.set { |n|
+      n.label = "FatMan"
+      n.shape = "rect"
+    }
+    cluster.grobil.set { |n|
+      n.label = "GroBil"
+      n.shape = "rect"
+    }
+  }
+  
+  graph.cluster1 { |cluster|
+    cluster[:label] = "DMZ"
+    
+    cluster.dupont.set { |n|
+      n.label = "Dupont"
+      n.shape = "rect"
+    }
+    cluster.dupond.set { |n|
+      n.label = "Dupond"
+      n.shape = "rect"
+    }
+  }
+
+  graph.cluster2() { |cluster|
+    cluster[:label] = "Front Office"
+    
+    cluster.door.set { |n|
+      n.label = "Door"
+      n.shape = "rect"
+    }
+  }
+  
+  graph.cluster0.fatman << graph.cluster1.dupont
+  graph.cluster0.fatman << graph.cluster1.dupond
+  graph.cluster0.grobil << graph.cluster1.dupont
+  graph.cluster0.grobil << graph.cluster1.dupond
+  graph.cluster1.dupont << graph.cluster2.door
+  graph.cluster1.dupond << graph.cluster2.door
+}.output( :path => '/usr/local/bin/', :png => "#{$0}.png" )

data/examples/sample07.rb

@@ -3,7 +3,7 @@
 $:.unshift( "../lib" );
 require "graphviz"
 
-GraphViz::options( :output => "png", :use => "dot" )
+GraphViz::options( :use => "dot" )
 
 if ARGV[0]
   GraphViz::options( :path => ARGV[0] )
@@ -20,4 +20,4 @@ g.add_node( "struct3", "shape" => "record", "label" => 'hello\nworld |{ b |{c|<h
 g.add_edge( "struct1:f1", "struct2:f0" )
 g.add_edge( "struct1:f2", "struct3:here" )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample08.rb

@@ -5,9 +5,9 @@ require "graphviz"
 
 g = nil
 if ARGV[0]
-  g = GraphViz::new( "G", "output" => "png", "nodesep" => ".05", "rankdir" => "LR", "path" => ARGV[0] )
+  g = GraphViz::new( "G" "nodesep" => ".05", "rankdir" => "LR", "path" => ARGV[0] )
 else
-  g = GraphViz::new( "G", "output" => "png", "nodesep" => ".05", "rankdir" => "LR" )
+  g = GraphViz::new( "G", "nodesep" => ".05", "rankdir" => "LR" )
 end
 
 g.node["shape"] = "record"
@@ -31,4 +31,4 @@ g.add_edge( "node0:f6", "node5:n" )
 g.add_edge( "node2:p", "node6:n" )
 g.add_edge( "node4:p", "node7:n" )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample09.rb

@@ -5,9 +5,9 @@ require "graphviz"
 
 g = nil
 if ARGV[0]
-  g = GraphViz::new( "G", "output" => "png", "path" => ARGV[0] )
+  g = GraphViz::new( "G", "path" => ARGV[0] )
 else
-  g = GraphViz::new( "G", "output" => "png" )
+  g = GraphViz::new( "G" )
 end
 
 g.node["shape"] = "ellipse"
@@ -47,4 +47,4 @@ g.add_edge( a3, a0 )
 g.add_edge( a3, endn )
 g.add_edge( b3, endn )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample10.rb

@@ -5,9 +5,9 @@ require "graphviz"
 
 g = nil
 if ARGV[0]
-  g = GraphViz::new( "G", "output" => "png", "path" => ARGV[0] )
+  g = GraphViz::new( "G", "path" => ARGV[0] )
 else
-  g = GraphViz::new( "G", "output" => "png" )
+  g = GraphViz::new( "G" )
 end
 
 g.node["shape"] = "ellipse"
@@ -47,4 +47,4 @@ g.add_edge( a3, a0 )
 g.add_edge( a3, endn )
 g.add_edge( b3, endn )
 
-g.output( :file => "#{$0}.png" )
+g.output( :png => "#{$0}.png" )

data/examples/sample21.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" );
+require "graphviz"
+
+{"png" => "#{$0}.png", "imap" => "#{$0}.html"}.each do |format, file|
+  GraphViz::new( "G", :output => format ) { |g|
+    g.command #(:URL => "http://www.research.att.com/base.html")
+    g._output(:label => "output") #(:URL => "colors.html")
+    g.command << g._output
+  }.output( :file => file )  
+end

data/examples/sample22.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" );
+require "graphviz"
+
+GraphViz::new( "mainmap" ) { |graph|
+  graph[:URL] = "http://www.research.att.com/base.html"
+  graph.command( :URL => "http://www.research.att.com/command.html" )
+  (graph.command << graph._output( :label => "output" ))[:URL] = "colors.html"
+}.output( :canon => nil, :cmapx => "#{$0}.html", :png => "#{$0}.png" )

data/lib/graphviz.rb

@@ -21,6 +21,7 @@ require 'graphviz/node'
 require 'graphviz/edge'
 require 'graphviz/attrs'
 require 'graphviz/constants'
+require 'graphviz/parser'
 
 class GraphViz 
   include Constants
@@ -28,10 +29,12 @@ class GraphViz
   public
 
   ## Var: Output format (dot, png, jpeg, ...)
-  @@format = "canon"
+  @@format = nil #"canon"
   @format
   ## Var: Output file name
   @filename
+  ## Var: Output format and file
+  @output
   ## Var: program to use (dot|twopi)
   @@prog = "dot"
   @prog
@@ -46,7 +49,12 @@ class GraphViz
   @graph
   @node
   @edge
-  attr_accessor :node, :edge
+  
+  # This accessor allow you to set global nodes attributs
+  attr_accessor :node
+
+  # This accessor allow you to set global edges attributs
+  attr_accessor :edge
 
   @elements_order
   
@@ -77,6 +85,17 @@ class GraphViz
     return( @hoNodes[xNodeName] )
   end
 
+  #
+  # Return the node object for the given name (or nil)
+  #
+  def get_node( xNodeName, &block )
+    node = @hoNodes[xNodeName] || nil
+    
+    yield( node ) if( block and node.nil? == false )
+    
+    return node
+  end
+  
   ##
   # Create a new edge
   # 
@@ -142,6 +161,17 @@ class GraphViz
     return( @hoGraphs[xGraphName] )
   end
   
+  #
+  # Return the graph object for the given name (or nil)
+  #
+  def get_graph( xGraphName, &block )
+    graph = @hoGraphs[xGraphName] || nil
+    
+    yield( graph ) if( block and graph.nil? == false )
+    
+    return graph
+  end
+  
   #
   # Get the number of nodes
   #
@@ -186,6 +216,7 @@ class GraphViz
   # Set value +xValue+ to the graph attribut +xAttrName+
   # 
   def []=( xAttrName, xValue )
+    xValue = xValue.to_s if xValue.class == Symbol
     @graph[xAttrName] = xValue
   end
 
@@ -204,6 +235,7 @@ class GraphViz
   #   :file : Output file name
   #   :use : Program to use (Constants::PROGRAMS)
   #   :path : Program PATH
+  #   :<format> => :<file>
   # 
   def output( *hOpt )
     xDOTScript = ""
@@ -288,13 +320,16 @@ class GraphViz
     else
       if hOpt.nil? == false and hOpt[0].nil? == false
         hOpt[0].each do |xKey, xValue|
+          xValue = xValue.to_s unless xValue.nil?
           case xKey.to_s
             when "output"
+              warn ":output option is deprecated, please use :<format> => :<file>"
               if FORMATS.index( xValue ).nil? == true
                 raise ArgumentError, "output format '#{xValue}' invalid"
               end
               @format = xValue
             when "file"
+              warn ":file option is deprecated, please use :<format> => :<file>"
               @filename = xValue
             when "use"
               if PROGRAMS.index( xValue ).nil? == true
@@ -304,7 +339,10 @@ class GraphViz
             when "path"
               @path = xValue
             else
-              raise ArgumentError, "option #{xKey.to_s} unknown"
+              if FORMATS.index( xKey.to_s ).nil? == true
+                raise ArgumentError, "output format '#{xValue}' invalid"
+              end
+              @output[xKey.to_s] = xValue
           end
         end
       end
@@ -324,9 +362,24 @@ class GraphViz
           raise StandardError, "GraphViz not installed or #{@prog} not in PATH. Install GraphViz or use the 'path' option"
         end
         
-        xFile = ""
-        xFile = "-o #{@filename}" if @filename.nil? == false
-        xCmd = "#{cmd} -T#{@format} #{xFile} #{t.path}"
+        xOutputWithFile = ""
+        xOutputWithoutFile = ""
+        unless @format.nil?
+          if @filename.nil?
+            xOutputWithoutFile = "-T#{@format} "
+          else
+            xOutputWithFile = "-T#{@format} -o#{@filename} "
+          end
+        end
+        @output.each do |format, file|
+          if file.nil?
+            xOutputWithoutFile << "-T#{format} "
+          else
+            xOutputWithFile << "-T#{format} -o#{file} "
+          end
+        end
+        
+        xCmd = "#{cmd} #{xOutputWithFile} #{xOutputWithoutFile} #{t.path}"
         
         f = IO.popen( xCmd )
         print f.readlines
@@ -398,6 +451,7 @@ class GraphViz
         when "path"
           @@path = v
         when "output"
+          warn ":output option is deprecated!"
           @@format = v
         else
           warn "Invalide option #{k}!"
@@ -409,6 +463,24 @@ class GraphViz
     GraphViz::default( hOpts )
   end
   
+## ----------------------------------------------------------------------------
+
+  # 
+  # Create a new graph from a GraphViz File
+  # 
+  # Options :
+  #   :output : Output format (Constants::FORMATS) (default : dot)
+  #   :file : Output file name (default : none)
+  #   :use : Program to use (Constants::PROGRAMS) (default : dot)
+  #   :path : Program PATH
+  #   :parent : Parent graph (default : none)
+  #   :type : Graph type (Constants::GRAPHTYPE) (default : digraph)
+  # 
+  def self.parse( xFile, *hOpts, &block )
+    g = GraphViz::Parser.parse( xFile, hOpts[0], &block )
+    return g
+  end
+
 ## ----------------------------------------------------------------------------
 
   private 
@@ -437,10 +509,11 @@ class GraphViz
   # 
   def initialize( xGraphName, *hOpt, &block )
     @filename = nil
-    @name     = xGraphName
+    @name     = xGraphName.to_s
     @format   = @@format
     @prog     = @@prog
     @path     = @@path
+    @output   = {}
     
     @elements_order = Array::new()
 
@@ -459,28 +532,30 @@ class GraphViz
       hOpt[0].each do |xKey, xValue|
         case xKey.to_s
           when "output"
-            if FORMATS.index( xValue ).nil? == true
+            warn ":output option is deprecated, please use :<format> => :<file>"
+            if FORMATS.index( xValue.to_s ).nil? == true
               raise ArgumentError, "output format '#{xValue}' invalid"
             end
-            @format = xValue
+            @format = xValue.to_s
           when "use"
-            if PROGRAMS.index( xValue ).nil? == true
+            if PROGRAMS.index( xValue.to_s ).nil? == true
               raise ArgumentError, "can't use '#{xValue}'"
             end
-            @prog = xValue
+            @prog = xValue.to_s
           when "file"
-            @filename = xValue
+            warn ":file option is deprecated, please use :<format> => :<file>"
+            @filename = xValue.to_s
           when "parent"
             @oParentGraph = xValue
           when "type"
-            if GRAPHTYPE.index( xValue ).nil? == true
+            if GRAPHTYPE.index( xValue.to_s ).nil? == true
               raise ArgumentError, "graph type '#{xValue}' unknow"
             end
-            @oGraphType = xValue
+            @oGraphType = xValue.to_s
           when "path"
-            @path = xValue
+            @path = xValue.to_s
           else
-            self[xKey.to_s] = xValue
+            self[xKey.to_s] = xValue.to_s
         end
       end
     end