feat(plugin): pass moves remove colors gracefully

NOTE: Also adds a new Constants, `PASS_MOVE_SKIPS`, which can be used
for alternate game play in which pass moves skip a turn only, without
    removing the color from gameplay

feat(plugin): add a separate SkipMove, only skipping one turn

Author: anarchuser

plugin/src/server/sc/plugin2021/Game.kt

@@ -161,8 +161,12 @@ class Game(UUID: String = GamePlugin.PLUGIN_UUID): RoundBasedGameInstance<Player
             logger.debug("Current State: $gameState")
             logger.debug("Performing Move $data")
             GameRuleLogic.performMove(gameState, data)
-            GameRuleLogic.validateMovability(gameState)
-            next(if(gameState.orderedColors.isNotEmpty()) gameState.currentPlayer else null)
+            if (!isGameOver()) {
+                GameRuleLogic.validateMovability(gameState)
+                next(gameState.currentPlayer)
+            } else {
+                next(null)
+            }
             logger.debug("Current Board:\n${gameState.board}")
         } catch(e: InvalidMoveException) {
             super.catchInvalidMove(e, fromPlayer)
@@ -171,4 +175,5 @@ class Game(UUID: String = GamePlugin.PLUGIN_UUID): RoundBasedGameInstance<Player
 
     override fun getCurrentState(): IGameState = gameState
 
+    fun isGameOver(): Boolean = gameState.orderedColors.isEmpty()
 }

plugin/src/shared/sc/plugin2021/GameState.kt

@@ -111,9 +111,11 @@ class GameState @JvmOverloads constructor(
      *  Do not do anything with currentColor before the turn is done for good.
      */
     fun removeActiveColor() {
+        logger.info("Removed $currentColor from the game")
         orderedColors.remove(currentColor)
         if (orderedColors.isNotEmpty())
             currentColorIndex = (currentColorIndex + orderedColors.size - 1) % orderedColors.size
+        logger.debug("Remaining Colors: $orderedColors")
     }
 
     override fun toString(): String = "GameState $round/$turn -> $currentColor"

plugin/src/shared/sc/plugin2021/Move.kt

@@ -16,5 +16,10 @@ class SetMove(val piece: Piece): Move(piece.color) {
 
 @XStreamAlias(value = "passmove")
 class PassMove(color: Color): Move(color) {
-    override fun toString(): String = "$color passed out"
+    override fun toString(): String = "$color passed"
+}
+
+@XStreamAlias(value = "skipmove")
+class SkipMove(color: Color): Move(color) {
+    override fun toString(): String = "$color skipped"
 }

plugin/src/shared/sc/plugin2021/util/GameRuleLogic.kt

@@ -28,8 +28,9 @@ object GameRuleLogic {
             validateMoveColor(gameState, move)
 
         when (move) {
+            is SkipMove -> {}
             is PassMove -> {
-                throw InvalidMoveException("Color ${move.color} intentionally passed out", move)
+                gameState.removeActiveColor()
             }
             is SetMove -> {
                 if (Constants.VALIDATE_MOVE)

plugin/src/test/sc/plugin2021/GameRuleLogicTest.kt

@@ -91,12 +91,13 @@ class GameRuleLogicTest: StringSpec({
         GameRuleLogic.getPointsFromUndeployed(emptySet(), false) shouldBe 15
         GameRuleLogic.getPointsFromUndeployed(emptySet(), true) shouldBe 20
     }
-    "After the color check, PassMoves throw" {
+    "After the color check, PassMoves remove the color" {
         val state = GameState()
-        assertThrows<InvalidMoveException> {
+        assertDoesNotThrow {
             GameRuleLogic.performMove(state, PassMove(Color.BLUE))
         }
-        state.orderedColors.size shouldBe 4
+        state.orderedColors.size shouldBe 3
+        state.currentColor shouldBe Color.YELLOW
     }
     "All possible start moves get calculated" {
         val piece = PieceShape.PENTO_W

plugin/src/test/sc/plugin2021/GameTest.kt

@@ -16,26 +16,32 @@ class GameTest: StringSpec({
         Color.BLUE.team
         val game = Game()
         val state = game.gameState
-        val first = game.onPlayerJoined()
-        val second = game.onPlayerJoined()
+        val player = Pair(game.onPlayerJoined(), game.onPlayerJoined())
 
-        first.color  shouldBe Team.ONE
-        second.color shouldBe Team.TWO
+        player.first.color  shouldBe Team.ONE
+        player.second.color shouldBe Team.TWO
 
         game.start()
 
-        val e: InvalidMoveException = assertThrows {
-            state.currentPlayer shouldBe first
-            state.currentColor  shouldBe Color.BLUE
-            game.onAction(state.currentPlayer, PassMove(state.currentColor))
-        }
+        state.currentPlayer shouldBe player.first
+        state.currentColor  shouldBe Color.BLUE
+        game.onAction(state.currentPlayer, PassMove(state.currentColor))
+    
+        state.currentPlayer shouldBe player.second
+        state.currentColor  shouldBe Color.YELLOW
+        game.onAction(state.currentPlayer, PassMove(state.currentColor))
+    
+        state.currentPlayer shouldBe player.first
+        state.currentColor  shouldBe Color.RED
+        game.onAction(player.first, PassMove(Color.RED))
+    
+        state.currentPlayer shouldBe player.second
+        state.currentColor  shouldBe Color.GREEN
+        game.onAction(player.second, PassMove(Color.GREEN))
 
-        game.winners shouldBe listOf(second)
+        game.winners shouldBe player.toList()
 
-        game.playerScores shouldContainExactly listOf(
-                PlayerScore(ScoreCause.RULE_VIOLATION, e.message, Constants.LOSE_SCORE, -178),
-                PlayerScore(ScoreCause.REGULAR, "", Constants.WIN_SCORE, -178)
-        )
+        game.playerScores shouldContainExactly List(2) {PlayerScore(ScoreCause.REGULAR, "", Constants.DRAW_SCORE, -178)}
     }
     "A few moves can be performd without issues" {
         val game = Game()