Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
67acfb9
docs: 기본 기능 및 모델링에 대한 README.md 작성
sjiwon Jun 25, 2023
d1eef0e
feat: Baseballs 관련 상수 인터페이스 구현
sjiwon Jun 25, 2023
7077cce
feat: Baseballs 모델 구현 및 예외 케이스 검증
sjiwon Jun 25, 2023
bd0fecc
test: Baseballs 테스트 케이스 작성
sjiwon Jun 25, 2023
2da9bf0
feat: Computer 모델 구현 및 테스트 케이스 작성
sjiwon Jun 25, 2023
312f766
feat: User 모델 구현 및 테스트 케이스 작성
sjiwon Jun 25, 2023
55bee8e
feat: 게임 결과 명세를 위한 Result 모델 구현
sjiwon Jun 25, 2023
6ffb501
feat: 게임 결과 도출을 위한 Referee 모델 구현 및 테스트 케이스 작성
sjiwon Jun 25, 2023
1dde87d
feat: 게임 진행 상태 Tracking을 위한 GameStatus 구현 및 테스트 케이스 작성
sjiwon Jun 25, 2023
7a3481e
feat: 게임 재시작 관련 GameProcessDecider 구현 및 테스트 케이스 작성
sjiwon Jun 25, 2023
ed74d6e
feat: 사용자 Input을 위한 InputView 구현
sjiwon Jun 25, 2023
cb910f1
feat: 콘솔 출력을 위한 OutputView 구현
sjiwon Jun 25, 2023
7150851
feat: 게임 프로세싱을 위한 GameController 및 Application 동작 처리
sjiwon Jun 25, 2023
f28211a
test: Controller 테스트 케이스 추가
sjiwon Jun 25, 2023
7f0707b
refactor: 사용자 숫자 Input시 Baseballs 수만큼 입력했는지 검증 추가
sjiwon Jun 25, 2023
b0dabea
refactor: 사용자 Input에 대한 Length 검증 -> 공백 존재 검증 케이스로 수정
sjiwon Jun 25, 2023
ba99c7e
refactor: SPACE -> SEPARATOR 네이밍 수정
sjiwon Jun 29, 2023
36107ff
fix: 컴퓨터 Baseballs 랜덤 생성 관련 not equal -> less 조건으로 수정
sjiwon Jul 2, 2023
10961ce
test: Computer Baseballs 랜덤 생성 관련 테스트 케이스 추가
sjiwon Jul 2, 2023
e619cf8
refactor: readUserBaseballInput 접근제어자 public -> private
sjiwon Jul 3, 2023
95f69e0
refactor: Computer baseballs 생성 간 내부 로직 메소드화
sjiwon Jul 3, 2023
0e47d89
refactor: Referee strikeCount 계산 로직 간 filter comparing method 분리
sjiwon Jul 3, 2023
d71a429
refactor: ExceptionConstants class -> interface
sjiwon Jul 3, 2023
56cf0e5
refactor: 사용자 Input I/O간 검증 순서 수정
sjiwon Jul 3, 2023
991a5d9
refactor: hasSpace 메소드 위치 수정
sjiwon Jul 3, 2023
bdb2346
fix: UserTest간 new Baseball -> new User로 수정
sjiwon Jul 15, 2023
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
108 changes: 108 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
## Feature

- [X] 컴퓨터는 1..9 범위에서 서로 다른 임의의 수 3개 선택
- [X] 유저는 1..9 범위에서 서로 다른 숫자 3개를 입력한다
- [X] 숫자가 아닌 값을 입력한 경우 `IllegalArgumentException` 발생
- [X] 심판은 `컴퓨터 <-> 유저의 3가지 숫자`를 토대로 숫자 야구 게임 결과를 도출한다
- 비교 후 `strikeCount & ballCount` 정보를 `Result`로 Wrapping한 후 결과를 발송한다
- [X] 컴퓨터가 선택한 모든 숫자를 맞히면 게임은 클리어된다
- [X] 사용자는 재시작[1], 종료[2] 중 하나를 입력한다
- [X] 숫자가 아닌 값을 입력한 경우 `IllegalArgumentException` 발생

<br>
<hr>

## Model

### `Baseballs`

- 입력한 3개의 숫자들을 추상화시킨 `Baseballs`
- Baseballs에 속한 `List<Integer>`은
- [X] 각 원소가 `1..9` 범위 사이여야 한다
- [X] 원소의 크기가 3이여야 한다
- [X] 중복된 원소가 없어야 한다

<br>

### `Computer: 컴퓨터`

- 1..9 범위에서 서로 다른 임의의 수 3개 선택
- Computer는 중복 숫자를 선택하지 않도록 구현
- User 선택을 통한 결과 산출의 기준

<br>

### `User: 사용자`

- 숫자 3개 입력
- 숫자를 입력하지 않을 경우 (IllegalArgumentException)
- 게임 재시작/종료와 관련된 커맨드 입력
- 숫자를 입력하지 않을 경우 (IllegalArgumentException)

<br>

### `Referee: 심판`

- 플레이어 점수 채점
- 숫자 겹침 + 동일 위치 = 스트라이크
- 숫자 겹침 + 다른 위치 = 볼
- 숫자 안겹침 = 낫싱

<br>

### `Result: 채점 결과`

- 스트라이크 & 볼에 대한 count field 보유

<br>

### `GameStatus: 게임 상태`

- 진행중인 게임에 대한 상태
- `GAME_RUN` -> 게임 실행
- `GAME_TERMINATE` -> 게임 종료

<br>

### `GameProcessDecider: 재시작 or 종료 결정자`

- 게임 클리어 후 종료 or 재시작에 대한 커맨더

<br>
<hr>

## Utils

### `ExceptionConstants`

- 전역 예외 메시지 통합 컴포넌트

### `BaseballConstants`

- Baseball에 대한 상수 전용 컴포넌트
- 숫자 범위
- Baseball 개수

<br>
<hr>

## View

### `InputView`

- 사용자 Input을 받기 위한 컴포넌트

### `OutputView`

- 게임 진행과 관련된 출력 컴포넌트

<br>
<hr>

## Controller

### `GameController`

- 게임 진행과 관련된 컨트롤러

<br>
4 changes: 3 additions & 1 deletion src/main/java/baseball/Application.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package baseball;

import baseball.controller.GameController;

public class Application {
public static void main(String[] args) {
// TODO: 프로그램 구현
new GameController().run();
}
}
67 changes: 67 additions & 0 deletions src/main/java/baseball/controller/GameController.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package baseball.controller;

import baseball.model.*;
import baseball.view.InputView;
import baseball.view.OutputView;

import java.util.List;

import static baseball.model.GameProcessDecider.GAME_RESTART;
import static baseball.model.GameStatus.GAME_RUNNING;
import static baseball.model.GameStatus.GAME_TERMINATE;

public class GameController {
private static GameStatus gameStatus;
private Computer computer;
private User user;

public GameController() {
computer = new Computer();
gameStatus = GAME_RUNNING;
}

public void run() {
// 게임 시작
OutputView.printGameStart();

while (gameStatus.isGameNotTerminated()) {
// User - Baseball 입력
readUserBaseballInput();

// 게임 결과 확인
Result result = judgeGameByReferee();
OutputView.printGameResult(result);

// 게임 클리어 확인
checkGameClear(result);
}
Comment on lines +27 to +37
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/kgu-woowa/woowa-java-baseball/blob/ba99c7e7ad9b5457bf2937dd3b69bfc7066dbdb7/src/main/java/baseball/controller/GameController.java#L40-L43

위 코드를 보면 while문을 돌면서 readUserBaseballInput()에서 입력을 받을 때마다 User 객체를 생성하고

https://github.com/kgu-woowa/woowa-java-baseball/blob/ba99c7e7ad9b5457bf2937dd3b69bfc7066dbdb7/src/main/java/baseball/model/User.java#L8-L10

위 코드에서 User 객체를 만들 때마다 Baseballs 객체를 생성하게 되는데 이러면 사용자가 숫자를 입력 할 때마다 메모리를 먹게 될 것 같고

또 한 번의 게임에서 숫자 입력마다 사용자를 새로 생성하는 것은 요구사항에 안 좋게 보일 수 있을 거 같은데 어떻게 생각하시나요?

Copy link
Collaborator Author

@sjiwon sjiwon Jul 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드 구조상 게임을 클리어한 후 사용자가 재시작 [1] Command를 요청했을 경우 게임을 다시 시작하는데 여기서 다시 시작하는 부분은 요구사항 이해에 따라서 다르긴한데 저는 완전히 새로운 게임으로 판단하였고 그에 따라서 determineGameRestartOrEnd -> new Computer() / readUserBaseballInput -> new User(~~)로 초기화를 하는게 깔끔하다고 생각했습니다.

  • 내부 N개의 게임 Cycle을 전체적인 시작 ~ 종료의 한 게임이라고 본다면 computer & user상에 baseballs을 초기화하고 다시 갈아끼우는 로직을 넣는것도 괜찮아 보이네요

메모리 관련 부분은 사실 Computer나 User나 그렇게 큰 리소스를 잡아먹는다고 생각하지 않고 내부에서 관리하는 List또한 어차피 필드 자체는 3개로 제한되기 때문에 이 부분이 메모리에 큰 영향을 준다고 생각은 하지 않습니다

}

private void readUserBaseballInput() {
List<Integer> userBaseballs = InputView.readUserBaseballs();
user = new User(userBaseballs);
}

private Result judgeGameByReferee() {
return Referee.judge(computer.getBaseballs(), user.getBaseballs());
}

private void checkGameClear(final Result result) {
if (result.isGameClear()) {
OutputView.printGameClear();
determineGameRestartOrEnd();
}
}

private void determineGameRestartOrEnd() {
int userCommand = InputView.readUserRestartCommand();
GameProcessDecider decider = GameProcessDecider.getDecider(userCommand);

if (decider == GAME_RESTART) {
computer = new Computer();
gameStatus = GAME_RUNNING;
} else {
gameStatus = GAME_TERMINATE;
}
}
}
51 changes: 51 additions & 0 deletions src/main/java/baseball/model/Baseballs.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package baseball.model;

import java.util.Collections;
import java.util.List;

import static baseball.utils.BaseballConstants.*;
import static baseball.utils.ExceptionConstants.BaseballException.*;

public class Baseballs {
private final List<Integer> baseballs;

public Baseballs(final List<Integer> baseballs) {
validateEachBaseballElementIsInRange(baseballs);
validateTotalBaseballSize(baseballs);
validateBaseballHasDuplicateNumber(baseballs);
this.baseballs = baseballs;
}

private void validateEachBaseballElementIsInRange(final List<Integer> baseballs) {
if (hasOutOfRange(baseballs)) {
throw new IllegalArgumentException(BASEBALL_IS_NOT_IN_RANGE.message);
}
}

private boolean hasOutOfRange(final List<Integer> baseballs) {
return baseballs.stream()
.anyMatch(baseball -> baseball < MIN_BASEBALL || baseball > MAX_BASEBALL);
}

private void validateTotalBaseballSize(final List<Integer> baseballs) {
if (baseballs.size() != BASEBALL_SIZE) {
throw new IllegalArgumentException(BASEBALL_SIZE_IS_NOT_FULFILL.message);
}
}

private void validateBaseballHasDuplicateNumber(final List<Integer> baseballs) {
if (hasDuplicateNumber(baseballs)) {
throw new IllegalArgumentException(BASEBALL_MUST_BE_UNIQUE.message);
}
}

private boolean hasDuplicateNumber(final List<Integer> baseballs) {
return baseballs.stream()
.distinct()
.count() != BASEBALL_SIZE;
}

public List<Integer> getBaseballs() {
return Collections.unmodifiableList(baseballs);
}
Comment on lines +48 to +50
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Collections.unmodifiableList는 Read-only라도 원본 컬렉션의 불변성을 보장하지 않는다고 합니다. CopyOf가 아닌 unmodifiableList를 사용하신 이유가 있을까요?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unmodifiableList를 사용하는거는 원본 객체에 대해서 immutable을 보장하지는 않는데 구조상 Baseballs의 원본 객체를 외부에서 접근할 수 없고 외부에서 얻는 List<Integer> baseballs는 immutable이기 때문에 unmodifiableList를 써도 상관없다고 생각했습니다.

  • copyOf를 안쓴이유는 어차피 외부에서 얻는 baseball은 immutable이 보장되기 때문에 굳이 매번 복사할 필요가 없다고 생각

}
48 changes: 48 additions & 0 deletions src/main/java/baseball/model/Computer.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package baseball.model;

import camp.nextstep.edu.missionutils.Randoms;

import java.util.ArrayList;
import java.util.List;

import static baseball.utils.BaseballConstants.*;

public class Computer {
private final Baseballs baseballs;

public Computer() {
this.baseballs = generateRandomBaseballs();
}

private Baseballs generateRandomBaseballs() {
List<Integer> baseballs = new ArrayList<>();

while (isNotReachedLimitSize(baseballs)) {
int randomNumber = getRandomNumberInRange();
if (isRandomNumberAbsentInBaseballs(baseballs, randomNumber)) {
baseballs.add(randomNumber);
}
}

return new Baseballs(baseballs);
}

private boolean isNotReachedLimitSize(final List<Integer> baseballs) {
return baseballs.size() < BASEBALL_SIZE;
}

private int getRandomNumberInRange() {
return Randoms.pickNumberInRange(MIN_BASEBALL, MAX_BASEBALL);
}

private boolean isRandomNumberAbsentInBaseballs(
final List<Integer> baseballs,
final int randomNumber
) {
return !baseballs.contains(randomNumber);
}

public List<Integer> getBaseballs() {
return baseballs.getBaseballs();
}
}
24 changes: 24 additions & 0 deletions src/main/java/baseball/model/GameProcessDecider.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package baseball.model;

import java.util.Arrays;

import static baseball.utils.ExceptionConstants.GameProcessCommandException.INVALID_COMMAND;

public enum GameProcessDecider {
GAME_RESTART(1),
GAME_END(2),
;

private final int command;

GameProcessDecider(final int command) {
this.command = command;
}

public static GameProcessDecider getDecider(final int userCommand) {
return Arrays.stream(values())
.filter(restartDecider -> restartDecider.command == userCommand)
.findFirst()
.orElseThrow(() -> new IllegalArgumentException(INVALID_COMMAND.message));
}
}
11 changes: 11 additions & 0 deletions src/main/java/baseball/model/GameStatus.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package baseball.model;

public enum GameStatus {
GAME_RUNNING,
GAME_TERMINATE,
;

public boolean isGameNotTerminated() {
return this != GAME_TERMINATE;
}
}
55 changes: 55 additions & 0 deletions src/main/java/baseball/model/Referee.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package baseball.model;

import java.util.List;
import java.util.stream.IntStream;

import static baseball.utils.BaseballConstants.BASEBALL_SIZE;

public class Referee {
private Referee() {
}

public static Result judge(
final List<Integer> computerBaseballs,
final List<Integer> userBaseballs
) {
final int strikeCount = calculateStrikeCount(computerBaseballs, userBaseballs);
final int ballCount = calculateBallCount(computerBaseballs, userBaseballs);

return new Result(strikeCount, ballCount);
}

private static int calculateStrikeCount(
final List<Integer> computerBaseballs,
final List<Integer> userBaseballs
) {
return (int) IntStream.range(0, BASEBALL_SIZE)
.filter(index -> isExactlyMatchAtIndex(computerBaseballs, userBaseballs, index))
.count();
}

private static boolean isExactlyMatchAtIndex(
final List<Integer> computerBaseballs,
final List<Integer> userBaseballs,
final int index
) {
return computerBaseballs.get(index).equals(userBaseballs.get(index));
}

private static int calculateBallCount(
final List<Integer> computerBaseballs,
final List<Integer> userBaseballs
) {
return getContainedElementsCount(computerBaseballs, userBaseballs)
- calculateStrikeCount(computerBaseballs, userBaseballs);
}

private static int getContainedElementsCount(
final List<Integer> computerBaseballs,
final List<Integer> userBaseballs
) {
return (int) userBaseballs.stream()
.filter(computerBaseballs::contains)
.count();
}
}
Loading