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

[WEAV-136] ToolTip AttibutedString 적용 #42

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Conversation

jisu15-kim
Copy link
Member

@jisu15-kim jisu15-kim commented Nov 18, 2024

구현사항

  • 부분 bold 적용을 위해 ToolTip 컴포넌트에 AttributedString 적용 가능하도록 수정
  • 가입 연령 툴팁 적용

스크린샷(선택)

가입 연령 안내 툴팁

Summary by CodeRabbit

  • 새로운 기능

    • 툴팁 기능이 추가되어 사용자 등록을 위한 연령 관련 정보를 제공합니다.
    • 툴팁 메시지가 문자열 및 서식 있는 문자열 모두를 지원하도록 업데이트되었습니다.
    • 툴팁의 가시성을 토글하는 기능이 추가되었습니다.
    • 성별 유형의 열거형에 대한 새로운 공개 속성 name이 추가되었습니다.
  • 버그 수정

    • GenderType 열거형의 toDto 속성 접근 수준이 변경되어 외부에서 접근 가능해졌습니다.
  • 문서화

    • 툴팁 관련 메시지 및 가시성 관리에 대한 설명이 추가되었습니다.

@jisu15-kim jisu15-kim added the Feature 기능 label Nov 18, 2024
@jisu15-kim jisu15-kim self-assigned this Nov 18, 2024
Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Walkthrough

이번 변경 사항은 여러 파일에서 툴팁 기능을 추가하거나 수정하는 내용을 포함하고 있습니다. .gitignore 파일에 OpenApiGenerator/.build 항목이 추가되어 해당 디렉토리의 빌드 아티팩트가 Git에서 무시됩니다. TooltipView.swift 파일에서는 툴팁 메시지가 StringAttributedString 모두를 지원하도록 수정되었습니다. AuthProfileAgeInputIntent.swift, AuthProfileAgeInputModel.swift, AuthProfileAgeInputView.swift 파일에서는 툴팁 표시 및 토글 기능이 추가되었습니다. 마지막으로, SignUpFormDomain.swift 파일에서는 GenderType 열거형의 접근 수준이 변경되었습니다.

Changes

파일 경로 변경 요약
.gitignore OpenApiGenerator/.build 항목 추가
Projects/DesignSystem/DesignCore/Sources/Tooltip/ToolTip.swift tooltip 함수와 ToolTipViewModifier 구조체에서 StringAttributedString 타입 지원 추가
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputIntent.swift Intentable 프로토콜에 toggleToolTip() 메서드 추가
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputModel.swift Stateful 프로토콜에 isShowToolTip 속성 추가 및 AuthProfileAgeInputModel 클래스에 해당 속성과 toggleToolTip() 메서드 구현
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputView.swift 툴팁 메시지와 버튼 액션 추가, 툴팁 표시 조건부 처리
Projects/Model/Model/Sources/SignUp/Domain/SignUpFormDomain.swift GenderType 열거형의 toDto 접근 수준을 private에서 public으로 변경 및 새로운 name 프로퍼티 추가
Projects/Features/Home/UnitTest/WidgetUnitTest.swift WidgetSelectionIntentWidgetWritingIntent 초기화에서 successHandler 클로저 제거

Suggested labels

Design

🐰 변화의 기쁨을 노래해요,
툴팁이 생겨나고,
메시지가 반짝이네,
사용자와 함께 춤추고,
더 나은 경험을 선사해요!
🥕✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c0a9915 and 4051ee4.

📒 Files selected for processing (3)
  • Projects/Features/Home/UnitTest/WidgetUnitTest.swift (1 hunks)
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputIntent.swift (2 hunks)
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputView.swift (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputIntent.swift
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputView.swift
🔇 Additional comments (2)
Projects/Features/Home/UnitTest/WidgetUnitTest.swift (2)

33-33: 콘텐츠 초기화 로직 검증 필요

content: nil로 초기화하는 것이 의도된 동작인지 확인이 필요합니다. 이전 구현에서는 successHandler와 함께 사용되었던 부분이 제거되었으므로, 초기 상태 설정이 적절한지 검토가 필요합니다.

#!/bin/bash
# Description: Check for content initialization patterns in widget-related files
ast-grep --pattern 'WidgetWritingIntent.*init.*content.*nil'

25-25: 성공 핸들러 제거에 대한 테스트 커버리지 확인 필요

successHandler가 제거된 것이 확인되었습니다. 성공 시나리오에 대한 테스트가 여전히 적절하게 이루어지고 있는지 확인이 필요합니다.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@jisu15-kim jisu15-kim marked this pull request as ready for review November 18, 2024 15:20
Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (7)
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputIntent.swift (1)

79-81: 옵셔널 처리 개선이 필요합니다

model이 weak 참조되어 있으므로, nil 체크를 추가하는 것이 좋습니다.

다음과 같이 수정하는 것을 제안합니다:

 func toggleToopTip() {
-    model?.toggleToolTip()
+    guard let model else {
+        Logger.debug("모델이 해제되었습니다")
+        return
+    }
+    model.toggleToolTip()
 }
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputModel.swift (1)

41-41: 구현이 깔끔하나 문서화가 필요합니다.

툴팁 기능의 구현이 간단하고 명확합니다. 하지만 다른 개발자들의 이해를 돕기 위해 문서화를 추가하면 좋을 것 같습니다.

다음과 같이 문서 주석을 추가하는 것을 제안합니다:

    @Published var targetGender: GenderType = .female
+    /// 나이 입력 툴팁의 표시 여부를 관리하는 상태값
    @Published var isShowToolTip: Bool = false

    // default
    @Published var isLoading: Bool = false
+    /// 툴팁의 표시 상태를 토글합니다.
+    /// 현재 표시 중이면 숨기고, 숨겨져 있으면 표시합니다.
    func toggleToolTip() {
        isShowToolTip.toggle()
    }

Also applies to: 85-87

Projects/DesignSystem/DesignCore/Sources/Tooltip/ToolTip.swift (2)

33-43: String 초기화 로직을 더 간단하게 개선할 수 있습니다.

현재 구현된 String 초기화 메서드의 nil 처리 로직을 map을 사용하여 더 간결하게 작성할 수 있습니다.

다음과 같이 개선해보세요:

    init(
        message: String?,
        offset: CGFloat
    ) {
-        if let message {
-            self.message = .init(stringLiteral: message)
-        } else {
-            self.message = nil
-        }
+        self.message = message.map { AttributedString(stringLiteral: $0) }
        self.offset = offset
    }

48-68: 접근성 및 레이아웃 관련 개선사항이 필요합니다.

  1. 고정 너비 제거로 인한 잠재적 문제:

    • 매우 긴 텍스트의 경우 화면을 벗어날 수 있습니다
    • 최대 너비 제한을 고려해보세요
  2. 접근성 개선 필요:

    • VoiceOver 지원을 위한 accessibilityLabel 추가
    • 툴팁의 역할을 명확히 하는 accessibilityRole 설정

다음과 같이 개선해보세요:

    if let message {
        Text(message)
            .padding(.horizontal, 20)
            .padding(.vertical, 10)
            .typography(.regular_12)
            .foregroundStyle(.white)
            .multilineTextAlignment(.center)
+           .frame(maxWidth: 300)
+           .accessibilityLabel("도움말: \(message)")
+           .accessibilityRole(.help)
Projects/Model/Model/Sources/SignUp/Domain/SignUpFormDomain.swift (1)

163-168: 문자열 현지화 적용을 고려해보세요.

현재 성별 표시 문자열이 하드코딩되어 있습니다. 앱의 국제화를 위해 Localizable.strings 파일을 사용한 현지화 처리를 권장드립니다.

다음과 같이 변경하는 것을 고려해보세요:

    public var name: String {
        switch self {
-        case .male: "남성"
-        case .female: "여성"
+        case .male: NSLocalizedString("gender.male", comment: "Male gender")
+        case .female: NSLocalizedString("gender.female", comment: "Female gender")
        }
    }
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputView.swift (2)

40-58: AttributedString 구현을 개선하세요.

텍스트 범위를 찾는 현재 방식은 텍스트가 변경되면 실패할 수 있습니다. 더 안정적인 구현을 위해 다음과 같이 수정하는 것이 좋습니다.

private var tooltipMessage: AttributedString {
-    let text = """
-    2024년 기준으로 2004년생(만 20살)부터
-    1989년생(만 35살)까지 가입할 수 있어요
-    """
-
-    var attributedString = AttributedString(text)
-    let boldRanges = [
-        text.range(of: "2004년생(만 20살)부터"),
-        text.range(of: "1989년생(만 35살)")
-    ].compactMap { $0 }
-
-    boldRanges.forEach { range in
-        let attributedRange = attributedString.range(of: text[range])!
-        attributedString[attributedRange].inlinePresentationIntent = .stronglyEmphasized
-    }
-
-    return attributedString
+    var young = AttributedString("2004년생(만 20살)부터")
+    young.inlinePresentationIntent = .stronglyEmphasized
+    
+    var old = AttributedString("1989년생(만 35살)")
+    old.inlinePresentationIntent = .stronglyEmphasized
+    
+    return young + AttributedString("\n") + old + AttributedString("까지 가입할 수 있어요")
}

104-107: 툴팁 토글 기능이 잘 구현되었습니다.

애니메이션과 조건부 렌더링이 적절히 구현되었습니다. 하지만 접근성을 위해 다음 사항을 고려해보세요:

Button(action: {
    withAnimation {
        intent.toggleToopTip()
    }
}, label: {
    HStack(spacing: 4) {
        DesignCore.Images.iconInformation.image
        Text("가입 연령 확인하기")
            .typography(.regular_14)
            .foregroundStyle(DesignCore.Colors.grey200)
    }
})
+.accessibilityLabel("가입 가능 연령 정보")
+.accessibilityHint("버튼을 눌러 가입 가능한 연령대를 확인하세요")

Also applies to: 119-119

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a1a1519 and c0a9915.

📒 Files selected for processing (6)
  • .gitignore (1 hunks)
  • Projects/DesignSystem/DesignCore/Sources/Tooltip/ToolTip.swift (1 hunks)
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputIntent.swift (2 hunks)
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputModel.swift (4 hunks)
  • Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputView.swift (4 hunks)
  • Projects/Model/Model/Sources/SignUp/Domain/SignUpFormDomain.swift (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .gitignore
🔇 Additional comments (5)
Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputModel.swift (1)

24-24: 프로토콜에 툴팁 상태 추가가 적절합니다!

상태 관리를 위한 프로토콜에 툴팁 표시 여부를 추가한 것이 적절해 보입니다.

Projects/DesignSystem/DesignCore/Sources/Tooltip/ToolTip.swift (1)

12-16: 구현이 깔끔하고 명확합니다!

String과 AttributedString을 모두 지원하도록 메서드를 분리한 것이 좋은 접근 방식입니다. SwiftUI의 관례를 잘 따르고 있습니다.

Projects/Model/Model/Sources/SignUp/Domain/SignUpFormDomain.swift (1)

156-162: 접근 제어자 변경이 적절합니다.

toDto 프로퍼티를 public으로 변경한 것은 툴팁 기능 구현을 위해 필요한 변경으로 보입니다.

Projects/Features/SignUp/Sources/ProfileInput/AuthProfileAge/AuthProfileAgeInputView.swift (2)

65-65: 성별 표시가 적절히 구현되었습니다.

상태 관리와 문자열 보간이 올바르게 구현되었습니다.


144-148: 툴팁 닫기 제스처가 적절히 구현되었습니다.

상태 확인 후 툴팁을 닫는 제스처가 올바르게 구현되었습니다.

@jisu15-kim jisu15-kim merged commit c20ec95 into develop Nov 19, 2024
2 checks passed
@jisu15-kim jisu15-kim deleted the feature/WEAV-136 branch November 19, 2024 15:31
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.

1 participant