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

fix(email-template): missing attribute #2487

Merged
merged 1 commit into from
Jan 3, 2025
Merged

Conversation

kzamanbd
Copy link
Contributor

@kzamanbd kzamanbd commented Dec 19, 2024

withdraw approval template
product publish template

All Submissions:

  • My code follow the WordPress' coding standards
  • My code satisfies feature requirements
  • My code is tested
  • My code passes the PHPCS tests
  • My code has proper inline documentation
  • I've included related pull request(s) (optional)
  • I've included developer documentation (optional)
  • I've added proper labels to this pull request

Changes proposed in this Pull Request:

Related Pull Request(s)

Closes

  • Closes #

How to test the changes in this Pull Request:

  • Steps or issue link

Changelog entry

  1. withdraw approved email template decimal format amount

Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

  • Code is not following code style guidelines
  • Bad naming: make sure you would understand your code if you read it a few months from now.
  • KISS: Keep it simple, Sweetie (not stupid!).
  • DRY: Don't Repeat Yourself.
  • Code that is not readable: too many nested 'if's are a bad sign.
  • Performance issues
  • Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
  • Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

  • Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
  • Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
  • Readable — Will your future self be able to understand this change months down the road?
  • Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

  • New Features

    • Enhanced formatting for withdrawal amount in email notifications.
    • Updated email template for product approval notifications to improve message formatting.
  • Bug Fixes

    • Corrected spacing in the product approval message to ensure proper display in emails.

withdraw approval template
product publish template
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request includes two minor modifications: an update to the WithdrawApproved email class to improve amount formatting, and a small formatting change in a product publication email template. The changes are focused on improving email content presentation and ensuring proper decimal formatting for withdrawal amounts.

Changes

File Change Summary
includes/Emails/WithdrawApproved.php Modified trigger method to use wc_format_decimal for formatting withdrawal amount in email placeholders
templates/emails/plain/product-published.php Added a leading space before the product approval message in the email template

Suggested Labels

QA approved, :+1: Dev Review Done, Upcoming Release

Suggested Reviewers

  • shohag121
  • mrabbani

Poem

🐰 A rabbit's tale of emails bright,
Formatting with decimal might!
A space, a decimal, small delight,
Emails polished, shining light!
Hop, hop, hooray! 🎉


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 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.

@kzamanbd kzamanbd requested a review from mrabbani December 19, 2024 04:02
Copy link
Contributor

@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)
includes/Emails/WithdrawApproved.php (1)

84-87: Consider adding defensive programming checks.

While the implementation is solid, consider adding validation for edge cases:

  1. Null amount handling
  2. Negative amount validation
  3. Currency compatibility checks

Example implementation:

-        $amount = wc_format_decimal( $withdraw->get_amount(), false, true );
+        $raw_amount = $withdraw->get_amount();
+        if ( $raw_amount === null || $raw_amount < 0 ) {
+            $amount = 0;
+        } else {
+            $amount = wc_format_decimal( $raw_amount, false, true );
+        }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 02d4fe1 and c7fc197.

📒 Files selected for processing (2)
  • includes/Emails/WithdrawApproved.php (1 hunks)
  • templates/emails/plain/product-published.php (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • templates/emails/plain/product-published.php
🔇 Additional comments (2)
includes/Emails/WithdrawApproved.php (2)

84-84: LGTM! Proper use of WooCommerce's decimal formatting.

The wc_format_decimal() function is appropriately used with correct parameters to ensure consistent decimal formatting.

Let's verify the formatting works correctly across different currency configurations:

✅ Verification successful

Based on the search results, I can see that the codebase properly handles currency formatting across different configurations:

  1. The system respects WooCommerce's currency settings including decimal points (woocommerce_price_num_decimals), currency position, and separators.
  2. The wc_format_decimal() function used in the withdrawal email is consistent with how currency amounts are formatted elsewhere in the codebase.
  3. The codebase properly handles currency symbols and formatting through WooCommerce's standard functions.

✓ The decimal formatting implementation is correct and consistent with the codebase's currency handling

The wc_format_decimal() usage in WithdrawApproved.php aligns with WooCommerce's currency formatting standards and will work correctly across different currency configurations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any custom currency formatting that might affect this change
rg -A 3 "woocommerce_price_num_decimals|woocommerce_currency" --type php

Length of output: 12678


87-87: LGTM! Proper currency symbol application.

The chain of formatting (decimal formatting followed by currency symbol application) ensures proper display of the withdrawal amount.

Let's verify the currency symbol application:

✅ Verification successful

LGTM! Currency symbol implementation is correctly used.

The verification shows that the currency_symbol() method is properly implemented in includes/Emails/Manager.php and is consistently used across various email templates. The implementation:

  • Uses WooCommerce's standard currency formatting
  • Properly handles HTML entities for symbol display
  • Is used consistently across all withdrawal and product-related emails
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any custom currency symbol implementations that might affect this
ast-grep --pattern 'class Email {
  $$$
  currency_symbol($$$) {
    $$$
  }
  $$$
}'

Length of output: 87


Script:

#!/bin/bash
# Let's try a broader search for currency_symbol method and its implementations
rg -A 5 "currency_symbol" --type php

# Also search for Email class definition
rg -A 10 "class Email" --type php

# Look for any files that might contain currency symbol related code
fd -e php -x grep -l "currency"

Length of output: 22453

@kzamanbd kzamanbd added Needs: Testing This requires further testing Needs: Dev Review It requires a developer review and approval labels Dec 24, 2024
@kzamanbd kzamanbd self-assigned this Dec 24, 2024
@mrabbani mrabbani added 👍 Dev Review Done and removed Needs: Dev Review It requires a developer review and approval labels Dec 24, 2024
@shashwatahalder01 shashwatahalder01 added QA In Progress QA approved This PR is approved by the QA team and removed Needs: Testing This requires further testing QA In Progress labels Jan 2, 2025
@Aunshon Aunshon merged commit de5c7a1 into develop Jan 3, 2025
1 of 2 checks passed
@mrabbani mrabbani deleted the update/email-template branch January 27, 2025 07:59
@coderabbitai coderabbitai bot mentioned this pull request Jan 27, 2025
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants