ruby-graphviz 1.0.9 → 1.1.0

data/lib/graphviz/attrs.rb

@@ -59,7 +59,7 @@ class GraphViz
          end
 
          begin
-            value = GraphViz::Types.const_get(@attributes[key.to_s]).new( value )
+            value = GraphViz::Types.const_get(@attributes[key.to_s]).new(value)
          rescue => e
             raise AttributeException, "Invalid value `#{value}` for attribute `#{key}` : #{e}"
          end

data/lib/graphviz/constants.rb

@@ -41,7 +41,7 @@
 #
 class GraphViz
   module Constants
-    RGV_VERSION = "1.0.9"
+    RGV_VERSION = "1.1.0"
 
     ## Const: Output formats
     FORMATS = [

data/lib/graphviz/dot2ruby.rb

@@ -24,13 +24,16 @@ class Dot2Ruby #:nodoc:
   def initialize( xGVPath, xOutFile, xOutFormat = nil ) #:nodoc:
     paths = (xGVPath.nil?) ? [] : [xGVPath]
     @xGvprPath = find_executable( 'gvpr', paths )
+    if (@xGvprPath.blank?)
+      raise Exception, "GraphViz is not installed. Please be sure that 'gvpr' is on the search path'"
+    end
     @xOutFile = xOutFile
     @xOutFormat = xOutFormat || "_"
     @gvprScript = GraphViz::Ext.find( "dot2ruby.g" )
   end
 
   def run( xFile ) #:nodoc:
-    xCmd = "#{@xGvprPath} -f #{@gvprScript} -a #{@xOutFormat} #{xFile}"
+    xCmd = [@xGvprPath, '-f', @gvprScript, '-a', @xOutFormat, xFile]
     xOutput = output_from_command( xCmd )
     if @xOutFile.nil?
       puts xOutput
@@ -42,7 +45,7 @@ class Dot2Ruby #:nodoc:
   end
 
   def eval( xFile ) #:nodoc:
-    xCmd = "#{@xGvprPath} -f #{@gvprScript} -a \"-\" #{xFile}"
+    xCmd = [@xGvprPath, '-f', @gvprScript, '-a', '-', xFile]
     xOutput = output_from_command( xCmd )
     instance_eval(xOutput)
     return @_graph_eval

data/lib/graphviz/edge.rb

@@ -18,180 +18,185 @@ require 'graphviz/attrs'
 require 'graphviz/constants'
 
 class GraphViz
-   class Edge
-      include GraphViz::Constants
-
-      # Create a new edge
-      #
-      # In:
-      # * vNodeOne : First node (can be a GraphViz::Node or a node ID)
-      # * vNodeTwo : Second node (can be a GraphViz::Node or a node ID)
-      # * parent_graph : Graph
-      def initialize( vNodeOne, vNodeTwo, parent_graph )
-         @node_one_id, @node_one_port = getNodeNameAndPort( vNodeOne )
-         @node_two_id, @node_two_port = getNodeNameAndPort( vNodeTwo )
-
-         @parent_graph = parent_graph
-         @edge_attributes = GraphViz::Attrs::new( nil, "edge", EDGESATTRS )
-         @index = nil
-
-         unless @parent_graph.directed?
-            (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id)).incidents << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id))
-            (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id)).neighbors << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id))
-         end
-         (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id)).neighbors << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id))
-         (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id)).incidents << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id))
-      end
-
-      # Return the node one as string (so with port if any)
-      def node_one( with_port = true )
-         if not(@node_one_port and with_port)
-            GraphViz.escape(@node_one_id)
-         else
-            GraphViz.escape(@node_one_id, :force => true) + ":#{@node_one_port}"
-         end
-      end
-      alias :tail_node :node_one
-
-      # Return the node two as string (so with port if any)
-      def node_two( with_port = true )
-         if not(@node_two_port and with_port)
-            GraphViz.escape(@node_two_id)
-         else
-            GraphViz.escape(@node_two_id, :force => true) + ":#{@node_two_port}"
-         end
-      end
-      alias :head_node :node_two
-
-      # Return the index of the edge
-      def index
-         @index
-      end
-      def index=(i) #:nodoc:
-         @index = i if @index == nil
-      end
-
-      # Set value +attribute_value+ to the edge attribute +attribute_name+
-      def []=( attribute_name, attribute_value )
-         attribute_value = attribute_value.to_s if attribute_value.class == Symbol
-         @edge_attributes[attribute_name.to_s] = attribute_value
-      end
-
-      # Set values for edge attributes or
-      # get the value of the given edge attribute +attribute_name+
-      def []( attribute_name )
-         # Modification by axgle (http://github.com/axgle)
-         if Hash === attribute_name
-            attribute_name.each do |key, value|
-               self[key] = value
-            end
-         else
-            if @edge_attributes[attribute_name.to_s]
-               @edge_attributes[attribute_name.to_s].clone
-            else
-               nil
-            end
-         end
-      end
-
-      #
-      # Calls block once for each attribute of the edge, passing the name and value to the
-      # block as a two-element array.
-      #
-      # If global is set to false, the block does not receive the attributes set globally
-      #
-      def each_attribute(global = true, &b)
-         attrs = @edge_attributes.to_h
-         if global
-            attrs = pg.edge.to_h.merge attrs
-         end
-         attrs.each do |k,v|
-            yield(k,v)
-         end
-      end
-      def each_attribut(global = true, &b)
-         warn "`GraphViz::Edge#each_attribut` is deprecated, please use `GraphViz::Edge#each_attribute`"
-         each_attribute(global, &b)
-      end
-
-      def <<( node ) #:nodoc:
-         n = @parent_graph.get_node(@node_two_id)
-
-         GraphViz::commonGraph( node, n ).add_edges( n, node )
-      end
-      alias :> :<< #:nodoc:
-      alias :- :<< #:nodoc:
-      alias :>> :<< #:nodoc:
-
-      #
-      # Return the root graph
-      #
-      def root_graph
-         return( (self.pg.nil?) ? nil : self.pg.root_graph )
-      end
-
-      def pg #:nodoc:
-         @parent_graph
-      end
-
-      # Set edge attributes
-      #
-      # Example :
-      #   e = graph.add_edges( ... )
-      #   ...
-      #   e.set { |_e|
-      #     _e.color = "blue"
-      #     _e.fontcolor = "red"
-      #   }
-      def set( &b )
-         yield( self )
-      end
-
-      # Add edge options
-      # use edge.<option>=<value> or edge.<option>( <value> )
-      def method_missing( idName, *args, &block ) #:nodoc:
-         return if idName == :to_ary # ruby 1.9.2 fix
-         xName = idName.id2name
-
-         self[xName.gsub( /=$/, "" )]=args[0]
-      end
-
-      def output( oGraphType ) #:nodoc:
-         xLink = " -> "
-         if oGraphType == "graph"
-            xLink = " -- "
-         end
-
-         xOut = self.node_one + xLink + self.node_two
-         xAttr = ""
-         xSeparator = ""
-         @edge_attributes.data.each do |k, v|
-            xAttr << xSeparator + k + " = " + v.to_gv
-            xSeparator = ", "
-         end
-         if xAttr.length > 0
-            xOut << " [" + xAttr + "]"
-         end
-         xOut << ";"
-
-         return( xOut )
-      end
-
-      private
-      def getNodeNameAndPort( node )
-         name, port = nil, nil
-         if node.class == Hash
-            node.each do |k, v|
-               name, port = getNodeNameAndPort(k)
-               port = v
-            end
-         elsif node.class == String
-            name = node
-         else
-            name = node.id
-         end
-
-         return name, port
-      end
-   end
+  class Edge
+    include GraphViz::Constants
+
+    # Create a new edge
+    #
+    # In:
+    # * vNodeOne : First node (can be a GraphViz::Node or a node ID)
+    # * vNodeTwo : Second node (can be a GraphViz::Node or a node ID)
+    # * parent_graph : Graph
+    def initialize( vNodeOne, vNodeTwo, parent_graph )
+      @node_one_id, @node_one_port = getNodeNameAndPort( vNodeOne )
+      @node_two_id, @node_two_port = getNodeNameAndPort( vNodeTwo )
+
+      @parent_graph = parent_graph
+      @edge_attributes = GraphViz::Attrs::new( nil, "edge", EDGESATTRS )
+      @index = nil
+
+      unless @parent_graph.directed?
+        (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id)).incidents << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id))
+        (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id)).neighbors << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id))
+      end
+      (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id)).neighbors << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id))
+      (@parent_graph.find_node(@node_two_id) || @parent_graph.add_nodes(@node_two_id)).incidents << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_nodes(@node_one_id))
+    end
+
+    # Return the node one as string (so with port if any)
+    def node_one(with_port = true, escaped = true)
+      if not(@node_one_port and with_port)
+        escaped ? GraphViz.escape(@node_one_id) : @node_one_id
+      else
+        escaped ? GraphViz.escape(@node_one_id, :force => true) + ":#{@node_one_port}" : "#{@node_one_id}:#{@node_one_port}"
+      end
+    end
+    alias :tail_node :node_one
+
+    # Return the node two as string (so with port if any)
+    def node_two(with_port = true, escaped = true)
+      if not(@node_two_port and with_port)
+        escaped ? GraphViz.escape(@node_two_id) : @node_two_id
+      else
+        escaped ? GraphViz.escape(@node_two_id, :force => true) + ":#{@node_two_port}" : "#{@node_two_id}:#{@node_two_port}"
+      end
+    end
+    alias :head_node :node_two
+
+    # Return the index of the edge
+    def index
+      @index
+    end
+    def index=(i) #:nodoc:
+      @index = i if @index == nil
+    end
+
+    # Set value +attribute_value+ to the edge attribute +attribute_name+
+    def []=( attribute_name, attribute_value )
+      attribute_value = attribute_value.to_s if attribute_value.class == Symbol
+      @edge_attributes[attribute_name.to_s] = attribute_value
+    end
+
+    # Set values for edge attributes or
+    # get the value of the given edge attribute +attribute_name+
+    def []( attribute_name )
+      # Modification by axgle (http://github.com/axgle)
+      if Hash === attribute_name
+        attribute_name.each do |key, value|
+          self[key] = value
+        end
+      else
+        if @edge_attributes[attribute_name.to_s]
+          @edge_attributes[attribute_name.to_s].clone
+        else
+          nil
+        end
+      end
+    end
+
+    #
+    # Calls block once for each attribute of the edge, passing the name and value to the
+    # block as a two-element array.
+    #
+    # If global is set to false, the block does not receive the attributes set globally
+    #
+    def each_attribute(global = true, &b)
+      attrs = @edge_attributes.to_h
+      if global
+        attrs = pg.edge.to_h.merge attrs
+      end
+      attrs.each do |k,v|
+        yield(k,v)
+      end
+    end
+    def each_attribut(global = true, &b)
+      warn "`GraphViz::Edge#each_attribut` is deprecated, please use `GraphViz::Edge#each_attribute`"
+      each_attribute(global, &b)
+    end
+
+    def <<( node ) #:nodoc:
+      n = @parent_graph.get_node(@node_two_id)
+
+      GraphViz::commonGraph( node, n ).add_edges( n, node )
+    end
+    alias :> :<< #:nodoc:
+    alias :- :<< #:nodoc:
+    alias :>> :<< #:nodoc:
+
+    #
+    # Return the root graph
+    #
+    def root_graph
+      return( (self.pg.nil?) ? nil : self.pg.root_graph )
+    end
+
+    def pg #:nodoc:
+      @parent_graph
+    end
+
+    # Set edge attributes
+    #
+    # Example :
+    #   e = graph.add_edges( ... )
+    #   ...
+    #   e.set { |_e|
+    #     _e.color = "blue"
+    #     _e.fontcolor = "red"
+    #   }
+    def set( &b )
+      yield( self )
+    end
+
+    # Add edge options
+    # use edge.<option>=<value> or edge.<option>( <value> )
+    def method_missing( idName, *args, &block ) #:nodoc:
+      return if idName == :to_ary # ruby 1.9.2 fix
+      xName = idName.id2name
+
+      self[xName.gsub( /=$/, "" )]=args[0]
+    end
+
+    def output( oGraphType ) #:nodoc:
+      xLink = " -> "
+      if oGraphType == "graph"
+        xLink = " -- "
+      end
+
+      # reserved words, they aren't accepted in dot as node name
+      reserved_names = ["node", "edge","graph", "digraph", "subgraph", "strict"]
+
+      xOut = reserved_names.include?(self.node_one) ? "" << "_" + self.node_one : "" << self.node_one
+      xOut = xOut << xLink
+      xOut = reserved_names.include?(self.node_two) ? xOut << "_" + self.node_two : xOut << self.node_two
+      xAttr = ""
+      xSeparator = ""
+      @edge_attributes.data.each do |k, v|
+        xAttr << xSeparator + k + " = " + v.to_gv
+        xSeparator = ", "
+      end
+      if xAttr.length > 0
+        xOut << " [" + xAttr + "]"
+      end
+      xOut << ";"
+
+      return( xOut )
+    end
+
+    private
+    def getNodeNameAndPort( node )
+      name, port = nil, nil
+      if node.class == Hash
+        node.each do |k, v|
+          name, port = getNodeNameAndPort(k)
+          port = v
+        end
+      elsif node.class == String
+        name = node
+      else
+        name = node.id
+      end
+
+      return name, port
+    end
+  end
 end

data/lib/graphviz/node.rb

@@ -134,11 +134,16 @@ class GraphViz
       end
 
       def output #:nodoc:
+         # reserved words, they aren't accepted in dot as node name
+         reserved_names = ["node", "edge","graph", "digraph", "subgraph", "strict"]
          #node_id = @node_id.clone
          #node_id = '"' << node_id << '"' if node_id.match( /^[a-zA-Z_]+[a-zA-Z0-9_\.]*$/ ).nil?
          node_id = GraphViz.escape(@node_id)
 
-         xOut = "" << node_id
+         # add a check to see if the node names are valid
+         # if they aren't is added an _ before
+         # and the print staies the same, because of the label
+         xOut = reserved_names.include?(node_id) ? "" << "_" + node_id : "" << node_id
          xAttr = ""
          xSeparator = ""
 

data/lib/graphviz/theory.rb

@@ -11,8 +11,8 @@ class GraphViz
          matrix = GraphViz::Math::Matrix.new( @graph.node_count, @graph.node_count )
 
          @graph.each_edge { |e|
-            x = @graph.get_node(e.node_one( false )).index
-            y = @graph.get_node(e.node_two( false )).index
+            x = @graph.get_node(e.node_one(false, false)).index
+            y = @graph.get_node(e.node_two(false, false)).index
             matrix[x+1, y+1] = 1
             matrix[y+1, x+1] = 1 if @graph.type == "graph"
          }
@@ -28,8 +28,8 @@ class GraphViz
          @graph.each_edge { |e|
             x = e.index
 
-            nstart = @graph.get_node(e.node_one( false )).index
-            nend = @graph.get_node(e.node_two( false )).index
+            nstart = @graph.get_node(e.node_one(false, false)).index
+            nend = @graph.get_node(e.node_two(false, false)).index
 
             matrix[nstart+1, x+1] = 1
             matrix[nend+1, x+1] = tail
@@ -48,7 +48,7 @@ class GraphViz
          end
 
          @graph.each_edge do |e|
-            degree += 1 if e.node_one(false) == name or e.node_two(false) == name
+            degree += 1 if e.node_one(false, false) == name or e.node_two(false, false) == name
          end
 
          return degree
@@ -246,8 +246,8 @@ class GraphViz
          matrix = GraphViz::Math::Matrix.new( @graph.node_count, @graph.node_count, (1.0/0.0) )
 
          @graph.each_edge { |e|
-            x = @graph.get_node(e.node_one( false )).index
-            y = @graph.get_node(e.node_two( false )).index
+            x = @graph.get_node(e.node_one(false, false)).index
+            y = @graph.get_node(e.node_two(false, false)).index
             unless x == y
                weight = ((e[:weight].nil?) ? 1 : e[:weight].to_f)
                matrix[x+1, y+1] = weight