Read summary feature

[rygelouv]

---

🚀 Description

• New Files Added

  • The team introduced several new files for refining user interface, navigation logic, and font configuration. They also prepared some elements for future test cases.
  • Relevant new files include ReadFontScaleChooserTest.kt and ReadSummaryScreenTest.kt for testing purposes, FileDownloader.kt and Storage.kt for better file handling, and ReadSummaryContainer.kt for UI management. They also added UI logic (ReadSummaryScreen.kt), navigation logic (ReadSummaryNavigation.kt), UI state contracts (ReadSummaryUiContract.kt), and functional implementation (SummaryBehaviorDelegate.kt).
  • Additionally, new visual elements and animations were introduced (DotsAnimation.kt, MarkdownText.kt) and the system's ability to hide system bars (SystemBarsVisibility.kt).
  • Moreover, to deal with Markdown parsing and rendering, MarkdownParser.kt was added.

• File Renaming

  • The team rearranged the repository for a clearer structure. There were several renaming activities but these don't induce any changes in the code.

• Modifications

  • The team adjusted several files to include new functionalities and UI improvements. Significant updates were made to SummaryNavigation.kt, SummaryUi.kt and SummaryDetailsScreen.kt to expand their functionality.
  • They also improved button visual appearance in SummaryDetailsSaveButton.kt and added more detailed navigation in MainNavigationGraph.kt.
  • Other changes include the way string concatenation is done (seen in SummariesByCategoryNavigation.kt) for cleaner code and better readability.

• Further Support for the Updates

  • Necessary alterations were made in associated testing and dependency files to support the new features (ReadSummaryViewModelTest.kt, MarkdownParserTest.kt, core-ui/build.gradle.kts).
  • Additional resources and images for the user interface were also added (diving_dark_blue.gif, font_size.xml).

• New Dependency

  • To facilitate Markdown rendering, a new dependency for the CommonMark Markdown library was also introduced in libs.versions.toml.

Please note that some additional test files were created to ensure the robustness of the newly added/existing features which might go unnoticeable to end-users but contribute to the overall stability and reliability of the application.

🖼 Screenshots/Videos (if applicable)

📦 Dependencies

• Added new dependencies? List:
• Updated existing?

🧪 Testing

Describe the steps to reproduce:

📱 Checklist

• Tested on all supported devices and OS versions
• UI/UX conforms to project design guidelines
• Unit/integration tests added
• Relevant documentation updated (e.g., README, Wiki, etc.)
• Checked linter on local.

---

[what-the-diff]

Warning
What The Diff skipped summarizing this PR.

The estimated token count of your changes is 36,668.
Your configured maximum tokens per PR is 30,000.

Login to change the settings, or manually trigger a comment here.

[github-actions]

PR automatically approved by auto-approve-action

[codecov]

Codecov Report

Attention: 327 lines in your changes are missing coverage. Please review.

Comparison is base (7335e02) 42.65% compared to head (34d2ef6) 43.68%.

Files	Patch %	Lines
.../app/books/tanga/feature/read/ReadSummaryScreen.kt	48.85%	66 Missing and 23 partials ⚠️
...s/tanga/feature/summary/SummaryBehaviorDelegate.kt	47.05%	19 Missing and 17 partials ⚠️
...va/app/books/tanga/coreui/common/MarkdownParser.kt	62.22%	24 Missing and 10 partials ⚠️
...p/books/tanga/feature/read/ReadSummaryContainer.kt	0.00%	27 Missing ⚠️
.../books/tanga/feature/read/ReadSummaryNavigation.kt	0.00%	25 Missing ⚠️
...p/books/tanga/feature/read/ReadSummaryViewModel.kt	65.07%	15 Missing and 7 partials ⚠️
...ga/feature/read/components/ReadFontScaleChooser.kt	74.57%	8 Missing and 7 partials ⚠️
.../java/app/books/tanga/coreui/components/Buttons.kt	76.59%	1 Missing and 10 partials ⚠️
...ks/tanga/coreui/components/SystemBarsVisibility.kt	0.00%	9 Missing ⚠️
...va/app/books/tanga/feature/read/TextScaleFactor.kt	52.94%	5 Missing and 3 partials ⚠️
... and 16 more

Additional details and impacted files

@@             Coverage Diff              @@
##                dev      #94      +/-   ##
============================================
+ Coverage     42.65%   43.68%   +1.02%     
- Complexity       70       74       +4     
============================================
  Files           153      167      +14     
  Lines          5631     6272     +641     
  Branches        954     1087     +133     
============================================
+ Hits           2402     2740     +338     
- Misses         2781     3001     +220     
- Partials        448      531      +83     

Flag	Coverage Δ
uitests	33.12% <39.38%> (+0.68%)	⬆️
unittests	17.87% <23.80%> (+0.74%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

PR automatically approved by auto-approve-action

[sonarqubecloud]

Quality Gate failed

Failed conditions
5.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud