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: updates main WCPDF class #15

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

alexmigf
Copy link

@alexmigf alexmigf commented Sep 25, 2024

Summary by CodeRabbit

  • New Features
    • Updated dependency checks for WooCommerce PDF Invoices to align with the new naming convention.
  • Bug Fixes
    • Ensured compatibility with the updated class name for the PDF Invoices dependency.

Copy link

coderabbitai bot commented Sep 25, 2024

Walkthrough

The changes involve updates to the dokan-invoice.php file, specifically in the constructor and the init_hooks method. The key for the WooCommerce PDF Invoices dependency has been renamed from 'woocommerce_pdf_invoices' to 'wpo_wcpdf'. Correspondingly, the class existence check has been modified from WooCommerce_PDF_Invoices to WPO_WCPDF. The notice messages remain unchanged but are now linked to the new keys, maintaining the overall structure and logic of the code.

Changes

File Change Summary
.../dokan-invoice.php Updated dependency key from 'woocommerce_pdf_invoices' to 'wpo_wcpdf'. Class check modified from WooCommerce_PDF_Invoices to WPO_WCPDF. Notice messages remain unchanged.

Poem

In the code where rabbits play,
Dependencies change in a clever way.
From woocommerce to wpo,
The logic still flows,
Hopping along, we greet the day! 🐇✨


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.

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

🧹 Outside diff range and nitpick comments (2)
dokan-invoice.php (2)

80-82: LGTM! Consider updating the plugin name in the notice message.

The dependency update from 'woocommerce_pdf_invoices' to 'wpo_wcpdf' is correct and consistent with the changes mentioned in the summary. This change likely reflects an update in the WooCommerce PDF Invoices plugin's naming convention.

Consider updating the plugin name in the notice message to match the new naming convention:

- 'notice' => sprintf( __( '<b>Dokan PDF Invoice </b> requires %sWooCommerce PDF Invoices & packing slips plugin%s to be installed & activated!' , 'dokan-invoice' ), '<a target="_blank" href="https://wordpress.org/plugins/woocommerce-pdf-invoices-packing-slips/">', '</a>' ),
+ 'notice' => sprintf( __( '<b>Dokan PDF Invoice </b> requires %sWPO WCPDF plugin%s to be installed & activated!' , 'dokan-invoice' ), '<a target="_blank" href="https://wordpress.org/plugins/woocommerce-pdf-invoices-packing-slips/">', '</a>' ),

Line range hint 339-350: LGTM! Consider using consistent method calls for improved readability.

The updates to the get_order_id_parent_id method are good improvements. They modernize the code to use newer WooCommerce methods, which enhances compatibility with recent WooCommerce versions.

For consistency and improved readability, consider using the same method call style for both get_id() and get_parent_id():

- $order_id  = $order->get_id();
- $parent_id = $order->get_parent_id();
+ $order_id  = $order->get_id();
+ $parent_id = $order->get_parent_id();

This makes the code more uniform and easier to read.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fd76a67 and d301fee.

📒 Files selected for processing (1)
  • dokan-invoice.php (2 hunks)
🔇 Additional comments not posted (2)
dokan-invoice.php (2)

164-165: LGTM! Class check updated correctly.

The update to the class existence check from 'WooCommerce_PDF_Invoices' to 'WPO_WCPDF' is correct and consistent with the changes in the constructor. This ensures that the plugin's hooks are only initialized when the WPO WCPDF plugin is active.


Line range hint 1-365: Overall, the changes in this file are well-implemented and necessary.

The updates to the dependency checks and method implementations improve compatibility with newer versions of WooCommerce and the WPO WCPDF plugin. The code quality has been maintained, and in some cases improved. The minor suggestions provided in the review comments will further enhance consistency and clarity.

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.

1 participant