ColoredLines: Renamed GameState -> UpperGameState.

Author: Daniel Barclay

…coloredlines/manual/game/GameState.scala …edlines/manual/game/UpperGameState.scalasrc/main/scala/com/us/dsb/explore/algs/coloredlines/manual/game/GameState.scala renamed to src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/game/UpperGameState.scala src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/game/GameState.scala renamed to src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/game/UpperGameState.scala

@@ -4,13 +4,12 @@ import cats.syntax.option._
 import cats.syntax.either._
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.CellAddress
 import com.us.dsb.explore.algs.coloredlines.manual.game.GameLogicSupport.MoveResult
-import com.us.dsb.explore.algs.coloredlines.manual.game.GameState.GameResult.Done
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.{BallKind, BoardPlus}
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.{ColumnIndex, RowIndex}
 
 import scala.util.Random
 
-private[manual] object GameState {
+private[manual] object UpperGameState {
 
   /**
    * Result of completed game.
@@ -20,35 +19,35 @@ private[manual] object GameState {
     private[manual] case class Done(score: Int) extends GameResult
   }
 
-  private[this] def makeInitialState(implicit rng: Random): GameState = {
+  private[this] def makeInitialState(implicit rng: Random): UpperGameState = {
     val initialPlacementResult = GameLogicSupport.placeInitialBalls(BoardPlus.empty)
     //????? probably split GameState level from slightly lower game state
     //  carrying board plus score (probably modifying MoveResult for that)
-    GameState(initialPlacementResult.boardPlus, None)
+    UpperGameState(initialPlacementResult.boardPlus, None)
   }
 
-  private[manual/*game*/] def initial(seed: Long): GameState = makeInitialState(new Random(seed))
-  private[manual] def initial(): GameState = makeInitialState(new Random())
+  private[manual/*game*/] def initial(seed: Long): UpperGameState = makeInitialState(new Random(seed))
+  private[manual] def initial(): UpperGameState = makeInitialState(new Random())
 }
-import GameState._
+import UpperGameState._
 
 //???? add random-data state
 
 /** Game state AND currently controller.
  * @constructor
  * @param gameResult  `None` means no win or draw yet
  */
-private[manual] case class GameState(boardPlus: BoardPlus,
-                                     gameResult: Option[GameResult]
-                                    )(implicit rng: Random) {
+private[manual] case class UpperGameState(boardPlus: BoardPlus,
+                                          gameResult: Option[GameResult]
+                                         )(implicit rng: Random) {
 
   //????? Probably move to GameLogicSupport
 
   // ?? later refine from Either[String, ...] to "fancier" error type
   // Xx?? maybe add result of move (win/draw/other) with new state (so caller
   //  doesn't have to check state's gameResult; also, think about where I'd add
   //  game history
-  private[manual] def tryMoveAt(tapAddress: CellAddress): Either[String, GameState] = {
+  private[manual] def tryMoveAt(tapAddress: CellAddress): Either[String, UpperGameState] = {
     import GameLogicSupport.Action._
     val tapAction = GameLogicSupport.interpretTapLocationToTapAction(boardPlus, tapAddress)
     println("tryMoveAt: tapAction = " + tapAction)
@@ -76,10 +75,10 @@ private[manual] case class GameState(boardPlus: BoardPlus,
 
     val nextState =
       if (! moveResult.boardPlus.isFull) {
-        GameState(moveResult.boardPlus, gameResult).asRight
+        UpperGameState(moveResult.boardPlus, gameResult).asRight
       }
       else {
-        GameState(moveResult.boardPlus, Some(Done(moveResult.boardPlus.getScore))).asRight
+        UpperGameState(moveResult.boardPlus, Some(GameResult.Done(moveResult.boardPlus.getScore))).asRight
       }
     nextState
   }

src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/ui/GameUI.scala

@@ -2,7 +2,7 @@ package com.us.dsb.explore.algs.coloredlines.manual.ui
 
 import cats.syntax.option._
 import cats.syntax.either._
-import com.us.dsb.explore.algs.coloredlines.manual.game.GameState
+import com.us.dsb.explore.algs.coloredlines.manual.game.UpperGameState
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.{ColumnIndex, Index, RowIndex}
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.CellAddress
 import enumeratum.{Enum, EnumEntry}
@@ -124,7 +124,7 @@ private[manual] object GameUI {
           case None => // game not done yet (after valid _or_ invalid mark try)
             newState.asRight
           case Some(gameResult) =>
-            import GameState.GameResult._
+            import UpperGameState.GameResult._
             val resultText =
               gameResult match {
                 case result: Done => s"Done: $result"
@@ -167,7 +167,7 @@ private[manual] object GameUI {
 
   def runGame(io: SegregatedTextIO): GameUIResult = {
     val initialState =
-      GameUIState(gameState     = GameState.initial(),
+      GameUIState(gameState     = UpperGameState.initial(),
                   cursorAddress = CellAddress.fromRaw(1, 1))
     getAndDoUiCommands(io, initialState)
   }

src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/ui/GameUIState.scala

@@ -5,7 +5,7 @@ import com.us.dsb.explore.algs.coloredlines.manual.game._
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.{ColumnIndex, Index, RowIndex, columnIndices, rowIndices}
 
 // ?? somewhere expand to allow for history (maybe via Semigroup or whatever has .compose?)
-private[this] case class GameUIState(gameState: GameState,
+private[this] case class GameUIState(gameState: UpperGameState,
                                      cursorAddress: CellAddress) {
 
   // ?? clean up that floorMod; I just want plain mathematical mod:

…redlines/manual/game/GameStateTest.scala …nes/manual/game/UpperGameStateTest.scalasrc/test/scala/com/us/dsb/explore/algs/coloredlines/manual/game/GameStateTest.scala renamed to src/test/scala/com/us/dsb/explore/algs/coloredlines/manual/game/UpperGameStateTest.scala src/test/scala/com/us/dsb/explore/algs/coloredlines/manual/game/GameStateTest.scala renamed to src/test/scala/com/us/dsb/explore/algs/coloredlines/manual/game/UpperGameStateTest.scala

@@ -4,7 +4,7 @@ import org.scalatest.funspec.AnyFunSpec
 import cats.syntax.option._
 import com.us.dsb.explore.algs.coloredlines.manual.game.board.{ColumnIndex, Index, RowIndex}
 
-class XxGameStateTest extends AnyFunSpec {
+class UpperGameStateTest extends AnyFunSpec {
 
   describe("XxGameState$?. tryMoveAt") {
 //    import Player._