[문자열 덧셈 계산기] 정재우 미션 제출합니다.

README.md

@@ -1 +1,78 @@
-# java-calculator-precourse
+# java-calculator-precourse
+
+## 🚀 구현할 기능 목록 
+
+### ⌨️ 입력
+
+- [x] 덧셈할 문자열을 입력받는 기능을 구현한다.
+  - [x] 덧셈 문자열 입력 안내 메시지를 출력한다.
+  - [x] 사용자로부터 덧셈할 문자열을 입력받는다.
+  - [x] 입력된 문자열을 검증한다.
+    - [x] 숫자가 하나라도 포함되어있지 않은 경우, 예외를 반환한다.
+    - [x] 기본 구분자 중 하나라도 포함되어있지 않은 경우, 예외를 반환한다.
+  - [x] 입력된 문자열을 파싱 및 추가 검증한다.
+    - [x] 입력값에서 편리하게 숫자를 추출하기 위해 전처리를 진행한다.
+      - [x] 문자열에 커스텀 구분자가 포함되어 있는지 확인한다.
+      - [x] 문자열 앞 부분에 커스텀 구분자가 있는 경우, 이를 따로 저장한다.
+      - [x] 커스텀 구분자를 뺸 문자열을 입력값으로 최종 저장한다.
+    - [x] 문자열로부터 숫자들을 추출한다.
+      - [x] 주어진 문자열에 구분자가 포함되어 있는지 확인한다.
+      - [x] 만약 구분자가 포함되어 있는 경우, 구분자를 기준으로 문자열을 분리한다.
+      - [x] 구분자를 통해 분리된 값이 빈 문자열일 경우, 결과로 0을 반환한다.
+      - [x] 구분자를 통해 분리된 값이 숫자가 아닐 경우, 예외를 반환한다.
+      - [x] 구분자를 통해 분리된 값이 음수일 경우, 예외를 반환한다.
+    - [x] 최종적으로 분리된 숫자들을 리스트에 저장한다.
+
+### 🖥 출력
+
+- [x] 덧셈 결과를 출력한다.
+  - [x] "결과"라는 문자열와 덧셈 결과를 ":" 구분자를 통해 구분한다.
+
+### ⚙️ 로직
+
+- [x] 리스트에 저장된 숫자들을 더하는 기능을 구현한다.
+  - [x] 리스트에 저장된 숫자들을 모두 더한 결과를 반환한다.
+
+---
+
+## 🛠️ 리팩토링 목록
+
+### 1️⃣ 모든 예외를 처리하지 못하는 있는 현 검증 로직 → 더 많은 예외에 대비하기 위해, 더 많은 검증 메서드 구현
+
+- [x] 커스텀 구분자에 실제 이스케이프 문법("\")이 포함된 경우에 대한 예외 처리를 추가한다.
+- [x] 커스텀 구분자에 숫자가 포함되는 경우에 대한 예외 처리를 추가한다.
+- [x] 커스텀 구분자가 빈 문자열("")일 경우에 대한 예외 처리를 추가한다.
+- [x] 구분자에 의해 분리된 값이 숫자가 아닌 경우에 대한 예외 처리를 추가한다.
+
+### 2️⃣ 입력값 검증과 파싱 로직이 혼용되는 문제 발생 → 확실하게 책임을 분리
+
+- [x] 입력값 검증과 관련된 메서드들은 모두 `InputValidator`에서 관리하도록 이동시킨다.
+- [x] 입력값 파싱 과정에서 쓰이는 검증 메서드들은 `InputFilter` 내에서 `InputValidator`를 참조하여 사용하도록 수정한다.
+
+### 3️⃣ 매직 넘버 및 리터럴 사용으로 인한 추후 유지보수에서의 어려움 예상 → 클래스 및 상수로서 관리
+
+- [x] 에러 메시지를 Enum을 통해 상수로 관리하도록 수정한다.
+- [x] 구분자 목록을 Enum을 통해 상수로 관리하도록 수정한다.
+
+### 4️⃣ 숫자 값들이 각 객체와 메서드를 거치며 변경될 여지가 있음 → 불변 개념 적용
+
+- [x] 숫자 값들을 변경할 수 없도록 `final` 키워드를 추가한다.
+- [x] 숫자 리스트를 전달할 떄, 불변 리스트로 전달될 수 있도록 List.of 또는 unmodifiableList를 적용한다.
+
+### 5️⃣ 인스턴스 관리가 여러 곳에 산재되어 있음 → 모든 인스턴스를 한 곳에서 관리 
+
+- [x] 정적 클래스와 일반 클래스의 구분을 분명히 하기 위해 `InputValidator` 클래스를 제외한 모든 클래스를 인스턴스화한다.
+- [x] `ApplicationConfig` 클래스를 통해 여러 개의 인스턴스를 한 곳에서 관리한다.
+
+### 6️⃣ 테스트 케이스가 단 2개밖에 없는 상황 → 더 많은 테스트 케이스를 작성하여 테스트 용이성 향상
+
+- [ ] 각 예외 상황에 대한 테스트 케이스를 추가한다.
+- [ ] 그 외에 각 메서드들이 정상적으로 동작하는지 확인할 수 있도록 테스트 케이스를 추가한다.
+
+### 7️⃣ 구분자를 단순 필드 변수로 관리중 → 구분자 관리를 위한 별도 클래스 생성
+
+- [x] `Delimiters` 클래스를 생성하여, 구분자 목록을 관리하도록 수정한다.
+
+### 8️⃣ 커스텀 구분자에 대한 처리를 `InputFilter` 클래스에서 전담하고 있는 상황 → `CustomDelimiterProcessor` 클래스 생성을 통한 책임 분리
+
+- [x] 기존 `InputFilter` 클래스에 있던 커스텀 구분자 처리 로직을 `CustomDelimiterProcessor` 클래스로 이동시킨다.

src/main/java/calculator/Application.java

@@ -1,7 +1,14 @@
 package calculator;
 
+import calculator.config.ApplicationConfig;
+import calculator.controller.CalculatorController;
+
 public class Application {
-    public static void main(String[] args) {
-        // TODO: 프로그램 구현
-    }
+
+	public static void main(String[] args) {
+		ApplicationConfig applicationConfig = new ApplicationConfig();
+		CalculatorController calculatorController = applicationConfig.initializeController();
+
+		calculatorController.run();
+	}
 }

src/main/java/calculator/config/ApplicationConfig.java

@@ -0,0 +1,22 @@
+package calculator.config;
+
+import calculator.controller.CalculatorController;
+import calculator.model.Calculator;
+import calculator.model.InputFilter;
+import calculator.model.delimiter.CustomDelimiterProcessor;
+import calculator.model.delimiter.Delimiters;
+import calculator.view.InputView;
+import calculator.view.OutputView;
+
+public class ApplicationConfig {
+	public CalculatorController initializeController() {
+		return new CalculatorController(
+			new InputView(),
+			new OutputView(),
+			new Delimiters(),
+			new CustomDelimiterProcessor(),
+			new InputFilter(),
+			new Calculator()
+		);
+	}
+}

src/main/java/calculator/config/CustomDelimiterPattern.java

@@ -0,0 +1,20 @@
+package calculator.config;
+
+public enum CustomDelimiterPattern {
+	START("//"),
+	END("\\n");
+
+	private final String pattern;
+
+	CustomDelimiterPattern(String pattern) {
+		this.pattern = pattern;
+	}
+
+	public String getPattern() {
+		return pattern;
+	}
+
+	public int getPatternLength() {
+		return pattern.length();
+	}
+}

src/main/java/calculator/config/DefaultDelimiter.java

@@ -0,0 +1,16 @@
+package calculator.config;
+
+public enum DefaultDelimiter {
+	COMMA(","),
+	COLON(":");
+
+	private final String delimiter;
+
+	DefaultDelimiter(String delimiter) {
+		this.delimiter = delimiter;
+	}
+
+	public String getDelimiter() {
+		return delimiter;
+	}
+}

src/main/java/calculator/controller/CalculatorController.java

@@ -0,0 +1,74 @@
+package calculator.controller;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+import calculator.model.Calculator;
+import calculator.model.delimiter.CustomDelimiterProcessor;
+import calculator.model.delimiter.Delimiters;
+import calculator.model.InputFilter;
+import calculator.view.InputView;
+import calculator.view.OutputView;
+
+public class CalculatorController {
+	private final InputView inputView;
+	private final OutputView outputView;
+	private final Delimiters delimiters;
+	private final CustomDelimiterProcessor customDelimiterProcessor;
+	private final InputFilter inputFilter;
+	private final Calculator calculator;
+
+	public CalculatorController(
+		InputView inputView,
+		OutputView outputView,
+		Delimiters delimiters,
+		CustomDelimiterProcessor customDelimiterProcessor,
+		InputFilter inputFilter,
+		Calculator calculator
+	) {
+		this.inputView = inputView;
+		this.outputView = outputView;
+		this.delimiters = delimiters;
+		this.customDelimiterProcessor = customDelimiterProcessor;
+		this.inputFilter = inputFilter;
+		this.calculator = calculator;
+	}
+
+	public void run() {
+		String input = readInput();
+
+		String processedInput = processCustomDelimiter(input);
+		Set<Integer> numbers = extractNumbers(processedInput);
+		int result = sum(numbers);
+
+		printResult(result);
+	}
+
+	private String readInput() {
+		outputView.printReadCommand();
+		String input = inputView.readInput();
+		inputView.closeRead();
+
+		return input;
+	}
+
+	private String processCustomDelimiter(String input) {
+		Optional<String> customDelimiter = customDelimiterProcessor.extractCustomDelimiter(input);
+		customDelimiter.ifPresent(delimiters::addDelimiter);
+
+		return customDelimiterProcessor.removeCustomDelimiterPattern(input);
+	}
+
+	private Set<Integer> extractNumbers(String processedInput) {
+		return inputFilter.extractNumbers(processedInput, delimiters);
+	}
+
+	private int sum(Set<Integer> numbers) {
+		return calculator.sum(numbers);
+	}
+
+	private void printResult(int result) {
+		outputView.printResult(result);
+	}
+}

src/main/java/calculator/exception/ErrorMessage.java

@@ -0,0 +1,30 @@
+package calculator.exception;
+
+public enum ErrorMessage {
+	// prefix
+	ERROR_PREFIX("[ERROR] "),
+
+	// delimiter
+	INVALID_DELIMITER("허용되지 않은 구분자가 포함되어 있습니다."),
+	INVALID_CUSTOM_DELIMITER("커스텀 구분자는 정수일 수 없습니다."),
+	EMPTY_CUSTOM_DELIMITER("커스텀 구분자는 빈 문자열일 수 없습니다."),
+
+	// calculator
+	NON_INTEGER_VALUE("계산기에 입력될 숫자는 정수이어야 합니다."),
+	NON_POSITIVE_NUMBER("계산기에 입력될 숫자는 양수이어야 합니다."),
+
+	// custom delimiter pattern
+	INVALID_START_PATTERN("커스텀 구분자의 시작 패턴이 올바르지 않습니다."),
+	INVALID_END_PATTERN("커스텀 구분자의 종료 패턴이 올바르지 않습니다."),
+	INVALID_PATTERN_POSITION("커스텀 구분자의 위치가 올바르지 않습니다.");
+
+	private final String message;
+
+	ErrorMessage(String message) {
+		this.message = message;
+	}
+
+	public String getMessage() {
+		return ERROR_PREFIX.message + message;
+	}
+}

src/main/java/calculator/model/Calculator.java

@@ -0,0 +1,11 @@
+package calculator.model;
+
+import java.util.Set;
+
+public class Calculator {
+	public int sum(Set<Integer> numbers) {
+		return numbers.stream()
+			.mapToInt(Integer::intValue)
+			.sum();
+	}
+}

src/main/java/calculator/model/InputFilter.java

@@ -0,0 +1,39 @@
+package calculator.model;
+
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import calculator.model.delimiter.Delimiters;
+import calculator.validation.InputValidator;
+
+public class InputFilter {
+	public Set<Integer> extractNumbers(String processedInput, Delimiters delimiters) {
+		if (processedInput.isBlank()) {
+			return Set.of(0);
+		}
+		String[] splitParts = splitInput(processedInput, delimiters);
+		validateEachPart(splitParts);
+
+		return mapToIntegerSet(splitParts);
+	}
+
+	private String[] splitInput(String processedInput, Delimiters delimiters) {
+		InputValidator.validateInvalidDelimiter(processedInput, delimiters);
+		String regex = String.join("|", delimiters.getRegex());
+
+		return processedInput.split(regex);
+	}
+
+	private static void validateEachPart(String[] splitParts) {
+		Arrays.stream(splitParts)
+			.map(String::trim)
+			.forEach(InputValidator::validateCalculatorNumber);
+	}
+
+	private static Set<Integer> mapToIntegerSet(String[] splitParts) {
+		return Arrays.stream(splitParts)
+			.map(Integer::valueOf)
+			.collect(Collectors.toUnmodifiableSet());
+	}
+}

src/main/java/calculator/model/delimiter/CustomDelimiterProcessor.java

@@ -0,0 +1,53 @@
+package calculator.model.delimiter;
+
+import static calculator.config.CustomDelimiterPattern.*;
+
+import java.util.Optional;
+
+import calculator.validation.InputValidator;
+
+public class CustomDelimiterProcessor {
+	public String removeCustomDelimiterPattern(String input) {
+		if (hasCustomDelimiterPattern(input)) {
+			int endIndex = findEndIndex(input);
+
+			return input.substring(endIndex + END.getPatternLength());
+		}
+
+		return input;
+	}
+
+	public Optional<String> extractCustomDelimiter(String input) {
+		if (!hasCustomDelimiterPattern(input)) {
+			return Optional.empty();
+		}
+		int startIndex = findStartIndex(input);
+		int endIndex = findEndIndex(input);
+
+		return Optional.of(extractCustomDelimiter(input, startIndex, endIndex));
+	}
+
+	private boolean hasCustomDelimiterPattern(String input) {
+		return input.contains(START.getPattern()) && input.contains(END.getPattern());
+	}
+
+	private int findStartIndex(String input) {
+		int startIndex = input.indexOf(START.getPattern());
+		InputValidator.validateStartPattern(startIndex);
+
+		return startIndex + START.getPatternLength();
+	}
+
+	private int findEndIndex(String input) {
+		int endIndex = input.indexOf(END.getPattern());
+		InputValidator.validateEndPattern(endIndex);
+
+		return endIndex;
+	}
+
+	private String extractCustomDelimiter(String input, int start, int end) {
+		InputValidator.validatePatternPosition(start, end);
+
+		return input.substring(start, end);
+	}
+}