Added proper unittest; bumped version

JohnAD · Oct 6, 2019 · 5f0791d · 5f0791d
1 parent 688e255
commit 5f0791d
Show file tree

Hide file tree

Showing 9 changed files with 202 additions and 63 deletions.
diff --git a/README.rst b/README.rst
@@ -1,6 +1,6 @@
 Introduction to turn_based_game
 ==============================================================================
-ver 1.1.3
+ver 1.1.4
 
 .. image:: https://raw.githubusercontent.com/yglukhov/nimble-tag/master/nimble.png
    :height: 34

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,6 @@
 Introduction to turn_based_game
 ==============================================================================
-ver 1.1.3
+ver 1.1.4
 
 This framework encapsulates the critical information (rules) needed for
 playing or simulating a turn-based game.

diff --git a/docs/turn_based_game-ref.rst b/docs/turn_based_game-ref.rst
@@ -29,10 +29,13 @@ Game
 
     For example:
 
+
     .. code:: nim
+    
         type
           GameOfThai21 = ref object of Game
             pile*: int
+    
 
 
 .. _Player.type:
@@ -45,7 +48,7 @@ Player
           name*: string
 
 
-    source line: `156 <../src/turn_based_game.nim#L156>`__
+    source line: `159 <../src/turn_based_game.nim#L159>`__
 
     The default player object. If used directly, the Player object
     is simply the end user playing the game from the OS's text console.
@@ -70,7 +73,7 @@ current_player
 
         method current_player*(self: Game) : Player {.base.} =
 
-    source line: `244 <../src/turn_based_game.nim#L244>`__
+    source line: `247 <../src/turn_based_game.nim#L247>`__
 
     Return the Player whose turn it is to play
 
@@ -83,7 +86,7 @@ default_setup
 
         method default_setup*(self: Game, players: seq[Player]) {.base.} =
 
-    source line: `340 <../src/turn_based_game.nim#L340>`__
+    source line: `348 <../src/turn_based_game.nim#L348>`__
 
     This is the default setup for Game. You are welcome to call it when writing
     the ``setup`` method.
@@ -98,6 +101,27 @@ default_setup
         self.winner_player_number = 0
 
 
+.. _determine_winner.e:
+determine_winner
+---------------------------------------------------------
+
+    .. code:: nim
+
+        method determine_winner*(self: Game) {.base.} =
+
+    source line: `303 <../src/turn_based_game.nim#L303>`__
+
+    Given the current state of the game, determine who the winner is, if there
+    is a winner.
+
+    If running a game manually (avoiding the .play method), it is expected that
+    this method is run BEFORE the turn finishes. If a winning condition is detected,
+    the current player is generally assumed to be the winner that caused that
+    condition.
+
+    See: https://github.com/JohnAD/turn_based_game/wiki/Game-Object-Methods#determine_winner
+
+
 .. _finish_turn.e:
 finish_turn
 ---------------------------------------------------------
@@ -106,7 +130,7 @@ finish_turn
 
         method finish_turn*(self: Game) {.base.} =
 
-    source line: `266 <../src/turn_based_game.nim#L266>`__
+    source line: `269 <../src/turn_based_game.nim#L269>`__
 
     Cleanup anything in the current turn and start the next turn.
 
@@ -122,7 +146,7 @@ get_move
 
         method get_move*(self: Player, game: Game): string {.base.} =
 
-    source line: `188 <../src/turn_based_game.nim#L188>`__
+    source line: `191 <../src/turn_based_game.nim#L191>`__
 
 
 
@@ -134,7 +158,7 @@ get_state
 
         method get_state*(self: Game): string {.base.} =
 
-    source line: `316 <../src/turn_based_game.nim#L316>`__
+    source line: `324 <../src/turn_based_game.nim#L324>`__
 
     Returns a string that is encoded to represent the current game, including who
     the current player is.
@@ -151,7 +175,7 @@ is_over
 
         method is_over*(self: Game): bool {.base.} =
 
-    source line: `285 <../src/turn_based_game.nim#L285>`__
+    source line: `288 <../src/turn_based_game.nim#L288>`__
 
     Return whether or not the game is over.
 
@@ -164,7 +188,7 @@ make_move
 
         method make_move*(self: Game, move: string): string {.base.} =
 
-    source line: `274 <../src/turn_based_game.nim#L274>`__
+    source line: `277 <../src/turn_based_game.nim#L277>`__
 
     Given a move (from ``set_possible_moves``), apply that move
     to the game.
@@ -183,9 +207,9 @@ next_player_number
 
         method next_player_number*(self: Game): int {.base.} =
 
-    source line: `261 <../src/turn_based_game.nim#L261>`__
+    source line: `264 <../src/turn_based_game.nim#L264>`__
 
-    Return the index to the next player.
+    Return the number to the next player.
 
 
 .. _play.e:
@@ -196,7 +220,7 @@ play
 
         method play*(self: Game) : seq[string] {.base discardable.} =
 
-    source line: `359 <../src/turn_based_game.nim#L359>`__
+    source line: `367 <../src/turn_based_game.nim#L367>`__
 
     Start and run the game. Unless this method is overriden, this plays
     the game from the text console.
@@ -210,7 +234,7 @@ restore_state
 
         method restore_state*(self: Game, state: string): void  {.base.} =
 
-    source line: `325 <../src/turn_based_game.nim#L325>`__
+    source line: `333 <../src/turn_based_game.nim#L333>`__
 
     Decodes the string to reset the game to the state encoded in the string.
 
@@ -226,26 +250,14 @@ scoring
 
         method scoring*(self: Game): float {.base.} =
 
-    source line: `308 <../src/turn_based_game.nim#L308>`__
+    source line: `316 <../src/turn_based_game.nim#L316>`__
 
     Return a score reflecting the advantage to the current player.
 
     This method is not actually used by this library; but is used by some
     external AI libraries.
 
 
-.. _set_possible_moves.e:
-set_possible_moves
----------------------------------------------------------
-
-    .. code:: nim
-
-        method set_possible_moves*(self: Game, moves: var OrderedTable[string, string]) {.base.}
-
-    source line: `173 <../src/turn_based_game.nim#L173>`__
-
-
-
 .. _set_possible_moves.e:
 set_possible_moves
 ---------------------------------------------------------
@@ -254,24 +266,12 @@ set_possible_moves
 
         method set_possible_moves*(self: Game, moves: var OrderedTable[string, string]) {.base.} =
 
-    source line: `238 <../src/turn_based_game.nim#L238>`__
+    source line: `241 <../src/turn_based_game.nim#L241>`__
 
     Set the current possible moves of the game.
     See https://github.com/JohnAD/turn_based_game/wiki/Game-Object-Methods#set_possible_moves
 
 
-.. _set_possible_moves.e:
-set_possible_moves
----------------------------------------------------------
-
-    .. code:: nim
-
-        method set_possible_moves*(self: Game, moves: var seq[string]) {.base.}
-
-    source line: `174 <../src/turn_based_game.nim#L174>`__
-
-
-
 .. _set_possible_moves.e:
 set_possible_moves
 ---------------------------------------------------------
@@ -280,7 +280,7 @@ set_possible_moves
 
         method set_possible_moves*(self: Game, moves: var seq[string]) {.base.} =
 
-    source line: `232 <../src/turn_based_game.nim#L232>`__
+    source line: `235 <../src/turn_based_game.nim#L235>`__
 
     Set the current possible moves of the game.
     See https://github.com/JohnAD/turn_based_game/wiki/Game-Object-Methods#set_possible_moves
@@ -294,25 +294,13 @@ setup
 
         method setup*(self: Game, players: seq[Player]) {.base.} =
 
-    source line: `333 <../src/turn_based_game.nim#L333>`__
+    source line: `341 <../src/turn_based_game.nim#L341>`__
 
     Setup the board; resetting all state for a new game.
 
     See https://github.com/JohnAD/turn_based_game/wiki/Game-Object-Methods#setup
 
 
-.. _status.e:
-status
----------------------------------------------------------
-
-    .. code:: nim
-
-        method status*(self: Game): string {.base.}
-
-    source line: `175 <../src/turn_based_game.nim#L175>`__
-
-
-
 .. _status.e:
 status
 ---------------------------------------------------------
@@ -321,7 +309,7 @@ status
 
         method status*(self: Game): string {.base.} =
 
-    source line: `290 <../src/turn_based_game.nim#L290>`__
+    source line: `293 <../src/turn_based_game.nim#L293>`__
 
     Return a status of the game overrall. By default, it simply returns either
     "game is over" or "game is active". Override this method for something
@@ -336,7 +324,7 @@ winning_player
 
         method winning_player*(self: Game) : Player {.base.} =
 
-    source line: `249 <../src/turn_based_game.nim#L249>`__
+    source line: `252 <../src/turn_based_game.nim#L252>`__
 
     Return the Player who is the winner.
     If there is no winner, a "false" Player is returned with the name

diff --git a/src/turn_based_game.nim b/src/turn_based_game.nim
@@ -144,10 +144,13 @@ type
     ## 
     ## For example:
     ## 
+    ##
     ## .. code:: nim
+    ##
     ##     type
     ##       GameOfThai21 = ref object of Game
     ##         pile*: int
+    ##
     player_count*: int
     players*: seq[Player]
     current_player_number*: int  # 1, 2, 3,... but 0 is never used
@@ -170,9 +173,9 @@ const
 # the following prototypes are needed to allow mutual recursion of methods
 #   It is properly defined later.
 # method possible_moves_seq*(self: Game): seq[string] {.base.}
-method set_possible_moves*(self: Game, moves: var OrderedTable[string, string]) {.base.}
-method set_possible_moves*(self: Game, moves: var seq[string]) {.base.}
-method status*(self: Game): string {.base.}
+method set_possible_moves*(self: Game, moves: var OrderedTable[string, string]) {.base.}  #SKIP!
+method set_possible_moves*(self: Game, moves: var seq[string]) {.base.}  #SKIP!
+method status*(self: Game): string {.base.}  #SKIP!
 
 # ######################################
 #
@@ -259,7 +262,7 @@ method winning_player*(self: Game) : Player {.base.} =
 
 
 method next_player_number*(self: Game): int {.base.} =
-  ## Return the index to the next player.
+  ## Return the number to the next player.
   (self.current_player_number %% self.player_count) + 1
 
 
@@ -297,10 +300,15 @@ method status*(self: Game): string {.base.} =
     return "game is active"
 
 
-method determine_winner(self: Game) {.base.} =
+method determine_winner*(self: Game) {.base.} =
   ## Given the current state of the game, determine who the winner is, if there
   ## is a winner.
   ## 
+  ## If running a game manually (avoiding the .play method), it is expected that
+  ## this method is run BEFORE the turn finishes. If a winning condition is detected,
+  ## the current player is generally assumed to be the winner that caused that
+  ## condition.
+  ## 
   ## See: https://github.com/JohnAD/turn_based_game/wiki/Game-Object-Methods#determine_winner
   raise newException(FieldError, "determine_winner() must be overridden")
 

diff --git a/tests/examplegame.nim b/tests/examplegame.nim
@@ -0,0 +1,44 @@
+#
+# Game of Thai 21 example
+#
+# Description: Twenty one flags are placed on a beach. Each player takes a turn
+# removing between 1 and 3 flags. The player that removes the last remaining flag wins.
+#
+# This game was introduced by an episode of Survivor: http://survivor-org.wikia.com/wiki/21_Flags
+#
+
+import strutils
+import turn_based_game
+import tables
+
+type
+  GameOfThai21* = ref object of Game
+    pile*: int
+
+method setup*(self: GameOfThai21, players: seq[Player]) =
+  self.default_setup(players)
+  self.pile = 21
+
+method set_possible_moves*(self: GameOfThai21, moves: var OrderedTable[string, string]) =
+  if self.pile==1:
+    moves = {"1": "Take One"}.toOrderedTable
+  elif self.pile==2:
+    moves = {"1": "Take One", "2": "Take Two"}.toOrderedTable
+  else:
+    moves = {"1": "Take One", "2": "Take Two", "3": "Take Three"}.toOrderedTable
+
+method make_move*(self: GameOfThai21, move: string): string =
+  var count = move.parseInt()
+  self.pile -= count  # remove bones.
+  return "$# flags removed.".format([count])
+
+method determine_winner*(self: GameOfThai21) =
+  if self.winner_player_number > 0:
+    return
+  if self.pile <= 0:
+    self.winner_player_number = self.current_player_number
+
+# the following method is not _required_, but makes it nicer to read
+method status*(self: GameOfThai21): string =
+  "$# flags available.".format([self.pile])
+
diff --git a/tests/nim.cfg b/tests/nim.cfg
@@ -0,0 +1 @@
+--path:"../src/"
diff --git a/tests/test1.nim b/tests/test1.nim
diff --git a/tests/test1.nims b/tests/test1.nims