🚀 4단계 - 자동차 경주(우승자) - 코드리뷰를 바탕으로 수정

TODO.md

@@ -0,0 +1,28 @@
+### TODO
+
+1. [x] 구현할 기능 목록을 정리해 추가
+2. [x] 자동자 수, 이동 수 입력 할 수 있어야 함
+3. [x] 전진하는 조건은 0에서 9 사이에서 random 값을 구한 후 random 값이 4이상일 경우
+4. [x] 모든 자동차가 이동을 완료하면 종료
+5. [x] 자동차의 상태를 화면에 출력
+6. [x] 각 자동차에 이름 입력 가능
+7. [x] 자동차 이름은 5글자를 초과할 수 없음
+9. [x] 자동차 이름은 쉼표(,)를 기준으로 구분
+8. [x] 전진하는 자동차를 출력할 때 이름 같이 출력
+10. [x] 자동차 경주 게임을 완료한 후 누가 우승했는지를 알려줌. 우승자는 한명 이상도 가능.
+
+- 값을 입력 받는 API는 Scanner를 이용
+- 랜덤 값은 자바 java.util.Random 클래스의 nextInt(10) 메소드를 활용
+- else 예약어를 쓰지 않는다
+- 기능을 구현하기 전에 README.md 파일에 구현할 기능 목록을 정리해 추가
+- git의 commit 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위로 추가
+
+### AngularJS Commit Message Conventions
+
+* feat (feature)
+* fix (bug fix)
+* docs (documentation)
+* style (formatting, missing semi colons, …)
+* refactor
+* test (when adding missing tests)
+* chore (maintain)

src/main/java/calculator/StringAddCalculator.java

@@ -0,0 +1,64 @@
+package calculator;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class StringAddCalculator {
+
+    public static final String DEFAULT_DELIMITER = ",|:";
+    public static final String CUSTOM_DELIMITER = "//(.)\n(.*)";
+    public static final Pattern CUSTOM_DELIMITER_PATTERN = Pattern.compile(CUSTOM_DELIMITER);
+
+    public static int calculateSum(String text) {
+        if (isBlank(text)) {
+            return 0;
+        }
+        return sumValues(toInts(splitValues(text)));
+    }
+
+    private static String[] splitValues(String text) {
+        Matcher matcher = CUSTOM_DELIMITER_PATTERN.matcher(text);
+        if (matcher.find()) {
+            String customDelimiter = matcher.group(1);
+            return matcher.group(2).split(customDelimiter);
+        }
+        return text.split(DEFAULT_DELIMITER);
+    }
+
+    private static boolean isBlank(String text) {
+        return text == null || text.isBlank();
+    }
+
+    private static int[] toInts(String[] values) {
+        int[] numbers = new int[values.length];
+
+        for (int i = 0; i < values.length; i++) {
+            validateNumber(values[i]);
+            numbers[i] = Integer.parseInt(values[i]);
+        }
+        return numbers;
+    }
+
+    private static void validateNumber(String value) {
+        int number = parseNumber(value);
+        if (number < 0) {
+            throw new IllegalArgumentException("음수는 계산되지 않습니다.");
+        }
+    }
+
+    private static int parseNumber(String value) {
+        try {
+            return Integer.parseInt(value);
+        } catch (NumberFormatException e) {
+            throw new IllegalArgumentException("숫자 이외의 값이 입력되었습니다.");
+        }
+    }
+
+    private static int sumValues(int[] values) {
+        int result = 0;
+        for (int value : values) {
+            result += value;
+        }
+        return result;
+    }
+}

src/main/java/racingcar/Car.java

@@ -0,0 +1,45 @@
+package racingcar;
+
+public class Car {
+
+    private static final int MOVE_CONDITION = 4;
+    private static final int MAX_NAME_LENGTH = 5;
+
+    private final String name;
+    private int currentPosition;
+
+    public Car(final String name) {
+        this(name, 0);
+    }
+
+    public Car(String name, int position) {
+        validationCarName(name);
+        this.name = name.trim();
+        this.currentPosition = position;
+    }
+
+    private void validationCarName(String name) {
+        if (name == null || name.trim().isBlank()) {
+            throw new IllegalArgumentException("자동차 이름은 값이 존재해야 합니다.");
+        }
+        if (name.trim().length() >= MAX_NAME_LENGTH) {
+            throw new IllegalArgumentException("자동차 이름은 5 미만의 글자여야 합니다.");
+        }
+    }
+
+    public int move(int randomNumber) {
+        if (randomNumber >= MOVE_CONDITION) {
+            currentPosition++;
+        }
+        return currentPosition;
+    }
+
+    public int getCurrentPosition() {
+        return currentPosition;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+}

src/main/java/racingcar/InputView.java

@@ -0,0 +1,22 @@
+package racingcar;
+
+import java.util.Scanner;
+
+public class InputView {
+
+    private static final Scanner SCANNER = new Scanner(System.in);
+
+    private InputView() {
+
+    }
+
+    public static String[] getCarNames() {
+        System.out.println("경주할 자동차 이름을 입력하세요. (이름은 쉼표(,)를 기준으로 구분");
+        return SCANNER.nextLine().split(",");
+    }
+
+    public static int getRoundNumber() {
+        System.out.println("시도 할 횟수는 몇 번 인가요?");
+        return SCANNER.nextInt();
+    }
+}

src/main/java/racingcar/Racing.java

@@ -0,0 +1,28 @@
+package racingcar;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Random;
+
+public class Racing {
+
+    private static final Random RANDOM = new Random();
+
+    private final List<Car> cars;
+
+    public Racing(List<Car> cars) {
+        this.cars = cars;
+    }
+
+    public List<RacingResult> play() {
+        List<RacingResult> racingResults = new ArrayList();
+
+        for (Car car : cars) {
+            car.move(RANDOM.nextInt(10));
+            RacingResult racingResult = new RacingResult(car.getName(), car.getCurrentPosition());
+            racingResults.add(racingResult);
+        }
+        return racingResults;
+    }
+
+}

src/main/java/racingcar/RacingCarMain.java

@@ -0,0 +1,28 @@
+package racingcar;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class RacingCarMain {
+
+    public static void main(String[] args) {
+        String[] names = InputView.getCarNames();
+        int roundNum = InputView.getRoundNumber();
+
+        List<Car> cars = new ArrayList<>();
+        for (int i = 0; i < names.length; i++) {
+            cars.add(new Car(names[i]));
+        }
+
+        Racing racing = new Racing(cars);
+
+        for (int i = 0; i < roundNum; i++) {
+            ResultView.roundStart(i + 1);
+            List<RacingResult> carPositions = racing.play();
+            ResultView.drawCarPositions(carPositions);
+        }
+        List<Car> winners = Winners.findWinners(cars);
+        ResultView.printWinners(winners);
+    }
+
+}

src/main/java/racingcar/RacingResult.java

@@ -0,0 +1,20 @@
+package racingcar;
+
+public class RacingResult {
+
+    private final String name;
+    private final int position;
+
+    public RacingResult(String name, int position) {
+        this.name = name;
+        this.position = position;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public int getPosition() {
+        return position;
+    }
+}

src/main/java/racingcar/ResultView.java

@@ -0,0 +1,39 @@
+package racingcar;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class ResultView {
+
+    private static final String LINE = "-".repeat(5);
+
+    private ResultView() {
+
+    }
+
+    public static void roundStart(int roundNumber) {
+        System.out.println(LINE + roundNumber + " 라운드 시작!" + LINE);
+    }
+
+    public static void drawCarPositions(List<RacingResult> results) {
+        for (RacingResult result : results) {
+            StringBuilder stringBuilder = new StringBuilder();
+            stringBuilder
+                    .append(result.getName())
+                    .append(" : ")
+                    .append("-".repeat(result.getPosition()));
+            System.out.println(stringBuilder.toString());
+        }
+    }
+
+    public static void printWinners(List<Car> winners) {
+        String winnersName = winners.stream().map(Car::getName)
+                .collect(Collectors.joining(","));
+
+        StringBuilder stringBuilder = new StringBuilder();
+        stringBuilder
+                .append(winnersName)
+                .append("이(가) 최종 우승 했습니다.");
+        System.out.println(stringBuilder.toString());
+    }
+}

src/main/java/racingcar/Winners.java

@@ -0,0 +1,32 @@
+package racingcar;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class Winners {
+    public static List<Car> findWinners(List<Car> cars) {
+        return findWinners(cars, getMaxPosition(cars));
+    }
+
+    private static List<Car> findWinners(List<Car> cars, int maxPosition) {
+        List<Car> winners = new ArrayList<>();
+        for (Car car : cars) {
+            addIfMaxPosition(maxPosition, car, winners);
+        }
+        return winners;
+    }
+
+    private static void addIfMaxPosition(int maxPosition, Car car, List<Car> winners) {
+        if (maxPosition == car.getCurrentPosition()) {
+            winners.add(car);
+        }
+    }
+
+    private static int getMaxPosition(List<Car> cars) {
+        int maxPosition = 0;
+        for (Car car : cars) {
+            maxPosition = Math.max(car.getCurrentPosition(), maxPosition);
+        }
+        return maxPosition;
+    }
+}

src/test/java/calculator/StringAddCalculatorTest.java

@@ -0,0 +1,64 @@
+package calculator;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+class StringAddCalculatorTest {
+
+    @Test
+    @DisplayName("숫자 하나를 문자열로 입력할 시 해당 숫자를 반환하는지 확인")
+    void oneStringNumTest() {
+        int result = StringAddCalculator.calculateSum("1");
+        assertThat(result).isEqualTo(1);
+    }
+
+    @Test
+    @DisplayName("콤마를 구분자로 나뉘어 각 숫자의 합을 반환하는지 확인")
+    void sumWithCommaDelimiter() {
+        int result = StringAddCalculator.calculateSum("1,2");
+        assertThat(result).isEqualTo(3);
+    }
+
+    @Test
+    @DisplayName("콜론을 구분자로 나뉘어 각 숫자의 합을 반환하는지 확인")
+    void sumWithColonDelimiter() {
+        int result = StringAddCalculator.calculateSum("1:2");
+        assertThat(result).isEqualTo(3);
+    }
+
+    @ParameterizedTest
+    @DisplayName("빈 문자열 또는 null 값을 입력할 경우 0을 반환하는지 확인")
+    @NullAndEmptySource
+    void returnZeroForEmpty(String input) {
+        int result = StringAddCalculator.calculateSum(input);
+        assertThat(result).isEqualTo(0);
+    }
+
+    @Test
+    @DisplayName("//”와 “\\n” 문자 사이에 커스텀 구분자 지정하여 사용할 수 있는지 확인")
+    void sumWithCustomDelimiter() {
+        int result = StringAddCalculator.calculateSum("//;\n1;2;3");
+        assertThat(result).isEqualTo(6);
+    }
+
+    @Test
+    @DisplayName("음수를 전달할 경우 RuntimeException 예외 throw하는지 확인")
+    void returnErrorForNegativeNum() {
+        assertThatThrownBy(() -> {
+            StringAddCalculator.calculateSum("-3");
+        }).isInstanceOf(IllegalArgumentException.class);
+    }
+
+    @Test
+    @DisplayName("숫자 이외의 값을 전달할 경우 RuntimeException 예외 throw하는지 확인")
+    void returnErrorForInvalidText() {
+        assertThatThrownBy(() -> {
+            StringAddCalculator.calculateSum("&");
+        }).isInstanceOf(IllegalArgumentException.class);
+    }
+}