🚀 1단계 - 지뢰 찾기(그리기)

README.md

@@ -1 +1,52 @@
-# kotlin-minesweeper
+# kotlin-minesweeper
+
+## 🚀 1단계 - 지뢰 찾기(그리기)
+### 기능 요구사항 
+지뢰 찾기를 변형한 프로그램을 구현한다.
+
+- 높이와 너비, 지뢰 개수를 입력받을 수 있다.
+- 지뢰는 눈에 잘 띄는 것으로 표기한다.
+- 지뢰는 가급적 랜덤에 가깝게 배치한다.
+
+### 실행 결과
+```
+높이를 입력하세요.
+10
+
+너비를 입력하세요.
+10
+
+지뢰는 몇 개인가요?
+10
+
+지뢰찾기 게임 시작
+C C C * C C C * C C
+C C * C * C C C C C
+C C C C C C C C C C
+C C C C C C C C C C
+* C C C C C C C C C
+C C C C C C * C C C
+C C * C C C * C C C
+C C C C C C * C C *
+C C C C C C C C C C
+C C C C C C C C C C
+```
+
+### 프로그래밍 요구 사항
+객체지향 생활 체조 원칙을 지키면서 프로그래밍한다.
+#### 객체지향 생활 체조 원칙
+1. 한 메서드에 오직 한 단계의 들여쓰기만 한다.
+2. else 예약어를 쓰지 않는다.
+3. 모든 원시 값과 문자열을 포장한다.
+4. 한 줄에 점을 하나만 찍는다.
+5. 줄여 쓰지 않는다(축약 금지).
+6. 모든 엔티티를 작게 유지한다.
+7. 3개 이상의 인스턴스 변수를 가진 클래스를 쓰지 않는다.
+8. 일급 컬렉션을 쓴다.
+9. getter/setter/프로퍼티를 쓰지 않는다.
+
+### 구현 사항
+- [x] 높이를 입력받는다
+- [x] 너비를 입력받는다
+- [x] 지뢰 갯수를 입력받는다
+- [x] 입력 결과를 출력한다

build.gradle.kts

@@ -13,7 +13,7 @@ repositories {
 dependencies {
     testImplementation("org.junit.jupiter", "junit-jupiter", "5.8.2")
     testImplementation("org.assertj", "assertj-core", "3.22.0")
-    testImplementation("io.kotest", "kotest-runner-junit5", "5.2.3")
+    testImplementation("io.kotest", "kotest-runner-junit5", "5.5.3")
 }
 
 tasks {

src/main/kotlin/minesweeper/controller/MineSweeperController.kt

@@ -0,0 +1,16 @@
+package minesweeper.controller
+
+import minesweeper.model.MineSweeperGame
+import minesweeper.view.InputView
+import minesweeper.view.OutputView
+
+class MineSweeperController {
+    fun start() {
+        val game = MineSweeperGame(InputView.inputHeight(), InputView.inputWidth(), InputView.inputCountOfMine())
+        OutputView.printMap(game.minefield())
+    }
+}
+
+fun main() {
+    MineSweeperController().start()
+}

src/main/kotlin/minesweeper/model/MineSweeperGame.kt

@@ -0,0 +1,22 @@
+package minesweeper.model
+
+import minesweeper.model.board.Minefield
+import minesweeper.model.cell.Opening
+
+class MineSweeperGame(
+    private val countOfMine: Int,
+    private val minefield: Minefield
+) {
+    constructor(rows: Int, cols: Int, countOfMine: Int) : this(
+        countOfMine = countOfMine,
+        minefield = Minefield(rows, cols)
+    )
+
+    init {
+        plantingMines()
+    }
+
+    fun minefield(): Array<Array<Opening>> = minefield.minefield
+
+    private fun plantingMines() = minefield.plantingMine(countOfMine)
+}

src/main/kotlin/minesweeper/model/board/Cols.kt

@@ -0,0 +1,11 @@
+package minesweeper.model.board
+
+import kotlin.random.Random
+
+data class Cols(val value: Int) {
+    init {
+        require(value > 0) { "입력 값은 양수여야 합니다." }
+    }
+
+    fun getPosition() = Random.nextInt(value)
+}

src/main/kotlin/minesweeper/model/board/Minefield.kt

@@ -0,0 +1,42 @@
+package minesweeper.model.board
+
+import minesweeper.model.cell.Island
+import minesweeper.model.cell.Mine
+import minesweeper.model.cell.Opening
+
+class Minefield(
+    private val rows: Rows,
+    private val cols: Cols,
+    val minefield: Array<Array<Opening>>
+) {
+    constructor(rows: Int, cols: Int) : this(
+        rows = Rows(rows),
+        cols = Cols(cols),
+        minefield = Array(rows) { Array(cols) { Island() } }
+    )
+
+    constructor(rows: Int, cols: Int, minefield: Array<Array<Opening>>) : this(
+        rows = Rows(rows),
+        cols = Cols(cols),
+        minefield = minefield
+    )
+
+    fun plantingMine(countOfMine: Int) {
+        var mineCount = 0
+
+        while (mineCount < countOfMine) {
+            val row = rows.getPosition()
+            val col = cols.getPosition()
+
+            mineCount = plantingResult(row, col, mineCount)
+        }
+    }
+
+    private fun plantingResult(row: Int, col: Int, mineCount: Int): Int {
+        if (minefield[row][col] is Island) {
+            minefield[row][col] = Mine()
+            return mineCount + 1
+        }
+        return mineCount
+    }
+}

src/main/kotlin/minesweeper/model/board/Rows.kt

@@ -0,0 +1,11 @@
+package minesweeper.model.board
+
+import kotlin.random.Random
+
+data class Rows(val value: Int) {
+    init {
+        require(value > 0) { "입력 값은 양수여야 합니다." }
+    }
+
+    fun getPosition() = Random.nextInt(value)
+}

src/main/kotlin/minesweeper/model/cell/Island.kt

@@ -0,0 +1,3 @@
+package minesweeper.model.cell
+
+data class Island(override val value: String = "C") : Opening

src/main/kotlin/minesweeper/model/cell/Mine.kt

@@ -0,0 +1,3 @@
+package minesweeper.model.cell
+
+data class Mine(override val value: String = "*") : Opening

src/main/kotlin/minesweeper/model/cell/Opening.kt

@@ -0,0 +1,5 @@
+package minesweeper.model.cell
+
+interface Opening {
+    val value: String
+}

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

@@ -0,0 +1,19 @@
+package minesweeper.view
+
+object InputView {
+
+    fun inputHeight(): Int {
+        println("높이를 입력하세요.")
+        return readln().toInt()
+    }
+
+    fun inputWidth(): Int {
+        println("\n너비를 입력하세요.")
+        return readln().toInt()
+    }
+
+    fun inputCountOfMine(): Int {
+        println("\n지뢰는 몇 개 인가요?")
+        return readln().toInt()
+    }
+}

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

@@ -0,0 +1,19 @@
+package minesweeper.view
+
+import minesweeper.model.cell.Opening
+
+object OutputView {
+    fun printMap(minefield: Array<Array<Opening>>) {
+        println("\n지뢰찾기 게임 시작")
+        for (row in minefield) {
+            printCols(row)
+        }
+    }
+
+    private fun printCols(row: Array<Opening>) {
+        for (it in row) {
+            print("${it.value} ")
+        }
+        println()
+    }
+}

src/test/kotlin/minesweeper/model/MineSweeperGameTest.kt

@@ -0,0 +1,22 @@
+package minesweeper.model
+
+import io.kotest.matchers.types.shouldBeInstanceOf
+import io.kotest.matchers.types.shouldBeSameInstanceAs
+import org.junit.jupiter.api.Test
+
+class MineSweeperGameTest {
+    @Test
+    fun `지뢰찾기 게임의 너비와 높이, 지뢰 갯수를 받아 게임을 생성한다`() {
+        // given
+        val cols = 10
+        val rows = 10
+        val countOfMine = 10
+
+        // when
+        val mineSweeperGame = MineSweeperGame(cols = cols, rows = rows, countOfMine = countOfMine)
+
+        // then
+        mineSweeperGame.shouldBeInstanceOf<MineSweeperGame>()
+        mineSweeperGame.minefield().size shouldBeSameInstanceAs cols
+    }
+}

src/test/kotlin/minesweeper/model/board/ColsTest.kt

@@ -0,0 +1,18 @@
+package minesweeper.model.board
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.ints.shouldBeBetween
+
+class ColsTest : StringSpec({
+    "행의 길이 범위 내의 랜덤한 위치값을 반환받는다" {
+        // given
+        val size = 10
+        val col = Cols(size)
+
+        // when
+        val result = col.getPosition()
+
+        // then
+        result.shouldBeBetween(0, size)
+    }
+})

src/test/kotlin/minesweeper/model/board/MinefieldTest.kt

@@ -0,0 +1,27 @@
+package minesweeper.model.board
+
+import io.kotest.matchers.shouldBe
+import minesweeper.model.cell.Island
+import minesweeper.model.cell.Mine
+import minesweeper.model.cell.Opening
+import org.junit.jupiter.api.Test
+
+class MinefieldTest {
+    @Test
+    fun `지뢰찾기 맵 생성 결과 지뢰 갯수만큼 지뢰가 심어진다`() {
+        // given
+        val openings: Array<Array<Opening>> = arrayOf(
+            arrayOf(Island(), Mine(), Island()),
+            arrayOf(Mine(), Island(), Mine()),
+            arrayOf(Mine(), Island(), Island())
+        )
+        val minefield = Minefield(3, 3, openings)
+
+        // when
+        val (islandCount, mineCount) = openings.flatten().partition { it is Island }
+
+        // then
+        islandCount.size shouldBe 5
+        mineCount.size shouldBe 4
+    }
+}

src/test/kotlin/minesweeper/model/board/RowsTest.kt

@@ -0,0 +1,18 @@
+package minesweeper.model.board
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.ints.shouldBeBetween
+
+class RowsTest : StringSpec({
+    "열의 길이 범위 내의 랜덤한 위치값을 반환받는다" {
+        // given
+        val size = 10
+        val row = Rows(size)
+
+        // when
+        val result = row.getPosition()
+
+        // then
+        result.shouldBeBetween(0, size)
+    }
+})