[2단계 - 자동차 경주 리팩터링] 테오(최우성) 미션 제출합니다. (#590)

* refactor: 우승자 반환 시 자동차가 없는 경우 디테일한 예외를 던지도록 변경

* refactor: 상수 필드를 모두 static final로 변경

* refactor: 예외메세지 출력을 View의 책임으로 변경

* refactor: OutputView을 ConsoleView로 리네이밍

* refactor: 시도 횟수 검증 메소드 네이밍을 이해하기 쉽도록 수정

* refactor: 자동차 비교 시 getter를 사용하지 않도록 수정

* refactor: 자동차 이름 VO 생성

* refactor: 자동차 이름 객체 getter명 변경

* refactor: 자동차 위치 정보를 관리하는 VO 생성

* refactor: 자동차 위치를 외부에서 주입받도록 수정

* refactor: 시도 횟수를 객체로 다루도록 수정

* refactor: 우승자 테스트 로직에 가독성 부여

* docs: 변경사항 및 고민사항 기재

* refactor: 코인을 사용할 때 유효성 검증 추가

* refactor: getter 명을 이해하기 쉽도록 변경

* refactor: 커스텀 예외를 사용해 도메인에서 뷰 의존성 제거

docs/README.md

@@ -26,3 +26,31 @@
 - [x] 문구들을 어디서 출력할지.
   - [x] OutputView에서 printGameResultMessage 메소드는 적절한지?
 - [x] 유효성 검증을 도메인에서 할지, 입력받을 때 할지.
+
+
+---
+#### 2단계 변경사항
+1. 상수 필드를 모두 static final로 변경.
+2. 우승자 검출을 위한 자동차 비교 시 getter를 전혀 사용하지 않도록 수정.
+3. 도메인과 컨트롤러 영역에서 View에 대해 전혀 모르도록 예외 메세지를 출력하는 부분까지 OutputView에게 위임함. <br>
+4. 자동차 이름을 관리하는 VO를 생성했음. 자동차 이름에 대한 제약조건도 여럿 존재하고, <br>
+이것을 자동차 객체가 다루기보다는 `carName` 객체가 다루는 것이 보다 적절한 책임 분배라고 생각했다. <br>
+비슷한 이유로 `Position` VO를 분리함. 
+5. 시도 횟수를 다루는 객체를 둬서 프로덕션 및 테스트 코드를 간결하게 변경.
+
+
+#### 2단계 고민사항
+1. 어느정도까지 확장성있게 설계하는게 옳을까? 얼마나 확장해야 오버프로그래밍이 되지 않을까? <br>
+예를 들어서, OutputView가 지금은 `한국어로 콘솔에 출력`하는 것이지만, `영어로 콘솔에 출력` 된다거나, 콘솔이 아닌 다른 곳에 출력이 될 수도 있을 것이다. <br>
+그러면 OutputView 위에 부모 클래스나 Interface를 정의하는 것이 낫지 않을까? 하지만 현재 문제 해결 상황에서는 전혀 필요하지 않다. <br>
+오버 프로그래밍과 유연함 사이의 적정선은 어디인가? <br> <br>
+
+2. VO의 경우 메소드 및 프로퍼티의 네이밍은 어떻게 해야할까? <br>
+CarName의 경우, 프로퍼티 및 getter의 이름은 어떻게 해야 좋을지 고민. <br>
+프로퍼티 이름은 `carName`으로 했는데, 클래스명과 중복이 된다는 점에서 애매하다는 느낌을 받았음. <br>
+또한 비슷한 이유에서 getter 이름을 `getCarName`이라고 하지 않고 `get` 이라고 정의했는데(carName.get() 처럼 사용될 수 있도록) <br>
+괜찮은 방법인지도 고민! <br> <br>
+
+3. 현재 입력을 위한 출력이 InputView에서 수행되고 있는데, <br>
+View가 콘솔창이 아니게 된다거나 하는 경우에는 InputView까지 수정이 되어야 한다. <br>
+그러면 InputView에서도 출력이 필요할 때 OutputView를 호출해야 하지 않을까? <br>

src/main/java/Application.java

@@ -1,12 +1,12 @@
 import controller.RacingController;
 import view.input.InputView;
-import view.output.OutputView;
+import view.output.ConsoleView;
 
 import java.util.Scanner;
 
 public class Application {
     public static void main(String[] args) {
         Scanner scanner = new Scanner(System.in);
-        new RacingController(new InputView(scanner), new OutputView()).start();
+        new RacingController(new InputView(scanner), new ConsoleView()).start();
     }
 }

src/main/java/controller/RacingController.java

@@ -3,64 +3,64 @@
 import domain.RacingGame;
 import domain.RandomNumberGenerator;
 import view.input.InputView;
-import view.output.OutputView;
+import view.output.ConsoleView;
 
 import java.util.List;
 
 public class RacingController {
 
     private final InputView inputView;
-    private final OutputView outputView;
+    private final ConsoleView consoleView;
     private RacingGame racingGame;
 
-    public RacingController(InputView inputView, OutputView outputView) {
+    public RacingController(InputView inputView, ConsoleView consoleView) {
         this.inputView = inputView;
-        this.outputView = outputView;
+        this.consoleView = consoleView;
     }
 
     public void start() {
         try {
-            makeRacingGame(readCarNames());
-            startRacingGame(readGameTry());
+            makeRacingGame(readCarNames(), readGameTry());
+            startRacingGame();
             makeRacingGameResult();
-        } catch (IllegalArgumentException e) {
-            System.out.println(e.getMessage());
+        } catch (RuntimeException e) {
+            consoleView.printExceptionMessage(e.getMessage());
             start();
         }
     }
 
-    private void makeRacingGame(List<String> carNames) {
-        this.racingGame = new RacingGame(carNames, new RandomNumberGenerator());
-    }
-
     private List<String> readCarNames() {
         try {
             return inputView.readCarName();
         } catch (IllegalArgumentException e) {
-            System.out.println(e.getMessage());
+            consoleView.printExceptionMessage(e.getMessage());
             return readCarNames();
         }
     }
 
-    private void startRacingGame(int gameTry) {
-        outputView.printGameResultMessage();
-        for (int i = 0; i < gameTry; i++) {
-            racingGame.start();
-            outputView.printRacingStatus(racingGame.getCars());
-        }
-    }
-
     private int readGameTry() {
         try {
             return inputView.readGameTry();
         } catch (IllegalArgumentException e) {
-            System.out.println(e.getMessage());
+            consoleView.printExceptionMessage(e.getMessage());
             return readGameTry();
         }
     }
 
+    private void makeRacingGame(List<String> carNames, int gameTry) {
+        this.racingGame = new RacingGame(carNames, gameTry, new RandomNumberGenerator());
+    }
+
+    private void startRacingGame() {
+        consoleView.printGameResultMessage();
+        while (racingGame.isGameOnGoing()) {
+            racingGame.start();
+            consoleView.printRacingStatus(racingGame.getCars());
+        }
+    }
+
     private void makeRacingGameResult() {
-        outputView.printRacingStatus(racingGame.getCars());
-        outputView.printRacingWinners(racingGame.getWinners());
+        consoleView.printRacingStatus(racingGame.getCars());
+        consoleView.printRacingWinners(racingGame.getWinners());
     }
 }

src/main/java/domain/Car.java

@@ -2,47 +2,32 @@
 
 public class Car {
 
-    private final String CAR_NAME_LENGTH_EXCEED = "[ERROR] 자동차 이름의 길이는 1자 이상, 5자 이하여야 합니다.";
-    private final String CAR_NAME_EMPTY = "[ERROR] 자동차의 이름은 공백이면 안됩니다.";
+    private final CarName carName;
+    private final Position position;
 
-    private final int MAX_CAR_NAME_LENGTH = 5;
-
-    private int position;
-    private final String carName;
-
-    public Car(String carName) {
-        validateCarName(carName);
-        this.carName = carName;
-        position = 0;
-    }
-
-    public void validateCarName(String carName) {
-        validateCarNameIsNotEmpty(carName);
-        validateCarNameLength(carName);
+    public Car(String name, int position) {
+        this.carName = new CarName(name);
+        this.position = new Position(position);
     }
 
-    private void validateCarNameIsNotEmpty(String carName) {
-        if (carName.isBlank()) {
-            throw new IllegalArgumentException(CAR_NAME_EMPTY);
-        }
+    public void move() {
+        position.moveForward();
     }
 
-    private void validateCarNameLength(String carName) {
-        if (carName.length() > MAX_CAR_NAME_LENGTH) {
-            throw new IllegalArgumentException(CAR_NAME_LENGTH_EXCEED);
-        }
+    public int comparePosition(Car otherCar) {
+        return this.getPosition() - otherCar.getPosition();
     }
 
-    public void move() {
-        position++;
+    public boolean hasSamePositionWith(Car otherCar) {
+        return comparePosition(otherCar) == 0;
     }
 
     public int getPosition() {
-        return position;
+        return position.getPosition();
     }
 
     public String getCarName() {
-        return carName;
+        return carName.getCarName();
     }
 }
 

src/main/java/domain/CarName.java

@@ -0,0 +1,37 @@
+package domain;
+
+import exception.CarNameBlankException;
+import exception.CarNameLengthException;
+
+public class CarName {
+
+    private static final int MAX_CAR_NAME_LENGTH = 5;
+
+    private final String carName;
+
+    public CarName(String carName) {
+        validateCarName(carName);
+        this.carName = carName;
+    }
+
+    private void validateCarName(String carName) {
+        validateCarNameIsNotEmpty(carName);
+        validateCarNameLength(carName);
+    }
+
+    private void validateCarNameIsNotEmpty(String carName) {
+        if (carName.isBlank()) {
+            throw new CarNameBlankException();
+        }
+    }
+
+    private void validateCarNameLength(String carName) {
+        if (carName.length() > MAX_CAR_NAME_LENGTH) {
+            throw new CarNameLengthException();
+        }
+    }
+
+    public String getCarName() {
+        return carName;
+    }
+}

src/main/java/domain/Coin.java

@@ -0,0 +1,20 @@
+package domain;
+
+public class Coin {
+
+    private int remaining;
+
+    public Coin(int remaining) {
+        this.remaining = remaining;
+    }
+
+    public void use() {
+        if (isLeft()) {
+            remaining--;
+        }
+    }
+
+    public boolean isLeft() {
+        return remaining > 0;
+    }
+}

src/main/java/domain/Position.java

@@ -0,0 +1,31 @@
+package domain;
+
+import exception.PositionInvalidException;
+
+public class Position {
+
+    private int position;
+
+    public Position(int position) {
+        validatePosition(position);
+        this.position = position;
+    }
+
+    private void validatePosition(int position) {
+        validatePositionIsNotNegative(position);
+    }
+
+    private void validatePositionIsNotNegative(int position) {
+        if (position < 0) {
+            throw new PositionInvalidException();
+        }
+    }
+
+    public void moveForward() {
+        position++;
+    }
+
+    public int getPosition() {
+        return position;
+    }
+}

src/main/java/domain/RacingGame.java

@@ -1,29 +1,34 @@
 package domain;
 
+import exception.NoCarsExistException;
+
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.stream.Collectors;
 
 public class RacingGame {
 
-    private final int MOVABLE_BOUND = 4;
+    private static final int DEFAULT_START_LINE = 0;
+    private static final int MOVABLE_BOUND = 4;
 
     private final List<Car> cars;
     private final NumberGenerator numberGenerator;
+    private final Coin gameCoin;
 
-    public RacingGame(List<String> splitCarNames, NumberGenerator numberGenerator) {
+    public RacingGame(List<String> splitCarNames, int gameTry, NumberGenerator numberGenerator) {
         cars = splitCarNames.stream()
-                .map(Car::new)
+                .map(carName -> new Car(carName, DEFAULT_START_LINE))
                 .collect(Collectors.toList());
-
+        gameCoin = new Coin(gameTry);
         this.numberGenerator = numberGenerator;
     }
 
     public void start() {
         for (Car car : cars) {
             moveCar(car);
         }
+        gameCoin.use();
     }
 
     private void moveCar(Car car) {
@@ -33,6 +38,10 @@ private void moveCar(Car car) {
         }
     }
 
+    public boolean isGameOnGoing() {
+        return gameCoin.isLeft();
+    }
+
     public List<Car> getCars() {
         return Collections.unmodifiableList(cars);
     }
@@ -41,13 +50,13 @@ public List<Car> getWinners() {
         Car furthestCar = getFurthestCar();
 
         return cars.stream()
-                .filter(car -> car.getPosition() == furthestCar.getPosition())
+                .filter(car -> car.hasSamePositionWith(furthestCar))
                 .collect(Collectors.toList());
     }
 
     private Car getFurthestCar() {
         return cars.stream()
-                .max(Comparator.comparingInt(Car::getPosition))
-                .orElseThrow(RuntimeException::new);
+                .max(Car::comparePosition)
+                .orElseThrow(NoCarsExistException::new);
     }
 }

src/main/java/domain/RandomNumberGenerator.java

@@ -4,7 +4,7 @@
 
 public class RandomNumberGenerator implements NumberGenerator {
 
-    private final int DIGIT_MAX = 10;
+    private static final int DIGIT_MAX = 10;
 
     public int makeDigit() {
         Random random = new Random();

src/main/java/exception/CarNameBlankException.java

@@ -0,0 +1,10 @@
+package exception;
+
+public class CarNameBlankException extends RuntimeException {
+
+    private static final String MESSAGE = "[ERROR] 자동차의 이름은 공백이면 안됩니다.";
+
+    public CarNameBlankException() {
+        super(MESSAGE);
+    }
+}

src/main/java/exception/CarNameLengthException.java

@@ -0,0 +1,10 @@
+package exception;
+
+public class CarNameLengthException extends RuntimeException {
+
+    private static final String MESSAGE = "[ERROR] 자동차 이름의 길이는 1자 이상, 5자 이하여야 합니다.";
+
+    public CarNameLengthException() {
+        super(MESSAGE);
+    }
+}

src/main/java/exception/NoCarsExistException.java

@@ -0,0 +1,10 @@
+package exception;
+
+public class NoCarsExistException extends RuntimeException {
+
+    private final static String MESSAGE = "[ERROR] 자동차가 존재하지 않습니다.";
+
+    public NoCarsExistException() {
+        super(MESSAGE);
+    }
+}