1단계 - 리팩터링(상품) (#201)

* feat(step1) Product 구현

- legacy 코드와 분리하기 위해 기존 파일을 모두 legacy/ 에 배치함
- Product 도메인 생성
- 0원 이상이라는 규칙을 갖는 ProductPrice 생성
- notEmpty 규칙을 갖는 Name을 통해 비속어가 없는 규칙까지 포함한 ProductName을 생성하는 ProductNameFactory추가
- 상품 가격이 변경될 때 메뉴의 노출 여부를 조정하기 위해 event를 발행하고, menu는 rearranger를 통해 메뉴의 노출여부를 재조정함

* feat(findAll) 누락된 상품의 findAll 추가

* fix(gitignore) gitignore 수정 & 누락된 commit push

* fix(revice) 리뷰반영

- 클래스 내 선언순서 조정
- 파라미터 이름 변경

* refactor(srp) SRP를 지킬 수 있도록 UseCase 분리

- ProductUseCase에 있는 책임을 분리함

* refactor(test) 도메인에 대한 테스트코드 작성

- 도메인 테스트코드 작성
- 파라미터 유효성 검사를 위한 Utils 생성

* feat(test) 테스트코드 추가

- 누락된 테스트코드 추가
- ContainsProfanityException 추가

* feat(test) usecase에 대한 테스트코드 작성

- usecase 테스트코드 작성
- 테스트 도우미 fixtures, accessor 추가

* refator(create) 엔티티 생성 메서드명 변경

- of -> create로 변경

* refactor(name) Name을 global 레벨로 분리

* refactor(naming) 변수명 변경

- eventPublisher.publish -> productPriceChangeEvent.publish 변경

---------

Co-authored-by: seungjoo.jeong <[email protected]>

Author: seungjoopet

.gitignore

@@ -22,7 +22,7 @@ build/
 *.iws
 *.iml
 *.ipr
-out/
+#out/
 
 ### NetBeans ###
 /nbproject/private/

README.md

@@ -13,20 +13,20 @@ docker compose -p kitchenpos up -d
 
 - 상품을 등록할 수 있다.
 - 상품의 가격이 올바르지 않으면 등록할 수 없다.
-  - 상품의 가격은 0원 이상이어야 한다.
+    - 상품의 가격은 0원 이상이어야 한다.
 - 상품의 이름이 올바르지 않으면 등록할 수 없다.
-  - 상품의 이름에는 비속어가 포함될 수 없다.
+    - 상품의 이름에는 비속어가 포함될 수 없다.
 - 상품의 가격을 변경할 수 있다.
 - 상품의 가격이 올바르지 않으면 변경할 수 없다.
-  - 상품의 가격은 0원 이상이어야 한다.
+    - 상품의 가격은 0원 이상이어야 한다.
 - 상품의 가격이 변경될 때 메뉴의 가격이 메뉴에 속한 상품 금액의 합보다 크면 메뉴가 숨겨진다.
 - 상품의 목록을 조회할 수 있다.
 
 ### 메뉴 그룹
 
 - 메뉴 그룹을 등록할 수 있다.
 - 메뉴 그룹의 이름이 올바르지 않으면 등록할 수 없다.
-  - 메뉴 그룹의 이름은 비워 둘 수 없다.
+    - 메뉴 그룹의 이름은 비워 둘 수 없다.
 - 메뉴 그룹의 목록을 조회할 수 있다.
 
 ### 메뉴
@@ -35,14 +35,14 @@ docker compose -p kitchenpos up -d
 - 상품이 없으면 등록할 수 없다.
 - 메뉴에 속한 상품의 수량은 0 이상이어야 한다.
 - 메뉴의 가격이 올바르지 않으면 등록할 수 없다.
-  - 메뉴의 가격은 0원 이상이어야 한다.
+    - 메뉴의 가격은 0원 이상이어야 한다.
 - 메뉴에 속한 상품 금액의 합은 메뉴의 가격보다 크거나 같아야 한다.
 - 메뉴는 특정 메뉴 그룹에 속해야 한다.
 - 메뉴의 이름이 올바르지 않으면 등록할 수 없다.
-  - 메뉴의 이름에는 비속어가 포함될 수 없다.
+    - 메뉴의 이름에는 비속어가 포함될 수 없다.
 - 메뉴의 가격을 변경할 수 있다.
 - 메뉴의 가격이 올바르지 않으면 변경할 수 없다.
-  - 메뉴의 가격은 0원 이상이어야 한다.
+    - 메뉴의 가격은 0원 이상이어야 한다.
 - 메뉴에 속한 상품 금액의 합은 메뉴의 가격보다 크거나 같아야 한다.
 - 메뉴를 노출할 수 있다.
 - 메뉴의 가격이 메뉴에 속한 상품 금액의 합보다 높을 경우 메뉴를 노출할 수 없다.
@@ -53,13 +53,13 @@ docker compose -p kitchenpos up -d
 
 - 주문 테이블을 등록할 수 있다.
 - 주문 테이블의 이름이 올바르지 않으면 등록할 수 없다.
-  - 주문 테이블의 이름은 비워 둘 수 없다.
+    - 주문 테이블의 이름은 비워 둘 수 없다.
 - 빈 테이블을 해지할 수 있다.
 - 빈 테이블로 설정할 수 있다.
 - 완료되지 않은 주문이 있는 주문 테이블은 빈 테이블로 설정할 수 없다.
 - 방문한 손님 수를 변경할 수 있다.
 - 방문한 손님 수가 올바르지 않으면 변경할 수 없다.
-  - 방문한 손님 수는 0 이상이어야 한다.
+    - 방문한 손님 수는 0 이상이어야 한다.
 - 빈 테이블은 방문한 손님 수를 변경할 수 없다.
 - 주문 테이블의 목록을 조회할 수 있다.
 
@@ -73,7 +73,7 @@ docker compose -p kitchenpos up -d
 - 매장 주문은 주문 항목의 수량이 0 미만일 수 있다.
 - 매장 주문을 제외한 주문의 경우 주문 항목의 수량은 0 이상이어야 한다.
 - 배달 주소가 올바르지 않으면 배달 주문을 등록할 수 없다.
-  - 배달 주소는 비워 둘 수 없다.
+    - 배달 주소는 비워 둘 수 없다.
 - 빈 테이블에는 매장 주문을 등록할 수 없다.
 - 숨겨진 메뉴는 주문할 수 없다.
 - 주문한 메뉴의 가격은 실제 메뉴 가격과 일치해야 한다.
@@ -96,65 +96,71 @@ docker compose -p kitchenpos up -d
 
 ## 용어 사전
 
+### 이름
+
+| 한글명 | 영문명  | 설명                   |
+|-----|------|----------------------|
+| 이름  | name | 비어있지 않은 이름. 음식이름, 메뉴이름의 후보가 된다. |
+
 ### 상품
 
-| 한글명 | 영문명 | 설명 |
-| --- | --- | --- |
-| 상품 | product | 메뉴를 관리하는 기준이 되는 데이터 |
-| 이름 | displayed name | 음식을 상상하게 만드는 중요한 요소 |
+| 한글명 | 영문명            | 설명                  |
+|-----|----------------|---------------------|
+| 상품  | product        | 메뉴를 관리하는 기준이 되는 데이터 |
+| 이름  | displayed name | 음식을 상상하게 만드는 중요한 요소 |
 
 ### 메뉴
 
-| 한글명 | 영문명 | 설명 |
-| --- | --- | --- |
-| 금액 | amount | 가격 * 수량 |
-| 메뉴 | menu | 메뉴 그룹에 속하는 실제 주문 가능 단위 |
-| 메뉴 그룹 | menu group | 각각의 메뉴를 성격에 따라 분류하여 묶어둔 그룹 |
-| 메뉴 상품 | menu product | 메뉴에 속하는 수량이 있는 상품 |
-| 숨겨진 메뉴 | not displayed menu | 주문할 수 없는 숨겨진 메뉴 |
-| 이름 | displayed name | 음식을 상상하게 만드는 중요한 요소 |
+| 한글명    | 영문명                | 설명                         |
+|--------|--------------------|----------------------------|
+| 금액     | amount             | 가격 * 수량                    |
+| 메뉴     | menu               | 메뉴 그룹에 속하는 실제 주문 가능 단위     |
+| 메뉴 그룹  | menu group         | 각각의 메뉴를 성격에 따라 분류하여 묶어둔 그룹 |
+| 메뉴 상품  | menu product       | 메뉴에 속하는 수량이 있는 상품          |
+| 숨겨진 메뉴 | not displayed menu | 주문할 수 없는 숨겨진 메뉴            |
+| 이름     | displayed name     | 음식을 상상하게 만드는 중요한 요소        |
 
 ### 매장 주문
 
-| 한글명 | 영문명 | 설명 |
-| --- | --- | --- |
-| 방문한 손님 수 | number of guests | 식기가 필요한 사람 수. 필수 사항은 아니며 주문은 0명으로 등록할 수 있다. |
-| 빈 테이블 | empty table | 주문을 등록할 수 없는 주문 테이블 |
-| 서빙 | served | 조리가 완료되어 음식이 나갈 수 있는 단계 |
-| 완료 | completed | 고객이 모든 식사를 마치고 결제를 완료한 단계 |
-| 접수 | accepted | 주문을 받고 음식을 조리하는 단계 |
-| 접수 대기 | waiting | 주문이 생성되어 매장으로 전달된 단계 |
-| 주문 | order | 매장에서 식사하는 고객 대상. 손님들이 매장에서 먹을 수 있도록 조리된 음식을 가져다준다. |
-| 주문 상태 | order status | 주문이 생성되면 매장에서 주문을 접수하고 고객이 음식을 받기까지의 단계를 표시한다. |
-| 주문 테이블 | order table | 매장에서 주문이 발생하는 영역 |
-| 주문 항목 | order line item | 주문에 속하는 수량이 있는 메뉴 |
+| 한글명      | 영문명              | 설명                                                 |
+|----------|------------------|----------------------------------------------------|
+| 방문한 손님 수 | number of guests | 식기가 필요한 사람 수. 필수 사항은 아니며 주문은 0명으로 등록할 수 있다.        |
+| 빈 테이블    | empty table      | 주문을 등록할 수 없는 주문 테이블                                |
+| 서빙       | served           | 조리가 완료되어 음식이 나갈 수 있는 단계                            |
+| 완료       | completed        | 고객이 모든 식사를 마치고 결제를 완료한 단계                          |
+| 접수       | accepted         | 주문을 받고 음식을 조리하는 단계                                 |
+| 접수 대기    | waiting          | 주문이 생성되어 매장으로 전달된 단계                               |
+| 주문       | order            | 매장에서 식사하는 고객 대상. 손님들이 매장에서 먹을 수 있도록 조리된 음식을 가져다준다. |
+| 주문 상태    | order status     | 주문이 생성되면 매장에서 주문을 접수하고 고객이 음식을 받기까지의 단계를 표시한다.     |
+| 주문 테이블   | order table      | 매장에서 주문이 발생하는 영역                                   |
+| 주문 항목    | order line item  | 주문에 속하는 수량이 있는 메뉴                                  |
 
 ### 배달 주문
 
-| 한글명 | 영문명 | 설명 |
-| --- | --- | --- |
-| 배달 | delivering | 배달원이 매장을 방문하여 배달 음식의 픽업을 완료하고 배달을 시작하는 단계 |
-| 배달 대행사 | delivery agency | 준비한 음식을 고객에게 직접 배달하는 서비스 |
-| 배달 완료 | delivered | 배달원이 주문한 음식을 고객에게 배달 완료한 단계 |
-| 서빙 | served | 조리가 완료되어 음식이 나갈 수 있는 단계 |
-| 완료 | completed | 배달 및 결제 완료 단계 |
-| 접수 | accepted | 주문을 받고 음식을 조리하는 단계 |
-| 접수 대기 | waiting | 주문이 생성되어 매장으로 전달된 단계 |
-| 주문 | order | 집이나 직장 등 고객이 선택한 주소로 음식을 배달한다. |
-| 주문 상태 | order status | 주문이 생성되면 매장에서 주문을 접수하고 고객이 음식을 받기까지의 단계를 표시한다. |
-| 주문 항목 | order line item | 주문에 속하는 수량이 있는 메뉴 |
+| 한글명    | 영문명             | 설명                                             |
+|--------|-----------------|------------------------------------------------|
+| 배달     | delivering      | 배달원이 매장을 방문하여 배달 음식의 픽업을 완료하고 배달을 시작하는 단계      |
+| 배달 대행사 | delivery agency | 준비한 음식을 고객에게 직접 배달하는 서비스                       |
+| 배달 완료  | delivered       | 배달원이 주문한 음식을 고객에게 배달 완료한 단계                    |
+| 서빙     | served          | 조리가 완료되어 음식이 나갈 수 있는 단계                        |
+| 완료     | completed       | 배달 및 결제 완료 단계                                  |
+| 접수     | accepted        | 주문을 받고 음식을 조리하는 단계                             |
+| 접수 대기  | waiting         | 주문이 생성되어 매장으로 전달된 단계                           |
+| 주문     | order           | 집이나 직장 등 고객이 선택한 주소로 음식을 배달한다.                 |
+| 주문 상태  | order status    | 주문이 생성되면 매장에서 주문을 접수하고 고객이 음식을 받기까지의 단계를 표시한다. |
+| 주문 항목  | order line item | 주문에 속하는 수량이 있는 메뉴                              |
 
 ### 포장 주문
 
-| 한글명 | 영문명 | 설명 |
-| --- | --- | --- |
-| 서빙 | served | 조리가 완료되어 음식이 나갈 수 있는 단계 |
-| 완료 | completed | 고객이 음식을 수령하고 결제를 완료한 단계 |
-| 접수 | accepted | 주문을 받고 음식을 조리하는 단계 |
-| 접수 대기 | waiting | 주문이 생성되어 매장으로 전달된 단계 |
-| 주문 | order | 포장하는 고객 대상. 고객이 매장에서 직접 음식을 수령한다. |
-| 주문 상태 | order status | 주문이 생성되면 매장에서 주문을 접수하고 고객이 음식을 받기까지의 단계를 표시한다. |
-| 주문 항목 | order line item | 주문에 속하는 수량이 있는 메뉴 |
+| 한글명   | 영문명             | 설명                                             |
+|-------|-----------------|------------------------------------------------|
+| 서빙    | served          | 조리가 완료되어 음식이 나갈 수 있는 단계                        |
+| 완료    | completed       | 고객이 음식을 수령하고 결제를 완료한 단계                        |
+| 접수    | accepted        | 주문을 받고 음식을 조리하는 단계                             |
+| 접수 대기 | waiting         | 주문이 생성되어 매장으로 전달된 단계                           |
+| 주문    | order           | 포장하는 고객 대상. 고객이 매장에서 직접 음식을 수령한다.              |
+| 주문 상태 | order status    | 주문이 생성되면 매장에서 주문을 접수하고 고객이 음식을 받기까지의 단계를 표시한다. |
+| 주문 항목 | order line item | 주문에 속하는 수량이 있는 메뉴                              |
 
 ## 모델링
 

build.gradle

@@ -22,6 +22,10 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-validation'
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.flywaydb:flyway-mysql'
+    implementation 'com.google.guava:guava:32.0.1-jre'
+    implementation 'org.apache.commons:commons-lang3:3.13.0'
+    implementation 'org.apache.commons:commons-collections4:4.4'
+
     runtimeOnly 'mysql:mysql-connector-java'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly 'com.h2database:h2'