ruby-graphviz 1.0.1 → 1.0.2

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - jruby

data/AUTHORS

@@ -15,6 +15,7 @@ oupo <http://github.com/oupo>
 Daniel Zollinger <https://github.com/dznz>
 Ronen Barzel <https://github.com/ronen>
 Jamison Dance <https://github.com/jergason>
+hirochachacha <https://github.com/hirochachacha>
 
 Thanks to :
 

data/README.rdoc

@@ -16,6 +16,12 @@ Interface to the GraphViz graphing tool
 
 == CHANGELOG
 
+=== 1.0.2 :
+* Add PageRank algorithm
+* Major bug corrections
+* Fix utils/colors.rb's case syntax
+* Modify deprecated method: Hash#index to Hash#key
+
 === 1.0.1 : 
 * Add GraphViz::DSL
 * Change project to use Bundler gem tools

data/Rakefile

@@ -42,7 +42,13 @@ RDoc::Task.new do |rdoc|
 end
 
 Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/test_*.rb']
+  require 'graphviz/utils'
+  include GVUtils
+  if find_executable("dot", nil).nil?
+    t.test_files = FileList['test/test_*.rb'].exclude("test/test_examples.rb") 
+  else
+    t.test_files = FileList['test/test_*.rb']
+  end
 end
 
 Bundler::GemHelper.install_tasks

data/examples/sample62.rb

@@ -21,4 +21,4 @@ end
 
 puts "---------"
 
-puts hello_world.output( :dot => String )
+puts hello_world.output( :canon => String )

data/examples/theory/tests.rb

@@ -39,15 +39,17 @@ puts "Symmetric ? #{t.symmetric?}"
 
 puts "Incidence matrix :"
 puts t.incidence_matrix
-# => [  1  1  1  1  0  0  0  0  0  0]
-#    [  0 -1  0  0  1  1  1  0  0  0]
-#    [  0  0  0  0 -1  0  0  1  1  0]
-#    [  0  0 -1  0  0 -1  0 -1  0  1]
-#    [  0  0  0  0  0  0 -1  0  0 -1]
-#    [  0  0  0 -1  0  0  0  0 -1  0]
+# => [  1  1  1  0  0  0  0  0  0]
+#    [ -1  0  0  1  1  1  0  0  0]
+#    [  0  0  0 -1  0  0  1  1  0]
+#    [  0 -1  0  0 -1  0 -1  0  1]
+#    [  0  0  0  0  0 -1  0  0 -1]
+#    [  0  0 -1  0  0  0  0 -1  0]
 
 g.each_node do |name, node|
   puts "Degree of node `#{name}' = #{t.degree(node)}"
+  print "neighbors : "; p t.neighbors(name).map{ |e| e.id } # = node.neighbors.map { |e| e.id }
+  print "incidents : "; p t.incidents(name).map{ |e| e.id } # = node.incidents.map { |e| e.id }
 end
 
 puts "Laplacian matrix :"
@@ -78,4 +80,8 @@ puts "Your graph contains circuits" if rr.include?(nil)
 puts "Critical path : "
 rrr = t.critical_path
 print "\tPath "; p rrr[:path]
-puts "\tDistance : #{rrr[:distance]}"
+puts "\tDistance : #{rrr[:distance]}"
+
+t.pagerank.each { |node, rank| 
+   puts "Pagerank for node #{node.id} = #{rank}"
+}

data/lib/graphviz.rb

@@ -93,31 +93,33 @@ class GraphViz
   # Return the GraphViz::Node object created
   #
   def add_node( xNodeName, hOpts = {} )
-    return @hoNodes[xNodeName] || Proc.new {
+    node = @hoNodes[xNodeName]
+
+    if node.nil?
       @hoNodes[xNodeName] = GraphViz::Node::new( xNodeName, self )
       @hoNodes[xNodeName].index = @elements_order.size_of( "node" )
     
       unless hOpts.keys.include?(:label) or hOpts.keys.include?("label")
         hOpts[:label] = xNodeName
       end
-      
-      hOpts.each do |xKey, xValue|
-        @hoNodes[xNodeName][xKey.to_s] = xValue
-      end
     
       @elements_order.push( { 
         "type" => "node", 
         "name" => xNodeName,
         "value" => @hoNodes[xNodeName] 
       } )
-    
-      return( @hoNodes[xNodeName] )
-    }.call
+
+      node = @hoNodes[xNodeName]
+    end
+
+    hOpts.each do |xKey, xValue|
+       @hoNodes[xNodeName][xKey.to_s] = xValue
+    end
+
+    return node
   end
 
-  #
-  # Return the node object for the given name (or nil)
-  #
+  # Return the node object for the given name (or nil) in the current graph
   def get_node( xNodeName, &block )
     node = @hoNodes[xNodeName] || nil
     
@@ -125,6 +127,23 @@ class GraphViz
     
     return node
   end
+
+  # Returns the first node found in the entire graph, starting from the root graph
+  def find_node(name) 
+     root = root_graph
+     return root.search_node(name)
+  end
+
+  # Return the first node found in the current graph, and it subgraphs
+  def search_node(name)
+     n = get_node(name)
+     return n unless n.nil?
+     each_graph { |_, g|
+        n = g.search_node(name)
+        return n unless n.nil?
+     }
+     return nil
+  end
   
   #
   # Return the node object for the given index
@@ -764,6 +783,10 @@ class GraphViz
     complete
   end
 
+  # Return true if the graph is directed.
+  def directed?
+     not (/digraph/ =~ "bla digraph bla").nil?
+  end
 ## ----------------------------------------------------------------------------
 
   private 

data/lib/graphviz/attrs.rb

@@ -15,54 +15,49 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 
 class GraphViz
-  class Attrs
-    @data
-    @name
-    @attributs
-	  @graphviz
-    
-    attr_accessor :data
+   class Attrs
+      attr_accessor :data
 
-    def initialize( gviz, name, attributs )
-      @name      = name
-      @attributs = attributs
-      @data      = Hash::new( )
-	    @graphviz  = gviz
-    end
+      def initialize( gviz, name, attributs )
+         @name      = name
+         @attributs = attributs
+         @data      = Hash::new( )
+         @graphviz  = gviz
+      end
 
-    def each
-      @data.each do |k, v|
-        yield(k, v)
+      def each
+         @data.each do |k, v|
+            yield(k, v)
+         end
       end
-    end
-    
-    def to_h
-      @data.clone
-    end
 
-    def []( xKey )
-      if xKey.class == Hash
-        xKey.each do |k, v|
-          self[k] = v
-        end
-      else
-        if @data.key?( xKey.to_s ) == false
-          nil
-        end
-        @data[xKey.to_s]
+      def to_h
+         @data.clone
       end
-    end
-    
-    def []=( xKey, xValue )
-      unless @attributs.keys.include?( xKey.to_s )
-        raise ArgumentError, "#{@name} attribut '#{xKey.to_s}' invalid"
+
+      def []( key )
+         if key.class == Hash
+            key.each do |k, v|
+               self[k] = v
+            end
+         else
+            if @data.key?( key.to_s ) == false
+               nil
+            end
+            @data[key.to_s]
+         end
       end
-      
-      @data[xKey.to_s] = GraphViz::Types.const_get(@attributs[xKey.to_s]).new( xValue )
 
-      if @graphviz.nil? == false
-        @graphviz.set_position( @name, xKey.to_s, @data[xKey.to_s] )
+      def []=( key, value )
+         unless @attributs.keys.include?( key.to_s )
+            raise ArgumentError, "#{@name} attribut '#{key.to_s}' invalid"
+         end
+
+         @data[key.to_s] = GraphViz::Types.const_get(@attributs[key.to_s]).new( value )
+
+         if @graphviz.nil? == false
+            @graphviz.set_position( @name, key.to_s, @data[key.to_s] )
+         end
       end
-    end
-  end
+   end
 end

data/lib/graphviz/constants.rb

@@ -40,7 +40,7 @@
 #   C => cluster
 #
 module Constants
-  RGV_VERSION = "1.0.1"
+  RGV_VERSION = "1.0.2"
   
   ## Const: Output formats
   FORMATS = [
@@ -103,8 +103,8 @@ module Constants
   ## Const: graphs type
   GRAPHTYPE = [
     "digraph",
-	  "graph",
-	  "strict digraph"
+	 "graph",
+	 "strict digraph"
   ]
 
   def self.getAttrsFor( x )

data/lib/graphviz/core_ext.rb

@@ -63,4 +63,11 @@ class Hash
          yield( k, v ) unless (key_table.size > 0 and key_table.include?(k)) or (key_regexp.size > 0 and k.to_s.match(key_regexp)) or (value_table.size > 0 and value_table.include?(v)) or (value_regexp.size > 0 and v.to_s.match(value_regexp))
       end
    end
+
+   unless self.method_defined? :key
+      # Add Hash#key to Ruby < 1.9
+      def key(v)
+         index(v)
+      end
+   end
 end

data/lib/graphviz/dsl.rb

@@ -3,12 +3,13 @@ require 'graphviz'
 class GraphViz::DSL
    attr_accessor :graph
 
-   def initialize(name, hOpts = {}, &block)
-      @graph = GraphViz.new(name, hOpts)
+   # Create a new graph
+   def initialize(name, options = {}, &block)
+      @graph = GraphViz.new(name, options)
       instance_eval(&block) if block
    end
 
-   def method_missing(sym, *args, &block)
+   def method_missing(sym, *args, &block) #:nodoc:
       return @graph.get_graph(sym.to_s) unless @graph.get_graph(sym.to_s).nil?
       return @graph.get_node(sym.to_s) unless @graph.get_node(sym.to_s).nil?
       if(@graph.respond_to?(sym, true))
@@ -20,11 +21,13 @@ class GraphViz::DSL
       end
    end
 
+   # Add a new node
    def n(name)
       return @graph.get_node(name) unless @graph.get_node(name.to_s).nil?
       @graph.add_node(name)
    end
 
+   # Create edges
    def e(*args)
       e = nil
       last = args.shift
@@ -35,25 +38,30 @@ class GraphViz::DSL
       return e
    end
 
+   # Add a subgraph
    def subgraph(name, &block) 
       @graph.add_graph(GraphViz::DSL.new(name, { :parent => @graph, :type => @graph.type }, &block).graph)
    end
    alias :cluster :subgraph
 
-   def output(hOpts = {}) 
-      @graph.output(hOpts)
+   # Generate output
+   def output(options = {}) 
+      @graph.output(options)
    end
 end
 
-def graph(name, hOpts = {}, &block) 
-   GraphViz::DSL.new(name, hOpts.merge( { :type => "graph" } ), &block).graph
+# Create a new undirected graph
+def graph(name, options = {}, &block) 
+   GraphViz::DSL.new(name, options.merge( { :type => "graph" } ), &block).graph
 end
 
-def digraph(name, hOpts = {}, &block) 
-   GraphViz::DSL.new(name, hOpts.merge( { :type => "digraph" } ), &block).graph
+# Create a new directed graph
+def digraph(name, options = {}, &block) 
+   GraphViz::DSL.new(name, options.merge( { :type => "digraph" } ), &block).graph
 end
 
-def strict(name, hOpts = {}, &block) 
-   GraphViz::DSL.new(name, hOpts.merge( { :type => "strict digraph" } ), &block).graph
+# Create a new strict directed graph
+def strict(name, options = {}, &block) 
+   GraphViz::DSL.new(name, options.merge( { :type => "strict digraph" } ), &block).graph
 end
 

data/lib/graphviz/edge.rb

@@ -18,196 +18,176 @@ require 'graphviz/attrs'
 require 'graphviz/constants'
 
 class GraphViz
-  class Edge
-    include Constants
-    @xNodeOne
-    @xNodeOnePort
-    @xNodeTwo
-    @xNodeTwoPort
-    @oAttrEdge
-    @oGParrent
-
-    # 
-    # 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)
-    # * oGParrent : Graph 
-    #
-    def initialize( vNodeOne, vNodeTwo, oGParrent )
-      @xNodeOne, @xNodeOnePort = getNodeNameAndPort( vNodeOne )
-	    # if vNodeOne.class == String
-      #   @xNodeOne = vNodeOne
-	    # else
-      #   @xNodeOne = vNodeOne.id
-	    # end
-	    @xNodeTwo, @xNodeTwoPort = getNodeNameAndPort( vNodeTwo )
-	    # if vNodeTwo.class == String
-      #   @xNodeTwo = vNodeTwo
-	    # else
-      #   @xNodeTwo = vNodeTwo.id
-	    # end
-	    
-	    @oGParrent = oGParrent
-
-      @oAttrEdge = GraphViz::Attrs::new( nil, "edge", EDGESATTRS )
-      
-      @index = nil
-    end
-
-    # Return the node one as string (so with port if any)
-    def node_one( with_port = true )
-      if @xNodeOnePort.nil? or with_port == false
-	      GraphViz.escape(@xNodeOne)
-      else
-        GraphViz.escape(@xNodeOne, :force => true) + ":#{@xNodeOnePort}"
+   class Edge
+      include 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_attributs = GraphViz::Attrs::new( nil, "edge", EDGESATTRS )
+         @index = nil
+
+         unless @parent_graph.directed? 
+            (@parent_graph.find_node(@node_one_id) || @parent_graph.add_node(@node_one_id)).incidents << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_node(@node_two_id))
+            (@parent_graph.find_node(@node_two_id) || @parent_graph.add_node(@node_two_id)).neighbors << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_node(@node_one_id))
+         end
+         (@parent_graph.find_node(@node_one_id) || @parent_graph.add_node(@node_one_id)).neighbors << (@parent_graph.find_node(@node_two_id) || @parent_graph.add_node(@node_two_id))
+         (@parent_graph.find_node(@node_two_id) || @parent_graph.add_node(@node_two_id)).incidents << (@parent_graph.find_node(@node_one_id) || @parent_graph.add_node(@node_one_id))
+      end
+
+      # Return the node one as string (so with port if any)
+      def node_one( with_port = true )
+         if @node_one_port.nil? or with_port == false
+            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 @node_two_port.nil? or with_port == false
+            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 +attribut_value+ to the edge attribut +attribut_name+
+      def []=( attribut_name, attribut_value )
+         attribut_value = attribut_value.to_s if attribut_value.class == Symbol
+         @edge_attributs[attribut_name.to_s] = attribut_value
+      end
+
+      # Set values for edge attributs or 
+      # get the value of the given edge attribut +attribut_name+
+      def []( attribut_name )
+         # Modification by axgle (http://github.com/axgle)
+         if Hash === attribut_name
+            attribut_name.each do |key, value|
+               self[key] = value
+            end
+         else
+            if @edge_attributs[attribut_name.to_s]
+               @edge_attributs[attribut_name.to_s].clone 
+            else
+               nil
+            end
+         end
       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 @xNodeTwoPort.nil? or with_port == false
-	      GraphViz.escape(@xNodeTwo) 
-	    else 
-	      GraphViz.escape(@xNodeTwo, :force => true) + ":#{@xNodeTwoPort}"
+
+      #
+      # Calls block once for each attribut 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 attributs set globally
+      #
+      def each_attribut(global = true, &b)
+         attrs = @edge_attributs.to_h
+         if global
+            attrs = pg.edge.to_h.merge attrs
+         end
+         attrs.each do |k,v|
+            yield(k,v)
+         end
       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 +xAttrValue+ to the edge attribut +xAttrName+
-    # 
-	  def []=( xAttrName, xAttrValue )
-      xAttrValue = xAttrValue.to_s if xAttrValue.class == Symbol
-      @oAttrEdge[xAttrName.to_s] = xAttrValue
-    end
-
-    # 
-    # Set values for edge attributs or 
-    # get the value of the given edge attribut +xAttrName+
-    # 
-    def []( xAttrName )
-      # Modification by axgle (http://github.com/axgle)
-      if Hash === xAttrName
-        xAttrName.each do |key, value|
-          self[key] = value
-        end
-      else
-        if @oAttrEdge[xAttrName.to_s]
-          @oAttrEdge[xAttrName.to_s].clone 
-        else
-          nil
-        end
+
+      def <<( node ) #:nodoc:
+         n = @parent_graph.get_node(@node_two_id)
+
+         GraphViz::commonGraph( node, n ).add_edge( n, node )
       end
-    end
-    
-    #
-    # Calls block once for each attribut 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 attributs set globally
-    #
-    def each_attribut(global = true, &b)
-      attrs = @oAttrEdge.to_h
-      if global
-        attrs = pg.edge.to_h.merge attrs
+      alias :> :<< #:nodoc:
+      alias :- :<< #:nodoc:
+      alias :>> :<< #:nodoc:
+
+      #
+      # Return the root graph
+      #
+      def root_graph
+         return( (self.pg.nil?) ? nil : self.pg.root_graph )
       end
-      attrs.each do |k,v|
-        yield(k,v)
+
+      def pg #:nodoc:
+         @parent_graph
+      end
+
+      # Set edge attributs
+      #
+      # Example :
+      #   e = graph.add_edge( ... )
+      #   ...
+      #   e.set { |_e|
+      #     _e.color = "blue"
+      #     _e.fontcolor = "red"
+      #   }
+      def set( &b )
+         yield( self )
       end
-    end
-    
-    def <<( oNode ) #:nodoc:
-      n = @oGParrent.get_node(@xNodeTwo)
-      
-      GraphViz::commonGraph( oNode, n ).add_edge( n, oNode )
-    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:
-      @oGParrent
-    end
-    
-    #
-    # Set edge attributs
-    #
-    # Example :
-    #   e = graph.add_edge( ... )
-    #   ...
-    #   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 = ""
-      @oAttrEdge.data.each do |k, v|
-        xAttr << xSeparator + k + " = " + v.to_gv
-        xSeparator = ", "
+
+      # 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
-      if xAttr.length > 0
-        xOut << " [" + xAttr + "]"
+
+      def output( oGraphType ) #:nodoc:
+         xLink = " -> "
+         if oGraphType == "graph"
+            xLink = " -- "
+         end
+
+         xOut = self.node_one + xLink + self.node_two
+         xAttr = ""
+         xSeparator = ""
+         @edge_attributs.data.each do |k, v|
+            xAttr << xSeparator + k + " = " + v.to_gv
+            xSeparator = ", "
+         end
+         if xAttr.length > 0
+            xOut << " [" + xAttr + "]"
+         end
+         xOut + ";"
+
+         return( xOut )
       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
+
+      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
-      
-      return name, port
-    end
-  end
+   end
 end