💣 Step1: 지뢰 찾기(그리기)

README.md

@@ -1 +1,37 @@
-# kotlin-minesweeper
+# kotlin-minesweeper
+
+## Step 1 - 지뢰 찾기(그리기)
+
+### 기능 목록
+
+- [X] 지뢰찾기 게임판(Board)을 그린다.
+- [X] 게임판은 포지션과 마크를 갖는다.
+    - [X] 게임판은 2차원 칸을 갖는다.
+    - [X] 게임판은 지뢰 위치를 받아 지뢰를 배치한다.
+    - [X] 가로 세로 크기는 1이상이다.
+    - [X] 지뢰 개수는 1이상 게임판 크기(가로*세로) 이하이다.
+- [X] 위치 생성기는 최대 x, y 좌표를 받아 랜덤한 위치를 생성한다.
+- [X] 마크는 지뢰와 일반 칸이 존재한다
+- [X] 포지션은 x, y 좌표를 갖는다.
+    - [X] x, y 좌표는 0이상이다
+
+### 기능 요구사항
+
+- 지뢰 찾기를 변형한 프로그램을 구현한다.
+- 높이와 너비, 지뢰 개수를 입력받을 수 있다.
+- 지뢰는 눈에 잘 띄는 것으로 표기한다.
+- 지뢰는 가급적 랜덤에 가깝게 배치한다.
+
+### 프로그래밍 요구사항
+
+객체지향 생활 체조 원칙을 지키면서 프로그래밍한다.
+
+- 한 메서드에 오직 한 단계의 들여쓰기만 한다.
+- else 예약어를 쓰지 않는다.
+- 모든 원시 값과 문자열을 포장한다.
+- 한 줄에 점을 하나만 찍는다.
+- 줄여 쓰지 않는다(축약 금지).
+- 모든 엔티티를 작게 유지한다.
+- 3개 이상의 인스턴스 변수를 가진 클래스를 쓰지 않는다.
+- 일급 컬렉션을 쓴다.
+- getter/setter/프로퍼티를 쓰지 않는다.

src/main/kotlin/minesweeper/domain/Minesweeper.kt

@@ -0,0 +1,21 @@
+package minesweeper.domain
+
+import minesweeper.domain.board.Board
+import minesweeper.domain.board.BoardMeta
+import minesweeper.ui.InputView
+import minesweeper.ui.OutputView
+
+class Minesweeper(
+    private val input: InputView,
+    private val output: OutputView,
+) {
+    fun start() {
+        val width = input.getWidth()
+        val height = input.getHeight()
+        val mineCount = input.getMineCount()
+
+        val boardMeta = BoardMeta(width, height, mineCount)
+        val board = Board.create(boardMeta)
+        output.printStart(board)
+    }
+}

src/main/kotlin/minesweeper/domain/board/Board.kt

@@ -0,0 +1,27 @@
+package minesweeper.domain.board
+
+import minesweeper.domain.field.Mark
+import minesweeper.domain.field.Position
+import minesweeper.domain.generator.PositionGenerator
+import minesweeper.domain.generator.RandomPositionGenerator
+
+class Board private constructor(val markMap: Map<Position, Mark>) {
+    companion object {
+        fun create(boardMeta: BoardMeta, positionGenerator: PositionGenerator = RandomPositionGenerator()): Board {
+            val minePositions = positionGenerator.get(boardMeta)
+            val baseBoard = generateAllPositions(boardMeta.boardSize)
+                .associateWith { Mark.SAFE }
+                .toMutableMap()
+            baseBoard.putAll(minePositions.associateWith { Mark.MINE })
+            return Board(baseBoard.toMap())
+        }
+
+        private fun generateAllPositions(boardSize: BoardSize): List<Position> {
+            return (0 until boardSize.width).flatMap { w ->
+                (0 until boardSize.height).map { h ->
+                    Position(w, h)
+                }
+            }
+        }
+    }
+}

src/main/kotlin/minesweeper/domain/board/BoardMeta.kt

@@ -0,0 +1,15 @@
+package minesweeper.domain.board
+
+class BoardMeta(val boardSize: BoardSize, val mineCount: Int) {
+    val width: Int
+        get() = boardSize.width
+    val height: Int
+        get() = boardSize.height
+
+    constructor(width: Int, height: Int, mineCount: Int) : this(BoardSize(width, height), mineCount)
+
+    init {
+        require(mineCount > 0) { "지뢰 개수는 0보다 커야 합니다." }
+        require(mineCount < width * height) { "지뢰 개수는 가로 * 세로 보다 작아야 합니다." }
+    }
+}

src/main/kotlin/minesweeper/domain/board/BoardSize.kt

@@ -0,0 +1,8 @@
+package minesweeper.domain.board
+
+class BoardSize(val width: Int, val height: Int) {
+    init {
+        require(width > 0) { "가로 길이는 0보다 커야 합니다." }
+        require(height > 0) { "세로 길이는 0보다 커야 합니다." }
+    }
+}

src/main/kotlin/minesweeper/domain/field/Mark.kt

@@ -0,0 +1,11 @@
+package minesweeper.domain.field
+
+enum class Mark {
+    MINE,
+    SAFE,
+    ;
+
+    fun isMine(): Boolean {
+        return this == MINE
+    }
+}

src/main/kotlin/minesweeper/domain/field/Position.kt

@@ -0,0 +1,8 @@
+package minesweeper.domain.field
+
+data class Position(val x: Int, val y: Int) {
+    init {
+        require(x >= 0) { "x는 0 이상이어야 합니다." }
+        require(y >= 0) { "y는 0 이상이어야 합니다." }
+    }
+}

src/main/kotlin/minesweeper/domain/generator/PositionGenerator.kt

@@ -0,0 +1,8 @@
+package minesweeper.domain.generator
+
+import minesweeper.domain.board.BoardMeta
+import minesweeper.domain.field.Position
+
+fun interface PositionGenerator {
+    fun get(boardMeta: BoardMeta): Set<Position>
+}

src/main/kotlin/minesweeper/domain/generator/RandomPositionGenerator.kt

@@ -0,0 +1,14 @@
+package minesweeper.domain.generator
+
+import minesweeper.domain.board.BoardMeta
+import minesweeper.domain.field.Position
+import kotlin.random.Random
+
+class RandomPositionGenerator : PositionGenerator {
+    override fun get(boardMeta: BoardMeta): Set<Position> {
+        return generateSequence { Position(Random.nextInt(0, boardMeta.width), Random.nextInt(0, boardMeta.height)) }
+            .distinct()
+            .take(boardMeta.mineCount)
+            .toSet()
+    }
+}

src/main/kotlin/minesweeper/main.kt

@@ -0,0 +1,13 @@
+package minesweeper
+
+import minesweeper.domain.Minesweeper
+import minesweeper.ui.InputView
+import minesweeper.ui.OutputView
+
+fun main() {
+    val input = InputView()
+    val output = OutputView()
+
+    val minesweeper = Minesweeper(input, output)
+    minesweeper.start()
+}

src/main/kotlin/minesweeper/ui/InputView.kt

@@ -0,0 +1,18 @@
+package minesweeper.ui
+
+class InputView {
+    fun getWidth(): Int {
+        println("너비를 입력하세요.")
+        return readln().toInt()
+    }
+
+    fun getHeight(): Int {
+        println("높이를 입력하세요.")
+        return readln().toInt()
+    }
+
+    fun getMineCount(): Int {
+        println("지뢰는 몇 개인가요?")
+        return readln().toInt()
+    }
+}

src/main/kotlin/minesweeper/ui/OutputView.kt

@@ -0,0 +1,28 @@
+package minesweeper.ui
+
+import minesweeper.domain.board.Board
+import minesweeper.domain.field.Mark
+
+class OutputView {
+    fun printStart(board: Board) {
+        println("지뢰찾기 게임 시작")
+        printBoard(board)
+    }
+
+    private fun printBoard(board: Board) {
+        groupByLine(board).forEach { (_, marks) ->
+            println(marks.joinToString(" ") { toSymbol(it) })
+        }
+    }
+
+    private fun groupByLine(board: Board): Map<Int, List<Mark>> {
+        return board.markMap.entries.groupBy({ it.key.x }, { it.value })
+    }
+
+    private fun toSymbol(mark: Mark): String {
+        if (mark.isMine()) {
+            return "*"
+        }
+        return "C"
+    }
+}

src/test/kotlin/minesweeper/domain/board/BoardMetaTest.kt

@@ -0,0 +1,20 @@
+package minesweeper.domain.board
+
+import io.kotest.assertions.throwables.shouldThrow
+import org.junit.jupiter.api.Test
+
+class BoardMetaTest {
+    @Test
+    fun `지뢰 개수가 0 이하이면 예외가 발생한다`() {
+        shouldThrow<IllegalArgumentException> {
+            BoardMeta(1, 1, 0)
+        }
+    }
+
+    @Test
+    fun `지뢰 개수가 가로 세로의 곱보다 크면 예외가 발생한다`() {
+        shouldThrow<IllegalArgumentException> {
+            BoardMeta(1, 1, 2)
+        }
+    }
+}

src/test/kotlin/minesweeper/domain/board/BoardSizeTest.kt

@@ -0,0 +1,16 @@
+package minesweeper.domain.board
+
+import io.kotest.assertions.throwables.shouldThrow
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.CsvSource
+
+class BoardSizeTest {
+
+    @ParameterizedTest
+    @CsvSource("0, 1", "1, 0", "0, 0")
+    fun `게임판의 가로 세로는 0보다 커야한다`(width: Int, height: Int) {
+        shouldThrow<IllegalArgumentException> {
+            BoardSize(width, height)
+        }
+    }
+}

src/test/kotlin/minesweeper/domain/board/BoardTest.kt

@@ -0,0 +1,31 @@
+package minesweeper.domain.board
+
+import io.kotest.assertions.assertSoftly
+import io.kotest.matchers.shouldBe
+import minesweeper.domain.field.Mark
+import minesweeper.domain.field.Position
+import minesweeper.domain.generator.PositionGenerator
+import org.junit.jupiter.api.Test
+
+class BoardTest {
+
+    @Test
+    fun `사이즈와 지뢰 위치를 받아 게임판을 생성한다`() {
+        val boardMeta = BoardMeta(3, 3, 3)
+        val positions = listOf(Position(1, 1), Position(2, 2))
+
+        val board = Board.create(boardMeta, getTestGenerator(positions))
+
+        assertSoftly {
+            board.markMap.size shouldBe boardMeta.width * boardMeta.height
+            board.markMap[Position(1, 1)] shouldBe Mark.MINE
+            board.markMap[Position(2, 2)] shouldBe Mark.MINE
+        }
+    }
+
+    private fun getTestGenerator(positions: List<Position>): PositionGenerator {
+        return PositionGenerator {
+            positions.toSet()
+        }
+    }
+}

src/test/kotlin/minesweeper/domain/field/MarkTest.kt

@@ -0,0 +1,14 @@
+package minesweeper.domain.field
+
+import io.kotest.matchers.shouldBe
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.CsvSource
+
+class MarkTest {
+
+    @ParameterizedTest
+    @CsvSource("MINE, true", "SAFE, false")
+    fun `지뢰인지 확인한다`(mark: Mark, expected: Boolean) {
+        mark.isMine() shouldBe expected
+    }
+}

src/test/kotlin/minesweeper/domain/field/PositionTest.kt

@@ -0,0 +1,15 @@
+package minesweeper.domain.field
+
+import io.kotest.assertions.throwables.shouldThrow
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.CsvSource
+
+class PositionTest {
+    @ParameterizedTest
+    @CsvSource("-1, 0", "0, -1", "-1, -1")
+    fun `x 또는 y가 0 미만이면 예외가 발생한다`(x: Int, y: Int) {
+        shouldThrow<IllegalArgumentException> {
+            Position(x, y)
+        }
+    }
+}

src/test/kotlin/minesweeper/domain/generator/RandomPositionGeneratorTest.kt

@@ -0,0 +1,24 @@
+package minesweeper.domain.generator
+
+import io.kotest.assertions.assertSoftly
+import io.kotest.matchers.shouldBe
+import minesweeper.domain.board.BoardMeta
+import org.junit.jupiter.api.Test
+
+class RandomPositionGeneratorTest {
+
+    @Test
+    fun `랜덤 포지션 생성기는 0부터 파라미터 까지의 값을 갖는 포지션을 생성한다`() {
+        val boardMeta = BoardMeta(3, 3, 3)
+        val generator = RandomPositionGenerator()
+
+        val positions = generator.get(boardMeta)
+
+        assertSoftly {
+            positions.size shouldBe boardMeta.mineCount
+            positions.all {
+                it.x in 0 until boardMeta.width && it.y in 0 until boardMeta.height
+            } shouldBe true
+        }
+    }
+}