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

[로또 게임] 권용현 과제 제출합니다. #3

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 16 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
206 changes: 6 additions & 200 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,207 +1,13 @@
# 과제 - 로또
1. 로또번호를 생성하는 클래스 RandomNumber class, RandomNumber 클래스 안의 getRandomNumber는 treeSet을 리턴함
2. 입력을 string 형태로 받은 후, ','단위로 split을 하여 이를 size가 6인 리스트로 리턴하는 클래스 Input 클래스
3. randomNumber와 input을 매개변수로 받은 후에 이를 비교하는 클래스 Compare클래스, Compare 클래스는 size가 6인 리스트를 리턴
4. Compare 클래스를 인수로 받아 최종 메지시 출력, 수익률 출력 하는 클래스 Result클래스
5. 변할 가능성이 있는 상수들을 포함하는 Constant 클래스
6. 출력문을 포함하는 Message 클래스

## 🔍 진행 방식

- 과제는 **기능 요구 사항, 프로그래밍 요구 사항, 과제 진행 요구 사항** 세 가지로 구성되어 있다.
- 세 개의 요구 사항을 만족하기 위해 노력한다. 특히 기능을 구현하기 전에 기능 목록을 만들고, 기능 단위로 커밋 하는 방식으로 진행한다.
- 기능 요구 사항에 기재되지 않은 내용은 스스로 판단하여 구현한다.

---

## 📈 과제 진행 및 제출 방법

- 과제는 [java-lotto](https://github.com/LandvibeDev/java-lotto) 저장소를 Fork/Clone해 시작한다.
- **기능을 구현하기 전에 java-baseball-precourse/README.md 파일에 구현할 기능 목록을 정리**해 추가한다.
- **Git의 커밋 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위**로 추가한다.
- [AngularJS Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) 참고해 commit log를 남긴다.
- 과제 진행 및 제출 방법은 [우아한코스 과제 제출 문서](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 를 참고한다.
- base repository를 `LandvibeDev/java-lotto`로 지정해서 PR 생성하면됨

<br>

### 테스트 실행 가이드

- 터미널에서 `java -version`을 실행하여 Java 버전이 14인지 확인한다. 또는 Eclipse 또는 IntelliJ IDEA와 같은 IDE에서 Java 14로 실행되는지 확인한다.
- 터미널에서 Mac 또는 Linux 사용자의 경우 `./gradlew clean test` 명령을 실행 하고,
Windows 사용자의 경우 `gradlew.bat clean test` 명령을 실행할 때 동작 하는지 만 확인(테스트는 실패).

---

## 🚀 기능 요구 사항

로또 게임 기능을 구현해야 한다. 로또 게임은 아래와 같은 규칙으로 진행된다.

```
- 로또 번호의 숫자 범위는 1~45까지이다.
- 1개의 로또를 발행할 때 중복되지 않는 6개의 숫자를 뽑는다.
- 당첨 번호 추첨 시 중복되지 않는 숫자 6개와 보너스 번호 1개를 뽑는다.
- 당첨은 1등부터 5등까지 있다. 당첨 기준과 금액은 아래와 같다.
- 1등: 6개 번호 일치 / 2,000,000,000원
- 2등: 5개 번호 + 보너스 번호 일치 / 30,000,000원
- 3등: 5개 번호 일치 / 1,500,000원
- 4등: 4개 번호 일치 / 50,000원
- 5등: 3개 번호 일치 / 5,000원
```

- 로또 구입 금액을 입력하면 구입 금액에 해당하는 만큼 로또를 발행해야 한다.
- 로또 1장의 가격은 1,000원이다.
- 당첨 번호와 보너스 번호를 입력받는다.
- 사용자가 구매한 로또 번호와 당첨 번호를 비교하여 당첨 내역 및 수익률을 출력하고 로또 게임을 종료한다.
- 사용자가 잘못된 값을 입력할 경우 `IllegalArgumentException`를 발생시키고, "[ERROR]"로 시작하는 에러 메시지를 출력 후 종료한다.

## ✍🏻 입출력 요구사항

### ⌨️ 입력

- 로또 구입 금액을 입력 받는다. 구입 금액은 1,000원 단위로 입력 받으며 1,000원으로 나누어 떨어지지 않는 경우 예외 처리한다.

```
14000
```

- 당첨 번호를 입력 받는다. 번호는 쉼표(,)를 기준으로 구분한다.

```
1,2,3,4,5,6
```

- 보너스 번호를 입력 받는다.

```
7
```

### 🖥 출력

- 발행한 로또 수량 및 번호를 출력한다. 로또 번호는 오름차순으로 정렬하여 보여준다.

```
8개를 구매했습니다.
[8, 21, 23, 41, 42, 43]
[3, 5, 11, 16, 32, 38]
[7, 11, 16, 35, 36, 44]
[1, 8, 11, 31, 41, 42]
[13, 14, 16, 38, 42, 45]
[7, 11, 30, 40, 42, 43]
[2, 13, 22, 32, 38, 45]
[1, 3, 5, 14, 22, 45]
```

- 당첨 내역을 출력한다.

```
3개 일치 (5,000원) - 1개
4개 일치 (50,000원) - 0개
5개 일치 (1,500,000원) - 0개
5개 일치, 보너스 볼 일치 (30,000,000원) - 0개
6개 일치 (2,000,000,000원) - 0개
```

- 수익률은 소수점 둘째 자리에서 반올림한다. (ex. 100.0%, 51.5%, 1,000,000.0%)

```
총 수익률은 62.5%입니다.
```

- 예외 상황 시 에러 문구를 출력해야 한다. 단, 에러 문구는 "[ERROR]"로 시작해야 한다.

```
[ERROR] 로또 번호는 1부터 45 사이의 숫자여야 합니다.
```

### 💻 실행 결과 예시

```
구입금액을 입력해 주세요.
8000

8개를 구매했습니다.
[8, 21, 23, 41, 42, 43]
[3, 5, 11, 16, 32, 38]
[7, 11, 16, 35, 36, 44]
[1, 8, 11, 31, 41, 42]
[13, 14, 16, 38, 42, 45]
[7, 11, 30, 40, 42, 43]
[2, 13, 22, 32, 38, 45]
[1, 3, 5, 14, 22, 45]

당첨 번호를 입력해 주세요.
1,2,3,4,5,6

보너스 번호를 입력해 주세요.
7

당첨 통계
---
3개 일치 (5,000원) - 1개
4개 일치 (50,000원) - 0개
5개 일치 (1,500,000원) - 0개
5개 일치, 보너스 볼 일치 (30,000,000원) - 0개
6개 일치 (2,000,000,000원) - 0개
총 수익률은 62.5%입니다.
```

---

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

- JDK 14 버전에서 실행 가능해야 한다.
- 프로그램 실행의 시작점은 `Application`의 `main()`이다.
- `build.gradle` 파일을 변경할 수 없고, 외부 라이브러리를 사용하지 않는다.
- [Java 코드 컨벤션](https://naver.github.io/hackday-conventions-java/) 가이드를 준수하며 프로그래밍한다.
- 프로그램 종료 시 `System.exit()`를 호출하지 않는다.
- 프로그램 구현이 완료되면 `ApplicationTest`의 모든 테스트가 성공해야 한다.
- 프로그래밍 요구 사항에서 달리 명시하지 않는 한 파일, 패키지 이름을 수정하거나 이동하지 않는다.
- indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
- 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
- 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다.
- 3항 연산자를 쓰지 않는다.
- 함수(또는 메서드)가 한 가지 일만 하도록 최대한 작게 만들어라.
- JUnit 5와 AssertJ를 이용하여 본인이 정리한 기능 목록이 정상 동작함을 테스트 코드로 확인한다.
- 함수(또는 메서드)의 길이가 15라인을 넘어가지 않도록 구현한다.
- 함수(또는 메서드)가 한 가지 일만 잘 하도록 구현한다.
- else 예약어를 쓰지 않는다.
- 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다.
- else를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다.
- Java Enum을 적용한다.
- 도메인 로직에 단위 테스트를 구현해야 한다. 단, UI(System.out, System.in, Scanner) 로직은 제외한다.
- 핵심 로직을 구현하는 코드와 UI를 담당하는 로직을 분리해 구현한다.

### 라이브러리

- [`camp.nextstep.edu.missionutils`](https://github.com/woowacourse-projects/mission-utils)에서 제공하는 `Randoms` 및 `Console` API를 사용하여 구현해야 한다.
- Random 값 추출은 `camp.nextstep.edu.missionutils.Randoms`의 `pickUniqueNumbersInRange()`를 활용한다.
- 사용자가 입력하는 값은 `camp.nextstep.edu.missionutils.Console`의 `readLine()`을 활용한다.

#### 사용 예시

```java
List<Integer> numbers = Randoms.pickUniqueNumbersInRange(1, 45, 6);
```

### Lotto 클래스

- 제공된 `Lotto` 클래스를 활용해 구현해야 한다.
- `Lotto`에 매개 변수가 없는 생성자를 추가할 수 없다.
- `numbers`의 접근 제어자인 private을 변경할 수 없다.
- `Lotto`에 필드(인스턴스 변수)를 추가할 수 없다.
- `Lotto`의 패키지 변경은 가능하다.

```java
public class Lotto {
private final List<Integer> numbers;

public Lotto(List<Integer> numbers) {
validate(numbers);
this.numbers = numbers;
}

private void validate(List<Integer> numbers) {
if (numbers.size() != 6) {
throw new IllegalArgumentException();
}
}

// TODO: 추가 기능 구현
}
```
13 changes: 13 additions & 0 deletions src/main/java/lotto/Application.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
package lotto;


import lotto.game.Game;
import lotto.game.GameImpl;
import lotto.input.InputImpl;
import lotto.print.PrintImpl;
import lotto.randomNumber.RandomNumberImpl;

public class Application {
public static void main(String[] args) {
// TODO: 프로그램 구현
Game game = new GameImpl(RandomNumberImpl.getInstance(), InputImpl.getInstance(), PrintImpl.getInstance());
Copy link

Choose a reason for hiding this comment

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

잘했습니다 👍

이렇게 인터페이스화 시키면 테스트 코드 짜기가 편해질거에요

try {
game.run();
} catch (Exception e) {
System.out.println(e.getMessage());
}
}
}
9 changes: 9 additions & 0 deletions src/main/java/lotto/compare/Compare.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package lotto.compare;

import java.util.List;

public interface Compare {
public List<Integer> compare();

public int[] winCount(List<Integer> list);
}
45 changes: 45 additions & 0 deletions src/main/java/lotto/compare/CompareImpl.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package lotto.compare;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import static lotto.constant.Constant.*;

public class CompareImpl implements Compare {

private final List<Integer> input;
private final List<Integer> randomNumber;

public CompareImpl(List<Integer> input, List<Integer> randomNumber) {
this.input = input;
this.randomNumber = randomNumber;
}

@Override
public List<Integer> compare() {
List<Integer> result;
int correct = 0;
int bonus = 0;
for (int i = 0; i < DIGITS; i++) {
Integer a = input.get(i);
if (randomNumber.contains(a)) {
correct++;
}
}
if (randomNumber.contains(input.get(DIGITS))) {
bonus++;
}
result = new ArrayList<>(Arrays.asList(correct, bonus));
return result;
}

@Override
public int[] winCount(List<Integer> list) {
int[] result = new int[2];
result[MATCH_COUNT_IDX] = Collections.frequency(list, MATCH_NUMBER);
result[BONUS_MATCH_COUNT_IDX] = Collections.frequency(list, BONUS_MATCH_NUMBER);
return result;
}
}
26 changes: 26 additions & 0 deletions src/main/java/lotto/constant/Constant.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package lotto.constant;

public class Constant {
public final static int DIGITS = 6;
public final static int MIN_BOUND = 1;
public final static int MAX_BOUND = 45;
public final static char MIN_BOUND_CHAR = '0';
public final static char MAX_BOUND_CHAR = '9';
public final static int FIRST_PLACE_COUNT = 6;
public final static int SECOND_PLACE_COUNT = 5;
public final static int FOURTH_PLACE_COUNT = 4;
public final static int FIFTH_PLACE_COUNT = 3;
public final static int BONUS_COUNT = 1;
public final static int FIRST_PLACE_IDX = 0;
public final static int SECOND_PLACE_IDX = 1;
public final static int THIRD_PLACE_IDX = 2;
public final static int FOURTH_PLACE_IDX = 3;
public final static int FIFTH_PLACE_IDX = 4;
public final static int TOTAL_PLACES = 5;
public final static int MATCH_COUNT_IDX = 0;
public final static int BONUS_MATCH_COUNT_IDX = 1;

public final static int MATCH_NUMBER = 1;
public final static int BONUS_MATCH_NUMBER = 2;

}
35 changes: 35 additions & 0 deletions src/main/java/lotto/constant/Message.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package lotto.constant;

public enum Message {


INPUT_PRICE("구입 금액을 입력해 주세요."),
OUTPUT_AMOUNT("개를 구매했습니다."),
INPUT_NUMBER("당첨 번호를 입력해 주세요"),
INPUT_BONUS("보너스 번호를 입력해 주세요"),
WINNING_RESULT("당첨 통계\n___"),
MATCH_THREE("3개 일치 (5,000원) - "),
MATCH_FOUR("4개 일치 (50,000원) - "),
MATCH_FIVE("5개 일치 (1,500,000원) - "),
MATCH_FIVE_BONUS("5개 일치, 보너스 볼 일치 (30,000,000원) - "),
MATCH_SIX("6개 일치 (2,000,000,000원) - "),
PROFIT_RESULT("총 수익률은 ");

private final String value;

Message(String value) {
this.value = value;
}

public String getValue() {
return value;
}

public String getMATCHValue(int x) {
return value + x + "개";
}

public String getProfitValue(int result, int price) {
return value + 100 * ((double) result / price) + "%입니다.";
}
}
14 changes: 14 additions & 0 deletions src/main/java/lotto/game/Game.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package lotto.game;

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

public interface Game {

List<List<Integer>> getRandomNumbers(int amount);

int[] getWinCounts(List<List<Integer>> winCounts);


public void run();
}
Loading