[자동차 경주 step1] 양두영 미션 제출합니다.

README.md

@@ -1 +1,87 @@
-# kotlin-racingcar
+# kotlin-racingcar
+
+초간단 자동차 경주 게임을 구현한다.
+
+- 주어진 횟수 동안 n대의 자동차는 전진 또는 멈출 수 있다.
+- 각 자동차에 이름을 부여할 수 있다. 자동차 이름은 5자를 초과할 수 없다.
+- 자동차 이름은 쉼표(,)를 기준으로 구분한다.
+- 전진하는 자동차를 출력할 때 자동차 이름을 같이 출력한다.
+- 사용자는 몇 대의 자동차로 몇 번의 이동을 할 것인지를 입력할 수 있어야 한다.
+- 전진하는 조건은 0에서 9 사이에서 무작위 값을 구한 후 무작위 값이 4 이상일 경우이다.
+- 자동차의 상태를 화면에 출력한다. 어느 시점에 출력할 것인지에 대한 제약은 없다.
+- 자동차 경주 게임을 완료한 후 누가 우승했는지를 알려준다. 우승자는 한 명 이상일 수 있다.
+- 사용자가 잘못된 값을 입력할 경우 `IllegalArgumentException`을 발생시킨 후 애플리케이션은 종료되어야 한다.
+---
+# 실행결과
+```kotlin
+경주할 자동차 이름을 입력하세요(이름은 쉼표(,)를 기준으로 구분).
+hoon,seong,choi
+시도할 횟수는 몇 회인가요?
+5
+
+실행 결과
+hoon : -
+seong : 
+choi : -
+
+hoon : --
+seong : -
+choi : --
+
+hoon : ---
+seong : --
+choi : ---
+
+hoon : ----
+seong : ---
+choi : ----
+
+hoon : -----
+seong : ----
+choi : -----
+
+최종 우승자: hoon, choi
+```
+---
+# 기능 명세
+### 주요 기능
+
+1. 사용자가 자동차 이름 입력
+2. 시도할 횟수 입력
+3. 입력된 횟수만큼 각 자동차를 이동
+4. 이동 종료 후 최종 우승자 출력
+
+### 자동차 이름 입력
+
+- [x]  이름 입력 안내 문구 출력
+- [x]  사용자로부터 자동차 이름들 입력받는 기능
+- [x]  이름을 쉼표 기준으로 구분하여 저장하는 기능
+
+### 시도할 횟수 입력
+
+- [x]  횟수 입력 안내 문구를 출력
+- [x]  사용자로부터 라운드 횟수를 입력받는 기능
+
+### 자동차 이동(게임 진행)
+
+- [x]  "실행 결과" 문구 출력
+- [x]  주사위를 사용해 1자리 난수 생성 기능
+- [x]  난수값이 4 이상인 자동차의 위치를 1 증가시키는 기능
+- [x]  각 라운드 별 실행 결과(자동차 위치) 출력하는 기능
+- [x]  입력된 횟수만큼 라운드를 반복하는 기능
+
+### 우승자 출력
+
+- [x]  우승자(가장 멀리 이동한 자동차)를 판별하는 기능
+- [x]  우승자 출력 기능
+    - [x]  공동 우승자의 경우 ","로 구분하여 출력해야 함
+
+---
+
+# 예외처리
+
+- 자동차 이름 입력 시 유효한 입력이 아니라면 재 시도
+    - 입력된 이름들의 유효성 검증
+        - [x]  이름은 5자 이하만 가능
+        - [x]  중복된 이름 설정 불가
+        - [x]  [a-zA-Z]+

src/main/kotlin/racingcar/controller/GameController.kt

@@ -0,0 +1,45 @@
+package racingcar.controller
+
+import racingcar.model.Car
+import racingcar.model.Cars
+import racingcar.model.RandomDice
+import racingcar.view.GameInputer
+import racingcar.view.GameAnnouncer
+
+class GameController {
+    fun run(){
+        GameAnnouncer.askForCarNames()
+        val carNames = GameInputer.getCarNames()
+        val carList = carNames.map { name -> Car(name) }
+        val cars = Cars(carList)
+
+        GameAnnouncer.askForRounds()
+        val rounds = GameInputer.getRounds()
+
+        GameAnnouncer.printProcess()
+        repeat(rounds){
+            processRound(cars)
+        }
+
+        val winners = resolveWinners(cars)
+        GameAnnouncer.printWinners(winners)
+    }
+
+    private fun processRound(cars: Cars) {
+        val carNum = cars.size
+        for (i in 1..carNum) {
+            if (RandomDice.rollDice() >= 4) {
+                cars.moveCar(i)
+            }
+        }
+        GameAnnouncer.printCarPositions(cars)
+    }
+
+    private fun resolveWinners(cars : Cars) : Cars{
+        val carList = cars.getCarList()
+        val maxPosition = carList.maxOf { it.position }
+        val winners = carList.filter { it.position == maxPosition }
+            .map { it }
+        return Cars(winners)
+    }
+}

src/main/kotlin/racingcar/main.kt

@@ -1,5 +1,8 @@
 package racingcar
 
+import racingcar.controller.GameController
+
 fun main() {
-    // TODO: 프로그램 구현
+    val gameController = GameController()
+    gameController.run()
 }

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

@@ -0,0 +1,16 @@
+package racingcar.model
+
+class Car (val name : String, position : Int = 0){
+    var position = position
+        private set
+    init {
+        require(name.isNotBlank()) { "이름은 공백일 수 없습니다." }
+        require(name.matches(Regex("^[a-zA-Z]+$"))) { "이름은 영어 대소문자로 이루어져있어야 합니다." }
+        require(name.length <= 5) { "이름은 5글자 이하여야 합니다." }
+        require(position >= 0) { "위치는 0이상이어야 합니다." }
+    }
+    fun move(){
+        position++
+    }
+
+}

src/main/kotlin/racingcar/model/Cars.kt

@@ -0,0 +1,19 @@
+package racingcar.model
+
+class Cars(private val carList:List<Car>) {
+    val size: Int
+        get() = carList.size
+
+    init{
+        val carNames = carList.map {it.name}.toSet()
+        require(carNames.size == carList.size) { "중복된 차 이름이 있습니다" }
+    }
+
+    fun getCarList():List<Car>{
+        return carList
+    }
+
+    fun moveCar(index : Int){
+        carList[index-1].move()
+    }
+}

src/main/kotlin/racingcar/model/RandomDice.kt

@@ -0,0 +1,7 @@
+package racingcar.model
+
+import kotlin.random.Random
+
+object RandomDice {
+    fun rollDice():Int = Random.nextInt(0, 10)
+}

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

@@ -0,0 +1,33 @@
+package racingcar.view
+
+import racingcar.model.Car
+import racingcar.model.Cars
+
+object GameAnnouncer {
+    private const val NAME_INPUT_DESCRIPTION = "경주할 자동차 이름을 입력하세요(이름은 쉼표(,)를 기준으로 구분)."
+    private const val ROUNDS_INPUT_DESCRIPTION = "시도할 횟수는 몇 회인가요?"
+    private const val PROCESSING_DESCRIPTION = "실행결과"
+
+    fun askForCarNames(){
+        println(NAME_INPUT_DESCRIPTION)
+    }
+    fun askForRounds() {
+        println(ROUNDS_INPUT_DESCRIPTION)
+    }
+    fun printCarPositions(cars : Cars){
+        cars.getCarList().forEach{printCarPosition(it)}
+        println()
+    }
+    fun printWinners(winners : Cars) {
+        val winnerList = winners.getCarList()
+        val winnerNames = winnerList.joinToString(", ") { it.name }
+        println("최종 우승자 : $winnerNames")
+    }
+    fun printProcess() {
+        println(PROCESSING_DESCRIPTION)
+    }
+
+    fun printCarPosition(car : Car){
+        println(car.name+" : "+("-".repeat(car.position)))
+    }
+}

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

@@ -0,0 +1,16 @@
+package racingcar.view
+
+object GameInputer {
+    fun getCarNames() : List<String>{
+        val inputString = readln()
+        return inputString.split(",").map { it.trim() }
+    }
+
+    fun getRounds() : Int{
+        val input = readlnOrNull()
+        val number = input?.toIntOrNull() ?: throw IllegalArgumentException("유효한 정수를 입력하지 않았습니다.")
+
+        require(number < 0){throw IllegalArgumentException("음수는 허용되지 않습니다.")}
+        return number
+    }
+}

src/test/kotlin/study/model/CarTest.kt

@@ -0,0 +1,39 @@
+package study.model
+
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+import racingcar.model.Car
+import java.io.ByteArrayOutputStream
+import java.io.PrintStream
+
+class CarTest {
+    @Test
+    fun `자동차를 1칸 앞으로 움직인다`(){
+        //given
+        val car = Car("apple")
+
+        //when
+        car.move()
+
+        //then
+        assertEquals(1,car.position)
+    }
+    @Test
+    fun `자동차의 위치를 출력한다`(){
+        //given
+        val expected = "apple : ---"
+        val car = Car("apple",3)
+
+        val outputStream = ByteArrayOutputStream()
+        val originalOut = System.out
+        System.setOut(PrintStream(outputStream))
+
+        //when
+        car.printNowPosition()
+        val result = outputStream.toString().trim()
+
+        //then
+        assertEquals(expected, result)
+        System.setOut(originalOut)
+    }
+}

src/test/kotlin/study/model/CarsTest.kt

@@ -0,0 +1,44 @@
+package study.model
+
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+import racingcar.model.Car
+import racingcar.model.Cars
+
+class CarsTest {
+
+    @Test
+    fun `자동차 이름 리스트로 자동차 객체들의 집합을 생성한다`(){
+        //given
+        val car1 = Car("apple")
+        val car2 = Car("banana")
+        val car3 = Car("cherry")
+        val expected = listOf(car1, car2, car3)
+
+        //when
+        val cars = Cars(listOf(car1,car2,car3))
+
+        //then
+        val result = cars.getCarList()
+
+        print(cars)
+        assertEquals(expected, result)
+    }
+
+    @Test
+    fun `특정 위치의 자동차를 한 칸 움직인다`(){
+        //given
+        val expected = 1
+        val car1 = Car("apple")
+        val car2 = Car("banana")
+        val car3 = Car("cherry")
+        val cars = Cars(listOf(car1,car2,car3))
+
+        //when
+        cars.moveCar(1)
+
+        //then
+        val carList = cars.getCarList()
+        assertEquals(carList[0].position, 1)
+    }
+}

src/test/kotlin/study/utils/GameInputerTest.kt

@@ -0,0 +1,56 @@
+package study.utils
+
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+import racingcar.view.GameInputer
+import java.io.ByteArrayInputStream
+import java.io.InputStream
+
+
+class GameInputerTest {
+    private val gameInputer = GameInputer
+    @Test
+    fun `자동차 이름을 입력받아 쉼표 기준으로 구분한다`(){
+        //given
+        val expected: List<String> = listOf("apple", "banana", "cherry")
+        val input = "apple,banana,cherry"
+        val simulatedInput: InputStream = ByteArrayInputStream(input.toByteArray())
+        System.setIn(simulatedInput)
+
+        //when
+        val result = gameInputer.getCarNames()
+
+        //then
+        assertThat(result).isEqualTo(expected)
+    }
+
+    @Test
+    fun `라운드를 입력받는다`(){
+        //given
+        val input = "5"
+        val simulatedInput: InputStream = ByteArrayInputStream(input.toByteArray())
+        System.setIn(simulatedInput)
+
+        //when
+        val result = gameInputer.getRounds()
+
+        //then
+        assertTrue(result is Int,"변수가 정수여야 합니다.")
+    }
+
+    @Test
+    fun `라운드가 잘못 입력될시, IllegalArgumentException을 발생시키고 프로그램을 종료한다`(){
+        //given
+        val input = "종경"
+        val simulatedInput: InputStream = ByteArrayInputStream(input.toByteArray())
+        System.setIn(simulatedInput)
+
+        //when
+        //then
+        assertThrows<IllegalArgumentException> {
+            gameInputer.getRounds()
+        }
+    }
+}