maze-solver 1.0.0

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pete Johns
+
+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,48 @@
+# Maze Solver
+
+Written as an exercise in applying Ruby, this project solves mazes:
+
+    maze-solver etc/demo.maze 18 0 38 0
+    About to solve your 40x14 maze from (18, 0) to (38,0).
+    GO!
+    Solved!
+    ******************.*******************.*
+    *      .......****.**      .......****.*
+    * *****.*****...**.** *****.*****...**.*
+    * *****.*******.**.** *****.*******.**.*
+    * *    ......**.**.** *    ......**.**.*
+    * **********.**....** **********.**....*
+    ************.*******************.*******
+    ************.***** *************.***** *
+    *           ..****............... **** *
+    * ***** *****...**.** ***** *****   ** *
+    * ***** *******.**.** ***** ******* ** *
+    * *          **.**.** *          ** ** *
+    * ********** **....** ********** **    *
+    ****************************************
+
+
+## Installation
+
+    $ gem install maze-solver
+
+## Usage
+
+    maze-solver filename start_x start_y end_x end_y
+
+## 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
+
+## Thanks
+
+If you find this stuff useful, please follow this repository on
+[GitHub](https://github.com/johnsyweb/ruby_maze_solver). If you have something to say,
+you can contact [johnsyweb](http://johnsy.com/about/) on
+[Twitter](http://twitter.com/johnsyweb/) and
+[GitHub](https://github.com/johnsyweb/).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec

data/bin/maze-solver

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'maze_solver'
+
+def main(filename, start_x, start_y, end_x, end_y)
+  maze = MazeSolver::MazeSolver.new(from_file: filename)
+  puts "About to solve your #{maze.width}x#{maze.height} maze from " +
+    "(#{start_x}, #{start_y}) to (#{end_x},#{end_y})."
+  puts 'GO!'
+  if maze.solve start_x.to_i, start_y.to_i, end_x.to_i, end_y.to_i
+    puts 'Solved!'
+  else
+    puts 'You beat me!'
+  end
+  puts maze
+end
+
+if ARGV.length == 5
+  filename, start_x, start_y, end_x, end_y = ARGV
+  main(filename, start_x, start_y, end_x, end_y)
+else
+  puts "Usage: #{$PROGRAM_NAME} filename start_x start_y end_x end_y\n"
+  puts "Example: #{$PROGRAM_NAME} demo.maze 18 0 38 0\n"
+end

data/etc/demo.maze

@@ -0,0 +1,14 @@
+****************** ******************* *
+*             **** **             **** *
+* ***** *****   ** ** ***** *****   ** *
+* ***** ******* ** ** ***** ******* ** *
+* *          ** ** ** *          ** ** *
+* ********** **    ** ********** **    *
+************ ******************* *******
+************ ***** ************* ***** *
+*             ****                **** *
+* ***** *****   ** ** ***** *****   ** *
+* ***** ******* ** ** ***** ******* ** *
+* *          ** ** ** *          ** ** *
+* ********** **    ** ********** **    *
+****************************************

data/lib/maze_solver.rb

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+
+require 'maze_solver/version'
+
+module MazeSolver
+
+  class MazeSolver
+
+    def initialize(args = {})
+      if args[:from_grid]
+        @grid = args[:from_grid].split("\n")
+      elsif args[:from_file]
+        @grid = from_file(args[:from_file])
+      end
+    end
+
+    def height
+      @grid.size
+    end
+
+    def width
+      @grid.map { |row| row.length }.max
+    end
+
+    def visitable?(x, y)
+      row, column = y, x
+      return false unless (0...height).include? row
+      return false unless (0...width).include? column
+      @grid[row][column].chr == ' '
+    end
+
+    def visit(x, y)
+      row, column = y, x
+      @grid[row][column] = '.'
+    end
+
+    def unvisit(x, y)
+      row, column = y, x
+      @grid[row][column] = ' '
+    end
+
+    def solve(start_x, start_y, end_x, end_y)
+      return false unless visitable?(start_x, start_y)
+
+      visit start_x, start_y
+
+      return true if [start_x, start_y] == [end_x, end_y]
+
+      return true if adjacent_cell_solvable?(start_x, start_y, end_x, end_y)
+
+      unvisit(start_x, start_y)
+
+      false
+    end
+
+    def adjacent_cell_solvable?(start_x, start_y, end_x, end_y)
+      solve(start_x + 1, start_y, end_x, end_y) ||
+        solve(start_x, start_y + 1, end_x, end_y) ||
+        solve(start_x - 1, start_y, end_x, end_y) ||
+        solve(start_x, start_y - 1, end_x, end_y)
+    end
+
+    def to_s
+      @grid.join("\n")
+    end
+
+    def from_file(filename)
+      @grid = File.open(filename, 'r').readlines
+      @grid.each { | row | row.strip! }
+    end
+
+  end
+
+end

data/lib/maze_solver/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module MazeSolver
+  VERSION = '1.0.0'
+end

data/maze_solver.gemspec

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maze_solver/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'maze-solver'
+  gem.version       = MazeSolver::VERSION
+  gem.authors       = ['Pete Johns']
+  gem.email         = ['paj-github@johnsy.com']
+  gem.description   = 'A gem to solve a 2D maze.'
+  gem.summary       = 'Written as an exercise'
+  gem.homepage      = 'https://github.com/johnsyweb/ruby_maze_solver#readme'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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']
+end

data/spec/maze_spec.rb

@@ -0,0 +1,106 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe MazeSolver do
+  def given_a_simple_8_x_3_maze
+    @maze = MazeSolver::MazeSolver.new(from_grid: "********\n" +
+                                       "        \n" +
+                                       "********\n"
+                                      )
+  end
+
+  it 'should have a width of 8' do
+    given_a_simple_8_x_3_maze
+    @maze.width.should eq 8
+  end
+
+  it 'should have a height of 3' do
+    given_a_simple_8_x_3_maze
+    @maze.height.should eq 3
+  end
+
+  it 'should be possible to visit an empty space' do
+    given_a_simple_8_x_3_maze
+    @maze.visitable?(0, 1).should be_true
+  end
+
+  it 'should not be possible to visit a wall' do
+    given_a_simple_8_x_3_maze
+    @maze.visitable?(0, 0).should be_false
+  end
+
+  it 'should not be possible to visit outside the maze' do
+    given_a_simple_8_x_3_maze
+    @maze.visitable?(8, 3).should be_false
+  end
+
+  it 'should not be possible to visit a visited space' do
+    given_a_simple_8_x_3_maze
+    @maze.visit 0, 1
+    @maze.visitable?(0, 1).should be_false
+  end
+
+  it 'should be possible to visit an unvisited space' do
+    given_a_simple_8_x_3_maze
+    @maze.visit 0, 1
+    @maze.unvisit 0, 1
+    @maze.visitable?(0, 1).should be_true
+  end
+
+  it 'should solve a simple maze' do
+    given_a_simple_8_x_3_maze
+    @maze.solve(0, 1, 7, 1).should be_true
+  end
+
+  it 'should solve a simple maze backwards' do
+    given_a_simple_8_x_3_maze
+    @maze.solve(7, 1, 0, 1).should be_true
+  end
+
+  it 'should solve a bigger maze' do
+    maze = MazeSolver::MazeSolver.new(from_grid: "********\n" +
+                          "  **   *\n" +
+                          "* ** * *\n" +
+                          "* *  * *\n" +
+                          "* ** * *\n" +
+                          "* **** *\n" +
+                          "*      *\n" +
+                          "********\n")
+    maze.solve(0, 1, 3, 3).should be_true
+  end
+
+  it 'should fail an impossible maze' do
+    maze = MazeSolver::MazeSolver.new(from_grid: "********\n" +
+                          "  **   *\n" +
+                          "* **** *\n" +
+                          "* *  * *\n" +
+                          "* ** * *\n" +
+                          "* **** *\n" +
+                          "*      *\n" +
+                          "********\n")
+    maze.solve(0, 1, 3, 3).should be_false
+  end
+
+  it 'should be printable' do
+    given_a_simple_8_x_3_maze
+    @maze.to_s.should eq "********\n" +
+      "        \n" +
+      '********'
+  end
+
+  it 'should be printable when solved' do
+    given_a_simple_8_x_3_maze
+    @maze.solve 0, 1, 7, 1
+    @maze.to_s.should eq "********\n" +
+      "........\n" +
+      '********'
+  end
+
+  it 'should be creatable from a file' do
+    maze = MazeSolver::MazeSolver.new(from_file: 'spec/test.maze')
+    maze.solve(18, 0, 12, 6).should be_true
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'maze_solver'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/test.maze

@@ -0,0 +1,7 @@
+****************** *
+*     *       **** *
+* ***** *****   ** *
+* ***** ******* ** *
+* *          ** ** *
+* ********** **    *
+************ *******

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: maze-solver
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pete Johns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies: []
+description: A gem to solve a 2D maze.
+email:
+- paj-github@johnsy.com
+executables:
+- maze-solver
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/maze-solver
+- etc/demo.maze
+- lib/maze_solver.rb
+- lib/maze_solver/version.rb
+- maze_solver.gemspec
+- spec/maze_spec.rb
+- spec/spec_helper.rb
+- spec/test.maze
+homepage: https://github.com/johnsyweb/ruby_maze_solver#readme
+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: Written as an exercise
+test_files:
+- spec/maze_spec.rb
+- spec/spec_helper.rb
+- spec/test.maze