[1단계 - 자동차 경주] 지니(손진영) 미션 제출합니다.

.eslintrc.json

@@ -1,15 +1,31 @@
 {
-  "rules": {},
   "env": {
-    "es6": true,
-    "node": true
+    "es2021": true,
+    "node": true,
+    "jest": true
   },
+  "extends": ["airbnb-base", "prettier",  "plugin:jsdoc/recommended", "plugin:jest/recommended"],
+  "overrides": [
+    {
+      "files": ["*.test.js", "console.js"],
+      "rules": {
+        "max-lines-per-function": ["off"]
+      }
+    }
+  ],
   "parserOptions": {
     "ecmaVersion": "latest",
     "sourceType": "module"
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:prettier/recommended"
-  ]
-}
+  "rules": {
+    "no-use-before-define": ["off"],
+    "import/prefer-default-export": ["off"],
+    "import/extensions": ["off"],
+    "class-methods-use-this" : ["off"],
+    "max-depth": ["error", 2],
+    "max-lines-per-function": ["error", { "max": 10, "ignoreComments": true }],
+    "jsdoc/require-returns" : ["off"],
+    "jsdoc/require-jsdoc" : ["off"],
+    "no-param-reassign" : ["off"]
+  }
+}

.prettierrc

@@ -0,0 +1,12 @@
+{
+    "singleQuote": true,
+    "semi": true,
+    "useTabs": false,
+    "tabWidth": 2,
+    "trailingComma": "all",
+    "printWidth": 120,
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "endOfLine": "auto"
+  }
+

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    // Set the default
+    "editor.formatOnSave": false,
+    // Enable per-language
+    "[javascript]": {
+        "editor.formatOnSave": true
+    },
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit"
+    }
+}

docs/REQUIREMENTS.md

@@ -0,0 +1,51 @@
+# 🎯 기능 구현 목록
+## 공통
+- [x] 공백이 포함되었을 경우, '입력한 값에 공백이 존재합니다.'와 함께 재입력 해야 한다.
+- [x] 입력 값이 빈 값일 경우 '아무것도 입력하지 않았으므로 다시 입력해주세요.'와 함께 재입력 해야 한다.
+
+## 예외 처리
+- [x] 사용자가 잘못된 입력 값을 작성한 경우 에러 메시지를 보여주고, 다시 입력할 수 있게 한다.
+- [x] 에러가 발생 시 prefix로 `[ERROR]`를 추가한다.
+
+## 자동차 이름 입력 기능 (phase 1)
+- [x] 자동차 이름은 쉼표(,)를 기준으로 구분한다.
+  - ,로 구분하지 않았을 경우 '자동차 이름은 ,로만 구분 가능합니다.' 라는 에러 메시지와 함께 재입력 해야 한다.
+- [x] 자동차 이름은 1 ~ 5자만 가능하다.
+  - 자동차 이름이 범위에서 벗어날 경우 '자동차 이름은 1 ~ 5자의 범위만 가능합니다.'라는 에러메시지와 함께 재입력 해야 한다.
+
+## 자동차 시도 횟수 입력 기능 (phase 2)
+- [x] 사용자는 정수만 입력 가능하다.
+  - 정수를 입력하지 않았을 경우 '정수만 입력 가능합니다.' 라는 에러 메시지와 함께 재입력 해야 한다.
+- [x] 사용자는 1 ~ 10의 범위만 입력 가능하다.
+  - 1 ~ 10의 범위가 아닐 경우 '시도 횟수는 1 ~ 10만 입력 가능합니다.'라는 에러 메시지와 함께 재입력 해야 한다.
+
+## 자동차 이동 기능 (phase 3)
+- [x] 자동차에 이름을 부여할 수 있다.
+- [x] 전진하는 조건은 0에서 9 사이에서 무작위 값을 구한 후 무작위 값이 4 이상일 경우이다.
+
+## 우승자 확인 기능 (phase 4)
+- [x] 우승자는 한 명 이상일 수 있다.
+
+## 자동차 경주 결과 출력 기능 (phase 5)
+- [x] 전진하는 자동차를 출력할 때 자동차 이름을 같이 출력한다.
+- [x] 최종 우승자를 출력한다.
+
+# ✅ 프로그래밍 요구사항
+- 프리코스 때 사용한 @woowacourse/mission-utils 라이브러리 사용을 금지한다.
+- 입출력(readline)과 관련된 테스트는 작성하지 않는다.
+  - 입력 또는 출력이 잘 되었는지를 확인하는 테스트
+  - 입력 후 출력 값을 기반으로 결괏값이 잘 도출되었는지를 확인하는 테스트
+- 코드 스타일 가이드에 따라 컨벤션을 준수하며 개발한다.
+- 변수 선언시 var를 사용하지 않는다. let, const를 사용한다.
+- 전역 변수를 만들지 않는다.
+- 축약하지 않는다.
+- 하드 코딩된 값 대신에 의미 있는 상수를 활용한다.
+- 동등 연산자는 === 로만 사용한다.
+- 함수(또는 메서드)의 길이가 10라인을 넘어가지 않도록 구현한다.
+  - 함수(또는 메서드)가 한 가지 일만 하도록 만든다.
+- 함수(또는 메서드)의 들여쓰기 depth는 2단계까지만 허용한다.
+  - 예를 들어 while문 안에 if문이 있으면 depth는 2단계 이다.
+  - 힌트) 함수(또는 메서드) 분리는 들여쓰기 depth를 줄이는 좋은 방법이다.
+- 도메인 로직과 UI 로직을 분리한다.
+- 모든 도메인 로직에 단위 테스트를 구현한다. (UI 로직은 제외)
+

src/App.js

@@ -0,0 +1,9 @@
+import RacingGameController from './controller/RacingGameController.js';
+
+const App = Object.freeze({
+  async start() {
+    await RacingGameController.run();
+  },
+});
+
+export default App;

src/constants/messages/messages.js

@@ -0,0 +1,26 @@
+import { SYMBOLS } from '../symbols.js';
+
+export const INPUT_MESSAGE = Object.freeze({
+  racingCar: '경주할 자동차 이름을 입력하세요(이름은 쉼표(,)를 기준으로 구분)\n',
+  tryCount: '시도할 횟수는 몇 회인가요?\n',
+});
+
+export const OUTPUT_MESSAGE = Object.freeze({
+  executeResult: '\n실행 결과',
+  movementIndicator: '-',
+});
+
+export const FORMAT_MESSAGE = Object.freeze({
+  racingResultToString(racingResult) {
+    const extractCarNameToString = ({ carName, moveCount }) =>
+      `${carName} : ${OUTPUT_MESSAGE.movementIndicator.repeat(moveCount)}`;
+
+    const generatePartialRacingResultToString = (racingTurn) => racingTurn.map(extractCarNameToString).join('\n');
+
+    return racingResult.map(generatePartialRacingResultToString).join('\n\n');
+  },
+
+  racingWinnersToString(racingWinners) {
+    return `\n최종 우승자: ${racingWinners.join(`${SYMBOLS.comma} `)}`;
+  },
+});

src/constants/messages/messages.test.js

@@ -0,0 +1,51 @@
+import { FORMAT_MESSAGE } from './messages';
+
+describe('자동차 경주 문자열 변환 테스트', () => {
+  describe('racingResultToString 메서드를 통한 자동차 경주 결과 문자열 변환 테스트', () => {
+    test.each([
+      {
+        description:
+          "racingResult가 [[{ carName: 'CarA', moveCount: 1 }, { carName: 'CarB', moveCount: 1 }]] 일 때, \n 문자열 변환 결과는 'CarA : - CarB : -'이다.",
+        racingResult: [
+          [
+            { carName: 'CarA', moveCount: 1 },
+            { carName: 'CarB', moveCount: 1 },
+          ],
+        ],
+        expected: 'CarA : -\nCarB : -',
+      },
+      {
+        description:
+          "racingResult가 [[{ carName: 'CarA', moveCount: 2 }, { carName: 'CarB', moveCount: 0 }], [{ carName: 'CarA', moveCount: 3 },{ carName: 'CarB', moveCount: 1 }]] 일 때, \n 문자열 변환 결과는 'CarA : -- CarB : CarA : --- CarB : -'이다.",
+        racingResult: [
+          [
+            { carName: 'CarA', moveCount: 2 },
+            { carName: 'CarB', moveCount: 0 },
+          ],
+          [
+            { carName: 'CarA', moveCount: 3 },
+            { carName: 'CarB', moveCount: 1 },
+          ],
+        ],
+        expected: 'CarA : --\nCarB : \n\nCarA : ---\nCarB : -',
+      },
+    ])('$description', ({ racingResult, expected }) => {
+      expect(FORMAT_MESSAGE.racingResultToString(racingResult)).toMatch(expected);
+    });
+  });
+
+  describe('racingWinnersToString 메서드를 통한 우승자 문자열 변환 테스트', () => {
+    test.each([
+      {
+        racingWinners: ['CarA'],
+        expected: '\n최종 우승자: CarA',
+      },
+      {
+        racingWinners: ['CarA', 'CarB'],
+        expected: '\n최종 우승자: CarA, CarB',
+      },
+    ])('racingWinners가 $racingWinners일 때, 문자열 변환 결과는 "$expected다."', ({ racingWinners, expected }) => {
+      expect(FORMAT_MESSAGE.racingWinnersToString(racingWinners)).toMatch(expected);
+    });
+  });
+});

src/constants/symbols.js

@@ -0,0 +1,10 @@
+/**
+ * 현재 single export로 인해 import/prefer-default-export 관련 airbnb 컨벤션을 위배하고 있지만
+ * constants 모듈이 default export 셩격에 맞지 않다는 점과 random과 관련된 상수가 추가될 수 있다고 판단되어
+ * export 방식을 유지하기로 결정
+ */
+export const SYMBOLS = Object.freeze({
+  emptyString: '',
+  space: ' ',
+  comma: ',',
+});

src/controller/RacingGameController.js

@@ -0,0 +1,35 @@
+import InputView from '../views/InputView.js';
+import OutputView from '../views/OutputView.js';
+import RacingGame from '../models/RacingGame/RacingGame.js';
+import RandomMoveCountMaker from '../models/RandomMoveCountMaker/RandomMoveCountMaker.js';
+import RacingWinnerRecorder from '../models/RacingWinnerRecorder/RacingWinnerRecorder.js';
+import RetryHandler from '../errors/RetryHandler/RetryHandler.js';
+
+const RacingGameController = Object.freeze({
+  async run() {
+    const { racingCarNames, tryCount } = await processUserInput();
+    processRacingGame({ racingCarNames, tryCount });
+  },
+});
+
+export default RacingGameController;
+
+async function processUserInput() {
+  const racingCarNames = await RetryHandler.errorWithLogging(() => InputView.readRacingCarNames());
+  const tryCount = await RetryHandler.errorWithLogging(() => InputView.readTryCount());
+
+  return { racingCarNames, tryCount };
+}
+
+function processRacingGame({ racingCarNames, tryCount }) {
+  const racingGame = new RacingGame({ racingCarNames, tryCount });
+
+  const randomMoveCounts = RandomMoveCountMaker.execute(tryCount, racingCarNames.length);
+  const racingResult = racingGame.startRace(randomMoveCounts);
+
+  const finalRacingResult = racingResult.at(-1);
+  const racingWinners = RacingWinnerRecorder.createRacingWinners(finalRacingResult);
+
+  OutputView.printRacingResult(racingResult);
+  OutputView.printRacingWinners(racingWinners);
+}

src/errors/AppError/AppError.js

@@ -0,0 +1,22 @@
+/**
+ * @module AppError
+ * '일관된 에러 메시지 제공'의 역할을 수행
+ */
+class AppError extends Error {
+  /**
+   * @static
+   * @public
+   * @constant
+   * @type {string}
+   */
+  static PREFIX = '[ERROR]';
+
+  /**
+   * @param {string} message - 에러 메시지
+   */
+  constructor(message) {
+    super(`\n${AppError.PREFIX} ${message}\n`);
+  }
+}
+
+export default AppError;

src/errors/AppError/AppError.test.js

@@ -0,0 +1,11 @@
+import AppError from './AppError';
+
+describe('AppError 테스트', () => {
+  const throwAppError = () => {
+    throw new AppError('test');
+  };
+  test(`발생 된 에러 메시지는 ${AppError.PREFIX}으로 시작 한다.`, () => {
+    // given - when - then
+    expect(throwAppError).toThrow(AppError.PREFIX);
+  });
+});

src/errors/RetryHandler/RetryHandler.js

@@ -0,0 +1,24 @@
+import Console from '../../utils/console.js';
+
+/**
+ * @module RetryHandler
+ * 시스템 작업 중 발생하는 예외 처리 및 재 실행을 위한 모듈
+ */
+const RetryHandler = {
+  /**
+   * 제공된 비동기 함수를 실행 후 오류가 발생하지 않을 때 까지 오류 메시지를 출력하고 함수를 재 실행
+   * @template T
+   * @param {Function} executeFunction - 실행할 비동기 함수
+   * @returns {Promise<T>} 비동기 함수가 성공적으로 완료되면 그 결과를 반환
+   */
+  async errorWithLogging(executeFunction) {
+    try {
+      return await executeFunction();
+    } catch (error) {
+      Console.print(error.message);
+      return this.errorWithLogging(executeFunction);
+    }
+  },
+};
+
+export default RetryHandler;

src/errors/RetryHandler/RetryHandler.test.js

@@ -0,0 +1,37 @@
+import Console from '../../utils/console.js';
+import RetryHandler from './RetryHandler.js';
+
+jest.mock('../../utils/console.js', () => ({
+  print: jest.fn(),
+}));
+
+describe('입력 관련 예외 처리 테스트', () => {
+  let executeTest;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    // given
+    executeTest = jest.fn().mockRejectedValueOnce(new Error('Test Error')).mockResolvedValueOnce('Success');
+  });
+
+  test('함수가 두 번 호출된다.', async () => {
+    // when
+    await RetryHandler.errorWithLogging(executeTest);
+    // then
+    expect(executeTest).toHaveBeenCalledTimes(2);
+  });
+
+  test('첫 번째 호출은 실패 후 에러 로깅이 발생한다.', async () => {
+    // when
+    await RetryHandler.errorWithLogging(executeTest);
+    // then
+    expect(Console.print).toHaveBeenCalledWith('Test Error');
+  });
+
+  test('두 번째 호출은 성공적인 결과를 반환한다.', async () => {
+    // when
+    const result = await RetryHandler.errorWithLogging(executeTest);
+    // then
+    expect(result).toMatch('Success');
+  });
+});

src/index.js

@@ -0,0 +1,3 @@
+import App from './App.js';
+
+App.start();

src/models/Car/Car.js

@@ -0,0 +1,32 @@
+class Car {
+  static #MIN_MOVABLE_VALUE = 4;
+
+  static #CAR_MOVE_COUNT = 1;
+
+  #carDetails;
+
+  constructor(carName) {
+    this.#carDetails = {
+      carName,
+      moveCount: 0,
+    };
+  }
+
+  move(randomMoveCount) {
+    this.#updateMoveCount(randomMoveCount);
+
+    return { ...this.#carDetails };
+  }
+
+  #updateMoveCount(randomMoveCount) {
+    if (this.#isMovable(randomMoveCount)) {
+      this.#carDetails.moveCount += Car.#CAR_MOVE_COUNT;
+    }
+  }
+
+  #isMovable(randomMoveCount) {
+    return randomMoveCount >= Car.#MIN_MOVABLE_VALUE;
+  }
+}
+
+export default Car;