ruby-graphviz 0.9.3 → 0.9.4

data/ChangeLog

@@ -1,3 +1,8 @@
+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)

data/README.rdoc

@@ -33,7 +33,7 @@ The same but with a block
   require 'graphviz'
 
   GraphViz::new( :G, :type => :digraph ) { |g|
-    g.world( :label => "World" ) << g.hello( :label => Hello )
+    g.world( :label => "World" ) << g.hello( :label => "Hello" )
   }.output( :png => "hello_world.png" )
 
 Create a graph from a file 
@@ -58,6 +58,8 @@ Create a graph from a file
 
 You also need to install GraphViz[http://www.graphviz.org] and Treetop[http://treetop.rubyforge.org/]
 
+On *Windows* you also need to install win32-open3. This is not an absolute requirement.
+
 == LICENCE
 
 Ruby/GraphViz is freely distributable according to the terms of the

data/examples/graphviz.org/TrafficLights.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( :png => "TrafficLights.png" )
+}.output( :errors => 1, :png => "TrafficLights.png" )

data/examples/maketest.sh

@@ -1,32 +1,85 @@
 #!/bin/sh
 
-ruby shapes.rb $1
+echo "arrowhead.rb"
 ruby arrowhead.rb $1
+echo "HTML-Labels.rb"
+ruby HTML-Labels.rb
+echo "p2p.rb"
+ruby p2p.rb $1
 
+echo "sample01.rb"
 ruby sample01.rb $1
+echo "sample02.rb"
 ruby sample02.rb $1
+echo "sample03.rb"
 ruby sample03.rb $1
+echo "sample04.rb"
 ruby sample04.rb $1
+echo "sample05.rb"
 ruby sample05.rb $1
-                   
+echo "sample06.rb"
+ruby sample06.rb                   
+echo "sample07.rb"
 ruby sample07.rb $1
+echo "sample08.rb"
 ruby sample08.rb $1
+echo "sample09.rb"
 ruby sample09.rb $1
+echo "sample10.rb"
 ruby sample10.rb $1
+echo "sample11.rb"
 ruby sample11.rb $1
+echo "sample12.rb"
 ruby sample12.rb $1
+echo "sample13.rb"
 ruby sample13.rb
+echo "sample14.rb"
 ruby sample14.rb
+echo "sample15.rb"
 ruby sample15.rb
+echo "sample16.rb"
 ruby sample16.rb
+echo "sample17.rb"
 ruby sample17.rb
+echo "sample18.rb"
 ruby sample18.rb
+echo "sample19.rb"
 ruby sample19.rb
+echo "sample20.rb"
 ruby sample20.rb
+echo "sample21.rb"
 ruby sample21.rb
+echo "sample22.rb"
 ruby sample22.rb
+echo "sample23.rb"
 ruby sample23.rb
+echo "sample24.rb"
+ruby sample24.rb
+echo "sample25.rb"
+ruby sample25.rb
 
+echo "shapes.rb"
+ruby shapes.rb $1
+echo "testorder.rb"
 ruby testorder.rb $1
+echo "testxml.rb"
 ruby testxml.rb $1
-ruby HTML-Labels.rb
+
+cd dot
+pwd
+echo "dot/hello_test.rb"
+ruby hello_test.rb
+cd ..
+
+cd graphviz.org
+echo "graphviz.org/cluster.rb"
+ruby cluster.rb
+echo "graphviz.org/hello_world.rb"
+ruby hello_world.rb
+echo "graphviz.org/lion_share.rb"
+ruby lion_share.rb
+echo "graphviz.org/process.rb"
+ruby process.rb
+echo "graphviz.org/TrafficLights.rb"
+ruby TrafficLights.rb
+cd ..

data/examples/sample25.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby
+
+$:.unshift( "../lib" );
+require "graphviz"
+
+GraphViz::new( "G" ) { |g|
+  g.hello << g.world
+  g.bonjour( :label => '"Bonjour"' ) - g.monde( :label => "Le\nmonde")
+  g.hola > g.mundo
+  g.holla >> g.welt
+}.output( :path => "/usr/local/bin", :png => "#{$0}.png" )

data/lib/graphviz.rb

@@ -41,6 +41,9 @@ class GraphViz
   ## Var: program path
   @@path = nil
   @path
+  ## Var: Error level
+  @@errors = 1
+  @errors
   
   ## Var: Graph name
   @name
@@ -62,8 +65,8 @@ class GraphViz
   # Create a new node
   #
   # In:
-  #   xNodeName : Name of the new node
-  #   *hOpt : Node attributs
+  # * xNodeName : Name of the new node
+  # * *hOpt : Node attributs
   # 
   # Return the GraphViz::Node object created
   #
@@ -100,9 +103,9 @@ class GraphViz
   # Create a new edge
   # 
   # In:
-  #   oNodeOne : First node (or node list)
-  #   oNodeTwo : Second Node (or node list)
-  #   *hOpt : Edge attributs
+  # * oNodeOne : First node (or node list)
+  # * oNodeTwo : Second Node (or node list)
+  # * *hOpt : Edge attributs
   #
   def add_edge( oNodeOne, oNodeTwo, *hOpt )
     
@@ -137,11 +140,11 @@ class GraphViz
   end
 
   # 
-  # Create à new graph
+  # Create a new graph
   # 
   # In:
-  #   xGraphName : Graph name
-  #   *hOpt : Graph attributs
+  # * xGraphName : Graph name
+  # * *hOpt : Graph attributs
   #
   def add_graph( xGraphName, *hOpt )
     @hoGraphs[xGraphName] = GraphViz::new( xGraphName, :parent => self, :type => @oGraphType )
@@ -231,14 +234,18 @@ class GraphViz
   # Generate the graph
   # 
   # Options :
-  #   :output : Output format (Constants::FORMATS)
-  #   :file : Output file name
-  #   :use : Program to use (Constants::PROGRAMS)
-  #   :path : Program PATH
-  #   :<format> => <file> : <file> can be
-  #     * a file name
-  #     * nil, then the output will be printed to STDOUT
-  #     * String, then the output will be returned as a String
+  # * :output : Output format (Constants::FORMATS)
+  # * :file : Output file name
+  # * :use : Program to use (Constants::PROGRAMS)
+  # * :path : Program PATH
+  # * :<format> => <file> : <file> can be
+  #   * a file name
+  #   * nil, then the output will be printed to STDOUT
+  #   * String, then the output will be returned as a String
+  # * :errors : DOT error level (default 1)
+  #   * 0 = Error + Warning
+  #   * 1 = Error
+  #   * 2 = none
   # 
   def output( *hOpt )
     xDOTScript = ""
@@ -341,6 +348,8 @@ class GraphViz
               @prog = xValue
             when "path"
               @path = xValue
+            when "errors"
+              @errors = xValue
             else
               if FORMATS.index( xKey.to_s ).nil? == true
                 raise ArgumentError, "output format '#{xValue}' invalid"
@@ -393,7 +402,7 @@ class GraphViz
         
         #xCmd = "#{cmd} #{xOutputWithFile} #{xOutputWithoutFile} #{t.path}"
         #if /Windows/.match( ENV['OS'] )
-          xCmd = "\"#{cmd}\" #{xOutputWithFile} #{xOutputWithoutFile} #{t.path}"
+          xCmd = "\"#{cmd}\" -q#{@errors} #{xOutputWithFile} #{xOutputWithoutFile} #{t.path}"
         #end
 
         output_from_command( xCmd )
@@ -492,7 +501,7 @@ class GraphViz
 ## ----------------------------------------------------------------------------
 
   #
-  # Change default options (:use, :path and :output)
+  # Change default options (:use, :path, :errors and :output)
   # 
   def self.default( hOpts )
     hOpts.each do |k, v|
@@ -501,6 +510,8 @@ class GraphViz
           @@prog = v
         when "path"
           @@path = v
+        when "errors"
+          @@errors = v
         when "output"
           warn ":output option is deprecated!"
           @@format = v
@@ -520,12 +531,12 @@ class GraphViz
   # 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)
+  # * :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 )
@@ -551,12 +562,16 @@ class GraphViz
   # Create a new graph object
   # 
   # 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)
+  # * :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)
+  # * :errors : DOT error level (default 1)
+  #   * 0 = Error + Warning
+  #   * 1 = Error
+  #   * 2 = none
   # 
   def initialize( xGraphName, *hOpt, &block )
     @filename = nil
@@ -564,6 +579,7 @@ class GraphViz
     @format   = @@format
     @prog     = @@prog
     @path     = @@path
+    @errors   = @@errors
     @output   = {}
     
     @elements_order = Array::new()
@@ -605,6 +621,8 @@ class GraphViz
             @oGraphType = xValue.to_s
           when "path"
             @path = xValue.to_s
+          when "errors"
+            @errors = xValue
           else
             self[xKey.to_s] = xValue.to_s
         end
@@ -617,8 +635,8 @@ class GraphViz
   #
   # Escape a string to be acceptable as a node name in a graphviz input file
   #
-  def self.escape(str) #:nodoc:
-    if str.match( /^[a-zA-Z_]+[a-zA-Z0-9_:\.]*$/ ).nil?
+  def self.escape(str, force = false) #:nodoc:
+    if force or str.match( /\A[a-zA-Z_]+[a-zA-Z0-9_:\.]*\Z/ ).nil?
       '"' + str.gsub('"', '\\"').gsub("\n", '\\\\n') + '"' 
     else
       str

data/lib/graphviz/constants.rb

@@ -15,7 +15,7 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 
 module Constants
-  RGV_VERSION = "0.9.3"
+  RGV_VERSION = "0.9.4"
   
   ## Const: Output formats
   FORMATS = [

data/lib/graphviz/edge.rb

@@ -29,9 +29,9 @@ class GraphViz
     # Create a new edge
     # 
     # In:
-    #   vNodeOne : First node
-    #   vNodeTwo : Second node
-    #   oGParrent : Graph 
+    # * vNodeOne : First node
+    # * vNodeTwo : Second node
+    # * oGParrent : Graph 
     #
     def initialize( vNodeOne, vNodeTwo, oGParrent = nil )
 	    if vNodeOne.class == String
@@ -71,9 +71,9 @@ class GraphViz
       
       GraphViz::commonGraph( oNode, n ).add_edge( n, oNode )
     end
-    alias :> :<<
-    alias :- :<<
-    alias :>> :<<
+    alias :> :<< #:nodoc:
+    alias :- :<< #:nodoc:
+    alias :>> :<< #:nodoc:
     
     #
     # Set edge attributs
@@ -116,7 +116,7 @@ class GraphViz
       xAttr = ""
       xSeparator = ""
       @oAttrEdge.data.each do |k, v|
-        xAttr << xSeparator + k + " = \"" + v + "\""
+        xAttr << xSeparator + k + " = " + GraphViz.escape(v, true)
         xSeparator = ", "
       end
       if xAttr.length > 0

data/lib/graphviz/node.rb

@@ -28,8 +28,8 @@ class GraphViz
     # Create a new node
     # 
     # In:
-    #   xNodeName : Name of the node
-    #   oGParrent : Graph 
+    # * xNodeName : Name of the node
+    # * oGParrent : Graph 
     # 
     def initialize( xNodeName, oGParrent = nil )
       @xNodeName = xNodeName
@@ -114,7 +114,7 @@ class GraphViz
 	      if k == "html"
 		      xAttr << xSeparator + "label = <" + v + ">"
 		    else
-          xAttr << xSeparator + k + " = \"" + v + "\""
+          xAttr << xSeparator + k + " = " + GraphViz.escape(v, true)
 		    end
         xSeparator = ", "
       end

data/lib/graphviz/parser.rb

@@ -44,8 +44,8 @@ class GraphViz
     
     class Graph < Treetop::Runtime::SyntaxNode
       def eval( context, hOpts )
-        puts "GRAPH TYPE = #{type.text_value}"
-        puts "GRAPH NAME = #{name.text_value}"
+        # puts "GRAPH TYPE = #{type.text_value}"
+        # puts "GRAPH NAME = #{name.text_value}"
         
         hOpts = hOpts[0].merge( {:type => type.text_value} )
         
@@ -69,15 +69,15 @@ class GraphViz
     
     class GraphPreference < Treetop::Runtime::SyntaxNode
       def eval( context )
-        puts "GRAPH PREFERENCE : "
-        puts "  #{key.text_value} = #{value.text_value.gsub(/"/, "")}"
+        # puts "GRAPH PREFERENCE : "
+        # puts "  #{key.text_value} = #{value.text_value.gsub(/"/, "")}"
         context.graph[key.text_value] = value.text_value.gsub(/"/, "")
       end
     end
     
     class NamedGraphPreference < Treetop::Runtime::SyntaxNode
       def eval( context )
-        puts "GRAPH PREFERENCES :"
+        # puts "GRAPH PREFERENCES :"
         options.eval().each do |k,v|
           context.graph[k] = v
         end
@@ -86,14 +86,14 @@ class GraphViz
     
     class NodePreference < Treetop::Runtime::SyntaxNode
       def eval( context )
-        puts "NODE PREFERENCES :"
+        # puts "NODE PREFERENCES :"
         context.options[:node] = context.options[:node].merge( options.eval() )
       end
     end
     
     class EdgePreference < Treetop::Runtime::SyntaxNode
       def eval( context )
-        puts "EDGE PREFERENCES :"
+        # puts "EDGE PREFERENCES :"
         context.options[:edge] = context.options[:edge].merge( options.eval() )
       end
     end
@@ -101,8 +101,8 @@ class GraphViz
     class Node < Treetop::Runtime::SyntaxNode
       def eval( context )
         node_name = name.text_value.gsub( /"/, "" )
-        puts "NODE NAME = #{node_name}"
-        puts "OPTIONS = "
+        # puts "NODE NAME = #{node_name}"
+        # puts "OPTIONS = "
         
         # Create node
         node = context.nodes[node_name] || context.graph.add_node( node_name )
@@ -126,7 +126,7 @@ class GraphViz
     
     class Edge < Treetop::Runtime::SyntaxNode
       def create_node( name, context )
-        puts "  NEED TO CREATE NODE : #{name}"
+        # puts "  NEED TO CREATE NODE : #{name}"
         # Create the node
         node = context.graph.add_node( name )
         
@@ -160,10 +160,10 @@ class GraphViz
       def eval( context )
         one_name = node_one.text_value.gsub( /"/, "" )
         two_name = node_two.text_value.gsub( /"/, "" )
-        puts "EDGE"
-        puts "NODE ONE = #{one_name}"
-        puts "NODE TWO = #{two_name}"
-        puts "OPTIONS = "
+        # puts "EDGE"
+        # puts "NODE ONE = #{one_name}"
+        # puts "NODE TWO = #{two_name}"
+        # puts "OPTIONS = "
         
         # Get or create node one
         one = context.nodes[one_name] || create_node( one_name, context )
@@ -181,7 +181,7 @@ class GraphViz
         last_node = two
         other_nodes.elements.each do |e|
           new_node_name = e.next_node.text_value.gsub( /"/, "" )
-          puts "OTHER NODE : #{new_node_name}"
+          # puts "OTHER NODE : #{new_node_name}"
           
           new_node = context.nodes[new_node_name] || create_node( new_node_name, context )
           create_edge( last_node, new_node, edge_options, context )
@@ -193,7 +193,7 @@ class GraphViz
     
     class Subgraph < Treetop::Runtime::SyntaxNode
       def eval( context )
-        puts "CREATE SUBGRAPH : #{name.text_value}"
+        # puts "CREATE SUBGRAPH : #{name.text_value}"
         
         # Save options
         saved_options = context.options.clone
@@ -220,10 +220,10 @@ class GraphViz
   def eval
     options = {}
     elements[2].elements.each do |e|
-      puts "  #{e.elements[0].text_value} = #{e.elements[4].text_value}"
+      # puts "  #{e.elements[0].text_value} = #{e.elements[4].text_value}"
       options[e.elements[0].text_value] = e.elements[4].text_value.gsub( /"/, "" )
     end
-    puts "  #{elements[3].text_value} = #{elements[7].text_value}"
+    # puts "  #{elements[3].text_value} = #{elements[7].text_value}"
     options[elements[3].text_value] = elements[7].text_value.gsub( /"/, "" )
     
     return options

data/lib/graphviz/xml.rb

@@ -30,10 +30,18 @@ class GraphViz
     # Generate the graph
     # 
     # Options :
-    #   :output : Output format (Constants::FORMATS)
-    #   :file : Output file name
-    #   :use : Program to use (Constants::PROGRAMS)
-    #   :path : Program PATH
+    # * :output : Output format (Constants::FORMATS)
+    # * :file : Output file name
+    # * :use : Program to use (Constants::PROGRAMS)
+    # * :path : Program PATH
+    # * :<format> => <file> : <file> can be
+    #   * a file name
+    #   * nil, then the output will be printed to STDOUT
+    #   * String, then the output will be returned as a String
+    # * :errors : DOT error level (default 1)
+    #   * 0 = Error + Warning
+    #   * 1 = Error
+    #   * 2 = none
     # 
     def output( *hOpt )
       @oGraph.output( *hOpt )
@@ -45,8 +53,8 @@ class GraphViz
     # Create a graph from a XML file
     # 
     # In:
-    #   xFile : XML File
-    #   *hOpt : Graph options
+    # * xFile : XML File
+    # * *hOpt : Graph options
     # 
     def initialize( xFile, *hOpt )
       @xNodeName = "00000"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-graphviz
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Gregoire Lejeune
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 +02:00
+date: 2009-10-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,7 +85,7 @@ files:
 - examples/sample22.rb
 - examples/sample23.rb
 - examples/sample24.rb
-- examples/sample24.rb.png
+- examples/sample25.rb
 - examples/shapes.rb
 - examples/test.xml
 - examples/testorder.rb