[자동차 경주] 김지훈 미션 제출합니다.

README.md

@@ -1 +1,78 @@
-# javascript-racingcar-precourse
+# 🏎️ 자동차 경주 기능 명세
+
+## 1. Domain
+
+### 1) `Car`
+
+- 자동차의 이름과 이동 거리를 보유합니다.
+- 전진 명령을 받아 이동 거리를 1 증가시킵니다.
+- 자동차 이름과 현재 이동 거리를 반환합니다.
+
+## 2. Model
+
+### 1) `RaceSimulator`
+
+- 자동차 이름과 시도 횟수를 받아 경주 전체를 관리합니다.
+- `createCars` 함수를 사용해 자동차 목록을 생성합니다.
+- 남은 시도 횟수를 추적하며, 각 턴마다 `runOneStep` 함수를 호출해 이동을 처리합니다.
+- 각 단계의 자동차 위치 정보를 반환합니다.
+- 최종 우승자를 계산해 반환합니다.
+
+### 2) `raceUtils`
+
+- 경주 관련 로직을 유틸 함수 형식으로 제공합니다.
+
+#### `createCars(carNames)`
+
+- 쉼표로 구분된 자동차 이름 문자열을 입력받아, 각 이름의 공백을 제거합니다.
+- 각 이름에 대해 `Car` 인스턴스를 생성해 배열로 반환합니다.
+
+#### `runOneStep(cars)`
+
+- 자동차 배열을 받아 한 번의 이동 시도를 처리합니다.
+- 각 자동차마다 0~9 범위의 난수를 생성하고,
+  난수가 4 이상일 경우 전진시킵니다.
+
+## 3. View
+
+### 1) `InputView`
+
+- 사용자에게 입력 안내 메시지를 표시합니다.
+- 자동차 이름들을 입력받습니다.
+- 시도 횟수를 입력받습니다.
+
+### 2) `OutputView`
+
+- 실행 결과 헤더를 출력합니다.
+- 단계마다 자동차별 현재 위치를 출력합니다.
+- 최종 우승자를 출력합니다.
+
+## 4. Controller
+
+### 1) `RaceController`
+
+- `InputView`를 통해 자동차 이름과 시도 횟수를 입력받습니다.
+- `RaceSimulator`를 생성하여 경주를 초기화합니다.
+- `OutputView`로 결과 헤더를 출력합니다.
+- 남은 시도가 있는 동안 반복하여 각 단계를 실행합니다.
+- 각 단계의 결과를 `OutputView`로 출력합니다.
+- 경주 종료 후 우승자를 `OutputView`로 출력합니다.
+
+## 5. 예외 처리
+
+### 1) 자동차 이름 검증
+
+- 자동차 이름 목록이 쉼표로 구분된 올바른 형식이 아닌 경우 예외를 발생시킵니다.
+- 자동차 이름의 길이를 검증합니다.
+- 이름이 5자를 초과하는 경우 예외를 발생시킵니다.
+- 이름이 비어있는 경우 예외를 발생시킵니다.
+- 이름이 중복된 경우 예외를 발생시킵니다.
+
+### 2) 시도 횟수 검증
+
+- 시도 횟수가 숫자가 아닌 경우 예외를 발생시킵니다.
+- 시도 횟수가 0 이하인 경우 예외를 발생시킵니다.
+
+### 3) 에러 메시지
+
+- 모든 예외는 `[ERROR]`로 시작하는 메시지를 제공합니다.

__tests__/ApplicationTest.js

@@ -1,5 +1,7 @@
-import App from "../src/App.js";
-import { MissionUtils } from "@woowacourse/mission-utils";
+import { MissionUtils } from '@woowacourse/mission-utils';
+import App from '../src/App.js';
+import TEST_CONFIG from '../src/constants/testConfig.js';
+import ERROR_MESSAGES from '../src/constants/errorMessages.js';
 
 const mockQuestions = (inputs) => {
   MissionUtils.Console.readLineAsync = jest.fn();
@@ -19,42 +21,114 @@ const mockRandoms = (numbers) => {
 };
 
 const getLogSpy = () => {
-  const logSpy = jest.spyOn(MissionUtils.Console, "print");
+  const logSpy = jest.spyOn(MissionUtils.Console, 'print');
   logSpy.mockClear();
   return logSpy;
 };
 
-describe("자동차 경주", () => {
-  test("기능 테스트", async () => {
-    // given
-    const MOVING_FORWARD = 4;
-    const STOP = 3;
-    const inputs = ["pobi,woni", "1"];
-    const logs = ["pobi : -", "woni : ", "최종 우승자 : pobi"];
-    const logSpy = getLogSpy();
+const runApp = async (inputs, randoms = []) => {
+  mockQuestions(inputs);
+  if (randoms.length > 0) {
+    mockRandoms(randoms);
+  }
+  const app = new App();
+  await app.run();
+};
+
+const expectLogsContain = (logSpy, logs) => {
+  logs.forEach((log) => {
+    expect(logSpy).toHaveBeenCalledWith(expect.stringContaining(log));
+  });
+};
+
+describe('자동차 경주 통합 테스트', () => {
+  describe('정상 동작 시나리오', () => {
+    test('우승자가 한 명인 경우 단독 우승자를 출력한다', async () => {
+      // given
+      const inputs = ['pobi,woni', '1'];
+      const logs = ['pobi : -', 'woni : ', '최종 우승자 : pobi'];
+      const logSpy = getLogSpy();
+
+      // when
+      await runApp(inputs, [TEST_CONFIG.MOVING_FORWARD, TEST_CONFIG.STOP]);
+
+      // then
+      expectLogsContain(logSpy, logs);
+    });
+
+    test('우승자가 여러 명인 경우 모든 우승자를 출력한다', async () => {
+      // given
+      const inputs = ['pobi,woni,jun', '2'];
+      const logs = ['pobi : --', 'woni : --', 'jun : -', '최종 우승자 : pobi, woni'];
+      const logSpy = getLogSpy();
+
+      // when
+      await runApp(inputs, [
+        TEST_CONFIG.MOVING_FORWARD,
+        TEST_CONFIG.MOVING_FORWARD,
+        TEST_CONFIG.MOVING_FORWARD,
+        TEST_CONFIG.MOVING_FORWARD,
+        TEST_CONFIG.MOVING_FORWARD,
+        TEST_CONFIG.STOP,
+      ]);
+
+      // then
+      expectLogsContain(logSpy, logs);
+    });
 
-    mockQuestions(inputs);
-    mockRandoms([MOVING_FORWARD, STOP]);
+    test('자동차 이름 앞뒤의 공백을 제거하고 경주를 진행한다', async () => {
+      // given
+      const inputs = [' pobi , woni ', '1'];
+      const logs = ['pobi : -', 'woni : -'];
+      const logSpy = getLogSpy();
 
-    // when
-    const app = new App();
-    await app.run();
+      // when
+      await runApp(inputs, [TEST_CONFIG.MOVING_FORWARD, TEST_CONFIG.MOVING_FORWARD]);
 
-    // then
-    logs.forEach((log) => {
-      expect(logSpy).toHaveBeenCalledWith(expect.stringContaining(log));
+      // then
+      expectLogsContain(logSpy, logs);
     });
   });
 
-  test("예외 테스트", async () => {
-    // given
-    const inputs = ["pobi,javaji"];
-    mockQuestions(inputs);
+  describe('유효성 검사 예외 케이스', () => {
+    test('자동차 이름이 5자를 초과하면 예외가 발생한다', async () => {
+      // given
+      const inputs = ['pobi,javaji', '1'];
 
-    // when
-    const app = new App();
+      // when & then
+      await expect(runApp(inputs)).rejects.toThrow(ERROR_MESSAGES.NAME_TOO_LONG);
+    });
+
+    test('중복된 자동차 이름이 있으면 예외가 발생한다', async () => {
+      // given
+      const inputs = ['pobi,woni,pobi', '1'];
+
+      // when & then
+      await expect(runApp(inputs)).rejects.toThrow(ERROR_MESSAGES.NAME_DUPLICATED);
+    });
+
+    test('자동차 이름에 빈 값이 있으면 예외가 발생한다', async () => {
+      // given
+      const inputs = ['pobi,,woni', '1'];
+
+      // when & then
+      await expect(runApp(inputs)).rejects.toThrow(ERROR_MESSAGES.NAME_LIST_FORMAT_INVALID);
+    });
+
+    test('시도 횟수가 숫자가 아닌 문자열이면 예외가 발생한다', async () => {
+      // given
+      const inputs = ['pobi,woni', 'abc'];
+
+      // when & then
+      await expect(runApp(inputs)).rejects.toThrow(ERROR_MESSAGES.ATTEMPT_COUNT_NON_NUMERIC);
+    });
+
+    test('시도 횟수가 0이하면 예외가 발생한다', async () => {
+      // given
+      const inputs = ['pobi,woni', '0'];
 
-    // then
-    await expect(app.run()).rejects.toThrow("[ERROR]");
+      // when & then
+      await expect(runApp(inputs)).rejects.toThrow(ERROR_MESSAGES.ATTEMPT_COUNT_NOT_POSITIVE);
+    });
   });
 });

src/App.js

@@ -1,5 +1,10 @@
+import RaceController from './controllers/RaceController.js';
+
 class App {
-  async run() {}
+  async run() {
+    const controller = new RaceController();
+    await controller.start();
+  }
 }
 
 export default App;

src/constants/errorMessages.js

@@ -0,0 +1,14 @@
+const ERROR_PREFIX = '[ERROR]';
+
+const ERROR_MESSAGES = Object.freeze({
+  NAME_TOO_LONG: `${ERROR_PREFIX} 자동차 이름은 5자 이하여야 합니다.`,
+  NAME_EMPTY: `${ERROR_PREFIX} 자동차 이름을 입력해야 합니다.`,
+  NAME_LIST_FORMAT_INVALID: `${ERROR_PREFIX} 자동차 이름은 쉼표로 구분된 올바른 형식으로 입력해야 합니다.`,
+  NAME_DUPLICATED: `${ERROR_PREFIX} 자동차 이름은 중복될 수 없습니다.`,
+  ATTEMPT_COUNT_EMPTY: `${ERROR_PREFIX} 시도 횟수를 입력해야 합니다.`,
+  ATTEMPT_COUNT_NON_NUMERIC: `${ERROR_PREFIX} 시도 횟수는 숫자만 입력해야 합니다.`,
+  ATTEMPT_COUNT_NOT_POSITIVE: `${ERROR_PREFIX} 시도 횟수는 0보다 커야 합니다.`,
+  ATTEMPT_COUNT_NOT_INTEGER: `${ERROR_PREFIX} 시도 횟수는 정수로 입력해야 합니다.`,
+});
+
+export default ERROR_MESSAGES;

src/constants/promptMessages.js

@@ -0,0 +1,8 @@
+const PROMPT_MESSAGES = Object.freeze({
+  CAR_NAMES_INPUT: '경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)\n',
+  ATTEMPT_COUNT_INPUT: '시도할 횟수는 몇 회인가요?\n',
+  RESULT_HEADER: '\n실행 결과',
+  FINAL_WINNERS_PREFIX: '최종 우승자',
+});
+
+export default PROMPT_MESSAGES;

src/constants/raceConfig.js

@@ -0,0 +1,8 @@
+const RACE_CONFIG = Object.freeze({
+  MOVE_THRESHOLD: 4,
+  MIN_RANDOM_VALUE: 0,
+  MAX_RANDOM_VALUE: 9,
+  MAX_CAR_NAME_LENGTH: 5,
+});
+
+export default RACE_CONFIG;

src/constants/testConfig.js

@@ -0,0 +1,6 @@
+const TEST_CONFIG = Object.freeze({
+  MOVING_FORWARD: 4,
+  STOP: 3,
+});
+
+export default TEST_CONFIG;

src/controllers/RaceController.js

@@ -0,0 +1,51 @@
+import RaceSimulator from '../models/RaceSimulator.js';
+import InputView from '../views/InputView.js';
+import OutputView from '../views/OutputView.js';
+import { validateNameListFormat, validateNumericValue } from '../utils/validators.js';
+import PROMPT_MESSAGES from '../constants/promptMessages.js';
+
+class RaceController {
+  #inputView;
+  #outputView;
+
+  constructor() {
+    this.#inputView = new InputView();
+    this.#outputView = new OutputView();
+  }
+
+  async start() {
+    const carNames = await this.#readCarNames();
+    validateNameListFormat(carNames);
+    const attemptCount = await this.#readAttemptCount();
+    validateNumericValue(attemptCount);
+    this.#runRace(carNames, Number(attemptCount));
+  }
+
+  async #readCarNames() {
+    return this.#inputView.readString(PROMPT_MESSAGES.CAR_NAMES_INPUT);
+  }
+
+  async #readAttemptCount() {
+    return this.#inputView.readString(PROMPT_MESSAGES.ATTEMPT_COUNT_INPUT);
+  }
+
+  #printRaceProgress(simulator) {
+    this.#outputView.printResultHeader();
+    while (simulator.hasRemainingAttempts()) {
+      const positions = simulator.executeStep();
+      this.#outputView.printStepResult(positions);
+    }
+  }
+
+  #printFinalResults(simulator) {
+    this.#outputView.printWinners(simulator.getRaceWinners());
+  }
+
+  #runRace(carNames, attemptCount) {
+    const simulator = new RaceSimulator(carNames, attemptCount);
+    this.#printRaceProgress(simulator);
+    this.#printFinalResults(simulator);
+  }
+}
+
+export default RaceController;

src/domains/Car.js

@@ -0,0 +1,26 @@
+import { validateNameLength } from '../utils/validators.js';
+
+class Car {
+  #name;
+  #position;
+
+  constructor(name) {
+    validateNameLength(name);
+    this.#name = name;
+    this.#position = 0;
+  }
+
+  move() {
+    this.#position += 1;
+  }
+
+  getName() {
+    return this.#name;
+  }
+
+  getPosition() {
+    return this.#position;
+  }
+}
+
+export default Car;