ColoredLines: Refining Board: Removed on-deck delegation from BoardPlus.

Author: Daniel Barclay

src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/game/GameLogicSupport.scala

@@ -1,7 +1,6 @@
 package com.us.dsb.explore.algs.coloredlines.manual.game
 
-import com.us.dsb.explore.algs.coloredlines.manual.game.board.CellAddress
-import com.us.dsb.explore.algs.coloredlines.manual.game.board.{BallKind, BoardPlus, BoardOrder, columnIndices, rowIndices}
+import com.us.dsb.explore.algs.coloredlines.manual.game.board.{BallKind, BoardOrder, BoardPlus, BoardState, CellAddress, columnIndices, rowIndices}
 import com.us.dsb.explore.algs.coloredlines.manual.game.lines.LineDetector
 
 import java.util
@@ -35,12 +34,16 @@ object GameLogicSupport {
                         //??? clarify re placing next three balls (re interpreting differently in different contexts
                         anyRemovals: Boolean)
   {
-    println(s"??? ${this}")
+    println(s"???  $this")
     //??? print("")
   }
 
+  //???? parameterize
+  private[this] def replenishOnDeckBalls(board: BoardState)(implicit rng: Random): BoardState =
+    board.withOnDeckBalls(List.fill(3)(pickRandomBallKind()))
+
   /**
-   * @param board
+   * @param boardPlus
    *   expected to be empty //???? maybe refactor something?
    */
   private[game] def placeInitialBalls(boardPlus: BoardPlus)(implicit rng: Random): MoveResult = {
@@ -50,12 +53,13 @@ object GameLogicSupport {
         case (resultSoFar, _) =>
           val address =
             pickRandomEmptyCell(resultSoFar.boardPlus).getOrElse(scala.sys.error("Unexpectedly full board"))
-          val postPlacementBoard = resultSoFar.boardPlus.withBallAt(address, pickRandomBallKind())
-          val placementHandlingResult = LineDetector.handleBallArrival(postPlacementBoard, address)
+          val postPlacementBoardPlus = resultSoFar.boardPlus.withBallAt(address, pickRandomBallKind())
+          val placementHandlingResult = LineDetector.handleBallArrival(postPlacementBoardPlus, address)
           MoveResult(placementHandlingResult.boardPlus, placementHandlingResult.anyRemovals)
       }
-    //???? parameterize
-    postPlacementsResult.copy(boardPlus = postPlacementsResult.boardPlus.withOnDeckBalls(List.fill(3)(pickRandomBallKind())))
+
+    val replenishedOnDeckBoard = replenishOnDeckBalls(postPlacementsResult.boardPlus.boardState)
+    postPlacementsResult.copy(boardPlus = postPlacementsResult.boardPlus.withBoardState(replenishedOnDeckBoard))
   }
 
   private[game] sealed trait Action
@@ -123,28 +127,32 @@ object GameLogicSupport {
     val postPlacementResult =
       //???? for 1 to 3, consume on-deck ball from list, and then place (better for internal state view);;
       // can replenish incrementally or later; later might show up better in internal state view
-      boardPlus.getOnDeckBalls
+      boardPlus.boardState.getOnDeckBalls
         .foldLeft(MoveResult(boardPlus, false)) {
           case (curMoveResult, onDeckBall) =>
             pickRandomEmptyCell(curMoveResult.boardPlus) match {
               case None =>  // board full; break out early (game will become over)
                 curMoveResult
               case Some(address) =>
-                val postDeueueBoardPlus =
-                  curMoveResult.boardPlus.withOnDeckBalls(curMoveResult.boardPlus.getOnDeckBalls.tail)
-                val postPlacementBoard = postDeueueBoardPlus.withBallAt(address, onDeckBall)
-                LineDetector.handleBallArrival(postPlacementBoard, address)
+                val postPlacementBoardPlus = {
+                  val curBoardState = curMoveResult.boardPlus.boardState
+                  val postDeueueBoard =
+                    curBoardState
+                        .withOnDeckBalls(curBoardState.getOnDeckBalls.tail)
+                        .withBallAt(address, onDeckBall)
+                  val postDeueueBoardPlus = curMoveResult.boardPlus.withBoardState(postDeueueBoard)
+                  postDeueueBoardPlus
+                }
+                LineDetector.handleBallArrival(postPlacementBoardPlus, address)
             }
         }
-    //???? parameterize?
-    //????? check re duplicate on-deck code (look for other "fill(3)"
-    postPlacementResult.copy(boardPlus = postPlacementResult.boardPlus.withOnDeckBalls(List.fill(3)(pickRandomBallKind())))
-  }
+
+    val replenishedOnDeckBoard = replenishOnDeckBalls(postPlacementResult.boardPlus.boardState)
+    postPlacementResult.copy(boardPlus = postPlacementResult.boardPlus.withBoardState(replenishedOnDeckBoard))}
 
   private[game] def doPass(boardPlus: BoardPlus)(implicit rng: Random): MoveResult =
     placeNextBalls(boardPlus)
 
-
   //???: likely move core algorithm out; possibly move outer code into BoardPlus/BoardState:
   /**
    * @param toTapCell - must be empty */

src/main/scala/com/us/dsb/explore/algs/coloredlines/manual/game/board/BoardPlus.scala

@@ -9,7 +9,7 @@ private[game] object BoardPlus {
 /**
  * CURRENTLY:  Core board state (now wrapped), not score yet, tap-UI selection state
  */
-private[game] class BoardPlus(private[this] val boardState: BoardState,
+private[game] class BoardPlus(private[game] val boardState: BoardState,
                               private[this] val score: Int,
                               //???? move to (low-level) tap-UI state:
                               private[this] val selectionAddress: Option[CellAddress]
@@ -24,12 +24,6 @@ private[game] class BoardPlus(private[this] val boardState: BoardState,
                          selectionAddress: Option[CellAddress] = selectionAddress) =
     new BoardPlus(boardState, score, selectionAddress)
 
-  // on-deck balls:
-  private[game] def getOnDeckBalls: Iterable[BallKind] = boardState.getOnDeckBalls
-
-  private[game] def withOnDeckBalls(newBalls: Iterable[BallKind]): BoardPlus =
-    copy(boardState.withOnDeckBalls(newBalls))
-
   // grid balls:
 
   private[game] def isFull: Boolean = boardState.isFull
@@ -61,6 +55,11 @@ private[game] class BoardPlus(private[this] val boardState: BoardState,
     }
   }
 
+  // (lower-level) board state
+
+  private[game] def withBoardState(boardState: BoardState): BoardPlus =
+    copy(boardState = boardState)
+
   // (running) score:
 
   private[game] def withAddedScore(increment: Int): BoardPlus =

src/test/scala/com/us/dsb/explore/algs/coloredlines/manual/game/board/BoardPlusTest.scala

@@ -22,7 +22,7 @@ class BoardPlusTest extends AnyFunSpec {
       }
     }
     it("- with empty board--empty on-deck list") {
-      assert(boardPlus.getOnDeckBalls.isEmpty)
+      assert(boardPlus.boardState.getOnDeckBalls.isEmpty)
     }
     it("- with no selection") {
       assert(boardPlus.hasAnyCellSelected == false)