rgl 0.5.0 → 0.5.1

data/ChangeLog

@@ -1,3 +1,42 @@
+2015-12 Release 0.5.1
+
+Horst Duchene <monora@gmail.com>
+ * Changed edge sequence to match example picture (daa88e)
+
+Chase <chase.gilliam@gmail.com>
+ * updated algorithms to 6.1 and added test unit to support newer rubies (fbd874)
+
+Louis Rose <louismrose@gmail.com>
+ * Fix #15. Use object IDs rather than labels to identify vertexs in DOT graph
+   to ensure that distinct nodes that share a label are shown. (33206f, 4fc455)
+
+2014-12 Release 0.5.0
+
+Horst Duchene <monora@gmail.com>
+  * Changed edge sequence to match example picture (daa88e)
+  * Fixed comment (6a6c93)
+  * Fixed spelling (7ca281)
+Horst Duchêne <monora@gmail.com>
+Chase <chase.gilliam@gmail.com>
+  * updated algorithms to 6.1 and added test unit to support newer rubies (fbd874)
+Louis Rose <louismrose@gmail.com>
+  * Fix #15. Use object IDs rather than labels to identify vertexs in DOT graph to ensure that distinct nodes that share a label are shown. (33206f)
+	* Issue #15. Fix tests. (4fc455)
+
+
+2014-12 Release 0.5.0
+Horst Duchene <monora@gmail.com>
+  * Changed edge sequence to match example picture (daa88e)
+  * Fixed comment (6a6c93)
+  * Fixed spelling (7ca281)
+Horst Duchêne <monora@gmail.com>
+Chase <chase.gilliam@gmail.com>
+  * updated algorithms to 6.1 and added test unit to support newer rubies (fbd874)
+Louis Rose <louismrose@gmail.com>
+  * Fix #15. Use object IDs rather than labels to identify vertexs in DOT graph to ensure that distinct nodes that share a label are shown. (33206f)
+	* Issue #15. Fix tests. (4fc455)
+
+
 2014-12 Release 0.5.0
 
 This release mainly contains the contributions of Kirill, who added many algorithms to the library. Thank you Kirill!

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'rake'
+gem 'yard'
+gem 'asciidoctor'

data/README.rdoc

@@ -18,10 +18,10 @@ Ruby. The main design goals directly taken from the BGL design are:
 
 * An interface for how the structure of a graph can be accessed using a generic
   interface that hides the details of the graph data structure
-  implementation. This interface is defined by the module Graph, which should be
+  implementation. This interface is defined by the module {Graph}, which should be
   included in concrete classes.
 
-* A standardized generic interface for traversing graphs (RGL::GraphIterator)
+* A standardized generic interface for traversing graphs {RGL::GraphIterator}
 
 RGL provides some general purpose graph classes that conform to this interface,
 but they are not meant to be the *only* graph classes. As in BGL I believe that
@@ -125,7 +125,7 @@ available only on Ruby 1.8.</em>
 
 The result:
 
-link:examples/images/example.jpg
+link:images/example.jpg
 
   irb> dg.directed?
   true
@@ -200,11 +200,11 @@ subgraph of the original graph, using a filtered graph:
 
 creates the following graph image with DOT:
 
-link:examples/images/module_graph.jpg
+link:images/module_graph.jpg
 
 This graph shows all loaded RGL modules:
 
-link:examples/images/rgl_modules.png
+link:images/rgl_modules.png
 
 Look for more in _examples_ directory (i.e. {file:examples/examples.rb}).
 
@@ -242,7 +242,7 @@ See also http://github.com/monora/rgl/contributors.
 
 == Copying
 
-RGL is Copyright (c) 2002,2004,2005,2008,2013 by Horst Duchene. It is free software,
+RGL is Copyright (c) 2002,2004,2005,2008,2013,2015 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

@@ -6,7 +6,6 @@ require 'bundler/setup'
 require 'rubygems/package_task'
 
 require 'rake/testtask'
-require 'rdoc/task'
 require 'yard'
 
 $:.unshift File.join(File.dirname(__FILE__), 'lib')
@@ -14,21 +13,8 @@ require 'rgl/base' # require base module to get RGL_VERSION
 
 SUMMARY = "Ruby Graph Library"
 SOURCES = FileList['lib/**/*.rb']
-RDOC_DIR = './rgl'
-
-# The location for published documents to be copied.
-remote_user = ENV['REMOTE_USER'] || ''
-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(
-  0,
-  remote_user + (remote_user.empty? ? '' : '@') + remote_host + ':'
-) unless remote_host.empty?
 
 # The default task is run if rake is given no explicit arguments.
-
 desc "Default Task"
 task :default => :test
 
@@ -63,16 +49,6 @@ task :tag do
   `git tag 'v#{RGL_VERSION}'`
 end
 
-# Tasks for generating docs.
-
-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.rdoc_files.include(SOURCES, 'README.rdoc', 'ChangeLog', 'examples/examples.rb', 'rakelib/*.rake')
-end
-
 YARD::Rake::YardocTask.new
 
 # Tasks for building and installing RGL gem.
@@ -124,3 +100,31 @@ 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|
+    date, author, subject, hash = entry.chomp.split("::")
+    entries[author] = Array.new unless entries[author]
+    day = date.split(" ").first
+    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

@@ -6,7 +6,7 @@
 
 require 'rgl/enumerable_ext'
 
-RGL_VERSION = "0.5.0"
+RGL_VERSION = "0.5.1"
 
 module RGL
   class NotDirectedError < RuntimeError; end

data/lib/rgl/dot.rb

@@ -12,6 +12,11 @@ module RGL
 
   module Graph
 
+    # Returns a label for vertex v. Default is v.to_s
+    def vertex_label(v)
+      v.to_s
+    end
+
     # Return a RGL::DOT::Digraph for directed graphs or a DOT::Graph for an
     # undirected Graph. _params_ can contain any graph property specified in
     # rdot.rb.
@@ -23,18 +28,17 @@ module RGL
       edge_class     = directed? ? DOT::DirectedEdge : DOT::Edge
 
       each_vertex do |v|
-        name = v.to_s
         graph << DOT::Node.new(
-            'name'     => name,
+            'name'     => v.object_id,
             'fontsize' => fontsize,
-            'label'    => name
+            'label'    => vertex_label(v)
         )
       end
 
       each_edge do |u, v|
         graph << edge_class.new(
-            'from'     => u.to_s,
-            'to'       => v.to_s,
+            'from'     => u.object_id,
+            'to'       => v.object_id,
             'fontsize' => fontsize
         )
       end

data/lib/rgl/graph_visitor.rb

@@ -3,7 +3,7 @@ require 'rgl/graph_wrapper'
 module RGL
 
   # Module GraphVisitor defines the BGL
-  # BFS[http://www.boost.org/libs/graph/doc/BFSVisitor.html] Visitor Concept).
+  # BFS[http://www.boost.org/libs/graph/doc/BFSVisitor.html] Visitor Concept.
   #
   # Visitors provide a mechanism for extending an algorithm (i.e., for
   # customizing what is done at each step of the algorithm). They allow users

data/test/dot_test.rb

@@ -13,14 +13,22 @@ class TestDot < Test::Unit::TestCase
     graph = RGL::DirectedAdjacencyGraph[1, 2]
     dot   = graph.to_dot_graph.to_s
 
+    first_vertex_id = 1.object_id
+    second_vertex_id = 2.object_id
+
     assert_match(dot, /\{[^}]*\}/) # {...}
-    assert_match(dot, /1\s*\[/)    # node 1
-    assert_match(dot, /2\s*\[/)    # node 2
-    assert_match(dot, /1\s*->\s*2/) # edge
+    assert_match(dot, /#{first_vertex_id}\s*\[/)  # node 1
+    assert_match(dot, /label\s*=\s*1/)            # node 1 label
+    assert_match(dot, /#{second_vertex_id}\s*\[/) # node 2
+    assert_match(dot, /label\s*=\s*2/)            # node 2 label
+    assert_match(dot, /#{first_vertex_id}\s*->\s*#{second_vertex_id}/) # edge
   end
 
   def test_to_dot_graph
     graph = RGL::AdjacencyGraph[1, 2]
-    dot   = graph.write_to_graphic_file
+    def graph.vertex_label(v)
+      "label-"+v.to_s
+    end
+    dot = graph.write_to_graphic_file
   end
 end

data/test/traversal_test.rb

@@ -11,7 +11,7 @@ class TestTraversal < Test::Unit::TestCase
 
   def setup
     @dg   = DirectedAdjacencyGraph.new(Array)
-    edges = [[1, 2], [2, 3], [2, 4], [4, 5], [1, 6], [6, 4]]
+    edges = [[1, 2], [1, 6], [2, 3], [2, 4], [4, 5], [6, 4]]
     edges.each do |(src, target)|
       @dg.add_edge(src, target)
     end
@@ -155,7 +155,7 @@ END
     ts_order = ts_it.to_a # do the traversal
     assert_equal(@dg.num_vertices, ts_order.size)
 
-    # Check topsort contraint:
+    # Check topsort constraint:
     @dg.each_edge { |u, v|
       assert(ts_order.index(u) < ts_order.index(v))
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: rgl/base
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stream
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +61,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -77,7 +77,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -131,7 +131,6 @@ files:
 - examples/images/rgl_modules.png
 - examples/insel_der_tausend_gefahren.rb
 - examples/rdep-rgl.rb
-- examples/graph.dot
 - examples/north2.rb
 - examples/canvas.rb
 - examples/north.rb
@@ -245,7 +244,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -105297123
+      hash: 900116365
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -254,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -105297123
+      hash: 900116365
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/examples/graph.dot

@@ -1,46 +0,0 @@
-subgraph RGL__AdjacencyGraph {
-    0 [
-        fontsize = 8,
-        label = 0
-    ]
-
-    1 [
-        fontsize = 8,
-        label = 1
-    ]
-
-    2 [
-        fontsize = 8,
-        label = 2
-    ]
-
-    3 [
-        fontsize = 8,
-        label = 3
-    ]
-
-    4 [
-        fontsize = 8,
-        label = 4
-    ]
-
-    0 -- 1 [
-        fontsize = 8
-    ]
-
-    0 -- 4 [
-        fontsize = 8
-    ]
-
-    1 -- 2 [
-        fontsize = 8
-    ]
-
-    2 -- 3 [
-        fontsize = 8
-    ]
-
-    3 -- 4 [
-        fontsize = 8
-    ]
-}