Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: 스터디 개설시 제목필드 추가 #632

Merged
merged 4 commits into from
Aug 16, 2024

Conversation

seulgi99
Copy link
Contributor

@seulgi99 seulgi99 commented Aug 16, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

📝 참고사항

📚 기타

Summary by CodeRabbit

  • New Features

    • 스터디 생성 시 제목을 추가할 수 있는 기능이 도입되었습니다.
    • 스터디 생성 요청 시 제목 필드가 필수로 추가되어 데이터 무결성이 향상되었습니다.
  • Bug Fixes

    • 스터디 생성 시 적절한 제목을 포함하도록 기능이 수정되었습니다.
  • Tests

    • 스터디 생성 기능과 관련된 테스트가 업데이트되어 제목을 포함한 확인이 추가되었습니다.

@seulgi99 seulgi99 added the ✨ feature 새로운 기능 추가 및 수정 label Aug 16, 2024
@seulgi99 seulgi99 self-assigned this Aug 16, 2024
@seulgi99 seulgi99 requested a review from a team as a code owner August 16, 2024 08:56
Copy link

coderabbitai bot commented Aug 16, 2024

Walkthrough

이번 변경은 Study 클래스와 관련된 여러 파일에서 스터디 제목을 추가하는 기능을 도입합니다. 새로운 title 매개변수는 생성자와 정적 메서드에 추가되어 스터디 객체를 생성할 때 제목을 설정할 수 있게 하며, 관련 요청 및 테스트 파일에서도 이 변화를 반영하도록 수정되었습니다.

Changes

파일 경로 변경 요약
src/main/java/com/gdschongik/gdsc/domain/study/... Study 클래스의 생성자와 createStudy 메서드에 title 매개변수를 추가하여 스터디 제목을 설정할 수 있도록 수정되었습니다.
src/main/java/com/gdschongik/gdsc/domain/study/... StudyCreateRequest 레코드에 title 필드를 추가하고, 비어 있지 않도록 검증하는 @NotBlank 어노테이션을 추가했습니다. 기존의 @Schema 어노테이션도 간소화되었습니다.
src/main/java/com/gdschongik/gdsc/domain/study/... StudyDomainFactorycreateNewStudy 메서드에서 request.title()을 호출하여 스터디 제목을 전달하도록 수정되었습니다.
src/test/java/com/gdschongik/gdsc/domain/study/... StudyTest.java와 기타 테스트 파일에서 createStudy 호출에 STUDY_TITLE 매개변수를 추가하여 제목을 테스트하도록 수정되었습니다.
src/test/java/com/gdschongik/gdsc/global/common/... StudyConstant에서 STUDY_TITLE 상수를 추가하여 제목을 전역적으로 사용할 수 있게 했습니다.
src/test/java/com/gdschongik/gdsc/helper/... FixtureHelperIntegrationTest에서 createStudy 메서드 호출에 STUDY_TITLE 매개변수를 추가하여 스터디 제목을 명시적으로 설정할 수 있도록 하였습니다.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StudyDomainFactory
    participant Study

    User->>StudyDomainFactory: createNewStudy(request)
    StudyDomainFactory->>Study: createStudy(academicYear, semesterType, title, mentor, period, applicationPeriod)
    Study-->>StudyDomainFactory: new Study instance
    StudyDomainFactory-->>User: return Study instance
Loading

Assessment against linked issues

Objective Addressed Explanation
스터디 개설시 제목필드 추가 (#628)
스터디 시간 초 데이터 제거 (#628) 해당 요구 사항은 코드 변경에서 다루어지지 않음.

🐰 변화를 축하하는 시

새로운 제목이 추가되어
스터디가 더욱 빛나요,
Rabbit이 기뻐 뛰어놀며,
함께 할 준비 다 되었어요!
스터디 준비 완료!
이젠 제목으로 함께해요! 🌼✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link
Member

@AlmondBreez3 AlmondBreez3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@uwoobeat uwoobeat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@seulgi99 seulgi99 merged commit 9f90571 into develop Aug 16, 2024
1 check passed
@seulgi99 seulgi99 deleted the feat/628-study-create-request branch August 16, 2024 08:59
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between da08b2b and 294179b.

Files selected for processing (7)
  • src/main/java/com/gdschongik/gdsc/domain/study/domain/Study.java (4 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/study/dto/request/StudyCreateRequest.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/study/factory/StudyDomainFactory.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyTest.java (5 hunks)
  • src/test/java/com/gdschongik/gdsc/global/common/constant/StudyConstant.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/helper/FixtureHelper.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.java (1 hunks)
Additional comments not posted (7)
src/test/java/com/gdschongik/gdsc/global/common/constant/StudyConstant.java (1)

10-10: 변경 사항이 적절합니다.

STUDY_TITLE 상수의 추가는 스터디 제목을 명확하게 정의하는 데 유용합니다. 이 변경은 코드의 가독성을 높이고 유지보수를 용이하게 합니다.

src/main/java/com/gdschongik/gdsc/domain/study/factory/StudyDomainFactory.java (1)

23-23: 변경 사항이 적절합니다.

createNewStudy 메서드에 title 매개변수를 추가하여 스터디 생성 시 제목을 설정할 수 있게 되었습니다. 이 변경은 스터디의 식별과 관리를 용이하게 합니다.

스터디 제목의 유효성 검사가 적절히 처리되고 있는지 확인하세요.

Verification successful

스터디 제목의 유효성 검사가 적절히 처리되고 있습니다.

StudyCreateRequest 클래스에서 @NotBlank 어노테이션을 사용하여 제목이 비어 있지 않도록 검증하고 있습니다. 이로 인해 스터디 생성 시 제목이 필수적으로 입력되도록 보장됩니다.

  • src/main/java/com/gdschongik/gdsc/domain/study/dto/request/StudyCreateRequest.java: @NotBlank(message = "스터디 제목을 입력해 주세요.")
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the title validation is properly implemented in the codebase.

# Test: Search for title validation logic. Expect: Validation logic using annotations or explicit checks.
rg --type java '@NotBlank' -A 2

Length of output: 9715

src/main/java/com/gdschongik/gdsc/domain/study/dto/request/StudyCreateRequest.java (1)

21-21: 변경 사항이 적절합니다.

title 필드의 추가와 @NotBlank 유효성 검사는 스터디 제목이 항상 제공되도록 보장합니다. 이 변경은 데이터의 무결성을 높입니다.

src/test/java/com/gdschongik/gdsc/helper/FixtureHelper.java (1)

74-74: 변경 사항이 잘 반영되었습니다.

createStudy 메서드에 studyTitle 매개변수가 추가되었습니다. 이 변경은 스터디 생성 시 제목을 설정할 수 있게 하여 기능을 향상시킵니다.

다른 코드에서 createStudy 메서드의 사용이 올바르게 업데이트되었는지 확인하세요.

Verification successful

모든 createStudy 메서드 사용이 올바르게 업데이트되었습니다.

createStudy 메서드의 모든 사용이 새로운 시그니처에 맞게 업데이트되었습니다. STUDY_TITLE이 올바르게 전달되고 있습니다.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all usages of `createStudy` method match the new signature.

# Test: Search for the method usage. Expect: Only occurrences of the new signature.
rg --type java -A 5 $'createStudy'

Length of output: 26473

src/main/java/com/gdschongik/gdsc/domain/study/domain/Study.java (1)

Line range hint 83-93: 스터디 객체에 제목 필드가 성공적으로 추가되었습니다.

Study 클래스의 생성자와 createStudy 메서드에 title 매개변수가 추가되었습니다. 이 변경은 객체 생성 시 제목을 설정할 수 있게 하여 기능을 확장합니다.

다른 코드에서 Study 생성자와 createStudy 메서드의 사용이 올바르게 업데이트되었는지 확인하세요.

Also applies to: 107-122

Verification successful

스터디 생성자 및 createStudy 메서드의 사용이 올바르게 업데이트되었습니다.

Study 클래스의 생성자와 createStudy 메서드의 새로운 시그니처가 코드베이스 전반에 걸쳐 올바르게 반영되었습니다. 테스트 파일과 StudyDomainFactory에서도 일관되게 사용되고 있습니다.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all usages of `Study` constructor and `createStudy` method match the new signature.

# Test: Search for the constructor and method usage. Expect: Only occurrences of the new signature.
rg --type java -A 5 $'Study('
rg --type java -A 5 $'createStudy'

Length of output: 26567


Script:

#!/bin/bash
# Correcting the regex error and verifying all usages of `Study` constructor and `createStudy` method match the new signature.

# Test: Search for the constructor and method usage. Expect: Only occurrences of the new signature.
rg --type java -A 5 'Study\('
rg --type java -A 5 'createStudy'

Length of output: 60402

src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyTest.java (1)

46-46: 테스트 케이스에 제목 필드가 성공적으로 반영되었습니다.

createStudy 메서드 호출에 STUDY_TITLE 매개변수가 추가되었습니다. 이는 다양한 시나리오에서 새로운 매개변수를 테스트하도록 보장합니다.

테스트 케이스가 새로운 title 매개변수를 충분히 다루고 있는지 확인하세요.

Also applies to: 70-70, 94-94, 120-120, 146-146

Verification successful

테스트 케이스가 새로운 title 매개변수를 충분히 다루고 있습니다.

createStudy 메서드 호출에 STUDY_TITLE 매개변수가 여러 테스트 케이스에서 일관되게 사용되고 있습니다. 이는 다양한 시나리오에서 해당 매개변수가 테스트되고 있음을 나타냅니다.

  • StudyTest.java
  • IntegrationTest.java
  • FixtureHelper.java
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify test coverage for the new `title` parameter in `createStudy` method.

# Test: Search for test cases using `createStudy`. Expect: All occurrences include the `title` parameter.
rg --type java -A 5 $'createStudy'

Length of output: 26473

src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.java (1)

213-213: STUDY_TITLE 매개변수 추가 확인

createStudy 메서드에 STUDY_TITLE 매개변수가 추가되었습니다. 이 변경 사항이 테스트 전반에 걸쳐 올바르게 반영되었는지 확인해야 합니다. 모든 createStudy 호출이 새로운 매개변수를 사용하도록 업데이트되었는지 검토하세요.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ feature 새로운 기능 추가 및 수정
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ 스터디 개설시 제목필드 추가 및 스터디 시간 초 데이터 제거
3 participants