rgl 0.4.0 → 0.5.0

data/ChangeLog

@@ -1,15 +1,25 @@
-2008-08-28 01:36  javanthropus
-
-	* ChangeLog (tags: REL_0_4_0): pre-tag commit
-
-2008-08-28 01:36  javanthropus
-
-	* Rakefile (tags: REL_0_4_0): Update rdoc2rf task to use rsync and
-	  more generic remote path specification
+2014-12 Release 0.5.0
+
+This release mainly contains the contributions of Kirill, who added many algorithms to the library. Thank you Kirill!
+
+ * @matiaskorhonen: Fixes the image paths in the README (#14)
+ * @monora: Implicit graph example fails (#13)
+ * @KL-7: Implement Graph#bipartite_sets. (#12)
+ * @monora:  syntax error in dot file for undirected graph (#11)
+ * @KL-7: Edmonds-Karp algorithm for maximum flow (#10)
+ * @KL-7: Prim's algorithm for minimum spanning tree (#9)
+ * @carlosantoniodasilva: Run tests on Ruby 2.0 and remove deprecation warning (#8)
+ * @KL-7: Bellman-Ford shortest paths algorithm (#7)
+ * @KL-7: Minor improvements (asserts) for Dijkstra algorithm (#6)
+ * @KL-7: Add Dijkstra shortest path algorithm. (#5)
+ * @KL-7: Indentation and whitespaces clean up of examples (#4)
+ * @KL-7: Travis configuration and README updates (#3)
+ * @KL-7: Code clean up and configuration updates (#2)
+ * @aschoerk: Renamed test-directory, (includes Rakefile), fixed TestComponents (#1)
 
 2008-08-27 23:30  javanthropus
 
-	* lib/rgl/base.rb (tags: REL_0_4_0): Preparing for 0.4.0 release
+	* lib/rgl/base.rb: Preparing for 0.4.0 release
 
 2008-08-26 20:07  javanthropus
 
@@ -476,4 +486,3 @@
 2002-08-19 21:58  monora
 
 	* README (tags: V0_2): Added link to SF.
-

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/{README → README.rdoc}

@@ -1,4 +1,4 @@
-= Ruby Graph Library (RGL)
+= 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]
 
 RGL is a framework for graph data structures and algorithms.
 
@@ -39,39 +39,41 @@ genericity:
 * Vertex and Edge Property Multi-Parameterization
 
 The first is easily achieved in RGL using mixins, which of course is not as
-efficient than C++ templates (but much more readable :-). The second one is
-even more easily implemented using standard iterators with blocks or using the
-Stream[http://rgl.rubyforge.org/stream/files/README.html] module. The third one
-is no issue since Ruby is dynamically typed: Each object can be a graph
-vertex. There is no need for a vertex (or even edge type). In the current
-version of RGL properties of vertices are simply attached using hashes. At
-first there seems to be not much need for the graph property machinery.
+efficient than C++ templates (but much more readable :-). The second one is even
+more easily implemented using standard iterators with blocks or using the
+{http://www.rubydoc.info/github/monora/stream stream module}. The third one is
+no issue since Ruby is dynamically typed: Each object can be a graph vertex.
+There is no need for a vertex (or even edge type). In the current version of RGL
+properties of vertices are simply attached using hashes. At first there seems to
+be not much need for the graph property machinery.
 
 === Algorithms
 
-The first version of RGL only contains a core set of algorithm patterns:
+RGL current contains a core set of algorithm patterns:
 
-* Breadth First Search (RGL::BFSIterator)
-* Depth First Search (RGL::DFSIterator)
+* Breadth First Search {RGL::BFSIterator}
+* Depth First Search {RGL::DFSIterator}
 
 The algorithm patterns by themselves do not compute any meaningful quantities
 over graphs, they are merely building blocks for constructing graph
 algorithms. The graph algorithms in RGL currently include:
 
-* Topological Sort (RGL::TopsortIterator)
-* Connected Components (RGL::Graph#each_connected_component)
-* Strongly Connected Components (RGL::Graph#strongly_connected_components)
-* Transitive Closure (RGL::Graph#transitive_closure)
+* Topological Sort {RGL::TopsortIterator}
+* Connected Components {RGL::Graph#each_connected_component}
+* Strongly Connected Components {RGL::Graph#strongly_connected_components}
+* Transitive Closure {RGL::Graph#transitive_closure}
+* Dijkstras Shortest Path Algorithm {RGL::DijkstraAlgorithm}
+* Bellman Ford Algorithm {RGL::BellmanFordAlgorithm}
 
 === Data Structures
 
 RGL currently provides two graph classes that implement a generalized adjacency
 list and an edge list adaptor.
 
-* RGL::AdjacencyGraph
-* RGL::ImplicitGraph
+* {RGL::AdjacencyGraph}
+* {RGL::ImplicitGraph}
 
-The AdjacencyGraph class is the general purpose *swiss army knife* of graph
+The AdjacencyGraph class is the general purpose _swiss army knife_ of graph
 classes. It is highly parameterized so that it can be optimized for different
 situations: the graph is directed or undirected, allow or disallow parallel
 edges, efficient access to just the out-edges, fast vertex insertion and removal
@@ -87,75 +89,44 @@ http://www.boost.org/libs/graph/doc/graph_concepts.html.
 
 == Installation
 
-RGL is depended on the
-stream[http://rgl.rubyforge.org/stream/files/README.html] library which can
-also be downloaded from http://rubyforge.org/frs/?group_id=110. If you use gem
-to install RGL the stream library will be installed as a prerequisite.
-
-=== GEM Installation
-
-Download the GEM file and install it with ..
-
-  % gem install rgl-VERSION.gem
-
-or directly with 
-
   % gem install rgl
 
-Use the correct version number for VERSION (e.g. 0.2.x).  You may need root
-privileges to install.
-
-=== Running tests
+or download the latest sources from the git repository http://github.com/monora/rgl.
 
-RGL comes with a Rakefile which automatically runs the tests. Goto the
-installation directory and start rake:
+== Running tests
 
- % gem env
- Rubygems Environment:
-  - VERSION: 0.9.0 (0.9.0)
-  - INSTALLATION DIRECTORY: /usr/lib/ruby/gems/1.8
-  - GEM PATH:
-     - /usr/lib/ruby/gems/1.8
-  - REMOTE SOURCES:
-     - http://gems.rubyforge.org
+Checkout RGL git repository and go to the project directory. First, install RGL
+dependencies with bundler:
 
- % cd /usr/lib/ruby/gems/1.8/gems/rgl-0.3.0/
- % rake
- (in /usr/lib/ruby/gems/1.8/gems/rgl-0.3.0)
- /usr/bin/ruby1.8 -Ilib:tests "/usr/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake/rake_test_loader.rb" "tests/TestTransitiveClosure.rb" "tests/TestComponents.rb" "tests/TestCycles.rb" "tests/TestDirectedGraph.rb" "tests/TestEdge.rb" "tests/TestGraph.rb" "tests/TestGraphXML.rb" "tests/TestImplicit.rb" "tests/TestUnDirectedGraph.rb" "tests/TestTraversal.rb" "tests/TestDot.rb" "tests/TestRdot.rb" 
- Loaded suite /usr/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake/rake_test_loader
- Started
- ......................................................................................................................................................
- Finished in 0.750958 seconds.
+ % bundle install
 
- 86 tests, 625 assertions, 0 failures, 0 errors
- 
-=== Code coverage
+After that you can run the tests:
 
-Running rcov[http://eigenclass.org/hiki.rb?rcov] on the test suite generates this[link:coverage/index.html] result.
+ % rake test
 
-=== Normal Installation
+To see tests coverage run rcov[http://github.com/relevance/rcov] rake task:
 
-You have to install stream library before. You can than install RGL with the
-following command:
+ % rake rcov
 
-  % ruby install.rb
+This command will generate tests coverage report in coverage/ directory.
 
-from its distribution directory. To uninstall it use
-
-  % ruby install.rb -u
+<em>Node: rcov is not compatible with Ruby >= 1.9, so this rake task is
+available only on Ruby 1.8.</em>
 
 == Example irb session with RGL
 
+
   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:
   irb> require 'rgl/dot'
   irb> dg.write_to_graphic_file('jpg')
   "graph.jpg"
-  
-The result: link:../examples/example.jpg  
-  
+
+The result:
+
+link:examples/images/example.jpg
+
   irb> dg.directed?
   true
   irb> dg.vertices
@@ -189,7 +160,7 @@ Add inverse edge (4-2) to directed graph:
   irb> dg.remove_edge 4,2
   true
 
-<em>Topological sort</em> is realized with as iterator:
+<em>Topological sort</em> is implemented as an iterator:
 
   require 'rgl/topsort'
   irb> dg.topsort_iterator.to_a
@@ -197,46 +168,49 @@ Add inverse edge (4-2) to directed graph:
 
 A more elaborated example showing <em>implicit graphs</em>:
 
+  require 'rgl/implicit'
   def module_graph
-	RGL::ImplicitGraph.new { |g|
-	  g.vertex_iterator { |b|
-		ObjectSpace.each_object(Module, &b) 
-	  }
-	  g.adjacent_iterator { |x, b|
-		x.ancestors.each { |y|
-		  b.call(y) unless x == y || y == Kernel || y == Object
-		}
-	  }
-	  g.directed = true
-	}
+    RGL::ImplicitGraph.new { |g|
+      g.vertex_iterator { |b|
+        ObjectSpace.each_object(Module, &b)
+      }
+      g.adjacent_iterator { |x, b|
+        x.ancestors.each { |y|
+          b.call(y) unless x == y || y == Kernel || y == Object
+        }
+      }
+      g.directed = true
+    }
   end
 
 This function creates a directed graph, with vertices being all loaded modules:
 
   g = module_graph
 
-We only want to see the ancestors of RGL::AdjacencyGraph:
+We only want to see the ancestors of {RGL::AdjacencyGraph}:
 
-  tree = bfs_search_tree_from(g,RGL::AdjacencyGraph)
+  require 'rgl/traversal'
+  tree = g.bfs_search_tree_from(RGL::AdjacencyGraph)
 
 Now we want to visualize this component of g with DOT.  We therefore create a
 subgraph of the original graph, using a filtered graph:
 
   g = g.vertices_filtered_by {|v| tree.has_vertex? v}
+  g.write_to_graphic_file('jpg')
+
+creates the following graph image with DOT:
 
-Create the graphics with DOT:
+link:examples/images/module_graph.jpg
 
-  g.write_to_graphic_file
+This graph shows all loaded RGL modules:
 
-produces module_graph.jpg: link:../examples/module_graph.jpg
+link:examples/images/rgl_modules.png
 
-Look for more in the examples directory (i.e.
-examples.rb[link:files/examples/examples_rb.html]).
+Look for more in _examples_ directory (i.e. {file:examples/examples.rb}).
 
 == My del.icio.us links concerning RGL
 
-I collect some links to stuff around RGL at http://del.icio.us/monora/rgl. I
-registered RGL at SWiK[http://swik.net/rgl].
+I collect some links to stuff around RGL at http://del.icio.us/monora/rgl.
 
 == Credits
 
@@ -259,18 +233,16 @@ and matz for Ruby. Dave included in the latest version of RDoc (alpha9) the
 module dot/dot.rb which I use instead of Roberts module to visualize graphs
 (see rgl/dot.rb).
 
-Jeremy Bopp, John Carter, Sascha Doerdelmann and Shawn Garbett for contributing
-additions, test cases and bugfixes.
+Jeremy Bopp, John Carter, Sascha Doerdelmann, Shawn Garbett, Andreas Schörk
+and Kirill Lashuk for contributing additions, test cases and bugfixes.
 
-== Copying
-
-RGL is Copyright (c) 2002,2004,2005,2008 by Horst Duchene.  It is free software, and may be
-redistributed under the terms specified in the README file of the Ruby distribution.
+Kirill Lashuk who started to take over further development in November 2012.
 
-== Support
+See also http://github.com/monora/rgl/contributors.
 
-Please contact me at mailto:monora@gmail.com with bug reports
-suggestions, and other comments. If you send patches, it would help if
-they were in-line (not attachments) and generated using "diff -u".
+== Copying
 
+RGL is Copyright (c) 2002,2004,2005,2008,2013 by Horst Duchene. It is free software,
+and may be redistributed under the terms specified in the README file of the
+Ruby distribution.
 

data/Rakefile

@@ -1,32 +1,25 @@
-# Rakefile for RGL        -*- ruby -*-
+# -*- ruby -*-
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rubygems/package_task'
 
-begin
-  require 'rubygems'
-  require 'rake/gempackagetask'
-rescue Exception
-  nil
-end
-require 'rake/clean'
 require 'rake/testtask'
-require 'rake/rdoctask'
-
-# Determine the current version of the software
-rgl_version =
-if %x(ruby -Ilib -rrgl/base -e'puts RGL_VERSION') =~ /\S+$/
-  $&
-else
-  "0.0.0"
-end
+require 'rdoc/task'
+require 'yard'
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rgl/base' # require base module to get RGL_VERSION
 
 SUMMARY = "Ruby Graph Library"
 SOURCES = FileList['lib/**/*.rb']
-CLOBBER.include('TAGS', 'coverage')
 RDOC_DIR = './rgl'
 
 # The location for published documents to be copied.
 remote_user = ENV['REMOTE_USER'] || ''
-remote_host = ENV['REMOTE_HOST'] || 'rubyforge.org'
-remote_path = ENV['REMOTE_PATH'] || '/var/www/gforge-projects/rgl'
+remote_host = ENV['REMOTE_HOST'] || 'github.org'
+remote_path = ENV['REMOTE_PATH'] || 'FIXME'
 remote_path += '/' unless remote_path[-1, 1] == '/'
 REMOTE_RDOC_DIR = remote_path
 REMOTE_RDOC_DIR.insert(
@@ -41,141 +34,51 @@ task :default => :test
 
 # Define a test task.
 
-Rake::TestTask.new { |t|
-  t.libs << "tests"
-  t.pattern = 'tests/Test*.rb'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
   t.verbose = true
-}
-
-task :test
-
-# Define a test that will run all the test targets.
-desc "Run all test targets"
-task :testall => [:test ]
-
-desc "Do code coverage with rcov"
-task :rcov do
-  begin 
-    sh 'rcov -Ilib:tests --exclude "tests/.*[tT]est.*.rb,usr.local" tests/Test*rb'
-  rescue Exception
-    nil
-  end
 end
 
-# Install rgl using the standard install.rb script.
-
-desc "Install the library"
-task :install do
-  ruby "install.rb"
+begin
+  require 'rcov/rcovtask'
+
+  desc "Calculate code coverage with rcov"
+  Rcov::RcovTask.new(:rcov) do |t|
+    t.libs << 'test'
+    t.pattern = 'test/*_test.rb'
+    t.verbose = true
+    t.rcov_opts += ['--exclude', 'test/,gems/']
+  end
+rescue LoadError
+  nil # rcov is available only on Ruby 1.8
 end
 
-# CVS Tasks ----------------------------------------------------------
+# Git tagging
 
-desc "Tag all the CVS files with the latest release number (TAG=x)"
+desc "Commit all changes as a new version commit. Tag the commit with v<version> tag"
 task :tag do
-  rel = "REL_" + rgl_version.gsub(/\./, '_')
-  rel << ENV['TAG'] if ENV['TAG']
-  puts rel
-  sh %{cvs commit -m 'pre-tag commit'}
-  sh %{cvs tag #{rel}}
-end
-
-desc "Accumulate changelog"
-task :changelog do
-  sh %{cvs2cl --tags --utc --prune --accum}
+  puts "Committing and tagging version #{RGL_VERSION}"
+  `git commit -am 'Version #{RGL_VERSION}'`
+  `git tag 'v#{RGL_VERSION}'`
 end
 
-# Create a task to build the RDOC documentation tree.
+# Tasks for generating docs.
 
-rd = Rake::RDocTask.new("rdoc") { |rdoc|
+Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = RDOC_DIR
   rdoc.template = 'doc/jamis.rb'
   rdoc.title    = SUMMARY
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include(SOURCES, 'README', 'ChangeLog', 'examples/examples.rb', 'rakelib/*.rake')
-}
-
-# ====================================================================
-# Create a task that will package the rgl software into distributable
-# tar, zip and gem files.
-
-PKG_FILES = FileList[
-  'install.rb',
-  '[A-Z]*',
-  'tests/**/*.rb',
-  'examples/**/*',
-  'rakelib/*.rake'
-] + SOURCES
-
-if ! defined?(Gem)
-  puts "Package Target requires RubyGems"
-else
-  spec = Gem::Specification.new do |s|
-    
-    s.name = 'rgl'
-    s.version = rgl_version
-    s.summary = SUMMARY
-    
-    s.description = <<-EOF
-    RGL is a framework for graph data structures and algorithms.
-
-    The design of the library is much influenced by the Boost Graph Library (BGL)
-    which is written in C++ heavily using its template mechanism.
-
-    RGL currently contains a core set of algorithm patterns:
-
-     * Breadth First Search 
-     * Depth First Search 
-
-    The algorithm patterns by themselves do not compute any meaningful quantities
-    over graphs, they are merely building blocks for constructing graph
-    algorithms. The graph algorithms in RGL currently include:
-
-     * Topological Sort 
-     * Connected Components 
-     * Strongly Connected Components 
-     * Transitive Closure
-     * Transitive Reduction
-     * Graph Condensation
-     * Search cycles (contributed by Shawn Garbett)
-    EOF
-    
-    #### Dependencies and requirements.
-    
-    s.add_dependency('stream', '>= 0.5')
-    s.add_dependency 'rake'
-    s.requirements << "Stream library, v0.5 or later"
-    
-    #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
-    s.files = PKG_FILES.to_a
-    
-    #### Load-time details: library and application (you will need one or both).
-    
-    s.require_path = 'lib'                         # Use these for libraries.
-    s.autorequire = 'rgl/base'
-    
-    #### Documentation and testing.
-    
-    s.has_rdoc = true
-    s.extra_rdoc_files = ['README']
-    s.rdoc_options <<
-      '--title' <<  'RGL - Ruby Graph Library' <<
-      '--main' << 'README' <<
-      '--line-numbers'
-    
-    #### Author and project details.
-    s.author = "Horst Duchene"
-    s.email = "monora@gmail.com"
-    s.homepage = "http://rgl.rubyforge.org"
-    s.rubyforge_project = "rgl"
-  end
-  
-  Rake::GemPackageTask.new(spec) do |pkg|
-    #pkg.need_zip = true
-    pkg.need_tar = true
-  end
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README.rdoc'
+  rdoc.rdoc_files.include(SOURCES, 'README.rdoc', 'ChangeLog', 'examples/examples.rb', 'rakelib/*.rake')
 end
 
+YARD::Rake::YardocTask.new
+
+# Tasks for building and installing RGL gem.
+
+Bundler::GemHelper.install_tasks
+
 # TAGS ---------------------------------------------------------------
 
 file 'tags' => SOURCES do
@@ -185,7 +88,7 @@ file 'tags' => SOURCES do
 end
 
 file 'TAGS' => SOURCES do
-  sh %{ctags -e #{SOURCES.join(' ')}}          # emacs TAGS
+  sh %{etags #{SOURCES.join(' ')}}          # emacs TAGS
 end
 
 # Misc tasks =========================================================
@@ -221,12 +124,3 @@ task :lines do
   end
   show_line("TOTAL", total_lines, total_code)
 end
-
-desc "Copy rdoc html to rubyforge"
-task :rdoc2rf => [:rdoc, :rcov, :changelog] do
-  cp_r 'coverage', RDOC_DIR
-  examples = File.join(RDOC_DIR, 'examples')
-  mkdir_p examples
-  cp Dir.glob('examples/*.jpg'), examples
-  sh "rsync -r --delete \"#{RDOC_DIR}\" \"#{REMOTE_RDOC_DIR}\""
-end