Enhance percentage formatting in Postman badge generation

[guibranco]

Description

• Improved the display of percentage values in badges by formatting them to two decimal places.
• Added a condition to prefix percentages less than 10% with a leading zero for better readability.

---

Changes walkthrough 📝

	Relevant files
Enhancement	Postman.php Enhance badge percentage formatting in Postman.php              src/Library/Postman.php Added formatting for percentage display in badge. Ensured percentages below 10% are prefixed with a zero. +6/-1

Summary by CodeRabbit

• New Features

  • Improved formatting of percentage display in badge URLs for better readability, ensuring consistent two-digit representation.

• Bug Fixes

  • Enhanced visual representation for percentages below 10%, now displayed as "0X.XX%".

[coderabbitai[bot]]

Walkthrough

The changes in the pull request focus on the getImageUsage function within the Postman.php file. The modification enhances the formatting of the percentage string used for badge generation. A new variable, $percentageStr, is introduced to format the percentage to two decimal places, ensuring consistent display, especially for values below 10%. The overall functionality remains unchanged, but the output format for the badge URL is improved.

Changes

File	Change Summary
Src/Library/Postman.php	Modified the getImageUsage function to introduce a variable for formatting the percentage string, ensuring consistent two-digit display for badge URLs.

Possibly related PRs

• 512: The changes in this PR also involve the getImageUsage function in Postman.php, which relates directly to the modifications made in the main PR regarding how the percentage string is formatted for badge generation.

Suggested labels

Review effort [1-5]: 4, size/M

Poem

In the land of code where rabbits play,
A badge shines bright, in a new display.
With numbers neat, and zeros in line,
Our percentages dance, oh how they shine!
Hopping through changes, we celebrate cheer,
For clearer outputs, we hold dear! 🐇✨

---

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 26f9b2132d94cc7650b2125a9d964621bd3e4a88 and 9d143fc7c322e01073647618b84b8dfd9ad3f47c.

Files selected for processing (1)

* Src/Library/Postman.php (1 hunks)

Additional comments not posted (1)

Src/Library/Postman.php (1)

`67-73`: **LGTM!** The changes made to format the percentage string before generating the badge URL are an improvement. The percentage is now consistently displayed with two decimal places, a percentage sign, and a leading zero for values below 10%. This enhances the visual representation of the percentage in the badge without affecting the overall functionality.

--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` -- `@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 generate interesting stats about this repository and render them as a table.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[penify-dev[bot]]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and primarily involve formatting, which is not complex.
🧪 Relevant tests	No
⚡ Possible issues	No
🔒 Security concerns	No

[penify-dev[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Validate the percentage value to ensure it is numeric before formatting ___ **Ensure that $percentage is validated to be a numeric value before formatting to prevent potential errors.** [Src/Library/Postman.php [67]](https://github.com/guibranco/projects-monitor/pull/519/files#diff-bc79bac405fa0cdab6162060ae374cf2697e5ee0783a73dfe4fde7914795712cR67-R67) ```diff +if (!is_numeric($percentage)) { $percentage = 0; } $percentageStr = number_format($percentage, 2, '.', '')."%"; ``` Suggestion importance[1-10]: 8 Why: Validating `$percentage` is important to prevent runtime errors, making this a significant improvement in code robustness.	8
Maintainability	Improve variable naming for clarity ___ **Consider using a more descriptive variable name for $percentageStr to enhance code readability and maintainability.** [Src/Library/Postman.php [67]](https://github.com/guibranco/projects-monitor/pull/519/files#diff-bc79bac405fa0cdab6162060ae374cf2697e5ee0783a73dfe4fde7914795712cR67-R67) ```diff -$percentageStr = number_format($percentage, 2, '.', '')."%"; +$formattedPercentage = number_format($percentage, 2, '.', '')."%"; ``` Suggestion importance[1-10]: 7 Why: While the suggestion improves readability, the original variable name is not critically misleading, making this a minor enhancement.	7
Enhancement	Simplify the percentage string assignment using a ternary operator ___ **Consider using a ternary operator for setting `$percentageStr` to streamline the code.** [Src/Library/Postman.php [67-70]](https://github.com/guibranco/projects-monitor/pull/519/files#diff-bc79bac405fa0cdab6162060ae374cf2697e5ee0783a73dfe4fde7914795712cR67-R70) ```diff -$percentageStr = number_format($percentage, 2, '.', '')."%"; -if ($percentage < 10) { - $percentageStr = "0" . $percentageStr; -} +$percentageStr = ($percentage < 10) ? "0" . number_format($percentage, 2, '.', '')."%" : number_format($percentage, 2, '.', '')."%"; ``` Suggestion importance[1-10]: 6 Why: The ternary operator can simplify the code, but the current implementation is clear and readable, making this a minor enhancement.	6
Best practice	Use a built-in function for padding the percentage string ___ **Instead of concatenating "0" to the percentage string, consider using str_pad for better readability and functionality.** [Src/Library/Postman.php [69]](https://github.com/guibranco/projects-monitor/pull/519/files#diff-bc79bac405fa0cdab6162060ae374cf2697e5ee0783a73dfe4fde7914795712cR69-R69) ```diff -$percentageStr = "0" . $percentageStr; +$percentageStr = str_pad($percentageStr, 5, "0", STR_PAD_LEFT); ``` Suggestion importance[1-10]: 5 Why: This suggestion offers a more elegant solution, but the current method is straightforward and functional, making this a moderate improvement.	5

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions[bot]]

Infisical secrets check: :white_check_mark: No secrets leaked!

Scan results:

8:46PM INF scanning for exposed secrets...
8:46PM INF 470 commits scanned.
8:46PM INF scan completed in 207ms
8:46PM INF no leaks found

[github-actions[bot]]

:rocket: Postman tests are disabled

:x: The Postman collection run is disabled.

[github-actions[bot]]

:test_tube: Request tests summary

:white_check_mark: All test requests succeeded

[github-actions[bot]]

:mag: Database integrity summary

:white_check_mark: The database integrity check succeeded

[github-actions[bot]]

:fire_engine: Smoke tests summary

:fire: Smoke tests passed!