Add showOrHideBookmark method to update bookmark button visibility

[PruthiviRaj27]

Summary by CodeRabbit

• New Features
  • The visibility of the bookmark button in the profile view now automatically reflects your institute's settings.

[coderabbitai]

Walkthrough

A new method, showOrHideBookmark(), was introduced in the ProfileViewController. This method asynchronously retrieves institute settings and updates the visibility of the bookmark button based on whether bookmarks are enabled. It is called during the view's loading process to ensure UI consistency with current settings.

Changes

File	Change Summary
ios-app/UI/ProfileViewController.swift	Added showOrHideBookmark() method; invoked it in viewDidLoad() to update bookmark button UI

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ProfileViewController
    participant InstituteRepository

    User->>ProfileViewController: viewDidLoad()
    ProfileViewController->>ProfileViewController: showOrHideBookmark()
    ProfileViewController->>InstituteRepository: getSettings()
    InstituteRepository-->>ProfileViewController: settings (bookmarksEnabled)
    ProfileViewController->>ProfileViewController: Update bookmarkButtonLayout visibility

Loading

Poem

A button may appear, or vanish from view,
Depending on settings—what’s old or what’s new.
The rabbit hops in, with code in its paw,
To show or to hide, by the institute’s law.
UI now listens, to settings so bright,
Bookmark in shadow, or bathed in the light!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[codetortoiseai]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

ios-app/UI/ProfileViewController.swift (1)

87-94: Implementation follows existing patterns well, but consider error handling.

The method correctly follows the established pattern used in showDeleteAccountButtonIfSignupAllowed() with proper weak self capture and main thread UI updates. However, the error parameter from the completion handler is ignored, which could lead to the UI not being updated if the settings fetch fails.

Consider adding basic error handling to ensure UI consistency:

 func showOrHideBookmark() {
     InstituteRepository.shared.getSettings { [weak self] settings, error in
-        guard let settings = settings else { return }
+        guard let settings = settings else { 
+            // Fallback to default behavior if settings fetch fails
+            DispatchQueue.main.async {
+                self?.bookmarkButtonLayout.isHidden = !Constants.BOOKMARKS_ENABLED
+            }
+            return 
+        }
         DispatchQueue.main.async {
             self?.bookmarkButtonLayout.isHidden = !settings.bookmarksEnabled
         }
     }
 }

Optional: Consider extracting common settings fetching pattern.

Both showOrHideBookmark() and showDeleteAccountButtonIfSignupAllowed() follow the same pattern. You could create a helper method to reduce duplication:

private func updateUIWithSettings(_ updateBlock: @escaping (InstituteSettings) -> Void) {
    InstituteRepository.shared.getSettings { [weak self] settings, error in
        guard let settings = settings else { return }
        DispatchQueue.main.async {
            updateBlock(settings)
        }
    }
}

Then use it like:

func showOrHideBookmark() {
    updateUIWithSettings { [weak self] settings in
        self?.bookmarkButtonLayout.isHidden = !settings.bookmarksEnabled
    }
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c242377 and ffcbea4.

📒 Files selected for processing (1)

• ios-app/UI/ProfileViewController.swift (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

ios-app/UI/ProfileViewController.swift (1)

CourseKit/Source/Repostories/InstituteRepository.swift (1)

• getSettings (22-32)

🔇 Additional comments (1)

ios-app/UI/ProfileViewController.swift (1)

65-65: Good placement of the method call.

The method call is appropriately placed in viewDidLoad to ensure the bookmark button visibility is updated based on current settings during the view initialization process.