🚀 2단계 - 수강신청(도메인 모델) (#793)

* refactor : 기존 코드 메서드명 변경 삭제 가능 여부 -> 삭제

* refactor : updatedDelete() 메서드 삭제 후 부모 클래스에서 바로 사용

* refactor : questionBody 클래스 재구성 및 주입 클래스 수정

* docs : 기능 요구사항, 프로그래밍 요구사항 작성

* feat : CoverImage 클래스 생성 및 테스트 코드 작성

* refactor : 이미지 사이즈 관련 클래스 분리 및 테스트 코드 이동

* feat : Payment 클래스 테스트코드 작성

* feat : 강의 클래스 생성 및 테스트 코드 작성, 내부 필요한 값 포장하여 클래스로 분리, Enum으로 강의 타입, 상태 관리

* feat : 수강 신청 관리 객체 생성 및 테스트 코드 작성

* refactor : tuition 객체 분리 및 테스트 코드 수정

* refactor : 수강인원 객체 분리 및 테스트 코드 수정

* refactor : SessionStatus from 메서드 StreamAPI로 변경

* refactor : SessionType from 메서드 StreamAPI로 변경

* refactor : SessionPolicy, SessionCore 클래스 생성 및 테스트 코드 수정

* refactor : 수강신청 목록 클래스 생성 후 포장

* feat : 테스트 필요한 builder 클래스 생성
refactor : builder 적용하여 테스트 코드 수정

Author: chanani

README.md

@@ -2,6 +2,7 @@
 
 ## 단계별 문서
 - [🚀 1단계 - 레거시 코드 리팩터링](./docs/01-refactoring.md)
+- [🚀 2단계 - 수강신청(도메인 모델)](./docs/02-lms-domain-model.md)
 
 ## 진행 방법
 * 학습 관리 시스템의 수강신청 요구사항을 파악한다.

docs/02-lms-domain-model.md

@@ -0,0 +1,41 @@
+# 🚀 2단계 - 수강신청(도메인 모델)
+***
+
+## 코드 리뷰
+> PR 링크 : 
+
+## 나의 학습 목표
+
+### 1. 객체 중심의 설계를 해보자.
+- 요구사항을 정확히 분석하고, TDD 사이클을 통해 객체의 핵심 비즈니스 로직을 우선적으로 만들어보자.
+- 그 이후 객체를 조립하며, 리팩터링 해보자.
+
+### 1. TDD 사이클을 의식하며 기능을 구현한다. 
+- `실패 → 성공 → 리팩터링` 과정으로 작업한다.
+- 습관처럼 이 과정을 지나치면, 다시 돌아와 사이클을 반복한다.
+- TDD 사이클 습관을 만들자.
+
+## 수간 신청 기능 요구사항
+
+- [x] 과정(Course)은 기수 단위로 운영하며, 여러 개의 강의(Session)를 가질 수 있다.
+- [x] 강의는 시작일과 종료일을 가진다.
+- [x] 강의는 강의 커버 이미지 정보를 가진다.
+  - [x] 이미지 크기는 1MB 이하여야 한다.
+  - [x] 이미지 타입은 gif, jpg(jpeg 포함), png, svg만 허용한다.
+  - [x] 이미지의 width는 300px, height는 200px 이상이어야 하며, width와 height의 비율은 3:2여야 한다.
+- [x] 강의는 무료 강의와 유료 강의로 나뉜다.
+  - [x] 무료 강의는 최대 수강 인원 제한이 없다.
+  - [x] 유료 강의는 강의 최대 수강 인원을 초과할 수 없다.
+  - [x] 유료 강의는 수강생이 결제한 금액과 수강료가 일치할 때 수강 신청이 가능하다.
+- [x] 강의 상태는 준비중, 모집중, 종료 3가지 상태를 가진다.
+- [x] 강의 수강신청은 강의 상태가 모집중일 때만 가능하다.
+- [x] 유료 강의의 경우 결제는 이미 완료한 것으로 가정하고 이후 과정을 구현한다.
+  - [x] 결제를 완료한 결제 정보는 payments 모듈을 통해 관리되며, 결제 정보는 Payment 객체에 담겨 반한된다.
+
+## 프로그래밍 요구사항
+
+- DB 테이블 설계 없이 도메인 모델부터 구현한다.
+- 도메인 모델은 TDD로 구현한다.
+  - 단, Service 클래스는 단위 테스트가 없어도 된다.
+- 다음 동영상을 참고해 DB 테이블보다 도메인 모델을 먼저 설계하고 구현한다.
+  - https://youtu.be/VjbBGjVRxfk

src/main/java/nextstep/courses/domain/Course.java

@@ -1,6 +1,10 @@
 package nextstep.courses.domain;
 
+import nextstep.courses.domain.session.Session;
+
 import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.List;
 
 public class Course {
     private Long id;
@@ -13,6 +17,8 @@ public class Course {
 
     private LocalDateTime updatedAt;
 
+    private List<Session> sessions = new ArrayList<>();
+
     public Course() {
     }
 
@@ -28,6 +34,10 @@ public Course(Long id, String title, Long creatorId, LocalDateTime createdAt, Lo
         this.updatedAt = updatedAt;
     }
 
+    public void addSession(Session session) {
+        this.sessions.add(session);
+    }
+
     public String getTitle() {
         return title;
     }

src/main/java/nextstep/courses/domain/image/CoverImage.java

@@ -0,0 +1,43 @@
+package nextstep.courses.domain.image;
+
+import nextstep.courses.domain.image.constant.ImageType;
+
+public class CoverImage {
+
+    public static final double MAX_FILE_SIZE = 1024 * 1024; // 1MB
+
+    private final long size;
+    private final ImageType type;
+    private final ImageDimentsion dimentsion;
+
+    public CoverImage(long size, String type, int width, int height) {
+        this(size, ImageType.fromName(type.toUpperCase()), width, height);
+    }
+
+    public CoverImage(long size, ImageType type, int width, int height) {
+        this(size, type, new ImageDimentsion(width, height));
+    }
+
+    public CoverImage(long size, ImageType type, ImageDimentsion dimentsion) {
+        validateFileSize(size);
+        this.size = size;
+        this.type = type;
+        this.dimentsion = dimentsion;
+    }
+
+    private void validateFileSize(long size) {
+        if (size > MAX_FILE_SIZE) {
+            throw new IllegalArgumentException("이미지 사이즈는 1MB 이하만 가능합니다.");
+        }
+    }
+
+    public long getSize() {
+        return size;
+    }
+
+    public ImageType getType() {
+        return type;
+    }
+
+
+}

src/main/java/nextstep/courses/domain/image/ImageDimentsion.java

@@ -0,0 +1,35 @@
+package nextstep.courses.domain.image;
+
+public class ImageDimentsion {
+
+    public static final int MIN_WIDTH = 300;
+    public static final int MIN_HEIGHT = 200;
+    public static final double ASPECT_RATIO = 1.5;
+
+    private final int width;
+    private final int height;
+
+    public ImageDimentsion(int width, int height) {
+        validateSize(width, height);
+        validateRatio(width, height);
+        this.width = width;
+        this.height = height;
+    }
+
+    private void validateRatio(int width, int height) {
+        double ratio = (double) width / height;
+        if (ratio != ASPECT_RATIO) {
+            throw new IllegalArgumentException("3:2 비율로 다시 업로드 해주세요.");
+        }
+    }
+
+    private void validateSize(int width, int height) {
+        if (isSize(width, height)) {
+            throw new IllegalArgumentException("너비는 300px, 높이는 200px 이상이어야 합니다.");
+        }
+    }
+
+    private static boolean isSize(int width, int height) {
+        return width < MIN_WIDTH || height < MIN_HEIGHT;
+    }
+}

src/main/java/nextstep/courses/domain/image/constant/ImageType.java

@@ -0,0 +1,18 @@
+package nextstep.courses.domain.image.constant;
+
+public enum ImageType {
+    GIF,
+    JPG,
+    JPEG,
+    PNG,
+    SVG;
+
+    public static ImageType fromName(String name){
+        for (ImageType type : ImageType.values()) {
+            if(type.name().equals(name)){
+                return type;
+            }
+        }
+        throw new IllegalArgumentException("이미지 타입을 다시 확인해주세요.");
+    }
+}

src/main/java/nextstep/courses/domain/session/Capacity.java

@@ -0,0 +1,32 @@
+package nextstep.courses.domain.session;
+
+import java.util.Objects;
+
+public class Capacity {
+
+    private int value;
+
+    public Capacity(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return value;
+    }
+
+    public boolean matchSize(int enrollmentsSize) {
+        return this.value <= enrollmentsSize;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+        Capacity capacity = (Capacity) o;
+        return value == capacity.value;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(value);
+    }
+}

src/main/java/nextstep/courses/domain/session/Enrollment.java

@@ -0,0 +1,38 @@
+package nextstep.courses.domain.session;
+
+import nextstep.payments.domain.Payment;
+import nextstep.users.domain.NsUser;
+
+import java.util.Objects;
+
+public class Enrollment {
+
+    private final NsUser user;
+    private final Long sessionId;
+    private final Payment payment;
+
+    public Enrollment(NsUser user, Long sessionId, Payment payment) {
+        this.user = user;
+        this.sessionId = sessionId;
+        this.payment = payment;
+    }
+
+    public void isPaymentAmount(SessionPolicy sessionPolicy) {
+        if(sessionPolicy.matchAmount(payment)){
+            throw new IllegalArgumentException("강의 금액과 결제 금액이 일치하지 않습니다.");
+        }
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+        Enrollment that = (Enrollment) o;
+        return Objects.equals(user.getId(), that.user.getId()) && Objects.equals(sessionId, that.sessionId);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(user, sessionId, payment);
+    }
+
+}

src/main/java/nextstep/courses/domain/session/Enrollments.java

@@ -0,0 +1,31 @@
+package nextstep.courses.domain.session;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class Enrollments {
+
+    private final List<Enrollment> enrollments = new ArrayList<>();
+
+    public void add(Enrollment enrollment) {
+        validateNotDuplicate(enrollment);
+        this.enrollments.add(enrollment);
+    }
+
+    public int size() {
+        return this.enrollments.size();
+    }
+
+    private void validateNotDuplicate(Enrollment enrollment) {
+        if (this.enrollments.contains(enrollment)) {
+            throw new IllegalArgumentException("이미 신청한 강의입니다.");
+        }
+    }
+
+    @Override
+    public String toString() {
+        return "Enrollments{" +
+                "enrollments=" + enrollments +
+                '}';
+    }
+}

src/main/java/nextstep/courses/domain/session/Session.java

@@ -0,0 +1,73 @@
+package nextstep.courses.domain.session;
+
+import nextstep.courses.domain.image.CoverImage;
+import nextstep.courses.domain.session.constant.SessionStatus;
+import nextstep.courses.domain.session.constant.SessionType;
+
+import java.time.LocalDateTime;
+import java.util.Objects;
+
+public class Session extends SessionCore {
+
+    private final Long id;
+    private final CoverImage coverImage;
+    private final Enrollments enrollments;
+
+    public Session(Long id, LocalDateTime startDate, LocalDateTime endDate, String sessionType, String sessionStatus, CoverImage coverImage) {
+        this(id, startDate, endDate, sessionType, Integer.MAX_VALUE, 0L, sessionStatus, coverImage);
+    }
+
+    public Session(Long id, LocalDateTime startDate, LocalDateTime endDate, String sessionType, int maxCapacity, Long tuition, String sessionStatus, CoverImage coverImage) {
+        this(id, startDate, endDate, SessionType.from(sessionType.toUpperCase()), maxCapacity, tuition, SessionStatus.from(sessionStatus.toUpperCase()), coverImage);
+    }
+
+    public Session(Long id, LocalDateTime startDate, LocalDateTime endDate, SessionType sessionType, int maxCapacity, Long tuition, SessionStatus sessionStatus, CoverImage coverImage) {
+        this(id, new SessionRange(startDate, endDate), sessionType, new Capacity(maxCapacity), new Tuition(tuition), sessionStatus, coverImage);
+    }
+
+    public Session(Long id, SessionRange sessionRange, SessionType sessionType, Capacity maxCapacity, Tuition tuition, SessionStatus sessionStatus, CoverImage coverImage) {
+        this(id, sessionRange, new SessionPolicy(maxCapacity, tuition, sessionType), sessionStatus, coverImage);
+    }
+
+    public Session(Long id, SessionRange sessionRange, SessionPolicy sessionPolicy, SessionStatus sessionStatus, CoverImage coverImage) {
+        super(sessionRange, sessionPolicy, sessionStatus);
+        this.id = id;
+        this.coverImage = coverImage;
+        this.enrollments = new Enrollments();
+    }
+
+    public Session(Long id, SessionRange sessionRange, SessionPolicy sessionPolicy, SessionStatus sessionStatus, CoverImage coverImage, Enrollments enrollments) {
+        super(sessionRange, sessionPolicy, sessionStatus);
+        this.id = id;
+        this.coverImage = coverImage;
+        this.enrollments = enrollments;
+    }
+
+    public void addEnrollment(Enrollment enrollment) {
+        validatePaymentAmount(enrollment);
+        validateNotFull(this.enrollments);
+        validateSessionStatus();
+        this.enrollments.add(enrollment);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+        Session session = (Session) o;
+        return Objects.equals(id, session.id) && Objects.equals(coverImage, session.coverImage) && Objects.equals(enrollments, session.enrollments);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id, coverImage, enrollments);
+    }
+
+    @Override
+    public String toString() {
+        return "Session{" +
+                "id=" + id +
+                ", coverImage=" + coverImage +
+                ", enrollments=" + enrollments +
+                '}';
+    }
+}