x_and_os 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26abf99b399b44f43e52de5048bf505d0ba28db0
-  data.tar.gz: 5f50b16285f9519b984be7590adbf5ac829c5001
+  metadata.gz: 0443f74019385ca1eb86756fa71d1aa789421ab2
+  data.tar.gz: 6bf57de3a7dda66671b2a214cd4aaab3c8e3fdd2
 SHA512:
-  metadata.gz: f8ab4f63dcd2fbdfd5f8388a2f9aafd6897a6773c6d23e4fa13fceb14011c613aba05a10af180f95eaa233656dcd87ea57f25d6170ab6cc2121f36664c042159
-  data.tar.gz: 2a47b86dc429bfeaf25ef08a3c9caabb358d6a39e32d8e3e6c23d7dc7385f0ca417ce5a0b29cf49cab4d5d4f1d6e4799e11a987f93828c09363f6f501842602a
+  metadata.gz: f6049143108f22d87912abc75ffad31117f4d733131639f01081c06ab0e5879c551ceab2ea88a252d4f01cb6e40ad1ac404ee00ba31528d270e6161ee82fa855
+  data.tar.gz: 8258c7b4a716be3f82e2bc9ba15ee40f5fbef088831dcd3aec47d6d53c190db6c95926d2d38cd7a0cb37a9fce53b02fce45fe1cd8f3bbc410d0fc98908d72f14

data/README.md

@@ -1,7 +1,7 @@
 # XAndOs
 
-XAndOs provides the basic structure and game logic to easily create the game Tic Tac Toe.
-It also comes with a mini CLA to play Tic Tac Toe in the command line. 
+x_and_os provides the basic structure and game logic to easily create a Tic Tac Toe game.
+It also comes with a mini command line app to play Tic Tac Toe / x and os. 
 
 ## Installation
 
@@ -21,16 +21,112 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
+require 'x_and_os'
+```
+
 ### Game
-  TODO
+Used to manage the basic state of game.
+
+Initialize a new game with:
+
+```ruby
+XAndOS::Game.new
+```
+or
+
+```ruby
+include XAndOs
+
+Game.new
+
+```
+By default `Game.new` will create a new game object that uses the XAndOs::Board that has 3rows and 3columns.
+
+It is possible to set rows and columns
+when instantiating a new game
+
+```ruby
+XAndOs::Game.new(rows: 4, columns: 3)
+
+```
+
+If you wish to use a different game board (not recommended):
+
+```ruby
+custom_game_board = Board.new
+
+XAndOs::Game.new(board: custom_game_board)
+```
+
+#### game API
+
+`add_move` takes a cell number and a marker(optional) to put in the cell.
+
+```ruby
+@game = XAndOs::Game.new
+
+@game.add_move(5, 'x') 
+@game.add_move(1, 'o') 
+```
+or
+
+```ruby
+@game.add_move(5) 
+@game.add_move(1) 
+
+```
+Will result in a board with a grid that looks like this.
+
+```ruby
+@game.board.grid # [['o',' ',' '],
+                 #  [' ','x',' '],
+                 #  [' ',' ',' ']]
+```
+
+Cell numbers map left to right as such :
+```
+[[1,2,3],
+ [4,5,6],
+ [7,8,9]]
+```
+
+
+`get_marker` returns the value of the next marker 'X' or 'O' depending on number of turns made. First move is always 'X'
+
+`winner?` returns `true` if there is a complete line e.g
+
+```
+# x |   | o
+# -------- 
+# o | x |  
+# -------- 
+#   |   | x 
+```
+
+
+`draw?` will return `true` when there are no moves available.
+
+
 ### Board
   TODO
 ### Game Mastery
   TODO
 
 ### Command Line App
-You can use XAndOs to play Tic Tac Toe in the command line
-`x_and_os`
+You can use x_and_os to play Tic Tac Toe / X and Os in the command line.
+
+After installing the gem run :
+
+    $ x_and_os
+
+And then follow the menu options.
+
+- Quick game sets up a You vs Computer on 3x3 game board.
+- settings allows the user to 
+  - pick two players (either player(human) or computer)
+  - choose a grid size to play on. e.g 3x3 or 5x5 
+- The computer player uses the GameMaster class to be make the best possible moves (unbeatable on 3x3 board)
 
 ## Development
 

data/lib/x_and_os/game_master.rb

@@ -12,7 +12,7 @@ module XAndOs
       move = win || block || fork_move || force_block || block_fork
       return move if move
 
-      if first_move
+      if first_move?
         1
       else
         center || corner || available_moves.sample
@@ -50,10 +50,10 @@ module XAndOs
     end
 
     def opponent_moves
-      (1..9).to_a - (moves_made + available_moves)
+      (1..total_cells).to_a - (moves_made + available_moves)
     end
 
-    def first_move
+    def first_move?
       available_moves.size == total_cells
     end
 
@@ -130,9 +130,14 @@ module XAndOs
     end
 
     def corner_moves
-      # To be improved to dynamically work out corners
-      # and move logic to board
-      [1,3,7,9]
+      total_columns = mastery_board.columns
+
+      top_left      = 1
+      top_right     = mastery_board.columns
+      bottom_left   = (total_cells - total_columns) + 1
+      bottom_right  = total_cells
+
+      [top_left, top_right, bottom_left, bottom_right]
     end
     
   end

data/lib/x_and_os/version.rb

@@ -1,3 +1,3 @@
 module XAndOs
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x_and_os
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jonny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler