Add user manga notes (mihonapp/mihon#428) #813
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: AntsyLich <[email protected]> (cherry picked from commit 8fbe630308b962043c7b59422878c94f80156e9f)
Reviewer's Guide by SourceryThis pull request introduces the ability for users to add and edit notes to manga entries. It includes UI changes to display and edit notes, database schema updates to store the notes, and backup/restore functionality to preserve the notes. A rich text editor is used for editing the notes. Sequence diagram for editing manga notessequenceDiagram
participant User
participant MangaScreen
participant MangaNotesScreen
participant UpdateMangaNotes
participant MangaRepository
User->>MangaScreen: Clicks on "Edit Notes"
MangaScreen->>MangaNotesScreen: Navigates to MangaNotesScreen
MangaNotesScreen->>User: Displays notes editor
User->>MangaNotesScreen: Edits notes
MangaNotesScreen->>UpdateMangaNotes: Updates notes
UpdateMangaNotes->>MangaRepository: Updates manga notes in database
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @cuong-tran, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces the ability for users to add and edit notes to manga within the application. It includes changes to the UI to display and edit these notes, as well as updates to the data layer to persist them. The notes are stored as markdown, and a rich text editor is used for editing.
Highlights
- UI Changes: A new screen,
MangaNotesScreen.kt, is added to allow users to edit manga notes using a rich text editor. TheMangaScreen.ktis updated to include a button to navigate to the notes screen. - Data Layer Changes: The
Mangadata class in the domain layer is updated to include anotesfield. The data and SQLDelight layers are updated to persist this field. An interactorUpdateMangaNotesis added to update the notes in the database. - Rich Text Editor: The pull request adds a rich text editor using the
richeditor-composelibrary, allowing users to format their notes with bold, italic, underline, and lists. - Backup and Restore: The backup and restore functionality is updated to include the manga notes, ensuring that notes are preserved during backup and restore operations.
Changelog
Click here to see the changelog
- CHANGELOG.md
- Added: Add user manga notes (@imkunet, @AntsyLich) (#428)
- app/build.gradle.kts
- Added implementation(libs.richeditor.compose) to include the rich text editor library.
- app/src/main/java/eu/kanade/domain/DomainModule.kt
- Added UpdateMangaNotes interactor to the DomainModule.
- app/src/main/java/eu/kanade/presentation/manga/MangaNotesScreen.kt
- Created a new composable screen for editing manga notes.
- app/src/main/java/eu/kanade/presentation/manga/MangaScreen.kt
- Added a button to navigate to the MangaNotesScreen.
- app/src/main/java/eu/kanade/presentation/manga/components/MangaInfoHeader.kt
- Added notes to the expandable manga description and an edit button.
- app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesDisplay.kt
- Created a composable to display the manga notes using a rich text view.
- app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesSection.kt
- Created a composable section to display notes with an edit button.
- app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesTextArea.kt
- Created a composable text area for editing manga notes with formatting options.
- app/src/main/java/eu/kanade/presentation/manga/components/MangaToolbar.kt
- Added an overflow menu item for editing notes.
- data/src/main/java/tachiyomi/data/manga/MangaMapper.kt
- Added notes mapping to the MangaMapper.
- data/src/main/java/tachiyomi/data/manga/MangaRepositoryImpl.kt
- Added notes to the manga repository implementation.
- data/src/main/sqldelight/tachiyomi/data/mangas.sq
- Added notes column to the mangas table.
- data/src/main/sqldelight/tachiyomi/migrations/38.sqm
- Added a migration script to add the notes column.
- domain/src/main/java/tachiyomi/domain/manga/interactor/UpdateMangaNotes.kt
- Created an interactor to update manga notes.
- domain/src/main/java/tachiyomi/domain/manga/model/Manga.kt
- Added notes field to the Manga data class.
- domain/src/main/java/tachiyomi/domain/manga/model/MangaUpdate.kt
- Added notes field to the MangaUpdate data class.
- eu/kanade/tachiyomi/data/backup/create/creators/MangaBackupCreator.kt
- Added notes to the backup manga data.
- eu/kanade/tachiyomi/data/backup/models/BackupManga.kt
- Added notes field to the BackupManga data class.
- eu/kanade/tachiyomi/data/backup/restore/restorers/MangaRestorer.kt
- Restored notes during manga restore.
- eu/kanade/tachiyomi/ui/manga/MangaScreen.kt
- Added navigation to MangaNotesScreen.
- eu/kanade/tachiyomi/ui/manga/notes/MangaNotesScreen.kt
- Created a screen to manage and edit manga notes.
- i18n/src/commonMain/moko-resources/base/strings.xml
- Added string resources for notes functionality.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Trivia time!
What is Markdown, the format used for storing manga notes in this pull request?
Click here for the answer
Markdown is a lightweight markup language with plain text formatting syntax. It is designed to be easy to read and write, and it is often used for formatting readme files, writing messages in online forums, and creating rich text using a plain text editor.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new feature that allows users to add and edit personal notes for individual manga. The implementation involves adding a rich text editor, creating a new screen for editing notes, and adding a notes section to the manga details screen. Overall, the code seems well-structured and addresses the intended functionality. However, there are a few areas that could benefit from further review and potential improvements.
Summary of Findings
- Missing null check: In
MangaNotesSection.kt, theMangaNotesDisplaycomposable is called regardless of whether the content is blank. This could lead to unnecessary rendering and potential issues ifMangaNotesDisplaydoesn't handle empty content gracefully. A check for blank content before callingMangaNotesDisplaywould improve efficiency. - Potential performance issue with
animateContentSize: InMangaNotesDisplay.kt,animateContentSizeis used only whencontentUpdatedOnceis true. This might prevent the initial content from being animated. Consider whether the initial content should also be animated for a smoother user experience. - Inconsistent use of Modifier parameter: In
MangaNotesSection.kt, themodifierparameter is passed to both theColumnand theMangaNotesDisplaycomposables. This could lead to unexpected behavior if the modifiers conflict. It's generally better to apply modifiers to the outermost composable or to document clearly how the modifiers are intended to be used. - Hardcoded max length: In
MangaNotesTextArea.kt, theMAX_LENGTHconstant is hardcoded. Consider making this configurable or providing a way to adjust it based on user preferences or other factors.
Merge Readiness
The pull request introduces a valuable feature and is generally well-implemented. However, addressing the issues identified in the review comments, particularly the missing null check and potential performance issue, would improve the code's robustness and user experience. I am unable to approve this pull request, and recommend that others review and approve this code before merging. I recommend that the pull request not be merged until the high severity issues are addressed.
app/src/main/java/eu/kanade/presentation/manga/components/MangaInfoHeader.kt
Show resolved
Hide resolved
app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesSection.kt
Outdated
Show resolved
Hide resolved
app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesDisplay.kt
Show resolved
Hide resolved
app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesTextArea.kt
Show resolved
Hide resolved
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @cuong-tran - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a loading state or other visual indicator while the notes are being saved to avoid accidental data loss.
- The rich text editor is a great addition, but consider if it's adding a lot to the app size.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull Request Overview
This PR adds the user manga notes feature by updating documentation in the changelog.
- Document the new user manga notes feature in CHANGELOG.md
- Reference the new feature and its contributors in the update
Files not reviewed (19)
- app/build.gradle.kts: Language not supported
- app/src/main/java/eu/kanade/domain/DomainModule.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/MangaNotesScreen.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/MangaScreen.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/components/MangaInfoHeader.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesDisplay.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesSection.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesTextArea.kt: Language not supported
- app/src/main/java/eu/kanade/presentation/manga/components/MangaToolbar.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/data/backup/create/creators/MangaBackupCreator.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/data/backup/models/BackupManga.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/data/backup/restore/restorers/MangaRestorer.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/ui/browse/migration/MigrationFlags.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/ui/browse/migration/advanced/design/MigrationBottomSheetDialog.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/ui/browse/migration/advanced/process/MigrationListScreenModel.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/ui/manga/MangaScreen.kt: Language not supported
- app/src/main/java/eu/kanade/tachiyomi/ui/manga/notes/MangaNotesScreen.kt: Language not supported
- data/src/main/java/tachiyomi/data/manga/MangaMapper.kt: Language not supported
- data/src/main/java/tachiyomi/data/manga/MangaRepositoryImpl.kt: Language not supported
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Co-authored-by: AntsyLich [email protected]
(cherry picked from commit 8fbe630308b962043c7b59422878c94f80156e9f)
Summary by Sourcery
Add user manga notes feature, allowing users to add and edit personal notes for individual manga
New Features:
Enhancements: