style(plugin): give each class a corresponding xstream alias

anarchuser · anarchuser · commit 4dadd96880cb · 2020-08-14T12:48:56.000+02:00
diff --git a/plugin/src/client/sc/plugin2021/PlayerType.kt b/plugin/src/client/sc/plugin2021/PlayerType.kt
@@ -1,6 +1,9 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
+
 /** The role of a Client. */
+@XStreamAlias(value = "playertype")
 enum class PlayerType {
     NONE,
     OBSERVER,
diff --git a/plugin/src/shared/sc/plugin2021/Board.kt b/plugin/src/shared/sc/plugin2021/Board.kt
@@ -1,9 +1,11 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import sc.api.plugins.IBoard
 import sc.plugin2021.util.Constants
 import sc.plugin2021.Field
 
+@XStreamAlias(value = "board")
 class Board(
         private val gameField: Array<Array<FieldContent>> =
                 Array(Constants.BOARD_SIZE) { Array(Constants.BOARD_SIZE) { FieldContent.EMPTY }}
diff --git a/plugin/src/shared/sc/plugin2021/Color.kt b/plugin/src/shared/sc/plugin2021/Color.kt
@@ -1,5 +1,8 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
+
+@XStreamAlias(value = "color")
 enum class Color(val team: Team) {
     BLUE  (Team.ONE),
     YELLOW(Team.TWO),
diff --git a/plugin/src/shared/sc/plugin2021/Coordinates.kt b/plugin/src/shared/sc/plugin2021/Coordinates.kt
@@ -1,7 +1,9 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
+@XStreamAlias(value = "coordinates")
 data class Coordinates(
         @XStreamAsAttribute val x: Int,
         @XStreamAsAttribute val y: Int) {
diff --git a/plugin/src/shared/sc/plugin2021/Field.kt b/plugin/src/shared/sc/plugin2021/Field.kt
@@ -1,7 +1,9 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import sc.api.plugins.IField
 
+@XStreamAlias(value = "field")
 class Field(val coordinates: Coordinates, val content: FieldContent): IField {
     override fun toString(): String = "'$content $coordinates'"
     
diff --git a/plugin/src/shared/sc/plugin2021/FieldContent.kt b/plugin/src/shared/sc/plugin2021/FieldContent.kt
@@ -1,5 +1,8 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
+
+@XStreamAlias(value = "content")
 enum class FieldContent(val letter: Char) {
     BLUE('B'),
     YELLOW('Y'),
diff --git a/plugin/src/shared/sc/plugin2021/GameState.kt b/plugin/src/shared/sc/plugin2021/GameState.kt
@@ -2,6 +2,7 @@ package sc.plugin2021
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
+import com.thoughtworks.xstream.annotations.XStreamOmitField
 import org.slf4j.LoggerFactory
 import sc.api.plugins.TwoPlayerGameState
 import sc.framework.plugins.Player
diff --git a/plugin/src/shared/sc/plugin2021/Move.kt b/plugin/src/shared/sc/plugin2021/Move.kt
@@ -1,17 +1,20 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import sc.api.plugins.IMove
 
 sealed class Move(val color: Color): IMove {
     abstract override fun toString(): String
 }
 
+@XStreamAlias(value = "setmove")
 class SetMove(val piece: Piece): Move(piece.color) {
     override fun toString(): String = piece.toString()
     override fun equals(other: Any?): Boolean = piece == other
     override fun hashCode(): Int = piece.hashCode()
 }
 
+@XStreamAlias(value = "passmove")
 class PassMove(color: Color): Move(color) {
     override fun toString(): String = "$color passed out"
 }
diff --git a/plugin/src/shared/sc/plugin2021/Piece.kt b/plugin/src/shared/sc/plugin2021/Piece.kt
@@ -9,7 +9,7 @@ import sc.plugin2021.util.print
 import sc.plugin2021.util.rotate
 
 /** A Piece has a color, a position and a normalised shape. */
-//@XStreamAlias(value = "piece")
+@XStreamAlias(value = "piece")
 class Piece(@XStreamAsAttribute val color: Color = Color.BLUE,
             @XStreamAsAttribute val kind: PieceShape = PieceShape.MONO,
             @XStreamAsAttribute val rotation: Rotation = Rotation.NONE,
diff --git a/plugin/src/shared/sc/plugin2021/PieceShape.kt b/plugin/src/shared/sc/plugin2021/PieceShape.kt
@@ -1,5 +1,6 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import com.thoughtworks.xstream.annotations.XStreamOmitField
 import sc.plugin2021.util.Constants
@@ -8,6 +9,7 @@ import sc.plugin2021.util.rotate
 import sc.plugin2021.util.flip
 import kotlin.math.max
 
+@XStreamAlias(value = "shape")
 enum class PieceShape(coordinates: Set<Coordinates>) {
 /* 0*/  MONO   (setOf(Coordinates(0, 0))),
 /* 1*/  DOMINO (setOf(Coordinates(0, 0), Coordinates(1, 0))),
diff --git a/plugin/src/shared/sc/plugin2021/Rotation.kt b/plugin/src/shared/sc/plugin2021/Rotation.kt
@@ -1,6 +1,9 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
+
 /** Determines how often a Piece has been rotated clockwise. */
+@XStreamAlias(value = "rotation")
 enum class Rotation(val value: Int) {
     NONE(0),
     RIGHT(1),
diff --git a/plugin/src/shared/sc/plugin2021/Team.kt b/plugin/src/shared/sc/plugin2021/Team.kt
@@ -1,7 +1,9 @@
 package sc.plugin2021
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import sc.api.plugins.ITeam
 
+@XStreamAlias(value = "team")
 enum class Team(override val index: Int, val colors: List<Color>): ITeam<Team> {
     ONE(0, listOf(Color.BLUE, Color.YELLOW)) {
         override fun opponent(): Team = TWO
diff --git a/plugin/src/shared/sc/plugin2021/util/WinReason.kt b/plugin/src/shared/sc/plugin2021/util/WinReason.kt
@@ -1,7 +1,9 @@
 package sc.plugin2021.util
 
+import com.thoughtworks.xstream.annotations.XStreamAlias
 import sc.shared.IWinReason
 
+@XStreamAlias(value = "winreason")
 enum class WinReason(override val message: String): IWinReason {
     EQUAL_SCORE("Das Spiel ist beendet.\nBeide Teams haben die gleiche Punktzahl erzielt.") {
         override fun getMessage(playerName: String?) = message
diff --git a/plugin/src/test/sc/plugin2021/PieceTest.kt b/plugin/src/test/sc/plugin2021/PieceTest.kt
@@ -139,32 +139,31 @@ class PieceTest: StringSpec({
         )
     
         Configuration.xStream.toXML(pieces[0]) shouldBe """
-            <sc.plugin2021.Piece color="YELLOW" kind="TETRO_O" rotation="RIGHT" isFlipped="false">
+            <piece color="YELLOW" kind="TETRO_O" rotation="RIGHT" isFlipped="false">
               <position x="0" y="0"/>
-            </sc.plugin2021.Piece>
+            </piece>
         """.trimIndent()
         Configuration.xStream.toXML(pieces[1]) shouldBe """
-            <sc.plugin2021.Piece color="RED" kind="PENTO_Y" rotation="LEFT" isFlipped="false">
+            <piece color="RED" kind="PENTO_Y" rotation="LEFT" isFlipped="false">
               <position x="0" y="0"/>
-            </sc.plugin2021.Piece>
+            </piece>
         """.trimIndent()
         Configuration.xStream.toXML(pieces[2]) shouldBe """
-            <sc.plugin2021.Piece color="BLUE" kind="PENTO_P" rotation="MIRROR" isFlipped="true">
+            <piece color="BLUE" kind="PENTO_P" rotation="MIRROR" isFlipped="true">
               <position x="0" y="0"/>
-            </sc.plugin2021.Piece>
+            </piece>
         """.trimIndent()
         Configuration.xStream.toXML(pieces[3]) shouldBe """
-            <sc.plugin2021.Piece color="GREEN" kind="TRIO_L" rotation="NONE" isFlipped="true">
+            <piece color="GREEN" kind="TRIO_L" rotation="NONE" isFlipped="true">
               <position x="5" y="9"/>
-            </sc.plugin2021.Piece>
+            </piece>
         """.trimIndent()
 
         pieces.forEach{
             val xml = Configuration.xStream.toXML(it)
             val converted = Configuration.xStream.fromXML(xml) as Piece
             converted.toString() shouldBe it.toString()
-//            converted shouldBe it
-//            printShapes(it.coordinates, converted.coordinates)
+            converted shouldBe it
             println("Expected: ${it.coordinates} - Actual: ${converted.coordinates}")
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,20 @@`
`1`	`1`	`package sc.plugin2021`
`2`	`2`
	`3`	`+import com.thoughtworks.xstream.annotations.XStreamAlias`
`3`	`4`	`import sc.api.plugins.IMove`
`4`	`5`
`5`	`6`	`sealed class Move(val color: Color): IMove {`
`6`	`7`	`abstract override fun toString(): String`
`7`	`8`	`}`
`8`	`9`
	`10`	`+@XStreamAlias(value = "setmove")`
`9`	`11`	`class SetMove(val piece: Piece): Move(piece.color) {`
`10`	`12`	`override fun toString(): String = piece.toString()`
`11`	`13`	`override fun equals(other: Any?): Boolean = piece == other`
`12`	`14`	`override fun hashCode(): Int = piece.hashCode()`
`13`	`15`	`}`
`14`	`16`
	`17`	`+@XStreamAlias(value = "passmove")`
`15`	`18`	`class PassMove(color: Color): Move(color) {`
`16`	`19`	`override fun toString(): String = "$color passed out"`
`17`	`20`	`}`