diff --git a/README.md b/README.md index 299a2d2..05a03dc 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,18 @@ -# java-calculator - -## **학습 목표** - -- Git, GitHub, IDE 등 실제 개발을 위한 환경에 익숙해진다. -- 교육 분야에 맞는 프로그래밍 언어를 사용하여 간단한 문제를 해결한다. +# 문자열 덧셈 계산기 +> 입력한 문자열에서 숫자를 추출하여 더하는 계산기를 구현하다. --- -## **미션 진행 방식** - -### **진행 방식** - -- 미션은 **과제 진행 요구 사항**, **기능 요구 사항**, **프로그래밍 요구 사항** 세 가지로 구성되어 있다. -- 세 개의 요구 사항을 만족하기 위해 노력한다. 특히 기능을 구현하기 전에 기능 목록을 만들고, 기능 단위로 커밋 하는 방식으로 진행한다. -- **기능 요구 사항에 기재되지 않은 내용은 스스로 판단하여 구현한다.** - -### **미션 제출 방법** - -- 미션 구현을 완료한 후 GitHub을 통해 제출해야 한다. - - GitHub을 활용한 제출 방법은 [프리코스 과제 제출](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 문서를 참고해 제출한다. - -### **과제 제출 전 체크 리스트** - -- 기능을 올바르게 구현했더라도 **요구 사항에 명시된 출력 형식을 따르지 않으면 0점**을 받게 된다. -- 기능 구현을 완료한 후 아래 가이드에 따라 모든 테스트가 성공적으로 실행되는지 확인한다. -- **테스트가 실패하면 점수가 0점**이 되므로 제출하기 전에 반드시 확인한다. - -### **테스트 실행 가이드** - -- 터미널에서 `java -version`을 실행하여 Java 버전이 21인지 확인한다. Eclipse 또는 IntelliJ IDEA와 같은 IDE에서 Java 21로 실행되는지 확인한다. -- 터미널에서 Mac 또는 Linux 사용자의 경우 `./gradlew clean test` 명령을 실행하고, Windows 사용자의 경우 `gradlew.bat clean test` 또는 `.\gradlew.bat clean test` 명령을 실행할 때 모든 테스트가 아래와 같이 통과하는지 확인한다. - -``` -BUILD SUCCESSFUL in 0s - -``` +## Tech Stack & Environment +* **Language:** Java 21 +* **Framework:** Spring Boot 3.x +* **Build Tool:** Gradle +* **Test:** JUnit 5, AssertJ --- -# **문자열 덧셈 계산기** - -## **과제 진행 요구 사항** -- **기능을 구현하기 전 `README.md`에 구현할 기능 목록을 정리**해 추가한다. -- Git의 커밋 단위는 앞 단계에서 `README.md`에 정리한 기능 목록 단위로 추가한다. - - [AngularJS Git Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)을 참고해 커밋 메시지를 작성한다. -- 자세한 과제 진행 방법은 프리코스 진행 가이드 문서를 참고한다. - -## **기능 요구 사항** - -입력한 문자열에서 숫자를 추출하여 더하는 계산기를 구현한다. - -- 쉼표(,) 또는 콜론(:)을 구분자로 가지는 문자열을 전달하는 경우 구분자를 기준으로 분리한 각 숫자의 합을 반환한다. - - 예: "" => 0, "1,2" => 3, "1,2,3" => 6, "1,2:3" => 6 -- 앞의 기본 구분자(쉼표, 콜론) 외에 커스텀 구분자를 지정할 수 있다. 커스텀 구분자는 문자열 앞부분의 "//"와 "\n" 사이에 위치하는 문자를 커스텀 구분자로 사용한다. - - 예를 들어 "//;\n1;2;3"과 같이 값을 입력할 경우 커스텀 구분자는 세미콜론(;)이며, 결과 값은 6이 반환되어야 한다. -- 사용자가 잘못된 값을 입력할 경우 `IllegalArgumentException`을 발생시킨 후 애플리케이션은 종료되어야 한다. - -### **입출력 요구 사항** - -### **입력** - -- 구분자와 양수로 구성된 문자열 - -### **출력** - -- 덧셈 결과 - -``` -결과 : 6 - -``` - -### **실행 결과 예시** - -``` -덧셈할 문자열을 입력해 주세요. -1,2:3 -결과 : 6 - -``` - -## **프로그래밍 요구 사항** - -- JDK 21 버전에서 실행 가능해야 한다. -- 프로그램 실행의 시작점은 `Application`의 `main()`이다. -- `build.gradle` 파일은 변경할 수 없으며, **제공된 라이브러리 이외의 외부 라이브러리는 사용하지 않는다.** -- 프로그램 종료 시 `System.exit()`를 호출하지 않는다. -- 프로그래밍 요구 사항에서 달리 명시하지 않는 한 파일, 패키지 등의 이름을 바꾸거나 이동하지 않는다. -- 자바 코드 컨벤션을 지키면서 프로그래밍한다. - - 기본적으로 [Java Style Guide](https://github.com/woowacourse/woowacourse-docs/blob/main/styleguide/java)를 원칙으로 한다. - -### **라이브러리** - -- `camp.nextstep.edu.missionutils`에서 제공하는 `Console` API를 사용하여 구현해야 한다. - - 사용자가 입력하는 값은 `camp.nextstep.edu.missionutils.Console`의 `readLine()`을 활용한다. \ No newline at end of file +## Key Features +* **커스텀 구분자 분석:** `//[구분자]\n[본문]` 형식의 문자열 패턴을 정규식으로 검증 및 추출 +* **기본 구분자 분석:** `[숫자][:or,][숫자][:or,]...` 형태의 패턴을 정규식으로 검증 및 추출 +* **도메인 중심 설계:** 비즈니스 검증 및 가공 로직을 `Domain` 객체 내부에 응집 +* **안전한 데이터 전송:** 계층 간 이동 시 `Static Inner Class` 기반의 DTO 구조 채택 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 9bbc975..e644113 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 37f853b..b82aa23 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip networkTimeout=10000 validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew index faf9300..1aa94a4 100755 --- a/gradlew +++ b/gradlew @@ -15,8 +15,6 @@ # See the License for the specific language governing permissions and # limitations under the License. # -# SPDX-License-Identifier: Apache-2.0 -# ############################################################################## # @@ -57,7 +55,7 @@ # Darwin, MinGW, and NonStop. # # (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt # within the Gradle project. # # You can find Gradle at https://github.com/gradle/gradle/. @@ -86,7 +84,7 @@ done # shellcheck disable=SC2034 APP_BASE_NAME=${0##*/} # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) -APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD=maximum @@ -205,7 +203,7 @@ fi DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Collect all arguments for the java command: -# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, # and any embedded shellness will be escaped. # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be # treated as '${Hostname}' itself on the command line. diff --git a/gradlew.bat b/gradlew.bat index 9b42019..7101f8e 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -13,8 +13,6 @@ @rem See the License for the specific language governing permissions and @rem limitations under the License. @rem -@rem SPDX-License-Identifier: Apache-2.0 -@rem @if "%DEBUG%"=="" @echo off @rem ########################################################################## diff --git a/src/main/java/calculator/Application.java b/src/main/java/calculator/Application.java index 573580f..8191ea1 100644 --- a/src/main/java/calculator/Application.java +++ b/src/main/java/calculator/Application.java @@ -1,7 +1,11 @@ package calculator; +import calculator.controller.CalculatorController; + public class Application { public static void main(String[] args) { // TODO: 프로그램 구현 + CalculatorController calculatorController = new CalculatorController(); + calculatorController.run(); } } diff --git a/src/main/java/calculator/controller/CalculatorController.java b/src/main/java/calculator/controller/CalculatorController.java new file mode 100644 index 0000000..d297cc0 --- /dev/null +++ b/src/main/java/calculator/controller/CalculatorController.java @@ -0,0 +1,17 @@ +package calculator.controller; + +import calculator.service.CalculatorService; +import calculator.view.*; +import static calculator.view.InputView.*; + +public class CalculatorController { + + public void run() { + String input = receiveInput(); + + CalculatorService calculatorService = new CalculatorService(); + int result = calculatorService.calculateInput(input); + + OutputView.showResult(result); + } +} diff --git a/src/main/java/calculator/domain/Delimiter.java b/src/main/java/calculator/domain/Delimiter.java new file mode 100644 index 0000000..545f207 --- /dev/null +++ b/src/main/java/calculator/domain/Delimiter.java @@ -0,0 +1,55 @@ +package calculator.domain; + +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Pattern; + +public class Delimiter { + + private final String delimiter; + private final Expression expression; + + public Delimiter(String input) { + expression = new Expression(input); + if (hasCustomDelimiter()) { + delimiter = expression.getCustomDelimiter(); + return; + } + delimiter = null; + } + + public boolean hasCustomDelimiter() { + if (expression.isCustomDelimiter()) { + return true; + } + if (expression.isDefaultDelimiter()) { + return false; + } + throw new IllegalArgumentException("올바르지 않은 입력 형식입니다."); + } + + public List parseAsCustomDelimiter(String input) { + String body = expression.getBody(); + String[] numbers = body.split(Pattern.quote(delimiter)); + + List numberList = new ArrayList<>(); + for (String number : numbers) { + Number num = new Number(Integer.parseInt(number)); + numberList.add(num); + } + return numberList; + } + + public List parseAsDefaultDelimiter(String input) { + List numberList = new ArrayList<>(); + String[] restResult = input.split(","); + for (String rr : restResult) { + String[] colonResult = rr.split(":"); + for (String cr : colonResult) { + Number number = new Number(Integer.parseInt(cr)); + numberList.add(number); + } + } + return numberList; + } +} diff --git a/src/main/java/calculator/domain/Expression.java b/src/main/java/calculator/domain/Expression.java new file mode 100644 index 0000000..fe616a8 --- /dev/null +++ b/src/main/java/calculator/domain/Expression.java @@ -0,0 +1,36 @@ +package calculator.domain; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +public class Expression { + + private static final Pattern customRegex = Pattern.compile("^//(.)\\\\n(([1-9][0-9]*)(\\1[1-9][0-9]*)*$)"); + private static final Pattern defaultRegex = Pattern.compile("([1-9][0-9]*)([, :][1-9][0-9]*)*"); + + private final String input; + + public Expression(String input) { + this.input = input; + } + + public boolean isCustomDelimiter() { + return Pattern.matches(String.valueOf(customRegex), input); + } + + public boolean isDefaultDelimiter() { + return Pattern.matches(String.valueOf(defaultRegex), input); + } + + public String getCustomDelimiter() { + Matcher matcher = customRegex.matcher(input); + matcher.matches(); + return matcher.group(1); + } + + public String getBody() { + Matcher matcher = customRegex.matcher(input); + matcher.matches(); + return matcher.group(2); + } +} diff --git a/src/main/java/calculator/domain/Number.java b/src/main/java/calculator/domain/Number.java new file mode 100644 index 0000000..65bae00 --- /dev/null +++ b/src/main/java/calculator/domain/Number.java @@ -0,0 +1,13 @@ +package calculator.domain; + +public class Number { + private final int num; + + public Number(int num) { + this.num = num; + } + + public int addTo(int sum) { + return sum += num; + } +} diff --git a/src/main/java/calculator/domain/Numbers.java b/src/main/java/calculator/domain/Numbers.java new file mode 100644 index 0000000..389e7fe --- /dev/null +++ b/src/main/java/calculator/domain/Numbers.java @@ -0,0 +1,15 @@ +package calculator.domain; + +import java.util.ArrayList; +import java.util.List; + +public class Numbers { + + List numbers = new ArrayList<>(); + + public void ReturnNumbers(String list) { + + } + + +} diff --git a/src/main/java/calculator/service/CalculatorService.java b/src/main/java/calculator/service/CalculatorService.java new file mode 100644 index 0000000..465223f --- /dev/null +++ b/src/main/java/calculator/service/CalculatorService.java @@ -0,0 +1,29 @@ +package calculator.service; + +import calculator.domain.Delimiter; +import calculator.domain.Number; + +import java.util.List; + +public class CalculatorService { + + public int calculateInput(String input) { + Delimiter delimiter = new Delimiter(input); + + if (delimiter.hasCustomDelimiter()) { + List numberList = delimiter.parseAsCustomDelimiter(input); + return addNum(numberList); + } + + List numberList = delimiter.parseAsDefaultDelimiter(input); + return addNum(numberList); + } + + public int addNum(List numberList) { + int result = 0; + for (Number number : numberList) { + result = number.addTo(result); + } + return result; + } +} diff --git a/src/main/java/calculator/view/InputView.java b/src/main/java/calculator/view/InputView.java new file mode 100644 index 0000000..897b9f6 --- /dev/null +++ b/src/main/java/calculator/view/InputView.java @@ -0,0 +1,11 @@ +package calculator.view; + +import static camp.nextstep.edu.missionutils.Console.readLine; + +public class InputView { + + public static String receiveInput() { + System.out.println("덧셈할 문자열을 입력해 주세요."); + return readLine(); + } +} diff --git a/src/main/java/calculator/view/OutputView.java b/src/main/java/calculator/view/OutputView.java new file mode 100644 index 0000000..e7d5356 --- /dev/null +++ b/src/main/java/calculator/view/OutputView.java @@ -0,0 +1,9 @@ +package calculator.view; + +public class OutputView { + + public static void showResult(int result) { + + System.out.println("결과 : " + result); + } +} diff --git a/src/test/java/calculator/domain/ExpressionTest.java b/src/test/java/calculator/domain/ExpressionTest.java new file mode 100644 index 0000000..11fb84c --- /dev/null +++ b/src/test/java/calculator/domain/ExpressionTest.java @@ -0,0 +1,22 @@ +package calculator.domain; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.*; + +class ExpressionTest { + + @Test + @DisplayName("matcher.group(1)이 뭐가 나오는지 테스트") + void 뭐가_나오는지_보자() { + // Given + String input = "//;\\n1;2;3"; + + // When + Expression expression = new Expression(input); + String customDelimiter = expression.getCustomDelimiter(); + System.out.println(customDelimiter); + } + +} \ No newline at end of file