Merge pull request #157 from YAPP-Github/feat/PRODUCT-237

[Feat] 응원 태그 도메인 추가

Author: leegwichan

src/main/java/eatda/domain/cheer/CheerTag.java

@@ -0,0 +1,44 @@
+package eatda.domain.cheer;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.EnumType;
+import jakarta.persistence.Enumerated;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.Table;
+import jakarta.persistence.UniqueConstraint;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Table(
+        name = "cheer_tag",
+        uniqueConstraints = @UniqueConstraint(name = "uk_cheer_tag_cheer_id_name", columnNames = {"cheer_id", "name"})
+)
+@Entity
+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class CheerTag {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(name = "cheer_id", nullable = false)
+    private Cheer cheer;
+
+    @Enumerated(EnumType.STRING)
+    @Column(nullable = false, length = 63)
+    private CheerTagName name;
+
+    public CheerTag(Cheer cheer, CheerTagName name) {
+        this.cheer = cheer;
+        this.name = name;
+    }
+}

src/main/java/eatda/domain/cheer/CheerTagName.java

@@ -0,0 +1,37 @@
+package eatda.domain.cheer;
+
+import lombok.Getter;
+
+@Getter
+public enum CheerTagName {
+
+    OLD_STORE_MOOD(CheerTagCategory.MOOD, "노포 감성"),
+    ENERGETIC(CheerTagCategory.MOOD, "활기찬"),
+    GOOD_FOR_DATING(CheerTagCategory.MOOD, "데이트하기좋은"),
+    QUIET(CheerTagCategory.MOOD, "조용한"),
+    GOOD_FOR_DRINKING(CheerTagCategory.MOOD, "술 땡기는"),
+    INSTAGRAMMABLE(CheerTagCategory.MOOD, "인스타 감성"),
+    GOOD_FOR_FAMILY(CheerTagCategory.MOOD, "부모님과 가기 좋은"),
+    YOUTUBE_FAMOUS(CheerTagCategory.MOOD, "유튜버 맛집"),
+
+    GROUP_RESERVATION(CheerTagCategory.PRACTICAL, "단체 예약"),
+    LARGE_PARKING(CheerTagCategory.PRACTICAL, "넓은 주차장"),
+    CLEAN_RESTROOM(CheerTagCategory.PRACTICAL, "깔끔한 화장실"),
+    PET_FRIENDLY(CheerTagCategory.PRACTICAL, "반려동물 동반 가능"),
+    LATE_NIGHT(CheerTagCategory.PRACTICAL, "늦게까지 영업"),
+    NEAR_SUBWAY(CheerTagCategory.PRACTICAL, "지하철과 가까운"),
+    MANY_NEARBY_ATTRACTIONS(CheerTagCategory.PRACTICAL, "주변에 놀거리가 많은"),
+    ;
+
+    private final CheerTagCategory type;
+    private final String displayName;
+
+    CheerTagName(CheerTagCategory type, String displayName) {
+        this.type = type;
+        this.displayName = displayName;
+    }
+
+    public enum CheerTagCategory {
+        MOOD, PRACTICAL
+    }
+}

src/main/java/eatda/domain/cheer/CheerTagNames.java

@@ -0,0 +1,49 @@
+package eatda.domain.cheer;
+
+import eatda.exception.BusinessErrorCode;
+import eatda.exception.BusinessException;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class CheerTagNames {
+
+    private static final int MAX_CHEER_TAGS_PER_TYPE = 2;
+
+    private final List<CheerTagName> cheerTagNames;
+
+    public CheerTagNames(List<CheerTagName> cheerTagNames) {
+        validate(cheerTagNames);
+        this.cheerTagNames = List.copyOf(cheerTagNames);
+    }
+
+    private void validate(List<CheerTagName> cheerTagNames) {
+        if (isDuplicated(cheerTagNames)) {
+            throw new BusinessException(BusinessErrorCode.CHEER_TAGS_DUPLICATED);
+        }
+        if (maxCountByType(cheerTagNames) > MAX_CHEER_TAGS_PER_TYPE) {
+            throw new BusinessException(BusinessErrorCode.EXCEED_CHEER_TAGS_PER_TYPE);
+        }
+    }
+
+    private boolean isDuplicated(List<CheerTagName> cheerTagNames) {
+        long distinctCount = cheerTagNames.stream()
+                .distinct()
+                .count();
+        return distinctCount != cheerTagNames.size();
+    }
+
+    private long maxCountByType(List<CheerTagName> cheerTagNames) {
+        return cheerTagNames.stream()
+                .collect(Collectors.groupingBy(CheerTagName::getType, Collectors.counting()))
+                .values()
+                .stream()
+                .max(Long::compareTo)
+                .orElse(0L);
+    }
+
+    public List<CheerTag> toCheerTags(Cheer cheer) {
+        return cheerTagNames.stream()
+                .map(name -> new CheerTag(cheer, name))
+                .toList();
+    }
+}

src/main/java/eatda/exception/BusinessErrorCode.java

@@ -29,6 +29,10 @@ public enum BusinessErrorCode {
     FULL_CHEER_SIZE_PER_MEMBER("CHE003", "회원당 응원 한도가 넘었습니다."),
     ALREADY_CHEERED("CHE004", "이미 응원한 가게입니다."),
 
+    // CheerTag
+    CHEER_TAGS_DUPLICATED("CHE_TAG001", "응원 태그는 중복될 수 없습니다."),
+    EXCEED_CHEER_TAGS_PER_TYPE("CHE_TAG002", "각 응원 태그 타입당 최대 태그 개수를 초과했습니다."),
+
     // Map
     MAP_SERVER_ERROR("MAP001", "지도 서버와의 통신 오류입니다.", HttpStatus.INTERNAL_SERVER_ERROR),
 
@@ -53,7 +57,8 @@ public enum BusinessErrorCode {
     INVALID_STORE_ID("STY006", "유효하지 않은 가게 ID입니다."),
     INVALID_STORE_KAKAO_ID("STY007", "스토어 Kakao ID는 필수입니다."),
     INVALID_STORE_NAME("STY008", "스토어 이름은 필수입니다."),
-    INVALID_STORE_ADDRESS("STY009", "스토어 주소는 필수입니다.");
+    INVALID_STORE_ADDRESS("STY009", "스토어 주소는 필수입니다."),
+    ;
 
     private final String code;
     private final String message;

src/main/resources/db/migration/V5__add_cheer_tag_table.sql

@@ -0,0 +1,9 @@
+CREATE TABLE `cheer_tag`
+(
+    `id`       BIGINT      NOT NULL AUTO_INCREMENT,
+    `cheer_id` BIGINT      NOT NULL,
+    `name`     VARCHAR(63) NOT NULL,
+    PRIMARY KEY (`id`),
+    FOREIGN KEY (`cheer_id`) REFERENCES `cheer` (`id`) ON DELETE CASCADE,
+    UNIQUE KEY `uk_cheer_tag_cheer_id_name` (`cheer_id`, `name`)
+);

src/main/resources/db/seed/dev/V6__dev_add_tag_data.sql

@@ -0,0 +1,12 @@
+INSERT INTO cheer_tag (cheer_id, name)
+VALUES (1, 'GOOD_FOR_FAMILY'),
+       (2, 'GOOD_FOR_DATING'),
+       (2, 'INSTAGRAMMABLE'),
+       (4, 'QUIET'),
+       (5, 'INSTAGRAMMABLE'),
+       (5, 'NEAR_SUBWAY'),
+       (6, 'GOOD_FOR_DATING'),
+       (6, 'INSTAGRAMMABLE'),
+       (6, 'CLEAN_RESTROOM'),
+       (6, 'MANY_NEARBY_ATTRACTIONS'),
+       (7, 'LATE_NIGHT');

src/main/resources/db/seed/local/V6__local_add_tag_data.sql

@@ -0,0 +1,12 @@
+INSERT INTO cheer_tag (cheer_id, name)
+VALUES (1, 'GOOD_FOR_FAMILY'),
+       (2, 'GOOD_FOR_DATING'),
+       (2, 'INSTAGRAMMABLE'),
+       (4, 'QUIET'),
+       (5, 'INSTAGRAMMABLE'),
+       (5, 'NEAR_SUBWAY'),
+       (6, 'GOOD_FOR_DATING'),
+       (6, 'INSTAGRAMMABLE'),
+       (6, 'CLEAN_RESTROOM'),
+       (6, 'MANY_NEARBY_ATTRACTIONS'),
+       (7, 'LATE_NIGHT');

src/main/resources/db/seed/prod/V6__prod_add_tag_data.sql

@@ -0,0 +1 @@
+-- Prod 환경 생략

src/test/java/eatda/domain/cheer/CheerTagNamesTest.java

@@ -0,0 +1,54 @@
+package eatda.domain.cheer;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatCode;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import eatda.exception.BusinessErrorCode;
+import eatda.exception.BusinessException;
+import java.util.Collections;
+import java.util.List;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+class CheerTagNamesTest {
+
+    @Nested
+    class Validate {
+
+        @Test
+        void 각_카테고리별_태그는_최대_개수가_정해져있다() {
+            List<CheerTagName> tagNames = List.of(
+                    CheerTagName.OLD_STORE_MOOD, CheerTagName.ENERGETIC,
+                    CheerTagName.GROUP_RESERVATION, CheerTagName.LARGE_PARKING);
+
+            assertThatCode(() -> new CheerTagNames(tagNames)).doesNotThrowAnyException();
+        }
+
+        @Test
+        void 태그_이름은_비어있을_수_있다() {
+            List<CheerTagName> tagNames = Collections.emptyList();
+
+            assertThatCode(() -> new CheerTagNames(tagNames)).doesNotThrowAnyException();
+        }
+
+        @Test
+        void 카테고리별_태그는_최대_개수를_초과할_수_없다() {
+            List<CheerTagName> tagNames = List.of(
+                    CheerTagName.OLD_STORE_MOOD, CheerTagName.ENERGETIC, CheerTagName.GOOD_FOR_DATING);
+
+            BusinessException exception = assertThrows(BusinessException.class, () -> new CheerTagNames(tagNames));
+
+            assertThat(exception.getErrorCode()).isEqualTo(BusinessErrorCode.EXCEED_CHEER_TAGS_PER_TYPE);
+        }
+
+        @Test
+        void 태그_이름은_중복될_수_없다() {
+            List<CheerTagName> tagNames = List.of(CheerTagName.OLD_STORE_MOOD, CheerTagName.OLD_STORE_MOOD);
+
+            BusinessException exception = assertThrows(BusinessException.class, () -> new CheerTagNames(tagNames));
+
+            assertThat(exception.getErrorCode()).isEqualTo(BusinessErrorCode.CHEER_TAGS_DUPLICATED);
+        }
+    }
+}