[4기][3주차] Wordle 과제 제출 - John

README.md

@@ -1,5 +1,12 @@
 # 미션 - 워들
 
+## 페어 프로그래밍 룰 
+- [룰](./readme/PairProgrammingRule.md)
+
+## 기능 명세
+- [기능 설명](./readme/FunctionDescription.md)
+- [클래스 설명](./readme/ClassDescription.md)
+
 ## 🔍 진행 방식
 
 - 미션은 **기능 요구 사항, 프로그래밍 요구 사항, 과제 진행 요구 사항** 세 가지로 구성되어 있다.

readme/ClassDescription.md

@@ -0,0 +1,39 @@
+# 기능 설명 
+
+### controller
+1. GameHost
+- Service Layer을 통해 게임의 흐름을 통제한다 
+
+### service
+1. InputManager
+- 사용자의 입력을 Word 객체로 전달 받는다
+2. InputViewManger 
+- ViewManger을 주입받는다. 
+- 단어 입력 전 / 후 출력을 관리하고, InputManager을 통해 단어를 받는다.
+3. ViewManger
+- 사용자에게 출력하는 모든 로직을 담당한다
+4. WordsGenerator 
+- 날짜에 따라 오늘의 정답 단어를 AnswerWord로 추출한다
+
+### domain
+1. Word
+- 입력받은 단어에 대해 저장 및 검증
+2. AnswerWord
+- Word를 상속받아, 다른 Word와의 비교 결과를 산출
+3. Result
+- 사용자의 입력 하나에 대한 게임 결과를 저장
+4. TileColor
+- Enum으로써, TileColor 별 표시 할 데이터를 저장
+5. Coin 
+- 문자 입력 가능 횟수를 의미
+- 최초 코인 개수를 통해 생성
+- 문자 입력시 코인 개수 감소
+- 코인이 남아있는지 여부 확인
+
+### utils
+1. FileUtils
+- 파일 경로를 받아 Stream<String>을 반환
+2. LocalDateTimeUtils
+- 입력받은 2개의 날짜 차이를 반환
+3. StringUtils
+- 입력받은 문자에 대해 5개의 소문자로 구성된 문자인지 검증

readme/FunctionDescription.md

@@ -0,0 +1,21 @@
+# 기능 명세
+
+### 정답 단어 추출하기
+1. 파일로부터 String데이터를 읽어와야 한다.
+2. 파일로부터 읽어온 데이터중, (2021-6-19 과 오늘 날짜의 차이) % (파일로부터 읽어온 String 개수) 의 위치에 있는 단어를 정답 단어로 선출한다. 
+
+### 단어 입력받기
+1. 사용자로부터 단어를 입력을 받는다. 단, 소문자 5개로 구성된 단어야만 한다. 
+2. 정상적이지 않은 입력이 발생했을때, 다시 입력을 받아야 한다. 
+
+### 정답 단어와 사용자가 입력한 단어 비교하기 
+1. 정답 단어와 사용자의 단어를 비교했을때, 위치까지 똑같은 Spelling과 위치는 다르나 정답 단어에 존재하는 Spelling 그리고 아예 관계없는 Spelling을 구분한 결과값이 있어야 한다.
+
+### 게임 결과를 출력하기 
+1. 정답 단어와 사용자의 단어 비교 결과를 색깔 박스를 통해 표시를 해주어야 한다. 
+2. 결과 출력시, 이전 결과도 함께 출력 해 주어야 한다. 
+3. 유저의 게임 성공, 실패에 대한 결과 출력 및 실패시 엔 오늘의 단어도 같이 출력
+
+### 게임 횟수 제한하기
+1. 사용자가 최대 6번까지 입력 받을 수 있게 제한. 6번 이내에 클리어 시 게임 종료.
+

readme/PairProgrammingRule.md

@@ -0,0 +1,36 @@
+# 페어프로그래밍 룰 
+
+### 네비게이터
+1. 오류를 너무 빨리 체크하지 말자 
+2. 높은 추상화 수준의 지시를 하자(큰 그림을 제안하자)
+3. 자신의 키보드를 사용하자
+
+### 드라이버
+1. 천천히 코딩하자. 네비게이터와 항상 말을 하면서 코딩하자
+2. 네비게이터가 말이 없다면 동기화가 안된것. 동기화를 다시 하고 드라이빙하자 
+3. 휴식하자.
+4. 경청하자. 네비게이터가 제안할때는 키보드에서 손을 떼자.
+
+
+### 네비게이터 & 드라이버 
+1. 시작하기 전에 모든 알림을 끄자. (필요한 어플만 켜놓자)
+2. 자주 역할을 전환하자. (시간을 정해두고)
+3. 항상 설계를 합의하고 시작하자. 
+---
+- [codeStyle](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)
+- 페어그래밍 툴 : Intellij Code With Me 
+- 각자 20분 코딩 & 10분회고 & 10분 휴식
+- 회고 10분이 넘어가면 다시 처음부터 회고
+- 자바 코드 컨벤션을 지키면서 프로그래밍한다.
+  - 기본적으로 Google Java Style Guide을 원칙으로 한다.
+  - 단, 들여쓰기는 '2 spaces'가 아닌 '4 spaces'로 한다.
+- indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
+  - 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
+  - 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다.
+- 3항 연산자를 쓰지 않는다.
+- 함수(또는 메서드)의 길이가 10라인을 넘어가지 않도록 구현한다.
+  - 함수(또는 메서드)가 한 가지 일만 잘 하도록 구현한다.
+- else 예약어를 쓰지 않는다.
+  - 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다.
+  - else를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다.
+

src/main/java/Application.java

@@ -0,0 +1,22 @@
+import com.wodle.controller.GameHost;
+import com.wodle.service.InputManager;
+import com.wodle.service.InputMangerProxy;
+import com.wodle.service.ViewManager;
+import com.wodle.service.WordsGenerator;
+
+public class Application {
+
+    public static void main(String[] args) {
+        ViewManager viewManager = new ViewManager();
+        InputManager inputMangerProxy = new InputMangerProxy(viewManager);
+        WordsGenerator wordsGenerator = new WordsGenerator();
+        GameHost host = new GameHost(
+            inputMangerProxy,
+            viewManager,
+            wordsGenerator
+        );
+
+        host.play();
+    }
+
+}

src/main/java/com/wodle/controller/GameHost.java

@@ -0,0 +1,72 @@
+package com.wodle.controller;
+
+import com.wodle.domain.AnswerWord;
+import com.wodle.domain.Coins;
+import com.wodle.domain.Result;
+import com.wodle.domain.Word;
+import com.wodle.service.InputManager;
+import com.wodle.service.ViewManager;
+import com.wodle.service.WordsGenerator;
+
+public class GameHost {
+
+    private static final int START_COIN = 6;
+    private final InputManager inputManagerProxy;
+
+    private final ViewManager viewManager;
+
+    private final WordsGenerator wordsGenerator;
+
+    public GameHost(InputManager inputManagerProxy, ViewManager viewManager,
+        WordsGenerator wordsGenerator) {
+        this.inputManagerProxy = inputManagerProxy;
+        this.viewManager = viewManager;
+        this.wordsGenerator = wordsGenerator;
+    }
+
+    public void play() {
+        GameMachine machine = init();
+
+        viewManager.printGameStart();
+
+        while (machine.isGameNotEnd()) {
+            machine.useCoin();
+            Word inputWord = inputManagerProxy.inputWord();
+            Result wordCompareResult = machine.compareWord(inputWord);
+            viewManager.printCompareResult(wordCompareResult);
+
+            machine.isGameEnd = wordCompareResult.isGameEnd();
+        }
+
+        viewManager.printResult(machine.isGameEnd, machine.word);
+    }
+
+    private GameMachine init(){
+        AnswerWord word = wordsGenerator.getTodayWord();
+        return new GameMachine(word, START_COIN);
+    }
+
+    private static class GameMachine {
+        private final AnswerWord word;
+        private final Coins coins;
+        private boolean isGameEnd = false;
+
+        public GameMachine(AnswerWord word, int startCoin){
+            this.word = word;
+            this.coins = new Coins(startCoin);
+        }
+
+        public boolean isGameNotEnd (){
+            return !coins.isEmpty() && !isGameEnd;
+        }
+
+        public void useCoin(){
+            coins.use();
+        }
+
+        public Result compareWord(Word inputWord){
+            return this.word.compare(inputWord);
+        }
+    }
+
+}

src/main/java/com/wodle/domain/AnswerWord.java

@@ -0,0 +1,45 @@
+package com.wodle.domain;
+
+import java.util.Arrays;
+import java.util.LinkedList;
+import java.util.List;
+
+public class AnswerWord extends Word {
+
+    private final boolean[] alphabetExistInfoStore = new boolean[26];
+
+    public AnswerWord(String word) {
+        super(word);
+        Arrays.fill(alphabetExistInfoStore, false);
+
+        char[] words = word.toCharArray();
+
+        for (char c : words) {
+            alphabetExistInfoStore[c - 'a'] = true;
+        }
+    }
+
+    public Result compare(Word target) {
+        char[] sourceWordArray = this.getWordArray();
+        char[] targetWordArray = target.getWordArray();
+        List<TileColor> matchResult = new LinkedList<>();
+
+        for (int i = 0; i < sourceWordArray.length; i++) {
+            matchResult.add(match(sourceWordArray, targetWordArray, i));
+        }
+
+        return new Result(matchResult);
+    }
+
+    private TileColor match(char[] source, char[] target, int index) {
+        if (source[index] == target[index]) {
+            return TileColor.GREEN;
+        }
+
+        if (alphabetExistInfoStore[target[index] - 'a']) {
+            return TileColor.YELLOW;
+        }
+
+        return TileColor.GREY;
+    }
+}

src/main/java/com/wodle/domain/Coins.java

@@ -0,0 +1,29 @@
+package com.wodle.domain;
+
+public class Coins {
+
+    private int coin;
+
+    public Coins(int availableCoin) {
+        validate(availableCoin);
+
+        this.coin = availableCoin;
+    }
+
+    public void use() {
+        int tempCoin = this.coin - 1;
+        validate(tempCoin);
+        this.coin = tempCoin;
+    }
+
+    private void validate(int availableCoin) {
+        if (availableCoin < 0) {
+            throw new IllegalArgumentException("Coin can be set under 0");
+        }
+    }
+
+
+    public boolean isEmpty() {
+        return this.coin == 0;
+    }
+}

src/main/java/com/wodle/domain/Result.java

@@ -0,0 +1,24 @@
+package com.wodle.domain;
+
+import com.wodle.domain.TileColor;
+import java.util.Collections;
+import java.util.List;
+
+public class Result {
+
+    private final long matchCount;
+    private final List<TileColor> matchStatus;
+
+    public Result(List<TileColor> matchStatus) {
+        this.matchStatus = matchStatus;
+        this.matchCount = matchStatus.stream()
+            .filter(tileColor -> tileColor == TileColor.GREEN)
+            .count();
+    }
+
+    public boolean isGameEnd() {
+        return matchCount == matchStatus.size();
+    }
+
+    public List<TileColor> getMatchStatus(){ return Collections.unmodifiableList(matchStatus) ;}
+}

src/main/java/com/wodle/domain/TileColor.java

@@ -0,0 +1,17 @@
+package com.wodle.domain;
+
+public enum TileColor {
+    GREEN("\uD83D\uDFE9"),
+    YELLOW("\uD83D\uDFE8"),
+    GREY("⬜");
+
+    private final String print;
+
+    TileColor(String print) {
+        this.print = print;
+    }
+
+    public String getPrint() {
+        return print;
+    }
+}

src/main/java/com/wodle/domain/Word.java

@@ -0,0 +1,28 @@
+package com.wodle.domain;
+
+
+import static com.wodle.utils.StringUtils.matchesFiveSmallAlphabet;
+
+public class Word {
+
+    private final String word;
+
+    public Word(String word) {
+        validate(word);
+        this.word = word;
+    }
+
+    private void validate(String word) {
+        if (!matchesFiveSmallAlphabet(word)) {
+            throw new IllegalArgumentException("user input require 5 small alphabet");
+        }
+    }
+
+    protected char[] getWordArray() {
+        return word.toCharArray();
+    }
+
+    public String getWord() {
+        return word;
+    }
+}

src/main/java/com/wodle/service/InputManager.java

@@ -0,0 +1,19 @@
+package com.wodle.service;
+
+import camp.nextstep.edu.missionutils.Console;
+import com.wodle.domain.Word;
+import java.util.NoSuchElementException;
+
+public class InputManager {
+
+    public Word inputWord() {
+        try {
+            String userInput = Console.readLine();
+            return new Word(userInput);
+        } catch (IllegalArgumentException e) {
+            throw e;
+        } catch (NoSuchElementException e) {
+            throw new NoSuchElementException("No such line");
+        }
+    }
+}