astar 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Richard Patching
+
+MIT License
+
+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,44 @@
+# Astar
+
+Pathfinding library using the astar algorithm
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'astar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install astar
+
+## Usage
+
+Make sure you have an object that responds to methods x,y and walkable_neighbours
+
+    class Tile
+      attr_reader :x, :y
+
+      #returns the surrounding tiles that are walkable
+      def walkable_neighbours
+      end
+    end
+
+Pass in your start and destination tiles
+
+    Astar::FindPath.from(tile1).to(tile3)
+    => [tile1, tile2, tile3]
+
+The specs also have an example of how to use the lib.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts =  %q[--exclude "spec"]
+end
+
+task :default => :spec

data/astar.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'astar/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "astar"
+  gem.version       = Astar::VERSION
+  gem.authors       = ["Richard Patching"]
+  gem.email         = ["richard@justaddpixels.com"]
+  gem.description   = %q{Pathfinding library using the a* algorithm}
+  gem.summary       = %q{Pathfinding library}
+  gem.homepage      = "http://github.com/patchfx/astar"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.10.0'
+  gem.add_development_dependency 'rake',  '~> 0.9.2.2'
+end

data/lib/astar/node.rb

@@ -0,0 +1,38 @@
+module Astar
+  class Node
+    attr_reader :tile, :parent
+    def initialize(tile, destination, parent=nil)
+      @tile = tile
+      @parent = parent
+      @destination = destination
+    end
+
+    def walkable_neighbours
+      @tile.walkable_neighbours
+    end
+
+    def x
+      @tile.x
+    end
+
+    def y
+      @tile.y
+    end
+
+    def score
+      relative_to_parent + manhatten_distance
+    end
+
+    def manhatten_distance
+      (@destination.x - @tile.x) + (@destination.y - @tile.y)
+    end
+
+    def relative_to_parent
+      return 10 if (@tile.x > @parent.x && @tile.y == @parent.y)
+      return 10 if (@tile.x < @parent.x && @tile.y == @parent.y)
+      return 10 if (@tile.y > @parent.y && @tile.x == @parent.x)
+      return 10 if (@tile.y < @parent.y && @tile.x == @parent.x)
+      14
+    end
+  end
+end

data/lib/astar/version.rb

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

data/lib/astar.rb

@@ -0,0 +1,48 @@
+require "astar/node"
+require "astar/version"
+
+module Astar
+  class FindPath
+    def self.from(node)
+      new(node)
+    end
+
+    def to(node)
+      @to_node = Node.new(node,nil)
+      @open_list << Node.new(@from_node, @to_node)
+      calculate_route
+    end
+
+    def calculate_route
+      until destination_reached? || @open_list.empty?
+        current_node = @open_list.pop
+        next if @closed_list.include?(current_node)
+        add_neighbours_to_list(current_node, current_node.walkable_neighbours)
+        calculate_fastest
+        @closed_list << current_node
+      end
+      @closed_list
+    end
+
+    def add_neighbours_to_list(current_node, neighbours)
+      nodes = neighbours.map {|n| Node.new(n, @to_node, current_node) }
+      @open_list << nodes
+      @open_list.flatten!
+    end
+
+    def calculate_fastest
+      @open_list.sort_by! {|node| node.score }.reverse
+    end
+
+    def destination_reached?
+      @closed_list.any? { |node| node.x == @to_node.x && node.y == @to_node.y }
+    end
+
+    private
+    def initialize(node)
+      @from_node = Node.new(node, nil)
+      @open_list = []
+      @closed_list = []
+    end
+  end
+end

data/spec/lib/astar_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Astar
+  describe FindPath do
+    let(:node) { double(:node, x: 0, y: 0) }
+    let(:node2) { double(:node2, x: 1, y: 0) }
+    let(:node3) { double(:node3, x: 0, y: 1) }
+    let(:node4) { double(:node4, x: 1, y: 1) }
+
+    before do
+      node.stub(:walkable_neighbours => [node2,node3,node4])
+      node2.stub(:walkable_neighbours => [node,node3,node4])
+      node3.stub(:walkable_neighbours => [node,node2,node4])
+      node4.stub(:walkable_neighbours => [node2,node3,node])
+    end
+
+    it 'finds the fastest route between 2 nodes' do
+      path = FindPath.from(node).to(node4)
+      coords = path.collect { |node| [node.x, node.y] }
+      coords.should == [[0, 0], [1, 1]]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'bundler/setup'
+require 'astar'
+require 'rspec'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: astar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Richard Patching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+description: Pathfinding library using the a* algorithm
+email:
+- richard@justaddpixels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- astar.gemspec
+- lib/astar.rb
+- lib/astar/node.rb
+- lib/astar/version.rb
+- spec/lib/astar_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/patchfx/astar
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pathfinding library
+test_files:
+- spec/lib/astar_spec.rb
+- spec/spec_helper.rb
+has_rdoc: