rgl 0.5.4 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8756a57ea9c8151eadaa993efee20e2d41ddba102bee5d4106e00c94318d328e
-  data.tar.gz: c2400afcdcc2d5c8f22ed0da9e48cd843629f57747335265087a7e3e892d55d0
+  metadata.gz: 43739f63914a8070716c45a94f95c058b75efee0f4cd478a30d1cdc0e45e30c0
+  data.tar.gz: 44d66025f8ca816c618eb12ac4a7fee1fa315c4312af698909e87caa0bdb48ad
 SHA512:
-  metadata.gz: 83cebc1a0570644f5dc1a48c16a5a38e11d73b9baf095f2627ef91676139c473f8027b608748dfe5d7df1926b17759e07dab85722fa0ced05b1656880fade8da
-  data.tar.gz: ad2d7ee636584a077313323efacf8c274f25643cc78e85b4f4f0e01dfbbbb522e00b7e50c295ad1e2ff395300c8f4f0551e00bb7b2a514cc179f01b9d327487e
+  metadata.gz: e910d7b6fdaaab9873f5daac67009eab91681789372e00e9d0bdbbfa09782f4b67763ce09634245cf0c07325847c5ec90695323dec65aaa6d940d775a89447a8
+  data.tar.gz: bfcd42c97cc6361e58145aa3bf5f97c89d3e9b9d1a290f67a4ffb52e0829f9f0aff06c4d17a4d0ed1f83997e0917a1fbd11cdf340a6967fc7e8cfa3ad6dc6118

data/ChangeLog

@@ -1,3 +1,31 @@
+2022-06 Release 0.5.8
+
+Horst Duchene
+ * switch to github actions (56030d)
+
+2020-12 Release 0.5.7
+
+Horst Duchene
+ * Fully automate dev setup with Gitpod (41dd00)
+ * Add Dockerfile to install graphviz (2bd738)
+ * Examples do not call dotty (6bba96)
+ * Add ruby license file (a21aa5)
+ujihisa <ujihisa@users.noreply.github.com>
+ * Test against Ruby 2.6 and 2.7 as well (50ac7c)
+ * Fix dead links (9184f3)
+Harry Lascelles <hlascelles@users.noreply.github.com>
+ * Update .travis.yml (45b9a2)
+ * Make the links more explicit (95dc3b)
+Harry Lascelles
+ * Add explicit license to gemspec (de3647)
+
+2019-01 Release 0.5.6
+
+Artemy Kirienko
+ * PR #42 Add method Graph#path?(u, v) to check if a path exists between two vertices
+Horst Duchene
+ * Fix #47 set_to_begin for graph iterator (881aa8)
+
 2019-01 Release 0.5.4
 
 Lia Skalkos

data/README.md

@@ -1,4 +1,4 @@
-# Ruby Graph Library (RGL) [<img src="https://secure.travis-ci.org/monora/rgl.png?branch=master" alt="Build Status" />](https://travis-ci.org/monora/rgl) [<img src="https://codeclimate.com/github/monora/rgl/badges/coverage.svg" />](https://codeclimate.com/github/monora/rgl/coverage) [<img src="https://badge.fury.io/rb/rgl.svg" alt="Version"/>](https://badge.fury.io/rb/rgl)
+# Ruby Graph Library (RGL) [![test](https://github.com/monora/rgl/actions/workflows/ruby.yml/badge.svg)](https://github.com/monora/rgl/actions/workflows/ruby.yml) [<img src="https://codeclimate.com/github/monora/rgl/badges/coverage.svg" />](https://codeclimate.com/github/monora/rgl/coverage) [<img src="https://badge.fury.io/rb/rgl.svg" alt="Version"/>](https://badge.fury.io/rb/rgl) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/monora/rgl)
 
 RGL is a framework for graph data structures and algorithms.
 
@@ -123,6 +123,8 @@ After that you can run the tests:
 
 ## Example irb session with RGL
 
+    % irb -Ilib
+
     irb> require 'rgl/adjacency'
     irb> dg=RGL::DirectedAdjacencyGraph[1,2 ,2,3 ,2,4, 4,5, 6,4, 1,6]
     # Use DOT to visualize this graph:
@@ -171,6 +173,12 @@ Add inverse edge (4-2) to directed graph:
     irb> dg.remove_edge 4,2
     true
 
+Check whether a path exists between vertices 1 and 5
+
+    irb> require 'rgl/path'
+    irb> dg.path?(1, 5)
+    true
+
 *Topological sort* is implemented as an iterator:
 
     require 'rgl/topsort'
@@ -253,6 +261,7 @@ See also http://github.com/monora/rgl/contributors.
 
 ## Copying
 
-RGL is Copyright (c) 2002,2004,2005,2008,2013,2015,2019 by Horst Duchene. It is
-free software, and may be redistributed under the terms specified in the
-README file of the Ruby distribution.
+RGL is Copyright (c) 2002,2004,2005,2008,2013,2015,2019,2020 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
+the LICENSE file.

data/Rakefile

@@ -15,7 +15,7 @@ require 'rgl/base' # require base module to get RGL_VERSION
 SOURCES = FileList['lib/**/*.rb']
 
 # The default task is run if rake is given no explicit arguments.
-desc "Default Task"
+desc 'Default Task'
 task :default => :test
 
 # Define a test task.
@@ -28,7 +28,7 @@ end
 
 # Git tagging
 
-desc "Commit all changes as a new version commit. Tag the commit with v<version> tag"
+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}'`
@@ -44,13 +44,13 @@ Bundler::GemHelper.install_tasks
 # TAGS ---------------------------------------------------------------
 
 file 'tags' => SOURCES do
-  print "Running ctags..."
-  sh %{ctags #{SOURCES.join(' ')}}             # vi tags
-  puts "done."
+  print 'Running ctags...'
+  sh %(ctags #{SOURCES.join(' ')}) # vi tags
+  puts 'done.'
 end
 
 file 'TAGS' => SOURCES do
-  sh %{etags #{SOURCES.join(' ')}}          # emacs TAGS
+  sh %(etags #{SOURCES.join(' ')}) # emacs TAGS
 end
 
 # Misc tasks =========================================================
@@ -73,34 +73,34 @@ def show_line(msg, lines, loc)
   printf "%6s %6s   %s\n", lines.to_s, loc.to_s, msg
 end
 
-desc "Count lines in the main files"
+desc 'Count lines in the main files'
 task :lines do
   total_lines = 0
   total_code = 0
-  show_line("File Name", "LINES", "LOC")
+  show_line('File Name', 'LINES', 'LOC')
   SOURCES.each do |fn|
     lines, codelines = count_lines(fn)
     show_line(fn, lines, codelines)
     total_lines += lines
-    total_code  += codelines
+    total_code += codelines
   end
-  show_line("TOTAL", total_lines, total_code)
+  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|
+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}`
+  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("::")
+    _, author, subject, hash = entry.chomp.split('::')
     entries[author] = Array.new unless entries[author]
     entries[author] << "#{subject} (#{hash[0..5]})" unless subject =~ /Merge/
   end

data/examples/examples.rb

@@ -77,7 +77,7 @@ def bfs_example(g = cycle(5), start = g.detect { |x| true })
 end
 
 # Would like to have GraphXML here
-def graph_from_dotfile (file)
+def graph_from_dotfile(file)
   g = RGL::AdjacencyGraph.new
   pattern = /\s*([^\"]+)[\"\s]*--[\"\s]*([^\"\[\;]+)/ # ugly but works
   IO.foreach(file) { |line|
@@ -94,21 +94,23 @@ def graph_from_dotfile (file)
   g
 end
 
-# ruby -Ilib -r examples/examples.rb -rrgl/dot -e'bfs_example(module_graph,RGL::AdjacencyGraph).dotty'
-
+# ruby -Ilib examples/examples.rb
 if $0 == __FILE__
   require 'rgl/dot'
 
   dg = RGL::DirectedAdjacencyGraph[1,2, 2,3, 2,4, 4,5, 6,4, 1,6]
-  dg.dotty
   dg.write_to_graphic_file
-  bfs_example(dg, 1).dotty
-  bfs_example(graph_from_dotfile('dot/unix.dot'), 'Interdata').dotty({ 'label' => 'Interdata Nachfolger', 'fontsize' => 12 })
 
+  # BFS tree from 1 of dg:
+  bfs_example(dg, 1).write_to_graphic_file('png', 'bfs_example')
+
+  # Unix history as a graph:
+  g = bfs_example(graph_from_dotfile('examples/unix.dot'), 'Interdata')
+  g.write_to_graphic_file('png', 'unix', { 'label' => 'Interdata Nachfolger', 'fontsize' => 12 })
+
+  # Modules included by AdjacencyGraph:
   g = module_graph
   tree = bfs_example(module_graph, RGL::AdjacencyGraph)
   g = g.vertices_filtered_by { |v| tree.has_vertex? v }
-  g.write_to_graphic_file
-  g.dotty
+  g.write_to_graphic_file('png', 'module_graph')
 end
-

data/examples/unix.dot

@@ -0,0 +1,53 @@
+/* courtesy Ian Darwin and Geoff Collyer, Softquad Inc. */
+digraph unix {
+size="6,6";
+	"5th Edition" -> "6th Edition";
+	"5th Edition" -> "PWB 1.0";
+	"6th Edition" -> "LSX";
+	"6th Edition" -> "1 BSD";
+	"6th Edition" -> "Mini Unix";
+	"6th Edition" -> "Wollongong";
+	"6th Edition" -> "Interdata";
+	"Interdata" -> "Unix/TS 3.0";
+	"Interdata" -> "PWB 2.0";
+	"Interdata" -> "7th Edition";
+	"7th Edition" -> "8th Edition";
+	"7th Edition" -> "32V";
+	"7th Edition" -> "V7M";
+	"7th Edition" -> "Ultrix-11";
+	"7th Edition" -> "Xenix";
+	"7th Edition" -> "UniPlus+";
+	"V7M" -> "Ultrix-11";
+	"8th Edition" -> "9th Edition";
+	"1 BSD" -> "2 BSD";
+	"2 BSD" -> "2.8 BSD";
+	"2.8 BSD" -> "Ultrix-11";
+	"2.8 BSD" -> "2.9 BSD";
+	"32V" -> "3 BSD";
+	"3 BSD" -> "4 BSD";
+	"4 BSD" -> "4.1 BSD";
+	"4.1 BSD" -> "4.2 BSD";
+	"4.1 BSD" -> "2.8 BSD";
+	"4.1 BSD" -> "8th Edition";
+	"4.2 BSD" -> "4.3 BSD";
+	"4.2 BSD" -> "Ultrix-32";
+	"PWB 1.0" -> "PWB 1.2";
+	"PWB 1.0" -> "USG 1.0";
+	"PWB 1.2" -> "PWB 2.0";
+	"USG 1.0" -> "CB Unix 1";
+	"USG 1.0" -> "USG 2.0";
+	"CB Unix 1" -> "CB Unix 2";
+	"CB Unix 2" -> "CB Unix 3";
+	"CB Unix 3" -> "Unix/TS++";
+	"CB Unix 3" -> "PDP-11 Sys V";
+	"USG 2.0" -> "USG 3.0";
+	"USG 3.0" -> "Unix/TS 3.0";
+	"PWB 2.0" -> "Unix/TS 3.0";
+	"Unix/TS 1.0" -> "Unix/TS 3.0";
+	"Unix/TS 3.0" -> "TS 4.0";
+	"Unix/TS++" -> "TS 4.0";
+	"CB Unix 3" -> "TS 4.0";
+	"TS 4.0" -> "System V.0";
+	"System V.0" -> "System V.2";
+	"System V.2" -> "System V.3";
+}

data/lib/rgl/base.rb

@@ -4,7 +4,7 @@
 # library. The main module is RGL::Graph which defines the abstract behavior of
 # all graphs in the library.
 
-RGL_VERSION = "0.5.4"
+RGL_VERSION = "0.5.8"
 
 module RGL
   class NotDirectedError < RuntimeError; end

data/lib/rgl/graphxml.rb

@@ -1,7 +1,7 @@
 # graphxml.rb
 #
 # This file contains minimal support for creating RGL graphs from the GraphML
-# format (see http://www.graphdrawing.org/graphml). The main purpose is to
+# format (see http://graphml.graphdrawing.org/). The main purpose is to
 # have a rich set of example graphs to have some more tests.
 #
 # See the examples directory, which contains a subdirectory _north_ with the
@@ -48,7 +48,7 @@ module RGL
     end # class MutableGraphParser
 
     # Initializes an RGL graph from a subset of the GraphML format given in
-    # +source+ (see http://www.graphdrawing.org/graphml).
+    # +source+ (see http://graphml.graphdrawing.org/).
     #
     def from_graphxml(source)
       listener = MutableGraphParser.new(self)

data/lib/rgl/path.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rgl/traversal'
+
+module RGL
+  module Graph
+    # Checks whether a path exists between _source_ and _target_ vertices
+    # in the graph.
+    #
+    def path?(source, target)
+      return false unless has_vertex?(source)
+
+      bfs_iterator = bfs_iterator(source)
+      bfs_iterator.include?(target)
+    end
+  end
+end

data/lib/rgl/rdot.rb

@@ -328,7 +328,7 @@ module RGL
       # :call-seq:
       #   graph << element -> graph
       #
-      def << (element)
+      def <<(element)
         @elements << element
         self
       end

data/lib/rgl/traversal.rb

@@ -58,9 +58,12 @@ module RGL
     # Reset the iterator to the initial state (i.e. at_beginning? == true).
     #
     def set_to_begin
+      # Reset color_map
+      @color_map = Hash.new(:WHITE)
       color_map[@start_vertex] = :GRAY
-      @waiting = [@start_vertex] # a queue
+      @waiting = [@start_vertex]           # a queue
       handle_tree_edge(nil, @start_vertex) # discovers start vertex
+      self
     end
 
     def basic_forward # :nodoc:

data/test/path_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+require 'rgl/adjacency'
+require 'rgl/path'
+
+class TestPath < Test::Unit::TestCase
+  include RGL
+
+  def setup
+    edges = [[1, 2], [2, 3], [2, 4], [4, 5], [6, 4], [1, 6]]
+    @directed_graph, @undirected_graph =
+      [DirectedAdjacencyGraph, AdjacencyGraph].map do |klass|
+        graph = klass.new
+        graph.add_edges(*edges)
+        graph
+      end
+  end
+
+  def test_path_for_directed_graph
+    assert(@directed_graph.path?(1, 5))
+  end
+
+  def test_path_for_undirected_graph
+    assert(@undirected_graph.path?(1, 5))
+  end
+
+  def test_inverse_path_for_directed_graph
+    assert_equal(@directed_graph.path?(3, 1), false)
+  end
+
+  def test_inverse_path_for_undirected_graph
+    assert(@undirected_graph.path?(3, 1))
+  end
+
+  def test_path_for_directed_graph_wrong_source
+    assert_equal(@directed_graph.path?(0, 1), false)
+  end
+
+  def test_path_for_undirected_graph_wrong_source
+    assert_equal(@undirected_graph.path?(0, 1), false)
+  end
+
+  def test_path_for_directed_graph_wrong_target
+    assert_equal(@directed_graph.path?(4, 0), false)
+  end
+
+  def test_path_for_undirected_graph_wrong_target
+    assert_equal(@undirected_graph.path?(4, 0), false)
+  end
+end

data/test/traversal_test.rb

@@ -218,4 +218,30 @@ END
     dg.depth_first_search(vis) { |x| }
     assert_equal("(1 (2 (3  3)(4 (5  5) 4) 2)(6  6) 1)(10 (11  11) 10)", a)
   end
+
+  def test_bfs_stream_protocol
+    it = @dg.bfs_iterator(1)
+    assert_true(it.at_beginning?)
+
+    it.set_to_end()
+    assert_true(it.at_end?)
+
+    it.set_to_begin()
+    assert_true(it.at_beginning?)
+
+    assert_equal(it.to_a(), [1, 2, 6, 3, 4, 5])
+  end
+
+  def test_dfs_stream_protocol
+    it = @dg.dfs_iterator(1)
+    assert_true(it.at_beginning?)
+
+    it.set_to_end()
+    assert_true(it.at_end?)
+
+    it.set_to_begin()
+    assert_true(it.at_beginning?)
+
+    assert_equal(it.to_a(), [1, 6, 4, 5, 2, 3])
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgl
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.8
 platform: ruby
 authors:
 - Horst Duchene
@@ -9,7 +9,7 @@ authors:
 autorequire: rgl/base
 bindir: bin
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stream
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: lazy_priority_queue
   requirement: !ruby/object:Gem::Requirement
@@ -39,6 +39,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +185,7 @@ files:
 - examples/north/g.14.9.graphml
 - examples/north2.rb
 - examples/rdep-rgl.rb
+- examples/unix.dot
 - lib/rgl/adjacency.rb
 - lib/rgl/base.rb
 - lib/rgl/bellman_ford.rb
@@ -183,6 +204,7 @@ files:
 - lib/rgl/graphxml.rb
 - lib/rgl/implicit.rb
 - lib/rgl/mutable.rb
+- lib/rgl/path.rb
 - lib/rgl/path_builder.rb
 - lib/rgl/prim.rb
 - lib/rgl/rdot.rb
@@ -205,6 +227,7 @@ files:
 - test/graph_test.rb
 - test/graph_xml_test.rb
 - test/implicit_test.rb
+- test/path_test.rb
 - test/prim_test.rb
 - test/rdot_test.rb
 - test/test_helper.rb
@@ -212,9 +235,10 @@ files:
 - test/traversal_test.rb
 - test/undirected_graph_test.rb
 homepage: https://github.com/monora/rgl
-licenses: []
+licenses:
+- ruby
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - RGL - Ruby Graph Library
@@ -234,8 +258,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Ruby Graph Library
 test_files: []