[자동차 경주] 홍성우 미션 제출합니다.

README.md

@@ -1 +1,107 @@
 # kotlin-racingcar-precourse
+
+## 자동차 경주 게임
+
+---
+> 주어진 횟수동안 n대의 자동차가 전진 또는 멈추는 프로그램으로, 최종적으로 가장 멀리 간 자동차가 우승한다
+
+- 각 자동차들은 이름을 부여할 수 있다. 
+- 전진하는 자동차를 출력할 때, 자동차의 이름을 같이 출력한다.
+- 자동차 이름은 쉼표로 구분한다. (이름은 5자 이내)
+- 사용자가 몇 번의 이동을 할 것인지 입력한다.
+- 전진 조건은 0-9 사이의 무작이 값을 구한 후 무작위 값이 4이상일 경우이다.
+- 경주 게임을 완료한 후 누가 우승했는지 알려준다. (우승자는 한 명 이상일 수 있다)
+- 사용자가 잘못된 입력값을 입력할 경우 `IllegalArgumentExcetpion`을 발생시킨다.
+
+### 실행 결과 예시
+```text
+경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)
+>>> pobi,woni,jun
+시도할 횟수는 몇 회인가요?
+>>> 5
+
+실행 결과
+pobi : -
+woni :
+jun : -
+
+pobi : --
+woni : -
+jun : --
+
+pobi : ---
+woni : --
+jun : ---
+
+pobi : ----
+woni : ---
+jun : ----
+
+pobi : -----
+woni : ----
+jun : -----
+
+최종 우승자 : pobi, jun
+```
+
+## 구현할 기능
+
+---
+### view
+**`InputManager`**
+- 사용자에게서 자동차들의 이름을 부여받는다
+- 사용자에게서 이동의 횟수를 부여받는다
+
+**OutputManager**
+- 가이드를 출력한다
+- 라운드별 실행 결과를 출력한다
+- 최종 우승자를 출력한다
+
+### model
+**InputValidator**
+- 입력하는 값들에 대해서 조건을 만족하는지 확인한다
+  - 차 이름이 조건을 만족하는지 확인
+    - 이름은 `String` 형태로 주어진다
+    - 이름은 5자가 넘지 않는다
+    - 공백이 주어지는지 확인한다
+    - `null`이 아니다
+  - 이동 횟수가 조건을 만족하는지 확인
+    - 이동 횟수는 `null`이 아니다
+    - 이동 횟수는 양수로 주어진다
+
+**(interface)NumberGenerator**
+- 수를 생성하는 `generate`에 대한 규칙이다
+
+**RandomNumberGenerator**
+- 0-9까지의 수 중 랜덤 숫자를 내놓는다
+- `camp.nextstep.edu.missionutils.Randoms`의 `pickNumberInRange()`를 사용한다
+
+**Car**
+- 생성될 때 입력한 이름이 조건에 맞는지 확인한다
+- 랜덤 번호를 생성하고 이 번호가 기준을 넘는다면 앞으로 전진한다
+
+**Judge**
+- 각 차의 거리를 비교해 우승자를 가린다
+
+### Controller
+
+- 자동차의 이름을 받아 생성한다
+- 반복할 횟수를 입력받는다
+- 차를 움직이고, 매 라운드 결과를 출력한다
+- 우승자를 가리고 출력한다
+
+## 개인적인 목표
+
+---
+1. MVC 패턴을 지키겠다
+2. 의미있는 이름을 짓도록 노력하겠다
+3. 각 함수들이 하는 일이 작고 명확하게 하겠다
+4. 좋은 커밋 메세지를 작성하겠다
+   1. 제목과 본문을 한 줄 띄워 작성
+   2. 제목은 영문 기준 50자 이내로 작성
+   3. 제목 첫 글자는 대문자
+   4. 제목 끝에 `.`금지
+   5. 본문은 영문 기준 72자마다 줄바꿈
+   6. 본문은 `무엇을`, `왜`에 중점으로 작성
+5. 테스트 코드를 작성 할 때 `AssertTrue`, `AssertThat` 등 기존에 써본 것들 뿐만 아니라 새로운 것들을 시도하겠다
+6. Kotlin 컨벤션을 지키면서 작성하겠다

src/main/kotlin/racingcar/Application.kt

@@ -1,5 +1,9 @@
 package racingcar
 
+import racingcar.domain.Judge
+import racingcar.view.InputView
+import racingcar.view.OutputView
+
 fun main() {
-    // TODO: 프로그램 구현
+    RacingController(InputView(), OutputView(), Judge()).run()
 }

src/main/kotlin/racingcar/InputValidator.kt

@@ -0,0 +1,25 @@
+package racingcar
+
+class InputValidator {
+    fun validateCarName(carNames: List<String>) {
+        require(carNames.isNotEmpty()) { "자동차의 이름을 입력하셔야 합니다" }
+        for (carName in carNames) {
+            require(carName.isNotBlank()) { "자동차의 이름은 빈칸일 수 없습니다" }
+            require(carName.length <= MAX_CAR_NAME_LENGTH) { "자동차의 이름은 5글자 이하여야 합니다" }
+        }
+    }
+
+    fun validateTotalMovement(totalMovement: String) {
+        require(totalMovement.isNotEmpty()) { "이동 횟수를 입력하셔야 합니다" }
+        require(totalMovement.isNotBlank()) { "빈칸으로 주어지면 안됩니다" }
+        try {
+            totalMovement.toInt()
+        } catch (e: NumberFormatException) {
+            throw IllegalArgumentException("정수를 입력하셔야 합니다")
+        }
+    }
+
+    companion object {
+        const val MAX_CAR_NAME_LENGTH = 5
+    }
+}

src/main/kotlin/racingcar/RacingController.kt

@@ -0,0 +1,62 @@
+package racingcar
+
+import racingcar.domain.Car
+import racingcar.domain.Judge
+import racingcar.domain.RandomNumberGenerator
+import racingcar.view.InputView
+import racingcar.view.OutputView
+
+class RacingController(val inputView: InputView, val outputView: OutputView, val judge: Judge) {
+    fun run() {
+        val carNames = handleCarNames()
+        val repeatTime = handleRepeatTime()
+
+        outputView.printTextOfResult()
+        val raceResult = race(carNames, repeatTime.toInt())
+        val winners = judge.judgeWinner(raceResult)
+        outputView.printWinner(winners)
+    }
+
+    fun handleCarNames(): List<String> {
+        outputView.printCarNameInputGuide()
+        val inputFromUser = inputView.getCarNameFromUser()
+        val carNames = Separator().separateName(inputFromUser)
+        InputValidator().validateCarName(carNames)
+        return carNames
+    }
+
+    fun handleRepeatTime(): String {
+        outputView.printMovementTimeInputGuide()
+        val repeatTime = inputView.getMovementTimeFromUser()
+        InputValidator().validateTotalMovement(repeatTime)
+        return repeatTime
+    }
+
+    fun race(carNames: List<String>, repeatTime: Int): List<Car> {
+        val cars: List<Car> = carNames.map { carName ->
+            Car(
+                name = carName,
+                RandomNumberGenerator()
+            )
+        }
+
+        repeat(repeatTime) {
+            moveCar(cars)
+            printCurrentCarState(cars)
+        }
+        return cars
+    }
+
+    private fun moveCar(cars: List<Car>) {
+        for (car in cars) {
+            car.moveForward()
+        }
+    }
+
+    private fun printCurrentCarState(cars: List<Car>) {
+        for (car in cars) {
+            outputView.printCurrentLocation(car.name, car.distance)
+        }
+        println()
+    }
+}

src/main/kotlin/racingcar/Separator.kt

@@ -0,0 +1,9 @@
+package racingcar
+
+class Separator {
+    fun separateName(names: String): List<String> = names.split(NAME_SEPARATOR)
+
+    companion object {
+        const val NAME_SEPARATOR = ","
+    }
+}

src/main/kotlin/racingcar/domain/Car.kt

@@ -0,0 +1,23 @@
+package racingcar.domain
+
+class Car(val name: String, val numberGenerator: NumberGenerator) {
+    var distance: Int = INITIAL_CAR_DISTANCE
+
+    init {
+        require(name.length < MAX_NAME_LENGTH) { "자동차 이름의 길이는 5자 이하여야 합니다" }
+        require(!name.contains(" ")) { "자동차 이름엔 공백이 포함되면 안됩니다" }
+    }
+
+    fun moveForward() {
+        val randomNumber = numberGenerator.generateNumber()
+        if (randomNumber >= MOVE_FORWARD_CONDITION_NUMBER) {
+            distance++
+        }
+    }
+
+    companion object {
+        private const val MAX_NAME_LENGTH = 5
+        private const val INITIAL_CAR_DISTANCE = 0
+        private const val MOVE_FORWARD_CONDITION_NUMBER = 4
+    }
+}

src/main/kotlin/racingcar/domain/Judge.kt

@@ -0,0 +1,19 @@
+package racingcar.domain
+
+class Judge {
+    fun judgeWinner(gameResult: List<Car>): List<String> {
+        val winners = mutableListOf<String>()
+
+        var maxDistance = 0
+        for (cars in gameResult) {
+            if (cars.distance == maxDistance) winners.add(cars.name)
+            else if (cars.distance > maxDistance) {
+                winners.clear()
+                winners.add(cars.name)
+                maxDistance = cars.distance
+            }
+        }
+
+        return winners
+    }
+}

src/main/kotlin/racingcar/domain/NumberGenerator.kt

@@ -0,0 +1,5 @@
+package racingcar.domain
+
+interface NumberGenerator {
+    fun generateNumber(): Int
+}

src/main/kotlin/racingcar/domain/RandomNumberGenerator.kt

@@ -0,0 +1,12 @@
+package racingcar.domain
+
+import camp.nextstep.edu.missionutils.Randoms
+
+class RandomNumberGenerator : NumberGenerator {
+    override fun generateNumber(): Int = Randoms.pickNumberInRange(RANDOM_MIN_NUMBER, RANDOM_MAX_NUMBER)
+
+    companion object {
+        const val RANDOM_MIN_NUMBER = 0
+        const val RANDOM_MAX_NUMBER = 9
+    }
+}

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

@@ -0,0 +1,8 @@
+package racingcar.view
+
+import camp.nextstep.edu.missionutils.Console
+
+class InputView {
+    fun getCarNameFromUser(): String = Console.readLine()
+    fun getMovementTimeFromUser(): String = Console.readLine()
+}

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

@@ -0,0 +1,29 @@
+package racingcar.view
+
+class OutputView {
+    fun printCarNameInputGuide() {
+        println("경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)")
+    }
+
+    fun printMovementTimeInputGuide() {
+        println("시도할 횟수는 몇 회인가요?")
+    }
+
+    fun printTextOfResult() {
+        println()
+        println("실행 결과")
+    }
+
+    fun printCurrentLocation(name: String, distance: Int) {
+        print("$name : ")
+        repeat(distance) {
+            print("-")
+        }
+        println()
+    }
+
+    fun printWinner(winners: List<String>) {
+        val result = winners.joinToString(separator = ", ")
+        print("최종 우승자 : $result")
+    }
+}

src/test/kotlin/racingcar/InputValidatorTest.kt

@@ -0,0 +1,60 @@
+package racingcar
+
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+
+class InputValidatorTest {
+    @Test
+    fun `자동차의 이름이 없다면 IllegalArgumentException을 발생시킨다`() {
+        // given
+        val carName = mutableListOf<String>()
+
+        // when & then
+        assertThrows<IllegalArgumentException> { InputValidator().validateCarName(carName) }
+    }
+
+    @Test
+    fun `자동차의 이름이 5글자를 초과하면 IllegalArgumentException을 발생시킨다`() {
+        // given
+        val carName = listOf<String>("thisistest", "arguments")
+
+        // when & then
+        assertThrows<IllegalArgumentException> { InputValidator().validateCarName(carName) }
+    }
+
+    @Test
+    fun `자동차의 이름이 공백이라면 IllegalArgumentException을 발생시킨다`() {
+        // given
+        val carName = listOf<String>("pluto", " ")
+
+        // when & then
+        assertThrows<IllegalArgumentException> { InputValidator().validateCarName(carName) }
+    }
+
+    @Test
+    fun `이동 횟수가 정수가 아니면 IllegalArgumentException을 발생시킨다`() {
+        // given
+        val repeatTime = "String"
+
+        // when & then
+        assertThrows<IllegalArgumentException> { InputValidator().validateTotalMovement(repeatTime) }
+    }
+
+    @Test
+    fun `이동 횟수가 빈칸이라면 IllegalArgumentException을 발생시킨다`() {
+        // given
+        val repeatTime = ""
+
+        // when & then
+        assertThrows<IllegalArgumentException> { InputValidator().validateTotalMovement(repeatTime) }
+    }
+
+    @Test
+    fun `이동 횟수가 공백으로 주어지면 IllegalArgumentException을 발생시킨다`() {
+        // given
+        val repeatTime = " "
+
+        // when & then
+        assertThrows<IllegalArgumentException> { InputValidator().validateTotalMovement(repeatTime) }
+    }
+}