Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[자동차 경주] 이세영 미션 제출합니다. #457

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 184 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,184 @@
# javascript-racingcar-precourse
# 우아한 테크코스 2주차 프리코스

# 자동차 경주

## 과제 진행 요구 사항

- 미션은 자동차 경주 저장소를 포크하고 클론하는 것으로 시작한다.
- 기능을 구현하기 전 README.md에 구현할 기능 목록을 정리해 추가한다.
- Git의 커밋 단위는 앞 단계에서 README.md에 정리한 기능 목록 단위로 추가한다.
- AngularJS Git Commit Message Conventions을 참고해 커밋 메시지를 작성한다.
- 자세한 과제 진행 방법은 프리코스 진행 가이드 문서를 참고한다.

## 기능 요구 사항

초간단 자동차 경주 게임을 구현한다.

- 주어진 횟수 동안 n대의 자동차는 전진 또는 멈출 수 있다.
- 각 자동차에 이름을 부여할 수 있다. 전진하는 자동차를 출력할 때 자동차 이름을 같이 출력한다.
- 자동차 이름은 쉼표(,)를 기준으로 구분하며 이름은 5자 이하만 가능하다.
- 사용자는 몇 번의 이동을 할 것인지를 입력할 수 있어야 한다.
- 전진하는 조건은 0에서 9 사이에서 무작위 값을 구한 후 무작위 값이 4 이상일 경우이다.
- 자동차 경주 게임을 완료한 후 누가 우승했는지를 알려준다. 우승자는 한 명 이상일 수 있다.
- 우승자가 여러 명일 경우 쉼표(,)를 이용하여 구분한다.
- 사용자가 잘못된 값을 입력할 경우 "[ERROR]"로 시작하는 메시지와 함께 Error를 발생시킨 후 애플리케이션은 종료되어야 한다.

### 입출력 요구 사항

#### 입력

- 경주할 자동차 이름(이름은 쉼표(,) 기준으로 구분)
```js
pobi, woni, jun;
```
- 시도할 횟수
```js
5;
```

#### 출력

- 차수별 실행 결과
```js
pobi : --
woni : ----
jun : ---
```
- 단독 우승자 안내 문구

```js
최종 우승자 : pobi

```

- 공동 우승자 안내 문구

```js
최종 우승자 : pobi, jun

```

#### 실행 결과 예시

```js
경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)
pobi,woni,jun
시도할 횟수는 몇 회인가요?
5

실행 결과
pobi : -
woni :
jun : -

pobi : --
woni : -
jun : --

pobi : ---
woni : --
jun : ---

pobi : ----
woni : ---
jun : ----

pobi : -----
woni : ----
jun : -----

최종 우승자 : pobi, jun
```

## 프로그래밍 요구 사항 1

- Node.js 20.17.0 버전에서 실행 가능해야 한다.
- 프로그램 실행의 시작점은 App.js의 run()이다.
- package.json 파일은 변경할 수 없으며, 제공된 라이브러리와 스타일 라이브러리 이외의 외부 라이브러리는 사용하지 않는다.
- 프로그램 종료 시 process.exit()를 호출하지 않는다.
- 프로그래밍 요구 사항에서 달리 명시하지 않는 한 파일, 패키지 등의 이름을 바꾸거나 이동하지 않는다.
- 자바스크립트 코드 컨벤션을 지키면서 프로그래밍한다.
- 기본적으로 JavaScript Style Guide를 원칙으로 한다.

## 프로그래밍 요구 사항 2

- indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
- 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
- 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다.
- 3항 연산자를 쓰지 않는다.
- 함수(또는 메서드)가 한 가지 일만 하도록 최대한 작게 만들어라.
- Jest를 이용하여 정리한 기능 목록이 정상적으로 작동하는지 테스트 코드로 확인한다.
- 테스트 도구 사용법이 익숙하지 않다면 아래 문서를 참고하여 학습한 후 테스트를 구현한다.
- [Using Matchers](https://jestjs.io/docs/using-matchers)
- [Testing Asynchronous Code](https://jestjs.io/docs/asynchronous)
- [Jest로 파라미터화 테스트하기: test.each(), describe.each()](https://www.daleseo.com/jest-each/)

### 라이브러리

- @woowacourse/mission-utils에서 제공하는 Random 및 Console API를 사용하여 구현해야 한다.
- Random 값 추출은 Random.pickNumberInRange()를 활용한다.
- 사용자의 값을 입력 및 출력하려면 Console.readLineAsync()와 Console.print()를 활용한다.

#### 사용 예시

- 0에서 9까지의 정수 중 한 개의 정수 반환

```js
MissionUtils.Random.pickNumberInRange(0, 9);
```

---

## 구현 기능 목록

- 입력 기능
- 자동차 이름 입력 기능
- 쉼표(,) 기준으로 구분
- 자동차 이름은 최소 한 글자에서 최대 다섯 글자까지 입력 가능
- 경주 참여 최대 수는 정해지지 않음
- 자동차 이름은 영어 대소문자, 숫자, -(하이픈), \_(언더라인)만 가능
- 영어 대소문자, 숫자, -(하이픈), \_(언더라인)이외의 값이 입력되면 "[ERROR]" 메시지와 함께 Error를 발생
- 자동차 이름이 입력되지 않았거나 여섯글자 이상이면 "[ERROR]" 메시지와 함께 Error를 발생
- 시도할 횟수 입력기능
- 시도할 횟수는 양의 정수만 입력 가능
- 시도 횟수는 1에서 10까지 가능
- 시도할 횟수가 1부터 10까지의 정수가 아니라면 "[ERROR]" 메시지와 함께 Error를 발생
- 전진 기능
- 0-9 무작위 값 추출하는 기능
- 4이상인지 판단하는 기능
- 점수 관리 기능
- 전진 기능에서 4이상인지 판단 후 점수판에 반영
- 점수판은 자동차 이름, 몇칸 전진했는지의 정보를 가지고 있음
- 우승자 선출 기능
- 점수판의 정보를 가지고 우승자를 선출하는 연산
- 우승자는 한명이거나 여러명이 될 수 있음
- 우승자가 여러명일경우 ,(쉼표)로 구분
- 출력 기능
- 차수별 실행 결과 화면
- 우승자 안내문구
- 단독 우승자 안내
- 공동 우승자 안내

---

## 요구사항 목록

- [ ] 자동차 이름 입력받기
- [ ] 각 자동차 이름이 5자 이하
- [ ] 시도할 횟수 입력받기
- [ ] 실행결과 출력화면에 자동차 이름 표시
- [ ] 전진하는 자동차를 출력할 때 자동차 이름 같이 출력
- [ ] 0-9 랜덤 값을 구한 후 값이 4이상일 때만 전진
- [ ] 우승화면 출력하기
- [ ] 우승자는 한명 이상일 수 있음
- [ ] 우승자가 여러명일 경우 쉼표로 구분
- [ ] 공백, 기호를 포함한 5자가 넘으면 Error 처리
- [ ] 시도 횟수는 1 이상의 자연수
- [ ] 시도 횟수에 잘못된 값을 입력할 경우 Error 처리
- [ ] 3항 연산자 사용하지 않기
- [ ] depth는 2까지만
- [ ] Jest 사용하여 테스트 코드 확인
- [ ] 함수를 최대한 작게 만들기
- [ ] Random.pickNumberInRange() 사용하여 랜덤 값 추출
- [ ] 입출력 값은 Console.readLineAsync()와 Console.print() 사용
- [ ] 프로그램 종료 시 process.exit()를 호출하지 않기
6 changes: 5 additions & 1 deletion src/App.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import InputView from "./views/InputView.js";

class App {
async run() {}
async run() {
await InputView.inputCarName();
}
}

export default App;
9 changes: 9 additions & 0 deletions src/constants/Constants.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export const MIN_CAR_NAME_LENGTH = 1;
export const MAX_CAR_NAME_LENGTH = 5;

export const VALID_CAR_NAME_REGEXP = /^[A-Za-z0-9\-_]+$/;

export const MIN_ATTEMPT_COUNT = 1;
export const MAX_ATTEMPT_COUNT = 10;

export const STANDARD_VALUE = 4;
5 changes: 5 additions & 0 deletions src/constants/ErrorMessages.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export const ERROR_EMPTY_CAR_NAME = `자동차 이름을 입력해주세요.`;
export const ERROR_OVER_CAR_NAME_LENGTH = `자동차 이름은 5글자 이내로 입력해주세요.`;
export const ERROR_INVALID_CAR_NAME = `자동차 이름은 영어 대소문자, 숫자, -(하이픈), 또는 \_(언더라인)만 입력 가능합니다.`;

export const ERROR_INVALID_NUMBER_OF_ATTEMPTS = `시도할 횟수는 1부터 10까지의 정수를 입력해 주세요`;
28 changes: 28 additions & 0 deletions src/controllers/RaceController.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { MissionUtils } from "@woowacourse/mission-utils";
import { STANDARD_VALUE } from "../constants/Constants.js";

export default class RaceController {
static async startRace(carNames, attemptCount) {
const results = {};
carNames.forEach((carName) => {
results[carName] = this.getForwardCount(attemptCount);
});
}

static getForwardCount(attemptCount) {
let forwardCount = 0;

for (let i = 0; i < attemptCount; i++) {
if (this.isMovingForward()) {
forwardCount++;
}
}

return forwardCount;
}

static isMovingForward() {
const randomNumber = MissionUtils.Random.pickNumberInRange(0, 9);
return randomNumber >= STANDARD_VALUE;
}
}
57 changes: 57 additions & 0 deletions src/views/InputView.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { Console } from "@woowacourse/mission-utils";
import {
VALID_CAR_NAME_REGEXP,
MIN_CAR_NAME_LENGTH,
MAX_CAR_NAME_LENGTH,
MIN_ATTEMPT_COUNT,
MAX_ATTEMPT_COUNT,
} from "../constants/Constants.js";
import {
ERROR_EMPTY_CAR_NAME,
ERROR_OVER_CAR_NAME_LENGTH,
ERROR_INVALID_CAR_NAME,
ERROR_INVALID_NUMBER_OF_ATTEMPTS,
} from "../constants/ErrorMessages.js";
import RaceController from "../controllers/RaceController.js";

export default class InputView {
static async inputCarName() {
const inputCarNames = await Console.readLineAsync(
`자동차 이름을 입력하세요 : `
);

const carNames = inputCarNames.split(",");
carNames.forEach((carName) => {
this.isValidCarNameLength(carName);
});

const attemptCount = await Console.readLineAsync(
`시도할 횟수를 입력하세요 : `
);
this.isValidAttemptCount(attemptCount);

RaceController.startRace(carNames, attemptCount);
}

static isValidCarNameLength(carName) {
if (MIN_CAR_NAME_LENGTH > carName) {
throw new Error(`[ERROR] ${ERROR_EMPTY_CAR_NAME}`);
} else if (carName > MAX_CAR_NAME_LENGTH) {
throw new Error(`[ERROR] ${ERROR_OVER_CAR_NAME_LENGTH}`);
} else {
this.isValidCarName(carName);
}
}

static isValidCarName(carName) {
if (!VALID_CAR_NAME_REGEXP.test(carName)) {
throw new Error(`[ERROR] ${ERROR_INVALID_CAR_NAME}`);
}
}

static isValidAttemptCount(attemptCount) {
if (MIN_ATTEMPT_COUNT > attemptCount || attemptCount > MAX_ATTEMPT_COUNT) {
throw new Error(`[ERROR] ${ERROR_INVALID_NUMBER_OF_ATTEMPTS}`);
}
}
}