xo 0.0.1 → 1.0.0

data/spec/xo/grid_spec.rb

@@ -4,135 +4,231 @@ module XO
 
   describe Grid do
 
-    it 'has 3 rows' do
+    it "defines X" do
+      Grid::X.must_equal :x
+    end
+
+    it "defines O" do
+      Grid::O.must_equal :o
+    end
+
+    it "has 3 rows" do
       Grid::ROWS.must_equal 3
     end
 
-    it 'has 3 columns' do
+    it "has 3 columns" do
       Grid::COLS.must_equal 3
     end
 
-    it 'contains all r, c where r is in {1, 2, 3} and c is in {1, 2, 3}' do
-      (1..3).each do |r|
-        (1..3).each do |c|
-          Grid.contains?(r, c).must_equal true
+    it "has 9 positions" do
+      Grid::N.must_equal 9
+    end
+
+    describe ".contains?" do
+
+      it "contains all r, c where r is in {1, 2, 3} and c is in {1, 2, 3}" do
+        (1..3).each do |r|
+          (1..3).each do |c|
+            Grid.contains?(r, c).must_equal true
+          end
+        end
+      end
+
+      it "does not contain any r, c where either r is not in {1, 2, 3} or c is not in {1, 2, 3}" do
+        [[0, 0], [0, 1], [0, 2], [0, 3], [0, 4],
+         [1, 0],                         [1, 4],
+         [2, 0],                         [2, 4],
+         [3, 0],                         [3, 4],
+         [4, 0], [4, 1], [4, 2], [4, 3], [4, 4]].each do |pos|
+          Grid.contains?(*pos).must_equal false
+        end
+      end
+    end
+
+    describe ".is_token?" do
+
+      it "returns true for an X" do
+        Grid.is_token?(Grid::X).must_equal true
+      end
+
+      it "returns true for an O" do
+        Grid.is_token?(Grid::O).must_equal true
+      end
+
+      it "returns false otherwise" do
+        [nil, :e, '', ' '].each do
+          Grid.is_token?(:e).must_equal false
         end
       end
     end
 
-    it 'does not contain any r, c where either r is not in {1, 2, 3} or c is not in {1, 2, 3}' do
-      [[0, 0], [0, 1], [0, 2], [0, 3], [0, 4],
-       [1, 0],                         [1, 4],
-       [2, 0],                         [2, 4],
-       [3, 0],                         [3, 4],
-       [4, 0], [4, 1], [4, 2], [4, 3], [4, 4]].each do |pos|
-        Grid.contains?(*pos).must_equal false
+    describe ".other_token" do
+
+      it "returns O given X" do
+        Grid.other_token(Grid::X).must_equal Grid::O
+      end
+
+      it "returns X given O" do
+        Grid.other_token(Grid::O).must_equal Grid::X
+      end
+
+      it "returns the same value it was given otherwise" do
+        Grid.other_token(:something_else).must_equal :something_else
       end
     end
 
     let(:grid) { Grid.new }
 
-    describe 'a new grid' do
+    describe "an initial grid" do
 
-      it 'is empty' do
+      it "is empty" do
         grid.empty?.must_equal true
       end
     end
 
-    describe '#dup' do
+    describe "#new" do
 
-      it 'creates a copy' do
-        grid[1, 1] = X
+      it "can create a grid from a string" do
+        grid = Grid.new('xox o')
 
-        grid_copy = grid.dup
-        grid_copy[1, 1] = O
+        grid[1, 1].must_equal Grid::X
+        grid[1, 2].must_equal Grid::O
+        grid[1, 3].must_equal Grid::X
+        grid[2, 2].must_equal Grid::O
 
-        grid[1, 1].must_equal X
+        [[2, 1], [2, 3], [3, 1], [3, 2], [3, 3]].each do |pos|
+          grid.open?(*pos).must_equal true
+        end
       end
-    end
 
-    describe '#empty?' do
+      it "only considers the first 9 characters" do
+        grid = Grid.new('         xoxoxoxox')
 
-      it 'returns false when at least one position has a token' do
-        grid[1, 1] = X
-        grid.empty?.must_equal false
+        grid.empty?.must_equal true
+      end
+
+      it "can create a grid given exactly 9 characters" do
+        grid = Grid.new('xoxoxoxox')
+
+        grid.full?.must_equal true
       end
     end
 
-    describe '#[]=' do
+    describe "#dup" do
+
+      it "creates a copy" do
+        grid[1, 1] = Grid::X
 
-      it 'raises IndexError when a token is placed at a position it does not contain' do
-        proc { grid[0, 0] = X }.must_raise IndexError
+        grid_copy = grid.dup
+        grid_copy[1, 1] = Grid::O
+
+        grid_copy[1, 1].must_equal Grid::O
+        grid[1, 1].must_equal Grid::X
       end
     end
 
-    describe '#[]' do
+    describe "#empty?" do
 
-      it 'raises IndexError when given a position it does not contain' do
-        proc { grid[4, 4] }.must_raise IndexError
+      it "returns false when at least one position has a token" do
+        grid[1, 2] = Grid::X
+        grid.empty?.must_equal false
+      end
+
+      it "returns true otherwise" do
+        grid.empty?.must_equal true
       end
     end
 
-    describe '#full?' do
+    describe "#full?" do
 
       before do
         (1..3).each do |r|
           (1..3).each do |c|
-            grid[r, c] = O
+            grid[r, c] = Grid::O
           end
         end
       end
 
-      it 'returns true when every position has a token' do
+      it "returns true when every position has a token" do
         grid.full?.must_equal true
       end
 
-      it 'returns false when at least one position does not have a token' do
-        grid[1, 1] = :e
+      it "returns false when at least one position doesn't have a token" do
+        grid[1, 3] = :e
         grid.full?.must_equal false
       end
     end
 
-    describe '#free?' do
+    describe "#[]=" do
+
+      it "sets a position to X, O or :e" do
+        grid[2, 1] = Grid::X
+        grid[2, 1].must_equal Grid::X
+
+        grid[2, 2] = Grid::O
+        grid[2, 2].must_equal Grid::O
+
+        grid[2, 3] = :anything_else
+        grid[2, 3].must_equal :e
+      end
+
+      it "raises IndexError when the position is off the grid" do
+        proc { grid[0, 0] = Grid::X }.must_raise IndexError
+      end
+    end
+
+    describe "#[]" do
+
+      it "raises IndexError when the position is off the grid" do
+        proc { grid[4, 4] }.must_raise IndexError
+      end
+    end
+
+    describe "#open?" do
 
-      it 'returns true when no token is at the given position' do
-        grid.free?(2, 2).must_equal true
+      it "returns true when no token is at the given position" do
+        grid.open?(2, 2).must_equal true
       end
 
-      it 'returns false when a token is at the given position' do
-        grid[3, 1] = O
-        grid.free?(3, 1).must_equal false
+      it "returns false when a token is at the given position" do
+        grid[2, 3] = Grid::O
+        grid.open?(2, 3).must_equal false
       end
 
-      it 'raises IndexError when given a position the grid does not contain' do
-        proc { grid.free?(0, 4) }.must_raise IndexError
+      it "raises IndexError when the position is off the grid" do
+        proc { grid.open?(0, 4) }.must_raise IndexError
       end
     end
 
-    describe '#clear' do
+    describe "#clear" do
 
-      it 'empties the grid' do
-        grid[1, 1] = X
-        grid[1, 3] = O
-        grid[3, 2] = X
+      it "removes all tokens from the grid" do
+        grid[3, 1] = Grid::X
+        grid[3, 2] = Grid::O
+        grid[3, 3] = Grid::X
 
         grid.clear
 
         grid.empty?.must_equal true
       end
+
+      it "returns self" do
+        grid.clear.must_be_same_as grid
+      end
     end
 
-    describe '#each' do
+    describe "#each" do
 
       it "visits every position and yields a block that takes the position's row, column and value" do
-        grid[1, 1] = O
-        grid[2, 2] = X
-        grid[3, 3] = O
+        grid[1, 1] = Grid::O
+        grid[2, 2] = Grid::X
+        grid[3, 3] = Grid::O
 
         visited = {}
 
         grid.each do |r, c, val|
-          # ensure that the value for the position is correct
+          # ensure that the position (r, c) is contained within the grid and
+          # ensure that the value at the position is correct
           grid[r, c].must_equal val
 
           # keep track of every position we visit
@@ -142,5 +238,52 @@ module XO
         visited.keys.size.must_equal(Grid::ROWS * Grid::COLS)
       end
     end
+
+    describe "#each_open" do
+
+      it "visits every open position and yields a block that takes the position's row and column" do
+        grid[1, 3] = Grid::X
+        grid[2, 2] = Grid::O
+        grid[3, 1] = Grid::X
+
+        visited = {}
+
+        grid.each_open do |r, c|
+          visited[[r, c]] = true
+        end
+
+        visited.keys.size.must_equal(Grid::ROWS * Grid::COLS - 3)
+
+        [[1, 1], [1, 2], [2, 1], [2, 3], [3, 2], [3, 3]].each do |pos|
+          visited.key?(pos)
+        end
+      end
+    end
+
+    describe "#inspect" do
+
+      it "returns a single line string representation of the grid" do
+        grid[1, 1] = grid[1, 3] = Grid::X
+        grid[1, 2] = grid[3, 3] = Grid::O
+
+        grid.inspect.must_equal "xox     o"
+      end
+    end
+
+    describe "#to_s" do
+
+      it "returns a multiline string representation of the grid" do
+        grid[2, 1] = grid[2, 3] = Grid::X
+        grid[1, 2] = grid[2, 2] = Grid::O
+
+        grid.to_s.must_equal [
+          "   | o |   ",
+          "---+---+---",
+          " x | o | x ",
+          "---+---+---",
+          "   |   |   "
+        ].join("\n")
+      end
+    end
   end
 end

data/xo.gemspec

@@ -18,6 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake', '~> 10.1', '>= 10.1.0'
-  spec.add_development_dependency 'minitest', '~> 5.3', '>= 5.3.2'
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'minitest', '~> 5.3'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+
+  # For documentation
+  spec.add_development_dependency 'redcarpet', '~> 3.1'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

metadata

@@ -1,77 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: xo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Dwayne R. Crooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '10.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.1'
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.3'
-    - - ">="
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 5.3.2
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: A Ruby library that can be used to develop Tic-tac-toe game clients.
 email:
 - me@dwaynecrooks.com
-executables: []
+executables:
+- xo
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/xo
 - lib/xo.rb
 - lib/xo/ai.rb
-- lib/xo/ai/advanced_beginner.rb
-- lib/xo/ai/expert.rb
+- lib/xo/ai/geometric_grid.rb
 - lib/xo/ai/minimax.rb
-- lib/xo/ai/novice.rb
 - lib/xo/engine.rb
 - lib/xo/evaluator.rb
 - lib/xo/grid.rb
 - lib/xo/version.rb
 - spec/spec_helper.rb
+- spec/xo/ai/geometric_grid_spec.rb
 - spec/xo/ai/minimax_spec.rb
 - spec/xo/engine_spec.rb
 - spec/xo/evaluator_spec.rb
@@ -87,12 +121,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -103,7 +137,9 @@ specification_version: 4
 summary: A Ruby library for Tic-tac-toe.
 test_files:
 - spec/spec_helper.rb
+- spec/xo/ai/geometric_grid_spec.rb
 - spec/xo/ai/minimax_spec.rb
 - spec/xo/engine_spec.rb
 - spec/xo/evaluator_spec.rb
 - spec/xo/grid_spec.rb
+has_rdoc: