shortest_path 0.0.2 → 0.0.3

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-head

data/README.md

@@ -1,18 +1,37 @@
 # Shortest Path  [![Build Status](https://travis-ci.org/dryade/shortest_path.png)](http://travis-ci.org/dryade/shortest_path?branch=master) [![Dependency Status](https://gemnasium.com/dryade/shortest_path.png)](https://gemnasium.com/dryade/shortest_path) [![Code Climate](https://codeclimate.com/github/dryade/shortest_path.png)](https://codeclimate.com/github/dryade/shortest_path)
 
-A* ruby implementation to find shortest path and map in a graph.
+A* ruby implementation to find shortest path and map in a graph with :
+ - a timeout to stop research when duration > timeout
+ - a context in a hash for each point in the graph
+ - the possibility to override default methods 
+
 
 Requirements
 ------------
  
-This code has been run and tested on Ruby 1.8 and 1.9
+This code has been run and tested on Ruby 1.9
+
+External Deps
+-------------
+On Debian/Ubuntu/Kubuntu OS : 
+```sh
+sudo apt-get install git
+```
 
 Installation
 ------------
  
 This package is available in RubyGems and can be installed with:
- 
-   gem install shortest_path
+```sh 
+gem install shortest_path
+```
+
+Test
+----
+
+```sh
+bundle exec rake spec
+```
 
 More Information
 ----------------
@@ -23,8 +42,40 @@ There is extensive usage documentation available [on the wiki](https://github.co
 Example Usage 
 -------------
 
+Create a basic shortest path finder : 
+```ruby
+# Create a graph
+graph = {   :a => { :e => 3, :b => 1, :c => 3},
+                :b => {:e => 1, :a => 1, :c => 3, :d => 5},
+                :c => {:a => 3, :b => 3, :d => 1, :s => 3},
+                :d => {:b => 5, :c => 1, :s => 1},
+                :e => {:a => 3, :b => 1},
+                :s => {:c => 3, :d => 1} }
+}
+
+# Create a finder
+finder = ShortestPath::Finder.new(:a, :e).tap do |shortest_path|
+  shortest_path.ways_finder = Proc.new { |node| graph[node] }
+end
+
+# Change the timeout in seconds
+finder.timeout = 2
+
+# Call graph result
+finder.path
+
+```
+
+Overwrite shortest path finder : 
+```ruby
+
+# TODO : Class that overwrites shortest path finder
 ...
 
+
+```
+
+
 License
 -------
  

data/lib/shortest_path/finder.rb

@@ -14,7 +14,11 @@ module ShortestPath
     # Example : { :a => 2, :b => 3 }
     attr_accessor :ways_finder
 
-    def ways(node)
+    def refresh_context( node, context)
+        {}
+    end
+
+    def ways(node, context={})
       ways_finder.call node
     end
 
@@ -26,17 +30,26 @@ module ShortestPath
       @previous ||= {}
     end
 
+    # @context is a hash
+    # each node is related to an hash defining the context
+    # context is specific to the path solution between departure dans target node
+    #
+    def context
+      @context ||= {}
+    end
+
     def search_heuristic(node)
       shortest_distances[node]
     end
 
-    def follow_way?(node, destination, weight)
+    def follow_way?(node, destination, weight, context={})
       true
     end
 
+    # timeout is in seconds
     attr_accessor :timeout
     attr_reader :begin_at, :end_at
-    
+
     def timeout?
       timeout and (duration > timeout)
     end
@@ -47,7 +60,7 @@ module ShortestPath
     end
 
     def visited?(node)
-      @visited[node]      
+      @visited[node]
     end
 
     def visit(node)
@@ -60,15 +73,16 @@ module ShortestPath
 
     def path_without_cache
       @begin_at = Time.now
-      
+
       visited = {}
-      pq = PQueue.new do |x,y| 
+      pq = PQueue.new do |x,y|
         search_heuristic(x) < search_heuristic(y)
       end
 
-      pq.push(source)
+      pq.push( source)
       visit source
       shortest_distances[source] = 0
+      context[source] = {}
 
       not_found = !found?(source)
 
@@ -79,16 +93,17 @@ module ShortestPath
         not_found = !found?(v)
         visit v
 
-        weights = ways(v)
+        weights = ways(v, context[v])
         if weights
           weights.keys.each do |w|
             if !visited?(w) and
                 weights[w] and
-                ( shortest_distances[w].nil? || shortest_distances[w] > shortest_distances[v] + weights[w]) and 
-                follow_way?(v, w, weights[w])
+                ( shortest_distances[w].nil? || shortest_distances[w] > shortest_distances[v] + weights[w]) and
+                follow_way?(v, w, weights[w], context[v])
               shortest_distances[w] = shortest_distances[v] + weights[w]
               previous[w] = v
-              pq.push(w)
+              context[w] = refresh_context( w, context[v])
+              pq.push( w)
             end
           end
         end

data/lib/shortest_path/version.rb

@@ -1,3 +1,3 @@
 module ShortestPath
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/shortest_path/finder_spec.rb

@@ -1,5 +1,17 @@
 require 'spec_helper'
 
+class TestContextualFinder < ShortestPath::Finder
+    def refresh_context( node, context)
+        count = context[:edges_count] ? context[:edges_count] : 0
+        return { :edges_count => (count + 1)}
+    end
+
+    def follow_way?(node, destination, weight, context={})
+      return context[:edges_count].nil? || context[:edges_count] < 3
+    end
+
+end
+
 describe ShortestPath::Finder do
   let(:graph) {
     {   :a => { :e => 3, :b => 1, :c => 3},
@@ -10,6 +22,18 @@ describe ShortestPath::Finder do
                 :s => {:c => 3, :d => 1} }
   }
 
+  def contextual_shortest_path(source, destination, given_graph = graph)
+    TestContextualFinder.new(source, destination).tap do |shortest_path|
+      shortest_path.ways_finder = Proc.new { |node| given_graph[node] }
+    end.path
+  end
+
+  context "when using an edge_count filter in context " do
+      it "should find shortest path in an exemple" do
+        contextual_shortest_path(:e, :s).should == [:e, :b, :c, :s]
+      end
+  end
+
   def shortest_path(source, destination, given_graph = graph)
     ShortestPath::Finder.new(source, destination).tap do |shortest_path|
       shortest_path.ways_finder = Proc.new { |node| given_graph[node] }
@@ -38,16 +62,16 @@ describe ShortestPath::Finder do
     shortest_path(:e, :s, not_connex).should be_empty
   end
 
-  subject { 
+  subject {
     ShortestPath::Finder.new(:e, :s).tap do |shortest_path|
       shortest_path.ways_finder = Proc.new {  |node| graph[node] }
     end
   }
 
   describe "begin_at" do
-    
+
     let(:expected_time) { Time.now }
-    
+
     it "should be defined when path starts" do
       Time.stub :now => expected_time
       subject.path
@@ -57,9 +81,9 @@ describe ShortestPath::Finder do
   end
 
   describe "end_at" do
-    
+
     let(:expected_time) { Time.now }
-    
+
     it "should be defined when path ends" do
       Time.stub :now => expected_time
       subject.path
@@ -69,7 +93,7 @@ describe ShortestPath::Finder do
   end
 
   describe "duration" do
-    
+
     it "should be nil before path is search" do
       subject.duration.should be_nil
     end
@@ -99,12 +123,12 @@ describe ShortestPath::Finder do
       subject.timeout = nil
       subject.should_not be_timeout
     end
-    
+
     it "should be false when duration is lower than timeout" do
       subject.stub :duration => (subject.timeout - 1)
       subject.should_not be_timeout
     end
-    
+
     it "should be true when duration is greater than timeout" do
       subject.stub :duration => (subject.timeout + 1)
       subject.should be_timeout
@@ -113,7 +137,7 @@ describe ShortestPath::Finder do
   end
 
   describe "path" do
-    
+
     it "should raise a Timeout::Error when timeout?" do
       subject.stub :timeout? => true
       lambda { subject.path }.should raise_error(ShortestPath::TimeoutError)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shortest_path
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alban Peignier
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-07 00:00:00 Z
+date: 2013-08-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -116,10 +116,11 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rvmrc
 - .travis.yml
 - Gemfile
 - Guardfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/shortest_path.rb