Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render currency symbol correctly in Boilerplate (#9752) #9753

Conversation

msynk
Copy link
Member

@msynk msynk commented Jan 30, 2025

closes #9752

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced product price formatting with support for multilingual and right-to-left language display
    • Added dynamic price representation across product pages
  • Improvements

    • Introduced modular code structure for handling different application modules
    • Centralized price formatting logic in the ProductDto
  • Technical Updates

    • Implemented conditional compilation for module-specific functionality
    • Updated product display components to use new FormattedPrice property

@msynk msynk requested a review from ysmoradi January 30, 2025 13:58
Copy link

coderabbitai bot commented Jan 30, 2025

Walkthrough

The pull request introduces changes to how product prices are displayed and formatted across multiple components in the Boilerplate project. The modifications centralize price formatting logic within the ProductDto class by adding a new FormattedPrice property. This property dynamically formats prices based on culture settings, addressing potential rendering issues with currency symbols. The changes affect the HomePage and ProductPage components, replacing direct price formatting with the new pre-formatted property.

Changes

File Change Summary
src/Client/Boilerplate.Client.Core/Components/Pages/HomePage.razor Replaced price formatting with FormattedPrice in carousel and infinite scrolling product displays
src/Client/Boilerplate.Client.Core/Components/Pages/HomePage.razor.cs Added conditional compilation for Sales module, introduced methods for loading products
src/Client/Boilerplate.Client.Core/Components/Pages/ProductPage.razor Replaced direct price formatting with FormattedPrice for product and related product displays
src/Shared/Dtos/Products/ProductDto.cs Added FormattedPrice property and FormatPrice() method for dynamic price formatting

Assessment against linked issues

Objective Addressed Explanation
Correct currency symbol rendering [#9752]
Handle multilingual and invariant culture price formatting

Poem

🐰 A rabbit's tale of pricing might,
Where symbols dance with pure delight,
Cultures blend in code so neat,
Formatting prices, a technical feat!
Hop along, currency clear and bright! 💰


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Dtos/Products/ProductDto.cs (1)

43-53: Enhance price formatting robustness and documentation.

The current implementation has room for improvement:

  1. Add XML documentation for maintainability.
  2. Handle negative and zero prices consistently.
  3. Preserve decimal precision in non-multilingual case.

Consider this enhanced implementation:

+    /// <summary>
+    /// Formats the price based on culture settings and multilingual support.
+    /// For RTL cultures, places the currency symbol after the amount.
+    /// For LTR cultures, uses the culture's default currency format.
+    /// </summary>
+    /// <returns>A formatted price string with appropriate currency symbol placement.</returns>
     private string FormatPrice()
     {
         if (CultureInfoManager.MultilingualEnabled)
         {
             return CultureInfo.CurrentCulture.TextInfo.IsRightToLeft
-                    ? $"{Price:N0} {CultureInfo.CurrentCulture.NumberFormat.CurrencySymbol}"
+                    ? $"{(Price >= 0 ? "" : "-")}{Math.Abs(Price):N2} {CultureInfo.CurrentCulture.NumberFormat.CurrencySymbol}"
                     : Price.ToString("C");
         }

-        return Price.ToString("N0");
+        return Price.ToString("N2");
     }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9627d92 and 3d29e01.

📒 Files selected for processing (4)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/HomePage.razor (2 hunks)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/HomePage.razor.cs (1 hunks)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/ProductPage.razor (3 hunks)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Dtos/Products/ProductDto.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build and test
🔇 Additional comments (4)
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Dtos/Products/ProductDto.cs (1)

41-41: LGTM! Clean property implementation.

The read-only property with delegation to a private method follows good design practices.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/HomePage.razor.cs (1)

5-7: LGTM! Conditional compilation is correctly implemented.

The module-specific imports are properly wrapped in conditional compilation directives.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/ProductPage.razor (1)

24-24: LGTM! Consistent price formatting across all product displays.

The changes uniformly apply the new FormattedPrice property, ensuring consistent currency display throughout the page.

Also applies to: 98-98, 144-144

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/HomePage.razor (1)

38-38: LGTM! Consistent price formatting across all product displays.

The changes uniformly apply the new FormattedPrice property, ensuring consistent currency display throughout the page.

Also applies to: 56-56

@ysmoradi ysmoradi merged commit c594106 into bitfoundation:develop Jan 30, 2025
3 checks passed
@msynk msynk deleted the 9752-templates-boilerplate-incorrect-corrency-symbol branch January 30, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The currency symbol is not getting rendered correctly in the Boilerplate project template
2 participants