rgl 0.6.2 → 0.6.4

data/README.md

@@ -227,6 +227,41 @@ This graph shows all loaded RGL modules:
 Look for more in
 [examples](https://github.com/monora/rgl/tree/master/examples) directory.
 
+## (Optional) Configuring Graphviz DOT output options
+
+The default graph will use standard DOT output visuals.
+
+If you wish to configure the styling of the diagram, module {RGL::DOT} adds the methods {RGL::Graph#set_edge_options} and {RGL::Graph#set_vertex_options} for this purpose. You can use any options from the {RGL::DOT::NODE_OPTS} and {RGL::DOT::EDGE_OPTS} constants in {RGL::DOT}. Use the exact option name as an argument in your method call.
+
+You can also configure the overall appearance of the graph by passing a hash of options from {RGL::DOT::GRAPH_OPTS} to the output method. The example below shows styling of vertices, edges and setting some basic graph options.
+
+The available options are described in the [GraphViz DOT Spec](https://www.graphviz.org/pdf/dotguide.pdf)
+
+![colored diagram](images/styled_graph.png "Colored DOT graph")
+
+```ruby
+require 'rgl/adjacency'
+require 'rgl/dot'
+
+graph = RGL::DirectedAdjacencyGraph['a','b', 'c','d', 'a','c']
+
+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')
+
+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})"
+}
+
+graph.write_to_graphic_file('png', 'graph', graph_options)
+
+```
+
 ## Credits
 
 Many thanks to Robert Feldt which also worked on a graph library
@@ -249,14 +284,28 @@ the module {RGL::DOT} which is used instead of Roberts module to visualize
 graphs.
 
 Jeremy Bopp, John Carter, Sascha Doerdelmann, Shawn Garbett, Andreas
-Schörk, Dan Čermák and Kirill Lashuk for contributing additions, test
+Schörk, Dan Čermák, Kirill Lashuk and Markus Napp for contributing additions, test
 cases and bugfixes.
 
-See also: https://github.com/monora/rgl/contributors
+See also the [list of contributers][5]
+
+## Links
+
+- See [CHANGELOG.md][1] for major/breaking updates, and [releases][2] for a
+  detailed version history.
+- To **contribute**, please read [CONTRIBUTING.md][4] first.
+- Please [open an issue][3] if anything is missing or unclear in this
+  documentation.
 
 ## Copying
 
-RGL is Copyright (c) 2002,2004,2005,2008,2013,2015,2019,2020,2022 by Horst
+RGL is Copyright (c) 2002,2004,2005,2008,2013,2015,2019,2020,2022,2023 by Horst
 Duchene. It is free software, and may be redistributed under the [Ruby
-license](https://en.wikipedia.org/wiki/Ruby_License) and terms specified in
+license](.LICENSE) and terms specified in
 the LICENSE file.
+
+[1] ./CHANGELOG.md
+[2] https://github.com/monora/rgl/releases
+[3] https://github.com/monora/rgl/issues/new
+[4] ./.github/CONTRIBUTING.md
+[5] https://github.com/monora/rgl/contributors

data/Rakefile

@@ -1,16 +1,12 @@
 # -*- ruby -*-
 
-require 'rubygems'
 require 'bundler/setup'
-
-require 'rubygems/package_task'
-
 require 'rake/testtask'
 require 'rake/clean'
 require 'yard'
 
 $:.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'rgl/base' # require base module to get RGL_VERSION
+require 'rgl/version' # defines RGL::VERSION
 
 SOURCES = FileList['lib/**/*.rb']
 
@@ -26,13 +22,20 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+# Test bfs_search_tree_from in isolation, to ensure that adjacency is not loaded by other tests.
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/traversal_bfs_require.rb'
+  t.verbose = true
+end
+
 # Git tagging
 
 desc 'Commit all changes as a new version commit. Tag the commit with v<version> tag'
 task :tag do
-  puts "Committing and tagging version #{RGL_VERSION}"
-  `git commit -am 'Version #{RGL_VERSION}'`
-  `git tag 'v#{RGL_VERSION}'`
+  puts "Committing and tagging version #{RGL::VERSION}"
+  `git commit -am 'Version #{RGL::VERSION}'`
+  `git tag 'v#{RGL::VERSION}'`
 end
 
 YARD::Rake::YardocTask.new
@@ -86,30 +89,3 @@ task :lines do
   end
   show_line('TOTAL', total_lines, total_code)
 end
-
-# simple rake task to output a changelog between two commits, tags ...
-# output is formatted simply, commits are grouped under each author name
-#
-desc 'generate changelog with nice clean output'
-task :changelog, :since_c, :until_c do |t, args|
-  since_c = args[:since_c] || `git tag | tail -1`.chomp
-  until_c = args[:until_c]
-  cmd = `git log --pretty='format:%ci::%an <%ae>::%s::%H' #{since_c}..#{until_c}`
-
-  entries = Hash.new
-  changelog_content = String.new
-
-  cmd.split("\n").each do |entry|
-    _, author, subject, hash = entry.chomp.split('::')
-    entries[author] = Array.new unless entries[author]
-    entries[author] << "#{subject} (#{hash[0..5]})" unless subject =~ /Merge/
-  end
-
-  # generate clean output
-  entries.keys.each do |author|
-    changelog_content += author + "\n"
-    entries[author].reverse.each { |entry| changelog_content += " * #{entry}\n" }
-  end
-
-  puts changelog_content
-end

data/lib/rgl/base.rb

@@ -1,8 +1,5 @@
 # base.rb
 
-# version information
-RGL_VERSION = "0.6.2"
-
 # Module {RGL} defines the namespace for all modules and classes of the graph
 # library. The main module is {Graph} which defines the abstract behavior of
 # all graphs in the library. Other important modules or classes are:

data/lib/rgl/dot.rb

@@ -10,9 +10,7 @@
 require 'rgl/rdot'
 
 module RGL
-
   module Graph
-
     # Returns a label for vertex v. Default is v.to_s
     def vertex_label(v)
       v.to_s
@@ -22,6 +20,27 @@ module RGL
       v
     end
 
+    # Set the configuration values for the given vertex
+    def set_vertex_options(vertex, **options)
+      @vertex_options ||= {}
+      @vertex_options[vertex] ||= {}
+
+      RGL::DOT::NODE_OPTS.each do |opt|
+        @vertex_options[vertex][:"#{opt}"] = options[:"#{opt}"] if options.key?(:"#{opt}")
+      end
+    end
+
+    # Set the configuration values for the given edge
+    def set_edge_options(u, v, **options)
+      edge = edge_class.new(u, v)
+      @edge_options ||= {}
+      @edge_options[edge] ||= {}
+
+      RGL::DOT::EDGE_OPTS.each do |opt|
+        @edge_options[edge][:"#{opt}"] = options[:"#{opt}"] if options.key?(:"#{opt}")
+      end
+    end
+
     # Return a {DOT::Digraph} for directed graphs or a {DOT::Graph} for an
     # undirected {Graph}. _params_ can contain any graph property specified in
     # rdot.rb.
@@ -31,30 +50,43 @@ module RGL
       fontsize       = params['fontsize'] ? params['fontsize'] : '8'
       graph          = (directed? ? DOT::Digraph : DOT::Graph).new(params)
       edge_class     = directed? ? DOT::DirectedEdge : DOT::Edge
-      vertex_options = params['vertex'] || {}
-      edge_options   = params['edge'] || {}
 
       each_vertex do |v|
-        default_vertex_options =  {
+        default_vertex_options = {
           'name'     => vertex_id(v),
           'fontsize' => fontsize,
           'label'    => vertex_label(v)
         }
-        each_vertex_options = default_vertex_options.merge(vertex_options)
-        vertex_options.each{|option, val| each_vertex_options[option] = val.call(v) if val.is_a?(Proc)}
+        each_vertex_options = default_vertex_options
+
+        if @vertex_options && @vertex_options[v]
+          RGL::DOT::NODE_OPTS.each do |opt|
+            if @vertex_options[v].key?(:"#{opt}")
+              each_vertex_options["#{opt}"] = @vertex_options[v].fetch(:"#{opt}")
+            end
+          end
+        end
         graph << DOT::Node.new(each_vertex_options)
       end
 
-      each_edge do |u, v|
+      edges.each do |edge|
         default_edge_options = {
-          'from'     => vertex_id(u),
-          'to'       => vertex_id(v),
+          'from'     => edge.source,
+          'to'       => edge.target,
           'fontsize' => fontsize
         }
-        each_edge_options = default_edge_options.merge(edge_options)
-        edge_options.each{|option, val| each_edge_options[option] = val.call(u, v) if val.is_a?(Proc)}
+
+        each_edge_options = default_edge_options
+
+        if @edge_options && @edge_options[edge]
+          RGL::DOT::EDGE_OPTS.each do |opt|
+            if @edge_options[edge].key?(:"#{opt}")
+              each_edge_options["#{opt}"] = @edge_options[edge].fetch(:"#{opt}")
+            end
+          end
+        end
         graph << edge_class.new(each_edge_options)
-      end
+        end
 
       graph
     end
@@ -81,7 +113,7 @@ module RGL
     # Use dot[https://www.graphviz.org] to create a graphical representation of
     # the graph. Returns the filename of the graphics file.
     #
-    def write_to_graphic_file(fmt='png', dotfile="graph", options={})
+    def write_to_graphic_file(fmt = 'png', dotfile = "graph", options = {})
       src = dotfile + ".dot"
       dot = dotfile + "." + fmt