maze-solver 1.0.0 → 1.0.1

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -4,5 +4,9 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'cane', '~> 2.6.0', require: false
+gem 'churn', '~> 0.0.29', require: false
+gem 'coveralls', require: false
+gem 'json', '~> 1.7.7'
 gem 'rake'
 gem 'rspec'

data/README.md

@@ -1,4 +1,4 @@
-# Maze Solver
+# Maze Solver [![Build Status](https://travis-ci.org/johnsyweb/ruby_maze_solver.png)](https://travis-ci.org/johnsyweb/ruby_maze_solver) [![Gem Version](https://badge.fury.io/rb/maze-solver.png)](http://badge.fury.io/rb/maze-solver) [![Dependency Status](https://gemnasium.com/johnsyweb/ruby_maze_solver.png)](https://gemnasium.com/johnsyweb/ruby_maze_solver) [![Code Climate](https://codeclimate.com/github/johnsyweb/ruby_maze_solver.png)](https://codeclimate.com/github/johnsyweb/ruby_maze_solver) [![Coverage Status](https://coveralls.io/repos/johnsyweb/ruby_maze_solver/badge.png?branch=master)](https://coveralls.io/r/johnsyweb/ruby_maze_solver?branch=master)
 
 Written as an exercise in applying Ruby, this project solves mazes:
 
@@ -24,19 +24,23 @@ Written as an exercise in applying Ruby, this project solves mazes:
 
 ## Installation
 
+Maze Solver is available from
+[RubyGems.org](https://rubygems.org/gems/maze-solver). Installation is simply:
+
     $ gem install maze-solver
 
 ## Usage
 
-    maze-solver filename start_x start_y end_x end_y
+    $ 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
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Ensure the tests pass for all Rubies in [`.travis.yml`](https://github.com/johnsyweb/ruby_maze_solver/blob/master/.travis.yml)
+1. Create new Pull Request
 
 ## Thanks
 

data/Rakefile

@@ -1,6 +1,29 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# encoding: utf-8
 
-RSpec::Core::RakeTask.new("spec")
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-task :default => :spec
+RSpec::Core::RakeTask.new('spec')
+task default: [:spec]
+
+begin
+  require 'cane/rake_task'
+
+  desc 'Run cane to check quality metrics'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 10
+    cane.no_style = true
+    cane.abc_exclude = %w(Foo::Bar#some_method)
+  end
+
+  task default: [:quality]
+rescue LoadError
+  warn 'cane not available, quality task not provided.'
+end
+
+begin
+  require 'churn'
+  task default: [:churn]
+rescue LoadError
+  warn 'churn not available, churn task not provided.'
+end

data/bin/maze-solver

@@ -23,5 +23,5 @@ if ARGV.length == 5
   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"
+  puts "Example: #{$PROGRAM_NAME} etc/demo.maze 18 0 38 0\n"
 end

data/lib/maze_solver.rb

@@ -4,6 +4,7 @@ require 'maze_solver/version'
 
 module MazeSolver
 
+  # Maze solver: solves a maze
   class MazeSolver
 
     def initialize(args = {})
@@ -12,6 +13,12 @@ module MazeSolver
       elsif args[:from_file]
         @grid = from_file(args[:from_file])
       end
+      pad_short_rows
+    end
+
+    def pad_short_rows
+      w = self.width
+      @grid.each { |row| row << ' ' * (w - row.length) if w > row.length }
     end
 
     def height
@@ -42,7 +49,7 @@ module MazeSolver
     def solve(start_x, start_y, end_x, end_y)
       return false unless visitable?(start_x, start_y)
 
-      visit start_x, start_y
+      visit(start_x, start_y)
 
       return true if [start_x, start_y] == [end_x, end_y]
 
@@ -61,7 +68,7 @@ module MazeSolver
     end
 
     def to_s
-      @grid.join("\n")
+      @grid.join("\n") << "\n"
     end
 
     def from_file(filename)
@@ -70,5 +77,4 @@ module MazeSolver
     end
 
   end
-
 end

data/lib/maze_solver/version.rb

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

data/spec/maze_solver_spec.rb

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe MazeSolver do
+  context 'a simple 8 x 3 maze' do
+    before do
+    @maze = MazeSolver::MazeSolver.new(from_grid: <<-GRID
+********
+
+********
+GRID
+      )
+    end
+
+    specify { @maze.width.should eq 8 }
+    specify { @maze.height.should eq 3 }
+
+    it 'should be possible to visit an empty space' do
+      @maze.should be_visitable(0, 1)
+    end
+
+    it 'should not be possible to visit a wall' do
+      @maze.should_not be_visitable(0, 0)
+    end
+
+    it 'should not be possible to visit outside the maze' do
+      @maze.should_not be_visitable(8, 3)
+    end
+
+    it 'should not be possible to visit a visited space' do
+      @maze.visit(0, 1)
+      @maze.should_not be_visitable(0, 1)
+    end
+
+    it 'should be possible to visit an unvisited space' do
+      @maze.visit(0, 1)
+      @maze.unvisit(0, 1)
+      @maze.should be_visitable(0, 1)
+    end
+
+    it 'should be soluble' do
+      @maze.solve(0, 1, 7, 1).should be_true
+    end
+
+    it 'should be soluble backwards' do
+      @maze.solve(7, 1, 0, 1).should be_true
+    end
+
+    it 'should be printable' do
+      @maze.to_s.should eq "********\n" +
+        "        \n" +
+        "********\n"
+    end
+
+    it 'should be printable when solved' do
+      @maze.solve(0, 1, 7, 1)
+      @maze.to_s.should eq <<-GRID
+********
+........
+********
+      GRID
+    end
+
+  end
+
+  context 'a bigger maze' do
+    it 'should be soluble' do
+      maze = MazeSolver::MazeSolver.new(from_grid: <<-GRID
+********
+  **   *
+* ** * *
+* *  * *
+* ** * *
+* **** *
+*      *
+********
+GRID
+      )
+      maze.solve(0, 1, 3, 3).should be_true
+    end
+  end
+
+  context 'an impossible maze' do
+    it 'should be insoluble' do
+      maze = MazeSolver::MazeSolver.new(from_grid: <<-GRID
+********
+  **   *
+* **** *
+* *  * *
+* ** * *
+* **** *
+*      *
+********
+GRID
+      )
+      maze.solve(0, 1, 3, 3).should be_false
+    end
+  end
+
+  context 'from file' do
+    before do
+      test_maze = StringIO.new(<<-DOC
+****************** *
+*     *       **** *
+* ***** *****   ** *
+* ***** ******* ** *
+* *          ** ** *
+* ********** **    *
+************ *******
+DOC
+      )
+      File.stub(:open).with('test.maze', 'r').and_return(test_maze)
+    end
+
+    it 'should be creatable' do
+      maze = MazeSolver::MazeSolver.new(from_file: 'test.maze')
+      maze.solve(18, 0, 12, 6).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 # encoding: UTF-8
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'rubygems'
 require 'bundler/setup'
 require 'maze_solver'
@@ -7,6 +10,5 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maze-solver
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies: []
 description: A gem to solve a 2D maze.
 email:
@@ -19,8 +19,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -30,9 +32,8 @@ files:
 - lib/maze_solver.rb
 - lib/maze_solver/version.rb
 - maze_solver.gemspec
-- spec/maze_spec.rb
+- spec/maze_solver_spec.rb
 - spec/spec_helper.rb
-- spec/test.maze
 homepage: https://github.com/johnsyweb/ruby_maze_solver#readme
 licenses: []
 post_install_message: 
@@ -58,6 +59,5 @@ signing_key:
 specification_version: 3
 summary: Written as an exercise
 test_files:
-- spec/maze_spec.rb
+- spec/maze_solver_spec.rb
 - spec/spec_helper.rb
-- spec/test.maze

data/spec/maze_spec.rb

@@ -1,106 +0,0 @@
-# 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/test.maze

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