[자동차 경주] 이상현 미션 제출합니다.

README.md

@@ -0,0 +1,46 @@
+# 자동차 경주 - 초간단 애플리케이션
+
+## 1단계 요구사항
+- 자동차는 이름과 거리를 가지고 있다.
+- 자동차는 움직일 수 있다.
+  - 0에서 9 사이에서 random 값을 구한 후 random 값이 4 이상일 경우 전진하고, 3 이하의 값이면 멈춘다.
+- 0 ~ 9 사이의 random 한 값을 생성시키는 객체가 필요하다.
+
+## 2단계 요구사항
+- n대의 자동차가 참여할 수 있다.
+- 자동차 경주 게임을 완료한 후 누가 우승했는지를 구할 수 있다. 우승자는 한 명 이상일 수 있다.
+- 경주 게임이라는 객체가 필요해보인다.
+  - 생성자로 n대의 자동차 객체가 들어간다
+  - 게임을 진행하는 메소드가 필요해보인다.
+  - 주어진 횟수가 끝나면 자동차끼리의 distance를 비교하여 자동차 이름 리스트를 반환하고 저장한다.
+
+## 3단계 요구사항
+- 메인 메서드를 추가하여 실행 가능한 애플리케이션으로 만든다.
+- 각 자동차에 이름을 부여할 수 있다. 전진하는 자동차를 출력할 때 자동차 이름을 같이 출력한다.
+  - 출력문에 대한 문자열 관리
+- 자동차 이름은 쉼표(,)를 기준으로 구분하며 이름은 5자 이하만 가능하다.
+  - 자동차 생성시 이름 길이에 대한 유효성 검증
+- 사용자는 몇 번의 이동을 할 것인지를 입력할 수 있어야 한다.
+  - 이동 횟수가 정수인지 유효성 검증
+
+## 4단계 요구사항 정리
+- 게임 시도 횟수 입력 시 정수가 아니면 예외 처리에 대한 문구 추가하기
+- 모든 로직에 단위 테스트를 구현
+- 예외 사항 더 추상화하여 처리해보기
+  - 자동차 이름 비었을 때
+  - 자동차 이름 6자 이상일 때
+
+## 프로그래밍 요구사항
+
+- 자동차가 움직이는 기능이 의도대로 동작하는지 테스트한다.
+- 자바 코드 컨벤션을 지키면서 프로그래밍한다.
+  - 기본적으로 Java Style Guide을 원칙으로 한다.
+- indent(인덴트, 들여쓰기) depth를 2를 넘지 않도록 구현한다. 1까지만 허용한다.
+  - 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다. 
+  - 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다.
+- 3항 연산자를 쓰지 않는다. 
+- else 예약어를 쓰지 않는다. 
+  - else 예약어를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다. 
+  - 힌트: if문에서 값을 반환하는 방식으로 구현하면 else 예약어를 사용하지 않아도 된다.
+- 함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다.
+  - 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다.

build.gradle

@@ -14,6 +14,8 @@ dependencies {
     testImplementation platform('org.assertj:assertj-bom:3.25.1')
     testImplementation('org.junit.jupiter:junit-jupiter')
     testImplementation('org.assertj:assertj-core')
+    testImplementation('org.mockito:mockito-core:5.11.0')
+    testImplementation('org.mockito:mockito-junit-jupiter:5.11.0')
 }
 
 test {

src/main/java/CarRaceApp.java

@@ -0,0 +1,37 @@
+import domain.Car;
+import domain.CarNameParser;
+import domain.CarRace;
+import domain.NumberGenerator;
+import domain.NumberGeneratorImpl.RandomNumberGenerator;
+import java.util.List;
+import view.InputView;
+import view.OutputView;
+
+public class CarRaceApp {
+    public static void main(String[] args) {
+        final InputView inputView = new InputView();
+        final OutputView outputView = new OutputView();
+        final CarNameParser carNameParser = new CarNameParser();
+        final NumberGenerator numberGenerator = new RandomNumberGenerator();
+
+        List<Car> cars = getCars(outputView, inputView, carNameParser);
+        int gameRounds = getGameRounds(outputView, inputView);
+        final CarRace carRace = new CarRace(cars, gameRounds, numberGenerator);
+        carRace.start();
+
+        outputView.printGameResult(carRace.getGameRoundsOutput());
+        outputView.printWinnerCarNames(carRace.getWinnerCarNames());
+    }
+
+    private static int getGameRounds(OutputView outputView, InputView inputView) {
+        outputView.printInputGameRounds();
+        return inputView.readGameRounds();
+    }
+
+    private static List<Car> getCars(OutputView outputView, InputView inputView,
+        CarNameParser carNameParser) {
+        outputView.printInputCarsName();
+        String carNames = inputView.readCarNames();
+        return carNameParser.parse(carNames).stream().map(Car::new).toList();
+    }
+}

src/main/java/domain/Car.java

@@ -0,0 +1,42 @@
+package domain;
+
+import exception.CarNameTooLongException;
+
+public class Car {
+    private String name;
+    private int distance = 0;
+    private final int MOVE_STANDARD_NUMBER = 4;
+    private final int MAX_CAR_NAME_LENGTH = 5;
+
+    public Car(String name){
+        validate(name);
+        this.name = name;
+    }
+
+    private void validate(String name) {
+        if(name.length() > MAX_CAR_NAME_LENGTH ){
+            throw new CarNameTooLongException("자동차의 이름은 5글자 이하여야합니다.");
+        }
+        if(name.trim().isEmpty()){
+            throw new IllegalArgumentException("자동차의 이름은 공백이 될 수 없습니다.");
+        }
+    }
+
+    public void tryMoveByNumber(int number){
+        if(number >= MOVE_STANDARD_NUMBER){
+            move();
+        }
+    }
+
+    private void move(){
+        distance+=1;
+    }
+
+    public int getDistance(){
+        return distance;
+    }
+
+    public String getName(){
+        return name;
+    }
+}

src/main/java/domain/CarNameParser.java

@@ -0,0 +1,14 @@
+package domain;
+
+import java.util.Arrays;
+import java.util.List;
+
+public class CarNameParser {
+    private final String DELIMITER=",";
+
+    public List<String> parse(String carNames) {
+        return Arrays.stream(carNames.trim().split(DELIMITER))
+            .map(String::trim)
+            .toList();
+    }
+}

src/main/java/domain/CarRace.java

@@ -0,0 +1,57 @@
+package domain;
+
+import java.util.List;
+
+public class CarRace {
+
+    private final List<Car> cars;
+    private final int gameRounds;
+    private final NumberGenerator numberGenerator;
+    private final StringBuilder gameRoundsOutput = new StringBuilder("\n실행결과");
+    private final String DISTANCE_EXPRESSION = "-";
+    private List<String> winnerCarNames;
+
+    public CarRace(List<Car> cars, int gameRounds, NumberGenerator numberGenerator) {
+        this.cars = cars;
+        this.gameRounds = gameRounds;
+        this.numberGenerator = numberGenerator;
+    }
+
+    public void start() {
+        playRounds();
+        int maxDistance = getMaxDistanceFromCars();
+        winnerCarNames = getWinnerCarNamesForMaxDistance(maxDistance);
+    }
+
+    private void playRounds() {
+        for (int i = 0; i < gameRounds; i++) {
+            cars.forEach(car -> {
+                car.tryMoveByNumber(numberGenerator.generate());
+                recordOutput(car);
+            });
+            gameRoundsOutput.append("\n");
+        }
+    }
+
+    private void recordOutput(Car car) {
+        gameRoundsOutput.append("\n").append(car.getName()).append(" : ")
+            .append(DISTANCE_EXPRESSION.repeat(car.getDistance()));
+    }
+
+    private int getMaxDistanceFromCars() {
+        return cars.stream().mapToInt(Car::getDistance).max().orElse(0);
+    }
+
+    private List<String> getWinnerCarNamesForMaxDistance(int maxDistance) {
+        return cars.stream().filter(car -> car.getDistance() == maxDistance).map(Car::getName)
+            .toList();
+    }
+
+    public List<String> getWinnerCarNames() {
+        return winnerCarNames;
+    }
+
+    public String getGameRoundsOutput() {
+        return gameRoundsOutput.toString();
+    }
+}

src/main/java/domain/NumberGenerator.java

@@ -0,0 +1,5 @@
+package domain;
+
+public interface NumberGenerator {
+    int generate();
+}

src/main/java/domain/NumberGeneratorImpl/RandomNumberGenerator.java

@@ -0,0 +1,15 @@
+package domain.NumberGeneratorImpl;
+
+import domain.NumberGenerator;
+import java.util.Random;
+
+public class RandomNumberGenerator implements NumberGenerator {
+    private final int MAX_RANDOM_NUMBER = 10;
+    private final int MIN_RANDOM_NUMBER = 0;
+    private static final Random random = new Random();
+
+    @Override
+    public int generate() {
+        return random.nextInt(MAX_RANDOM_NUMBER - MIN_RANDOM_NUMBER) + MIN_RANDOM_NUMBER;
+    }
+}

src/main/java/exception/CarNameTooLongException.java

@@ -0,0 +1,7 @@
+package exception;
+
+public class CarNameTooLongException extends IllegalArgumentException {
+    public CarNameTooLongException(String message) {
+        super(message);
+    }
+}

src/main/java/view/InputView.java

@@ -0,0 +1,20 @@
+package view;
+
+import java.util.InputMismatchException;
+import java.util.Scanner;
+
+public class InputView {
+    Scanner scanner = new Scanner(System.in);
+
+    public String readCarNames() {
+        return scanner.nextLine();
+    }
+
+    public int readGameRounds() {
+        try {
+            return scanner.nextInt();
+        } catch (InputMismatchException e) {
+            throw new IllegalArgumentException("정수가 아닌 입력입니다.");
+        }
+    }
+}

src/main/java/view/OutputView.java

@@ -0,0 +1,24 @@
+package view;
+
+import java.util.List;
+
+public class OutputView {
+    private final String WINNER_DELIMITER = ", ";
+
+    public void printInputCarsName(){
+        System.out.println("경주할 자동차 이름을 입력하세요(이름은 쉼표(,)를 기준으로 구분).");
+    }
+
+    public void printInputGameRounds(){
+        System.out.println("시도할 회수는 몇회인가요?");
+    }
+
+    public void printGameResult(String gameResult){
+        System.out.println(gameResult);
+    }
+
+    public void printWinnerCarNames(List<String> carNames){
+        System.out.print(String.join(WINNER_DELIMITER, carNames));
+        System.out.println("가 최종 우승했습니다.");
+    }
+}

src/test/java/CarRaceAppTest.java

@@ -0,0 +1,62 @@
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.when;
+
+import domain.Car;
+import domain.CarNameParser;
+import domain.CarRace;
+import domain.NumberGenerator;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.util.List;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import view.OutputView;
+
+public class CarRaceAppTest {
+    @Mock
+    NumberGenerator randomNumberGenerator;
+
+    @Test
+    @DisplayName("자동차 경주 애플리케이션 출력 테스트")
+    void carRaceTest() {
+        // Given
+        MockitoAnnotations.openMocks(this);
+        int gameRounds = 3;
+        String carNamesInput = "a,b";
+        CarNameParser carNameParser = new CarNameParser();
+        List<Car> cars = carNameParser.parse(carNamesInput).stream().map(Car::new).toList();
+        when(randomNumberGenerator.generate()).thenReturn(1, 5, 1, 5, 1, 5);
+
+        ByteArrayOutputStream outContent = new ByteArrayOutputStream();
+        System.setOut(new PrintStream(outContent));
+        OutputView outputView = new OutputView();
+        CarRace carRace = new CarRace(cars, gameRounds, randomNumberGenerator);
+
+        // When
+        carRace.start();
+        outputView.printGameResult(carRace.getGameRoundsOutput());
+        outputView.printWinnerCarNames(carRace.getWinnerCarNames());
+
+        // Then
+        String output = outContent.toString();
+        String[] lines = output.split("\\R");
+        assertThat(lines).containsExactly(
+            "",
+            "실행결과",
+            "a : ",
+            "b : -",
+            "",
+            "a : ",
+            "b : --",
+            "",
+            "a : ",
+            "b : ---",
+            "",
+            "b가 최종 우승했습니다."
+        );
+
+        System.setOut(System.out);
+    }
+}

src/test/java/domain/CarNameParserTest.java

@@ -0,0 +1,25 @@
+package domain;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+public class CarNameParserTest {
+    @ParameterizedTest
+    @ValueSource(strings = {"a,b,c", "  a, b,c  "," a , b,  c"})
+    @DisplayName("자동차 문자열 파싱 테스트")
+    void splitCarNamesString(String carNamesInput) {
+        // Given
+        CarNameParser carNameParser = new CarNameParser();
+        List<String> expected = List.of("a", "b", "c");
+
+        // When
+        List<String> actual = carNameParser.parse(carNamesInput);
+
+        // Then
+        assertThat(actual).isEqualTo(expected);
+    }
+}