Improve file size format handling. #67
Conversation
There was a problem hiding this comment.
Hello @wajid-h, 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 focuses on improving the way file sizes and speeds are formatted within the SaveHere application. The primary change involves refactoring the FormatSize and FormatSpeed methods in Helpers.cs to use an enum-based approach for better readability and maintainability. Additionally, a minor change was made in YtdlpService.cs to reorder an interface method.
Highlights
- File Size Formatting: The
FormatSizemethod inHelpers.cshas been refactored to use an enum (BufferSizeFormat) for defining size units (B, KB, MB, GB). This makes the code more readable and easier to extend with additional units in the future. - Speed Formatting: The
FormatSpeedmethod inHelpers.csnow reuses theFormatSizemethod and appends "/s" to the result, ensuring consistency in formatting. - Interface Method Reordering: The
GetExecutablePathmethod inIYtdlpServiceinterface has been moved aboveGetSupportedSitesFilePathfor better organization.
Changelog
- SaveHere/SaveHere/Helpers/Helpers.cs
- Introduced
BufferSizeFormatenum to represent file size units. - Refactored
FormatSizemethod to use theBufferSizeFormatenum for formatting. - Modified
FormatSpeedmethod to reuseFormatSizeand append "/s".
- Introduced
- SaveHere/SaveHere/Services/YtdlpService.cs
- Reordered
GetExecutablePathmethod inIYtdlpServiceinterface.
- Reordered
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.
A byte's a byte, that much is true,
But sizes grow, for me and you.
With KB, MB, GB's might,
Formatting code shines ever so bright,
And readability improves for the coder too.
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
The pull request improves the handling of file size formats by introducing an enum for buffer sizes and a more streamlined FormatSize function. This change enhances readability and maintainability. Additionally, a minor change was made in YtdlpService.cs to adjust the spacing of a method declaration.
Summary of Findings
- Code Duplication: The original code had duplicated logic for formatting file sizes and speeds. The refactoring eliminates this duplication by creating a single
FormatSizefunction and reusing it forFormatSpeed. - Readability and Maintainability: The introduction of the
BufferSizeFormatenum and the use of aforeachloop inFormatSizeimproves the readability and maintainability of the code compared to the original nestedif-elsestatements.
Merge Readiness
The code changes are well-structured and improve the codebase. I recommend merging this pull request after addressing the identified issue.
| { | ||
| public static string FormatSpeed(double speed) | ||
| { | ||
| enum BufferSizeFormat |
There was a problem hiding this comment.
UX Recommendation: Its better to use a step of 1000 for KB/MB/GB instead of 1024, recommend switching MiB KiB etc for a step of 1024
No description provided.