ManualTicTacToe: Misc. little: fixed misspellings, edited comments, etc.

Author: Daniel Barclay

src/main/scala/com/us/dsb/explore/algs/ttt/manual/game/Board.scala

@@ -56,8 +56,8 @@ private[game] class Board(private val cellStates: Vector[Cell]) {
   // ?? Q: How to use Tuple3 in data and then convert to or use as 3-element
   //   List and call .forall?
   // ?? any way auto-generate this simply?  or factor out repeated cell pairs?
-  private type CellRawIndices = Tuple2[Int, Int]
-  private val linesData: List[Tuple3[CellRawIndices, CellRawIndices, CellRawIndices]] =
+  private type CellRawIndices = (Int, Int)
+  private val linesData: List[(CellRawIndices, CellRawIndices, CellRawIndices)] =
         List(
           ((1, 1), (1, 2), (1, 3)),
           ((2, 1), (2, 2), (2, 3)),
@@ -98,7 +98,6 @@ private[game] class Board(private val cellStates: Vector[Cell]) {
   def renderMultiline: String = {
     val cellWidth = " X ".length
     val cellSeparator = "|"
-    // ?? use new Order or leave using indices declarations?
     val wholeWidth =
       columnIndices.length * cellWidth +
           (columnIndices.length - 1) * cellSeparator.length
@@ -115,7 +114,6 @@ private[game] class Board(private val cellStates: Vector[Cell]) {
   }
 
   def renderCompactMultiline: String = {
-    // ?? use new Order or leave using indices declarations?
     rowIndices.map { row =>
       columnIndices.map { column =>
         getMarkAt(row, column) match {

src/main/scala/com/us/dsb/explore/algs/ttt/manual/game/GameState.scala

@@ -32,7 +32,8 @@ case class GameState(board: Board,
 
   // ?? later refine from Either[String, ...] to "fancier" error type
   // ?? maybe add result of move (win/draw/other) with new state (so caller
-  //  doesn't have to check state's gameResult;
+  //  doesn't have to check state's gameResult; also, think about where I'd add
+  //  game history
 
   def tryMoveAt(row: RowIndex,
                 column: ColumnIndex
@@ -53,7 +54,7 @@ case class GameState(board: Board,
         GameState(markedBoard, newGameResult, currentPlayer.opponent).asRight
       case Some(nameThis) =>
         (s"Can't place mark at row $row, column $column;" +
-            s" is already marked (${nameThis})").asLeft
+            s" is already marked ($nameThis)").asLeft
     }
   }
 

src/main/scala/com/us/dsb/explore/algs/ttt/manual/game/package.scala

@@ -8,16 +8,14 @@ import io.estatico.newtype.macros.newtype
 package object game {
 
   type Order = 3
-  val Order = valueOf[Order]
+  val Order: Order = valueOf[Order]
 
   /** TTT row or column index integer; 1-based; top row, left column row are #1. */
   type Index = Int Refined Closed[1, Order]
   object Index extends RefinedTypeOps.Numeric[Index, Int]
 
-  // ?? revisit use--in both table and UI selection model; separate?
-
-  import scala.language.implicitConversions  // suppress warning from  @newtype
-  // ???? what exactly does "private" on a newtype affect?
+  import scala.language.implicitConversions  // suppress warning from @newtype
+  // ?? what exactly does "private" on a newtype affect?
   @newtype case class RowIndex(value: Index)
   @newtype case class ColumnIndex(value: Index)
 

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

@@ -8,9 +8,6 @@ import enumeratum.{Enum, EnumEntry}
 import scala.annotation.tailrec
 import scala.util.chaining.scalaUtilChainingOps
 
-// ?? any substantial benefit to moving internal methods to class? we could
-//  avoid some state passing, but only by mutating top-level state member
-
 /** TTT UI controller. */
 object GameUI {
 
@@ -73,10 +70,10 @@ object GameUI {
                            ): GameUIState = {
     import UICommand._
     moveCommand match {
-      case Up    => uiState.withRowAdustedBy(-1)
-      case Down  => uiState.withRowAdustedBy(1)
-      case Left  => uiState.withColumnAdustedBy(-1)
-      case Right => uiState.withColumnAdustedBy(1)
+      case Up    => uiState.withRowAdjustedBy(-1)
+      case Down  => uiState.withRowAdjustedBy(1)
+      case Left  => uiState.withColumnAdjustedBy(-1)
+      case Right => uiState.withColumnAdjustedBy(1)
     }
   }
 

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

@@ -8,7 +8,7 @@ private case class GameUIState(gameState: GameState,
                                selectedColumn: ColumnIndex) {
 
   // ?? clean up that floorMod; I just want plain mathematical mod:
-  private def adjustAndwrapToRange(unincremented: Index, delta: Int): Index = {
+  private def adjustAndWrapToRange(unincremented: Index, delta: Int): Index = {
     // ?? maybe enable auto-wrapping and -unwrapping around math
     val indexOrigin = Index.MinValue.value
     val rangeSize = Index.MaxValue.value - Index.MinValue.value + 1
@@ -24,11 +24,11 @@ private case class GameUIState(gameState: GameState,
   //   our cursor-based row/column specification; what would GUI use, just
   //   9 table-level IDs tied to GUI cells/buttons?);
 
-  private[ui] def withRowAdustedBy(delta: Int): GameUIState =
-    copy(selectedRow = RowIndex(adjustAndwrapToRange(selectedRow.value, delta)))
+  private[ui] def withRowAdjustedBy(delta: Int): GameUIState =
+    copy(selectedRow = RowIndex(adjustAndWrapToRange(selectedRow.value, delta)))
 
-  private[ui] def withColumnAdustedBy(delta: Int): GameUIState =
-    copy(selectedColumn = ColumnIndex(adjustAndwrapToRange(selectedColumn.value, delta)))
+  private[ui] def withColumnAdjustedBy(delta: Int): GameUIState =
+    copy(selectedColumn = ColumnIndex(adjustAndWrapToRange(selectedColumn.value, delta)))
 
   private def renderTableMultilineWithSelection: String = {
     val cellWidth = " X ".length