[크리스마스 프로모션] 코드 리뷰

docs/README.md

@@ -0,0 +1,120 @@
+# 미션 - 크리스마스 프로모션
+<hr/>
+
+## 🔍 개요 및 목표
+- 크리스마스 프로모션은 중복 가능한 할인과 증정, 배지 부여를 통한 예비 혜택의 기대 심리가 결합된 
+프로모션으로 중복된 할인과 증정을 허용해 고객 입장에서 혜택을 체감할 수 있어야 하며 주최측에서는 
+지난 5년 중 최고 판매 금액 달성과 참여 고객중 5%이상의 인원이 다음 프로모션에 재참여 할 수 
+있도록 유도하는 것을 목표로 한다.
+<hr/>
+
+## 📝 기능 목록
+
+### 이벤트
+#### 핵심 기능 1. 크리스마스 디데이 할인
+- [x] 적용 기간: 2023.12.1 ~ 2023.12.25 (매일)
+- [x] 1000원 + ((날짜 - 1) * 100원) 중복 할인을 적용한다.
+#### 핵심 기능 2. 평일 할인
+- [x] 적용 기간: 2023.12.1 ~ 2023.12.31 (일요일~목요일)
+- [x] (디저트 메뉴 총 주문 수량 * 2023)원 중복 할인을 적용한다.
+#### 핵심 기능 3. 주말할인
+- [x] 적용 기간: 2023.12.1 ~ 2023.12.31 (금요일~토요일)
+- [x] (메인 메뉴 총 주문 수량 * 2023)원 중복 할인원 중복 할인을 적용한다.
+#### 핵심 기능 4. 특별 할인
+- [x] 적용 기간: 2023.12.1 ~ 2023.12.31 (일요일, 크리스마스 당일)
+- [x] 총 주문 금액 1000원 중복 할인을 적용한다.
+#### 핵심 기능 5. 증정 이벤트
+- [x] 적용 기간: 2023.12.1 ~ 2023.12.31
+- [x] 할인 전 총 주문 금액이 12만 원 이상일 때, 샴페인 1개 증정한다.
+#### 핵심 기능 6. 배지 부여
+- [x] 적용 기간: 2023.12.1 ~ 2023.12.31
+- [x] 총 혜택 금액 5천 원 이상 : 별
+- [x] 총 혜택 금액 1만 원 이상 : 트리
+- [x] 총 혜택 금액 2만 원 이상 : 산타
+#### 핵심 기능 7. 이벤트 적용
+- [x] 총 주문 금액 10,000원 이상이면 핵심 기능 1, 2, 3, 4, 5, 6을 적용한다.
+
+### 입력
+#### 입력 기능 1. 예상 방문 날짜 입력
+- [x] 유효한 예상 방문 날짜를 입력한다.
+- [x] 예외 처리 
+  - 양의 정수를 입력하지 않은 경우 
+  - 1~31 범위에 해당하지 않는 경우
+  - 에러 메세지는 "[ERROR] 유효하지 않은 날짜입니다. 다시 입력해 주세요.” 로 통일한다.
+#### 입력 기능 2. 메뉴와 수량 입력
+- [x] 유효한 메뉴와 수량을 입력한다.
+- [x] 예외 처리
+  - 공백인 경우
+  - 메뉴 형식에서 하이픈이 없는 경우
+  - 존재하지 않는 메뉴 이름을 입력한 경우
+  - 메뉴 형식의 수량이 양의 정수가 아닌 경우
+  - 메뉴의 수량이 1보다 적은 경우
+  - 입력한 주문의 총 수량이 20개를 초과한 경우
+  - 중복되는 메뉴 이름을 입력한 경우
+  - 음료 메뉴만 입력한 경우
+  - 에러 메세지는 “[ERROR] 유효하지 않은 주문입니다. 다시 입력해 주세요." 로 통일한다.
+
+### 출력
+#### 출력 기능 1. 혜택 미리 보기
+- [x] 혜택 미리보기 안내 메세지 출력
+- [x] <주문 메뉴> 출력
+  - 출력 순서는 메뉴의 에피타이저, 메인, 디저트, 음료 순서로 정렬하여 출력한다.
+- [x] <할인 전 총주문 금액> 출력
+- [x] <증정 메뉴> 출력
+  - 증정 이벤트에 해당하지 않는 경우, 증정 메뉴 "없음"으로 출력한다.
+- [x] <혜택 내역> 출력
+  - 고객에게 적용된 이벤트 내역만 출력한다.
+  - 적용된 이벤트가 하나도 없다면 혜택 내역 "없음"으로 출력한다.
+  - 혜택 내역에 여러 개의 이벤트가 적용된 경우, 출력 순서는 핵심 기능 상위 순서부터 출력한다.
+- [x] <총헤택 금액> 출력
+  - 총혜택 금액 = 할인 금액의 합계 + 증정 메뉴의 가격
+- [x] <할인 후 예상 결제 금액> 출력
+  - 할인 후 예상 결제 금액 = 할인 전 총주문 금액 - 할인 금액
+- [x] <12월 이벤트 배지> 출력
+  - 총혜택 금액에 따라 이벤트 배지의 이름을 다르게 출력한다.
+  - 이벤트 배지가 부여되지 않는 경우, "없음"으로 출력한다.
+<hr/>
+
+## 🕒 시스템 흐름
+1. 고객이 식당에 방문할 날짜를 미리 선택해 입력한다.
+   1) 예외 처리 후 유효한 입력을 customer의 visitDate에 저장한다. 
+2. 고객이 식당에 주문할 메뉴를 미리 선택해 입력한다.
+   1) 예외 처리 후 유효한 입력을 customer의 orderMenu에 저장한다.
+3. 이벤트 적용을 요청한다.
+   1) 고객의 주문 금액이 10,000원 이상이면 요청에 대한 이벤트 적용 처리를 수행한다. 
+   2) 고객의 주문 금액이 10,000원 미만이면 요청에 대한 이벤트 적용 처리는 수행되지 않는다.
+4. 이벤트 플래너가 해당하는 미리보기 내용을 출력한다.
+   1) 주문 메뉴 
+   2) 할인 전 총주문 금액 
+   3) 증정 메뉴 
+   4) 혜택 내역 
+   5) 총혜택 금액 
+   6) 할인 후 예상 결제 금액 
+   7) 12월 이벤트 배지 
+<hr/>
+
+## 🚨 구현 과정 주의 사항
+- [x] 입력과 출력은 InputView, OutputView 클래스로 별도 구현한다.
+- [x] 적용된 이벤트가 하나도 없는 경우를 고려한다.
+- [x] 모든 에러 메시지는 "[ERROR]"로 시작한다.
+- [x] 사용자가 잘못된 값을 입력할 경우 IllegalArgumentException를 발생시키고, 
+"[ERROR]"로 시작하는 에러 메시지를 출력 후 그 부분부터 입력을 다시 받는다.
+- [x] indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다.
+- [x] 함수(또는 메서드)의 길이가 15라인을 넘어가지 않도록 구현한다.
+- [x] JUnit 5와 AssertJ를 이용해 정리한 기능 목록이 정상 동작함을 테스트 코드로 확인한다.
+- [x] else 사용을 지양한다.
+- [x] 도메인 로직에 단위 테스트를 구현해야 한다.
+<hr/>
+
+## 🏁 목표
+- [x] 테스트 주도 개발(TDD)로 구현한다.
+- [x] 테스트 코드에서 반복적으로 하는 부분을 중복되지 않게 한다.
+- [x] Enum Class 를 적극 활용한다.
+- [x] README를 구체적으로 작성하고 살아있는 문서 작성을 위해 노력한다.
+- [x] 필드의 수를 최소화한다.
+- [x] 객체는 객체스럽게 사용한다.
+- [x] 객체의 필드는 private으로 접근을 제한하고 val을 사용해 값의 변경을 제한한다.
+- [x] Controller가 아닌 InputView에서 입력을 처리한다.
+- [x] 예외 처리 과정에서 "^\\d+$" 를 통해 유효한 숫자를 검사한다.
+- [x] getter사용을 지양하기 위해 노력하며 객체에게 메세지를 던진다.
+<hr/>

src/main/kotlin/christmas/Application.kt

@@ -1,5 +1,7 @@
 package christmas
 
+import christmas.controller.ChristmasController
+
 fun main() {
-    TODO("프로그램 구현")
+    ChristmasController().run()
 }

src/main/kotlin/christmas/controller/ChristmasController.kt

@@ -0,0 +1,58 @@
+package christmas.controller
+
+import christmas.model.Customer
+import christmas.model.EventHelper
+import christmas.model.OrderItems
+import christmas.model.StoreMenu.Companion.sortOrderMenu
+import christmas.model.StoreMenu.Companion.splitOrderMenu
+import christmas.model.StoreMenu.Companion.splitOrderMenuForValidate
+import christmas.utils.Validate.validateOrderMenu
+import christmas.utils.Validate.validateVisitDate
+import christmas.view.InputView
+import christmas.view.OutputView
+
+class ChristmasController {
+    private val input = InputView()
+    private val output = OutputView()
+
+    fun run() {
+        output.printStartPlanner()
+        val customer = Customer(inputVisitDate(), inputOrderMenu())
+
+        customer.requestApplyDecemberEvent()
+        previewBenefit(customer, customer.getEventHelper())
+    }
+
+    private fun inputVisitDate(): Int {
+        return try {
+            val visitDateInput = input.readVisitDate()
+            validateVisitDate(visitDateInput)
+            visitDateInput.toInt()
+        } catch (e: IllegalArgumentException) {
+            println(e.message)
+            inputVisitDate()
+        }
+    }
+
+    private fun inputOrderMenu(): List<OrderItems> {
+        return try {
+            val orderMenuInput = input.readOrderMenu()
+            validateOrderMenu(splitOrderMenuForValidate(orderMenuInput))
+            splitOrderMenu(orderMenuInput)
+        } catch (e: IllegalArgumentException) {
+            println(e.message)
+            inputOrderMenu()
+        }
+    }
+
+    private fun previewBenefit(customer: Customer, eventHelper: EventHelper) {
+        output.printPreviewAnnounce(customer.getVisitDate())
+        output.printOrderMenu(sortOrderMenu(customer.getOrderMenu()))
+        output.printTotalOrderPrize(customer.calculateTotalOrderSum())
+        output.printFreebieMenu(eventHelper.getFreebie())
+        output.printBenefitDetails(eventHelper.getDiscountHistory(), eventHelper.getFreebie())
+        output.printBenefitAmount(eventHelper.calculateTotalBenefitAmount())
+        output.printPaymentAmount(customer.calculateTotalOrderSum(), eventHelper.getDiscountHistory())
+        output.printBadge(eventHelper.getBadge())
+    }
+}

src/main/kotlin/christmas/model/Customer.kt

@@ -0,0 +1,33 @@
+package christmas.model
+
+import christmas.utils.Constant.DISCOUNT_THRESHOLD
+import christmas.utils.Constant.EMPTY
+
+class Customer(
+    private val visitDate: Int,
+    private val orderMenu: List<OrderItems>
+) {
+    private val eventHelper = EventHelper()
+
+    fun getVisitDate(): Int = visitDate
+
+    fun getOrderMenu(): List<OrderItems> = orderMenu
+
+    fun getEventHelper(): EventHelper = eventHelper
+
+    fun calculateTotalOrderSum(): Int {
+        var totalOrderSum = EMPTY
+
+        for (item in orderMenu) {
+            val storeMenu = enumValues<StoreMenu>().first { menu -> menu.menuName == item.getMenuName() }
+            totalOrderSum += storeMenu.menuPrice * item.getQuantity()
+        }
+
+        return totalOrderSum
+    }
+
+    fun requestApplyDecemberEvent() {
+        if (calculateTotalOrderSum() >= DISCOUNT_THRESHOLD)
+            eventHelper.applyDecemberEvent(visitDate, orderMenu, calculateTotalOrderSum())
+    }
+}

src/main/kotlin/christmas/model/DecemberCalender.kt

@@ -0,0 +1,7 @@
+package christmas.model
+
+enum class DecemberCalender(val dates: List<Int>) {
+    WEEKDAY(listOf(3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 17, 18, 19, 20, 21, 24, 25, 26, 27, 28, 31)),
+    WEEKEND(listOf(1, 2, 8, 9, 15, 16, 22, 23, 29, 30)),
+    SPECIAL_DAY(listOf(3, 10, 17, 24, 25, 31))
+}

src/main/kotlin/christmas/model/DecemberEvent.kt

@@ -0,0 +1,79 @@
+package christmas.model
+
+import christmas.utils.Constant.BADGE_SANTA
+import christmas.utils.Constant.BADGE_STAR
+import christmas.utils.Constant.BADGE_TREE
+import christmas.utils.Constant.CHAMPAGNE_CONDITION_AMOUNT
+import christmas.utils.Constant.CHRISTMAS_DAY_DISCOUNT_AMOUNT
+import christmas.utils.Constant.DAILY_DISCOUNT_AMOUNT
+import christmas.utils.Constant.FIRST_DAY_DISCOUNT_AMOUNT
+import christmas.utils.Constant.EMPTY
+import christmas.utils.Constant.NONE
+import christmas.utils.Constant.ONE_DAY_DECREASE
+import christmas.utils.Constant.SANTA_MIN
+import christmas.utils.Constant.STAR_MAX
+import christmas.utils.Constant.STAR_MIN
+import christmas.utils.Constant.TREE_MAX
+import christmas.utils.Constant.TREE_MIN
+import christmas.utils.Constant.WEEK_DISCOUNT_AMOUNT
+
+class DecemberEvent {
+    fun applyTheDayDiscount(date: Int): Int {
+        val dailyDiscount = (date - ONE_DAY_DECREASE) * DAILY_DISCOUNT_AMOUNT
+
+        return FIRST_DAY_DISCOUNT_AMOUNT + dailyDiscount
+    }
+
+    fun applyWeekdayDiscount(orderMenu: List<OrderItems>): Int {
+        var dessertMenuCount = EMPTY
+
+        for (item in orderMenu) {
+            val increaseCount = increaseDessertMenuCount(item.getMenuName(), item.getQuantity())
+            dessertMenuCount += increaseCount
+        }
+
+        return dessertMenuCount * WEEK_DISCOUNT_AMOUNT
+    }
+
+    private fun increaseDessertMenuCount(menuName: String, quantity: Int): Int {
+        if (menuName == StoreMenu.CHOCO_CAKE.menuName || menuName == StoreMenu.ICE_CREAM.menuName)
+            return quantity
+
+        return EMPTY
+    }
+
+
+    fun applyWeekendDiscount(orderMenu: List<OrderItems>): Int {
+        var mainMenuCount = EMPTY
+
+        for (item in orderMenu) {
+            val increaseCount = increaseMainMenuCount(item.getMenuName(), item.getQuantity())
+            mainMenuCount += increaseCount
+        }
+
+        return mainMenuCount * WEEK_DISCOUNT_AMOUNT
+    }
+
+    private fun increaseMainMenuCount(menuName: String, quantity: Int): Int {
+        if (menuName == StoreMenu.T_BONE_STEAK.menuName || menuName == StoreMenu.BBQ_RIBS.menuName ||
+            menuName == StoreMenu.SEAFOOD_PASTA.menuName || menuName == StoreMenu.CHRISTMAS_PASTA.menuName
+        )
+            return quantity
+
+        return EMPTY
+    }
+
+    fun applySpecialDiscount(): Int = CHRISTMAS_DAY_DISCOUNT_AMOUNT
+
+    fun presentChampagne(totalOrderAmount: Int): Boolean = totalOrderAmount >= CHAMPAGNE_CONDITION_AMOUNT
+
+    fun assignBadge(benefitAmount: Int): String {
+        when {
+            benefitAmount in STAR_MIN..STAR_MAX -> return BADGE_STAR
+            benefitAmount in TREE_MIN..TREE_MAX -> return BADGE_TREE
+            benefitAmount >= SANTA_MIN -> return BADGE_SANTA
+        }
+
+        return NONE
+    }
+}

src/main/kotlin/christmas/model/DiscountType.kt

@@ -0,0 +1,43 @@
+package christmas.model
+
+import christmas.utils.Constant.CHRISTMAS_DAY
+import christmas.utils.Constant.EMPTY
+
+enum class DiscountType(val eventName: String) {
+    THE_DAY_DISCOUNT("크리스마스 디데이 할인"),
+    WEEKDAY_DISCOUNT("평일 할인"),
+    WEEKEND_DISCOUNT("주말 할인"),
+    SPECIAL_DISCOUNT("특별 할인");
+
+    companion object {
+        private val decemberEvent = DecemberEvent()
+
+        fun requestTheDayDiscount(visitDate: Int): Int {
+            if (visitDate <= CHRISTMAS_DAY)
+                return decemberEvent.applyTheDayDiscount(visitDate)
+
+            return EMPTY
+        }
+
+        fun requestWeekdayDiscount(visitDate: Int, orderMenu: List<OrderItems>): Int {
+            if (visitDate in DecemberCalender.WEEKDAY.dates)
+                return decemberEvent.applyWeekdayDiscount(orderMenu)
+
+            return EMPTY
+        }
+
+        fun requestWeekendDiscount(visitDate: Int, orderMenu: List<OrderItems>): Int {
+            if (visitDate in DecemberCalender.WEEKEND.dates)
+                return decemberEvent.applyWeekendDiscount(orderMenu)
+
+            return EMPTY
+        }
+
+        fun requestSpecialDiscount(visitDate: Int): Int {
+            if (visitDate in DecemberCalender.SPECIAL_DAY.dates)
+                return decemberEvent.applySpecialDiscount()
+
+            return EMPTY
+        }
+    }
+}