**This PR implements the Download Quran feature for issue #1109
Description
This pull request adds the Download Quran feature to the app. The feature allows users to check for updates to the Quran content and download the latest version if available. The implementation follows the business logic and handles various edge cases to ensure a smooth and reliable download process.
Key components of the feature:
DownloadQuranNotifier: Manages the state of the download process and handles the business logic for checking updates, downloading, extracting, and cleaning up.
DownloadQuranRemoteDataSource: Interacts with the remote server to fetch the remote Quran version and download the Quran ZIP file.
DownloadQuranLocalDataSource: Handles local file operations such as saving SVG files, deleting existing files, extracting the ZIP file, and creating directories.
Custom exception classes (QuranException, CancelDownloadException, etc.) to handle specific error scenarios.
The feature includes the following flow:
Check for Quran Update: Compares the local and remote Quran versions to determine if an update is available.
Download Quran: If an update is available and the user chooses to download, the Quran ZIP file is downloaded from the remote server.
Extract Quran: After the download is complete, the ZIP file is extracted, and the old Quran files are deleted.
Cleanup: The downloaded ZIP file is deleted, and the local Quran version is updated.
Error Handling: Various error scenarios are handled gracefully, with appropriate error messages displayed to the user.
Cancellation: The user can cancel the download process at any time, and the app will clean up any incomplete downloads.
The implementation ensures a reliable and user-friendly download experience for updating the Quran content within the app.
Tests
🧪 Use case 1
💬 Description:
Launch the app and navigate to the Quran download screen.
Check for an available Quran update.
If an update is available, choose to download the update.
Verify that the download progress is displayed correctly.
Wait for the download and extraction process to complete.
Verify that the user is notified of the successful update.
Access the updated Quran content within the app and ensure it matches the latest version.
📷 Screenshots or GIFs (if applicable):
[Attach relevant screenshots or GIFs showcasing the feature in action]
🧪 Use case 2
💬 Description:
Launch the app and navigate to the Quran download screen.
Check for an available Quran update.
If an update is available, choose to download the update.
While the download is in progress, cancel the download.
Verify that the download is stopped, and any partially downloaded files are cleaned up.
Verify that the user is notified that the download has been cancelled.
📷 Screenshots or GIFs (if applicable):
[Attach relevant screenshots or GIFs showcasing the cancellation scenario]
Checklist:
[x] Coding Standards: I have reviewed my code to ensure it follows the project's coding standards.
[x] Testing: I have tested the changes and they work as expected.
[x] Merge Conflicts: I have resolved any merge conflicts with the latest main/development branch.
[x] Branch Status: The branch is up-to-date with the target branch (main/development).
YassinNouh21
commented
3 weeks ago
📝 Summary
**This PR implements the Download Quran feature for issue #1109
Description
This pull request adds the Download Quran feature to the app. The feature allows users to check for updates to the Quran content and download the latest version if available. The implementation follows the business logic and handles various edge cases to ensure a smooth and reliable download process.
Key components of the feature:
DownloadQuranNotifier: Manages the state of the download process and handles the business logic for checking updates, downloading, extracting, and cleaning up.DownloadQuranRemoteDataSource: Interacts with the remote server to fetch the remote Quran version and download the Quran ZIP file.DownloadQuranLocalDataSource: Handles local file operations such as saving SVG files, deleting existing files, extracting the ZIP file, and creating directories.QuranException,CancelDownloadException, etc.) to handle specific error scenarios.The feature includes the following flow:
The implementation ensures a reliable and user-friendly download experience for updating the Quran content within the app.
Tests
🧪 Use case 1
💬 Description:
📷 Screenshots or GIFs (if applicable): [Attach relevant screenshots or GIFs showcasing the feature in action]
🧪 Use case 2
💬 Description:
📷 Screenshots or GIFs (if applicable): [Attach relevant screenshots or GIFs showcasing the cancellation scenario]
Checklist: