shortest_path 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~
+coverage/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shortest_path.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2012 Dryade SAS
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Shortest Path
+
+A* ruby implementation to find shortest path and map in a graph.
+
+## Requirements
+ 
+This code has been run and tested on Ruby 1.8
+
+## Installation
+ 
+This package is available in RubyGems and can be installed with:
+ 
+   gem install shortest_path
+
+## More Information
+ 
+More information can be found on the [project website on GitHub](http://github.com/dryade/shortest_path). 
+There is extensive usage documentation available [on the wiki](https://github.com/dryade/shortest_path/wiki).
+
+## Example Usage 
+
+...
+
+## License
+ 
+This project is licensed under the MIT license, a copy of which can be found in the LICENSE file.
+
+## Support
+ 
+Users looking for support should file an issue on the GitHub issue tracking page (https://github.com/dryade/shortest_path/issues), or file a pull request (https://github.com/dryade/shortest_path/pulls) if you have a fix available.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
+end

data/lib/shortest_path/finder.rb

@@ -0,0 +1,118 @@
+require 'pqueue'
+
+module ShortestPath
+  class Finder
+
+    attr_reader :source, :destination
+
+    def initialize(source, destination)
+      @source, @destination = source, destination
+      @visited = {}
+    end
+
+    # Should return a map with accessible nodes and associated weight
+    # Example : { :a => 2, :b => 3 }
+    attr_accessor :ways_finder
+
+    def ways(node)
+      ways_finder.call node
+    end
+
+    def shortest_distances
+      @shortest_distances ||= {}
+    end
+
+    def previous
+      @previous ||= {}
+    end
+
+    def search_heuristic(node)
+      shortest_distances[node]
+    end
+
+    def follow_way?(node, destination, weight)
+      true
+    end
+
+    attr_accessor :timeout
+    attr_reader :begin_at, :end_at
+    
+    def timeout?
+      timeout and (duration > timeout)
+    end
+
+    def duration
+      return nil unless begin_at
+      (end_at or Time.now) - begin_at
+    end
+
+    def visited?(node)
+      @visited[node]      
+    end
+
+    def visit(node)
+      @visited[node] = true
+    end
+
+    def found?(node)
+      node == destination
+    end
+
+    def path_without_cache
+      @begin_at = Time.now
+      
+      visited = {}
+      pq = PQueue.new do |x,y| 
+        search_heuristic(x) < search_heuristic(y)
+      end
+
+      pq.push(source)
+      visit source
+      shortest_distances[source] = 0
+
+      not_found = !found?(source)
+
+      while pq.size != 0 && not_found
+        raise TimeoutError if timeout?
+
+        v = pq.pop
+        not_found = !found?(v)
+        visit v
+
+        weights = ways(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] = shortest_distances[v] + weights[w]
+              previous[w] = v
+              pq.push(w)
+            end
+          end
+        end
+      end
+
+      @end_at = Time.now
+      not_found ? [] : sorted_array
+    end
+
+    def path_with_cache
+      @path ||= path_without_cache
+    end
+    alias_method :path, :path_with_cache
+
+    def sorted_array
+      [].tap do |sorted_array|
+        previous_id = destination
+        previous.size.times do |t|
+          sorted_array.unshift(previous_id)
+          break if previous_id == source
+          previous_id = previous[previous_id]
+          raise "Unknown #{previous_id.inspect}" unless previous_id
+        end
+      end
+    end
+  end
+end

data/lib/shortest_path/map.rb

@@ -0,0 +1,70 @@
+module ShortestPath
+  class Map
+
+    attr_reader :source
+    attr_accessor :max_distance
+
+    def initialize(source)
+      @source = source
+    end
+
+    # Should return a map with accessible nodes and associated weight
+    # Example : { :a => 2, :b => 3 }
+    attr_accessor :ways_finder
+
+    def ways(node)
+      ways_finder.call node
+    end
+
+    def shortest_distances
+      @shortest_distances ||= {}
+    end
+
+    def previous
+      @previous ||= {}
+    end
+
+    def search_heuristic(node)
+      shortest_distances[node]
+    end
+
+    def map
+      @shortest_distances = {}
+      @previous = {}
+
+      visited = {}
+      pq = PQueue.new { |x,y| search_heuristic(x) < search_heuristic(y) }
+
+      pq.push(source)
+      visited[source] = true
+      shortest_distances[source] = 0
+
+      while pq.size != 0
+        v = pq.pop
+        visited[v] = true
+
+        weights = ways(v)
+        if weights
+          weights.keys.each do |w|
+            w_distance = shortest_distances[v] + weights[w]
+
+            if !visited[w] and
+                weights[w] and
+                ( shortest_distances[w].nil? || shortest_distances[w] > w_distance) and
+                follow_way?(v, w, weights[w])
+              shortest_distances[w] = w_distance
+              previous[w] = v
+              pq.push(w)
+            end
+          end
+        end
+      end
+
+      shortest_distances
+    end
+
+    def follow_way?(node, destination, weight)
+      max_distance.nil? or shortest_distances[node] + weight <= max_distance
+    end
+  end
+end

data/lib/shortest_path/version.rb

@@ -0,0 +1,3 @@
+module ShortestPath
+  VERSION = "0.0.1"
+end

data/lib/shortest_path.rb

@@ -0,0 +1,10 @@
+require "shortest_path/version"
+
+module ShortestPath
+  class TimeoutError < StandardError
+  end
+end
+
+require "shortest_path/finder"
+require "shortest_path/map"
+

data/shortest_path.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shortest_path/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shortest_path"
+  s.version     = ShortestPath::VERSION
+  s.authors     = ["Alban Peignier", "Marc Florisson"]
+  s.email       = ["alban@dryade.net", "marc@dryade.net"]
+  s.homepage    = "http://github.com/dryade/shortest_path"
+  s.summary     = %q{Ruby library to find shortest path(s) in a graph}
+  s.description = %q{A* ruby implementation to find shortest path and map}
+
+  s.rubyforge_project = "shortest_path"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "pqueue"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rcov"
+
+end

data/spec/shortest_path/finder_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe ShortestPath::Finder do
+  let(: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} }
+  }
+
+  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] }
+    end.path
+  end
+
+  it "should find shortest path in an exemple" do
+    shortest_path(:e, :s).should == [:e, :b, :c, :d, :s]
+  end
+
+  it "should return empty array when unknown start or end" do
+    shortest_path(:e, :unknown).should be_empty
+    shortest_path(:unknown, :s).should be_empty
+    shortest_path(:unknown, :unknown2).should be_empty
+  end
+
+  it "should find trivial solution" do
+    shortest_path(:a, :b).should == [:a, :b]
+  end
+
+  it "should return empty array when graph is not connex" do
+    not_connex = graph.clone
+    not_connex[:d].delete(:s)
+    not_connex[:c].delete(:s)
+
+    shortest_path(:e, :s, not_connex).should be_empty
+  end
+
+  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
+      subject.begin_at.should == expected_time
+    end
+
+  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
+      subject.end_at.should == expected_time
+    end
+
+  end
+
+  describe "duration" do
+    
+    it "should be nil before path is search" do
+      subject.duration.should be_nil
+    end
+
+    let(:time) { Time.now }
+
+    it "should be difference between Time.now and begin_at when path isn't ended'" do
+      Time.stub :now => time
+      subject.stub :begin_at => time - 2, :end_at => nil
+      subject.duration.should == 2
+    end
+
+    it "should be difference between end_at and begin_at when available" do
+      subject.stub :begin_at => time - 2, :end_at => time
+      subject.duration.should == 2
+    end
+
+  end
+
+  describe "timeout?" do
+
+    before(:each) do
+      subject.timeout = 2
+    end
+
+    it "should be false without timeout" 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
+    end
+
+  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)
+    end
+
+  end
+
+end

data/spec/shortest_path/map_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ShortestPath::Map do
+
+  let(:graph) {
+    { :a => { :b => 2, :d => 1 },
+      :b => { :c => 1, :a => 2 },
+      :c => { :b => 1, :d => 3 },
+      :d => { :a => 1, :c => 3 } }
+  }
+
+  def shortest_path_map(source, max_distance = nil, given_graph = graph)
+    ShortestPath::Map.new(source).tap do |shortest_path_map|
+      shortest_path_map.max_distance = nil
+      shortest_path_map.ways_finder = Proc.new { |node| given_graph[node] }
+    end.map
+  end
+
+  it "should find shortest path map in an exemple" do
+    shortest_path_map(:a).should == { :a => 0, :b => 2, :c => 3, :d => 1 }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+
+require 'shortest_path' # and any other gems you need
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: shortest_path
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alban Peignier
+- Marc Florisson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  name: pqueue
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  name: rake
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  name: rcov
+description: A* ruby implementation to find shortest path and map
+email: 
+- alban@dryade.net
+- marc@dryade.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/shortest_path.rb
+- lib/shortest_path/finder.rb
+- lib/shortest_path/map.rb
+- lib/shortest_path/version.rb
+- shortest_path.gemspec
+- spec/shortest_path/finder_spec.rb
+- spec/shortest_path/map_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dryade/shortest_path
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: shortest_path
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby library to find shortest path(s) in a graph
+test_files: []
+