rgl 0.6.2 → 0.6.4

data/lib/rgl/rdot.rb

@@ -7,131 +7,185 @@ module RGL
   # It also supports undirected edges.
   module DOT
 
-    # options for node declaration
+    # attributes due to
+    # https://www.graphviz.org/pdf/dotguide.pdf
+    # January 5, 2015
 
+    # options for node declaration
     NODE_OPTS = [
-        # attributes due to
-        # https://www.graphviz.org/Documentation/dotguide.pdf
-        # February 23, 2008
-        'color', # default: black; node shape color
-        'comment', # any string (format-dependent)
-        'distortion', # default: 0.0; node distortion for shape=polygon
-        'fillcolor', # default: lightgrey/black; node fill color
-        'fixedsize', # default: false; label text has no affect on node size
-        'fontcolor', # default: black; type face color
-        'fontname', # default: Times-Roman; font family
-        'fontsize', #default: 14; point size of label
-        'group', # name of node's group
-        'height', # default: .5; height in inches
-        'label', # default: node name; any string
-        'layer', # default: overlay range; all, id or id:id
-        'orientation', # dafault: 0.0; node rotation angle
-        'peripheries', # shape-dependent number of node boundaries
-        'regular', # default: false; force polygon to be regular
-        'shape', # default: ellipse; node shape; see Section 2.1 and Appendix E
-        'shapefile', # external EPSF or SVG custom shape file
-        'sides', # default: 4; number of sides for shape=polygon
-        'skew' , # default: 0.0; skewing of node for shape=polygon
-        'style', # graphics options, e.g. bold, dotted, filled; cf. Section 2.3
-        'URL', # URL associated with node (format-dependent)
-        'width', # default: .75; width in inches
-        'z', #default: 0.0; z coordinate for VRML output
-
-        # maintained for backward compatibility or rdot internal
-        'bottomlabel', # auxiliary label for nodes of shape M*
-        'bgcolor',
-        'rank',
-        'toplabel' # auxiliary label for nodes of shape M*
-    ]
+      'color', # default: black; node shape color
+      'colorscheme', # default: X11; scheme for interpreting color names
+      'comment', # any string (format-dependent)
+      'distortion', # default: 0.0; node distortion for shape=polygon
+      'fillcolor', # default: lightgrey/black; node fill color
+      'fixedsize', # default: false; label text has no affect on node size
+      'fontcolor', # default: black; type face color
+      'fontname', # default: Times-Roman; font family
+      'fontsize', # default: 14; point size of label
+      'group', # name of node's group
+      'height', # default: .5; height in inches
+      'id', # any string (user-defined output object tags)
+      'label', # default: node name; any string
+      'labelloc', # default: c; node label vertical alignment
+      'layer', # default: overlay range; all, id or id:id
+      'margin', # default: 0.11,0.55; space around label
+      'nojustify', # default: false; if true, justify to label, not node
+      'orientation', # default: 0.0; node rotation angle
+      'penwidth', # default: 1.0; width of pen for drawing boundaries, in points
+      'peripheries', # shape-dependent number of node boundaries
+      'regular', # default: false; force polygon to be regular
+      'samplepoints', # default 8 or 20; number vertices to convert circle or ellipse
+      'shape', # default: ellipse; node shape; see Section 2.1 and Appendix E
+      'shapefile', # external EPSF or SVG custom shape file
+      'sides', # default: 4; number of sides for shape=polygon
+      'skew', # default: 0.0; skewing of node for shape=polygon
+      'style', # graphics options, e.g. bold, dotted, filled; cf. Section 2.3
+      'target', # if URL is set, determines browser window for URL
+      'tooltip', # default: label, tooltip annotation for node
+      'URL', # URL associated with node (format-dependent)
+      'width', # default: .75; width in inches
+    ].freeze
+
+    # maintained for backward compatibility or rdot internal
+    NODE_OPTS_LGCY = [
+      'bottomlabel', # auxiliary label for nodes of shape M*
+      'bgcolor',
+      'rank',
+      'toplabel' # auxiliary label for nodes of shape M*
+    ].freeze
 
     # options for edge declaration
-
     EDGE_OPTS = [
-        'arrowhead', # default: normal; style of arrowhead at head end
-        'arrowsize', # default: 1.0; scaling factor for arrowheads
-        'arrowtail', # default: normal; style of arrowhead at tail end
-        'color', # default: black; edge stroke color
-        'comment', # any string (format-dependent)
-        'constraint', # default: true use edge to affect node ranking
-        'decorate', # if set, draws a line connecting labels with their edges
-        'dir', # default: forward; forward, back, both, or none
-        'fontcolor', # default: black type face color
-        'fontname', # default: Times-Roman; font family
-        'fontsize', # default: 14; point size of label
-        'headlabel', # label placed near head of edge
-        'headport', # n,ne,e,se,s,sw,w,nw
-        'headURL', # URL attached to head label if output format is ismap
-        'label', # edge label
-        'labelangle', # default: -25.0; angle in degrees which head or tail label is rotated off edge
-        'labeldistance', # default: 1.0; scaling factor for distance of head or tail label from node
-        'labelfloat', # default: false; lessen constraints on edge label placement
-        'labelfontcolor', # default: black; type face color for head and tail labels
-        'labelfontname', # default: Times-Roman; font family for head and tail labels
-        'labelfontsize', # default: 14 point size for head and tail labels
-        'layer', # default: overlay range; all, id or id:id
-        'lhead', # name of cluster to use as head of edge
-        'ltail', # name of cluster to use as tail of edge
-        'minlen', # default: 1 minimum rank distance between head and tail
-        'samehead', # tag for head node; edge heads with the same tag are merged onto the same port
-        'sametail', # tag for tail node; edge tails with the same tag are merged onto the same port
-        'style', # graphics options, e.g. bold, dotted, filled; cf. Section 2.3
-        'taillabel', # label placed near tail of edge
-        'tailport', # n,ne,e,se,s,sw,w,nw
-        'tailURL', # URL attached to tail label if output format is ismap
-        'weight', # default: 1; integer cost of stretching an edge
-
-        # maintained for backward compatibility or rdot internal
-        'id'
-    ]
+      'arrowhead', # default: normal; style of arrowhead at head end
+      'arrowsize', # default: 1.0; scaling factor for arrowheads
+      'arrowtail', # default: normal; style of arrowhead at tail end
+      'color', # default: black; edge stroke color
+      'colorscheme', # default: X11; scheme for interpreting color names
+      'comment', # any string (format-dependent)
+      'constraint', # default: true use edge to affect node ranking
+      'decorate', # if set, draws a line connecting labels with their edges
+      'dir', # default: forward; forward, back, both, or none
+      'edgeURL', # URL attached to non-label part of edge
+      'edgehref', # synonym for edgeURL
+      'edgetarget', # if URL is set, determines browser window for URL
+      'edgetooltip', # default: label; tooltip annotation for non-label part of edge
+      'fontcolor', # default: black type face color
+      'fontname', # default: Times-Roman; font family
+      'fontsize', # default: 14; point size of label
+      'headclip', # default: true; if false, edge is not clipped to head node boundary
+      'headhref', # synonym for headURL
+      'headlabel', # default: label; placed near head of edge
+      'headport', # n,ne,e,se,s,sw,w,nw
+      'headtarget', # if headURL is set, determines browser window for URL
+      'headtooltip', # default: label; tooltip annotation near head of edge
+      'headURL', # URL attached to head label if output format is ismap
+      'href', # alias for URL
+      'id', # any string (user-defined output object tags)
+      'label', # edge label
+      'labelangle', # default: -25.0; angle in degrees which head or tail label is rotated off edge
+      'labeldistance', # default: 1.0; scaling factor for distance of head or tail label from node
+      'labelfloat', # default: false; lessen constraints on edge label placement
+      'labelfontcolor', # default: black; type face color for head and tail labels
+      'labelfontname', # default: Times-Roman; font family for head and tail labels
+      'labelfontsize', # default: 14 point size for head and tail labels
+      'labelhref', # synonym for labelURL
+      'labelURL', # URL for label, overrides edge URL
+      'labeltarget', # if URL or labelURL is set, determines browser window for URL
+      'labeltooltip', # default: label; tooltip annotation near label
+      'layer', # default: overlay range; all, id or id:id
+      'lhead', # name of cluster to use as head of edge
+      'ltail', # name of cluster to use as tail of edge
+      'minlen', # default: 1 minimum rank distance between head and tail
+      'penwidth', # default: 1.0; width of pen for drawing boundaries, in points
+      'samehead', # tag for head node; edge heads with the same tag are merged onto the same port
+      'sametail', # tag for tail node; edge tails with the same tag are merged onto the same port
+      'style', # graphics options, e.g. bold, dotted, filled; cf. Section 2.3
+      'weight', # default: 1; integer cost of stretching an edge
+      'tailclip', # default: true; if false, edge is not clipped to tail node boundary
+      'tailhref', # synonym for tailURL
+      'taillabel', # label placed near tail of edge
+      'tailport', # n,ne,e,se,s,sw,w,nw
+      'tailtarget', # if tailURL is set, determines browser window for URL
+      'tailtooltip', # default: label; tooltip annotation near tail of edge
+      'tailURL', # URL attached to tail label if output format is ismap
+      'target', # if URL is set, determines browser window for URL
+      'tooltip' # default: label; tooltip annotation for edge
+    ].freeze
+
+    # maintained for backward compatibility or rdot internal
+    EDGE_OPTS_LGCY = [].freeze
 
     # options for graph declaration
-
     GRAPH_OPTS = [
-        'bgcolor', # background color for drawing, plus initial fill color
-        'center', # default: false; center draing on page
-        'clusterrank', # default: local; may be "global" or "none"
-        'color', # default: black; for clusters, outline color, and fill color if
-                 # fillcolor not defined
-        'comment', # any string (format-dependent)
-        'compound', # default: false; allow edges between clusters
-        'concentrate', # default: false; enables edge concentrators
-        'fillcolor', # default: black; cluster fill color
-        'fontcolor', # default: black; type face color
-        'fontname', # default: Times-Roman; font family
-        'fontpath', # list of directories to search for fonts
-        'fontsize', # default: 14; point size of label
-        'label', # any string
-        'labeljust', # default: centered; "l" and "r" for left- and right-justified
-                     # cluster labels, respectively
-        'labelloc', # default: top; "t" and "b" for top- and bottom-justified
-                    # cluster labels, respectively
-        'layers', # id:id:id...
-        'margin', # default: .5; margin included in page, inches
-        'mclimit', # default: 1.0; scale factor for mincross iterations
-        'nodesep', # default: .25; separation between nodes, in inches.
-        'nslimit', # if set to "f", bounds network simplex iterations by
-                   # (f)(number of nodes) when setting x-coordinates
-        'nslimit1', # if set to "f", bounds network simplex iterations by
-                    # (f)(number of nodes) when ranking nodes
-        'ordering', # if "out" out edge order is preserved
-        'orientation', # default: portrait; if "rotate" is not used and the value is
-                       # "landscape", use landscape orientation
-        'page', # unit of pagination, e.g. "8.5,11"
-        'rank', # "same", "min", "max", "source", or "sink"
-        'rankdir', # default: TB; "LR" (left to right) or "TB" (top to bottom)
-        'ranksep', # default: .75; separation between ranks, in inches.
-        'ratio', # approximate aspect ratio desired, "fill" or "auto"
-        'samplepoints', # default: 8; number of points used to represent ellipses
-                        # and circles on output
-        'searchsize', # default: 30; maximum edges with negative cut values to check
-                      # when looking for a minimum one during network simplex
-        'size', # maximum drawing size, in inches
-        'style', # graphics options, e.g. "filled" for clusters
-        'URL', # URL associated with graph (format-dependent)
-
-        # maintained for backward compatibility or rdot internal
-        'layerseq'
-    ]
+      'aspect', # controls aspect ratio adjustment
+      'bgcolor', # background color for drawing, plus initial fill color
+      'center', # default: false; center draing on page
+      'clusterrank', # default: local; may be "global" or "none"
+      'color', # default: black; for clusters, outline color, and fill color if
+               # fillcolor not defined
+      'colorscheme', # default: X11; scheme for interpreting color names
+      'comment', # any string (format-dependent)
+      'compound', # default: false; allow edges between clusters
+      'concentrate', # default: false; enables edge concentrators
+      'dpi', # default: 96; dots per inch for image output
+      'fillcolor', # default: black; cluster fill color
+      'fontcolor', # default: black; type face color
+      'fontname', # default: Times-Roman; font family
+      'fontnames', # svg, ps, gd (SVG only)
+      'fontpath', # list of directories to search for fonts
+      'fontsize', # default: 14; point size of label
+      'id', # any string (user-defined output object tags)
+      'label', # any string
+      'labeljust', # default: centered; "l" and "r" for left- and right-justified
+                   # cluster labels, respectively
+      'labelloc', # default: top; "t" and "b" for top- and bottom-justified
+                  # cluster labels, respectively
+      'landscape', # if true, means orientation=landscape
+      'layers', # id:id:id...
+      'layersep', # default: : ; specifies separator character to split layers'
+      'margin', # default: .5; margin included in page, inches
+      'mclimit', # default: 1.0; scale factor for mincross iterations
+      'nodesep', # default: .25; separation between nodes, in inches.
+      'nojustify', # default: false; if true, justify to label, not graph
+      'nslimit', # if set to "f", bounds network simplex iterations by
+                 # (f)(number of nodes) when setting x-coordinates
+      'nslimit1', # if set to "f", bounds network simplex iterations by
+                  # (f)(number of nodes) when ranking nodes
+      'ordering', # if "out" out edge order is preserved
+      'orientation', # default: portrait; if "rotate" is not used and the value is
+                     # "landscape", use landscape orientation
+      'outputorder', # default: breadthfirst; or nodesfirst, edgesfirst
+      'page', # unit of pagination, e.g. "8.5,11"
+      'pagedir', # default: BL; traversal order of pages
+      'pencolor', # default: black; color for drawing cluster boundaries
+      'penwidth', # default: 1.0; width of pen for drawing boundaries, in points
+      'peripheries', # default: 1; shape-dependent number of node boundaries
+      'rank', # "same", "min", "max", "source", or "sink"
+      'rankdir', # default: TB; "LR" (left to right) or "TB" (top to bottom)
+      'ranksep', # default: .75; separation between ranks, in inches.
+      'ratio', # approximate aspect ratio desired, "fill" or "auto"
+      'remincross', # default: true; whether to run edge crossing minimization
+                    # a second time when there are multiple clusters
+      'rotate', # If 90, set orientation to landscape
+      'samplepoints', # default: 8; number of points used to represent ellipses
+                      # and circles on output
+      'searchsize', # default: 30; maximum edges with negative cut values to check
+                    # when looking for a minimum one during network simplex
+      'size', # maximum drawing size, in inches
+      'splines', # draw edges as splines, polylines, lines
+      'style', # graphics options, e.g. "filled" for clusters
+      'stylesheet', # pathname or URL to XML style sheet for SVG
+      'target', # if URL is set, determines browser window for URL
+      'tooltip', # default: label; tooltip annotation for cluster
+      'truecolor', # if set, force 24 bit or indexed color in image output
+      'viewport', # clipping window on output
+      'URL', # URL associated with graph (format-dependent)
+    ].freeze
+
+    # maintained for backward compatibility or rdot internal
+    GRAPH_OPTS_LGCY = [
+      'layerseq'
+    ].freeze
 
     # Ancestor of Edge, Node, and Graph.
     #
@@ -179,16 +233,15 @@ module RGL
         # Return a quoted version of the label otherwise.
         '"' + label.split(/(\\n|\\r|\\l)/).collect do |part|
           case part
-            when "\\n", "\\r", "\\l"
-              part
-            else
-              part.gsub('\\', '\\\\\\\\').gsub('"', '\\\\"').gsub("\n", '\\n')
+          when "\\n", "\\r", "\\l"
+            part
+          else
+            part.gsub('\\', '\\\\\\\\').gsub('"', '\\\\"').gsub("\n", '\\n')
           end
         end.join + '"'
       end
     end
 
-
     # Ports are used when a Node instance has its `shape' option set to
     # _record_ or _Mrecord_. Ports can be nested.
     #
@@ -244,7 +297,7 @@ module RGL
       # option which, if specified, must be an Enumerable containing a list of
       # ports.
       #
-      def initialize(params = {}, option_list = NODE_OPTS)
+      def initialize(params = {}, option_list = NODE_OPTS+NODE_OPTS_LGCY)
         super(params, option_list)
         @ports = params['ports'] ? params['ports'] : []
       end
@@ -287,11 +340,10 @@ module RGL
           leader + quote_ID(@name) unless @name.nil?
         else
           leader + (@name.nil? ? '' : quote_ID(@name) + " ") + "[\n" +
-              stringified_options + "\n" +
-              leader + "]"
+          stringified_options + "\n" +
+          leader + "]"
         end
       end
-
     end # class Node
 
     # A graph representation. Whether or not it is rendered as directed or
@@ -306,7 +358,7 @@ module RGL
       # option which, if specified, must be an Enumerable containing a list of
       # nodes, edges, and/or subgraphs.
       #
-      def initialize(params = {}, option_list = GRAPH_OPTS)
+      def initialize(params = {}, option_list = GRAPH_OPTS+GRAPH_OPTS_LGCY)
         super(params, option_list)
         @elements   = params['elements'] ? params['elements'] : []
         @dot_string = 'graph'
@@ -368,9 +420,8 @@ module RGL
         end.join("\n\n")
 
         hdr + (options.empty? ? '' : options + "\n\n") +
-            (elements.empty? ? '' : elements + "\n") + leader + "}"
+        (elements.empty? ? '' : elements + "\n") + leader + "}"
       end
-
     end # class Graph
 
     # A digraph is a directed graph representation which is the same as a Graph
@@ -385,7 +436,7 @@ module RGL
       # option which, if specified, must be an Enumerable containing a list of
       # nodes, edges, and/or subgraphs.
       #
-      def initialize(params = {}, option_list = GRAPH_OPTS)
+      def initialize(params = {}, option_list = GRAPH_OPTS+GRAPH_OPTS_LGCY)
         super(params, option_list)
         @dot_string = 'digraph'
       end
@@ -404,7 +455,7 @@ module RGL
       # option which, if specified, must be an Enumerable containing a list of
       # nodes, edges, and/or subgraphs.
       #
-      def initialize(params = {}, option_list = GRAPH_OPTS)
+      def initialize(params = {}, option_list = GRAPH_OPTS+GRAPH_OPTS_LGCY)
         super(params, option_list)
         @dot_string = 'subgraph'
       end
@@ -427,7 +478,7 @@ module RGL
       # edge options. The _option_list_ parameter restricts those options to the
       # list of valid names it contains.
       #
-      def initialize(params = {}, option_list = EDGE_OPTS)
+      def initialize(params = {}, option_list = EDGE_OPTS+EDGE_OPTS_LGCY)
         super(params, option_list)
         @from = params['from'] ? params['from'] : nil
         @to   = params['to'] ? params['to'] : nil
@@ -452,8 +503,8 @@ module RGL
           leader + quote_ID(f_s) + ' ' + edge_link + ' ' + quote_ID(t_s)
         else
           leader + quote_ID(f_s) + ' ' + edge_link + ' ' + quote_ID(t_s) + " [\n" +
-              stringified_options + "\n" +
-              leader + "]"
+          stringified_options + "\n" +
+          leader + "]"
         end
       end
 

data/lib/rgl/traversal.rb

@@ -117,7 +117,9 @@ module RGL
     #
     # @return [DirectedAdjacencyGraph] which represents a BFS search tree starting at _v_.
     def bfs_search_tree_from(v)
-      require 'rgl/adjacency'
+      unless defined?(DirectedAdjacencyGraph)
+        require 'rgl/adjacency'
+      end
       bfs  = bfs_iterator(v)
       tree = DirectedAdjacencyGraph.new
 

data/lib/rgl/version.rb

@@ -0,0 +1,3 @@
+module RGL
+  VERSION = "0.6.4".freeze
+end

data/test/dot_test.rb

@@ -13,7 +13,7 @@ class TestDot < Test::Unit::TestCase
     graph = RGL::DirectedAdjacencyGraph["a", "b"]
 
     begin
-      dot   = graph.to_dot_graph.to_s
+      dot  = graph.to_dot_graph.to_s
 
       first_vertex_id = "a"
       second_vertex_id = "b"
@@ -29,31 +29,29 @@ class TestDot < Test::Unit::TestCase
     end
   end
 
-  def test_to_dot_digraph_with_options
-      graph = RGL::DirectedAdjacencyGraph["a", "b"]
+  def test_dot_digraph_with_complicated_options
+    graph = RGL::DirectedAdjacencyGraph['a','b', 'c','d', 'a','c']
 
-    begin
-      edge_labels = {}
-      graph.each_edge do |b, e|
-        key              = "#{b}-#{e}"
-        edge_labels[key] = "#{b} to #{e}"
-      end
-      
-      vertex_fontcolors = {'a' => 'green', 'b' => 'blue'}
-      vertex_fontcolor_setting = Proc.new{|v| vertex_fontcolors[v]}
-      vertex_settings          = {'fontcolor' => vertex_fontcolor_setting, 'fontsize' => 12}
-      
-      edge_label_setting = Proc.new{|b, e| edge_labels["#{b}-#{e}"]}
-      edge_settings      = {'color' => 'red', 'label' => edge_label_setting}
-      dot_options        = {'edge' => edge_settings,'vertex' => vertex_settings}
-      dot                = graph.to_dot_graph(dot_options).to_s
+    graph.set_vertex_options('a', label: 'This is A', shape: 'box3d', fontcolor: 'green', fontsize: 16)
+    graph.set_vertex_options('b', label: 'This is B', shape: 'tab', fontcolor: 'red', fontsize: 14)
+    graph.set_vertex_options('c', shape: 'tab', fontcolor: 'blue')
 
-      assert_match(dot, /a \[\n\s*fontcolor = green,\n\s*fontsize = 12,\n\s*label = a\n\s*/)
-      assert_match(dot, /b \[\n\s*fontcolor = blue,\n\s*fontsize = 12,\n\s*label = b\n\s*/)
-      assert_match(dot, /a -> b \[\n\s*color = red,\n\s*fontsize = 8,\n\s*label = \"a to b\"\n/)
-    rescue
-      puts "Graphviz not installed?"
-    end
+    graph.set_edge_options('a', 'b', label: 'NotCapitalEdge', style: 'dotted', dir: 'back', color: 'magenta')
+    graph.set_edge_options('a', 'c', weight: 5, color: 'blue')
+
+    graph_options = {
+      "rankdir"  => "LR",
+      "labelloc" => "t",
+      "label"    => "Graph\n (generated #{Time.now.utc})"
+    }
+
+    dot = graph.to_dot_graph(graph_options).to_s
+
+    assert_match(dot, /labelloc = t\n\s*/)
+    assert_match(dot, /rankdir = LR\n\s*/)
+    assert_match(dot, /a \[\n\s*fontcolor = green,\n\s*fontsize = 16,\n\s*shape = box3d,\n\s*label = "This is A"\n\s*/)
+    assert_match(dot, /b \[\n\s*fontcolor = red,\n\s*fontsize = 14,\n\s*shape = tab,\n\s*label = "This is B"\n\s*/)
+    assert_match(dot, /a -> b \[\n\s*color = magenta,\n\s*dir = back,\n\s*fontsize = 8,\n\s*label = NotCapitalEdge,\n\s*style = dotted\n\s*/)
   end
 
   def test_to_dot_graph
@@ -65,10 +63,6 @@ class TestDot < Test::Unit::TestCase
     def graph.vertex_id(v)
       "id-"+v.to_s
     end
-    begin
-      graph.write_to_graphic_file
-    rescue
-      puts "Graphviz not installed?"
-    end
+    graph.write_to_graphic_file
   end
 end

data/test/traversal_bfs_require.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+
+# Do not require rgl/adjacency !
+require 'rgl/traversal'
+require 'rgl/implicit'
+
+include RGL
+
+# Cyclic graph with _n_ vertices. Need a concrete graph, that is not an AdjacencyGraph
+def cycle(n)
+  RGL::ImplicitGraph.new { |g|
+    g.vertex_iterator { |b| 0.upto(n - 1, &b) }
+    g.adjacent_iterator { |x, b| b.call((x + 1) % n) }
+    g.directed = true
+  }
+end
+
+class TestAdjacencyNotRequired < Test::Unit::TestCase
+
+  def setup
+    @dg = cycle(4)
+  end
+
+  def test_bfs_search_tree
+    # bfs_search_tree_from requires rgl/adjacency if not yet loaded.
+    assert_equal("(1-2)(2-3)(3-0)", @dg.bfs_search_tree_from(1).edges.sort.join)
+  end
+
+end