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

Support code added for min max module refactor #2164

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from

Conversation

aihimel
Copy link
Contributor

@aihimel aihimel commented Feb 7, 2024

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

How to test the changes in this Pull Request:

  • Steps or issue link

Changelog entry

Title

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 product listing with customizable columns for image, name, status, SKU, stock, price, type, views, and date using new action hooks.

Copy link

coderabbitai bot commented May 21, 2024

Walkthrough

The changes in templates/products/products-listing-row.php include the addition of do_action calls for various product columns such as image, name, status, SKU, stock, price, type, views, and date. This enhancement allows for greater flexibility and customization through hooks.

Changes

Files Change Summary
templates/products/products-listing-row.php Added do_action calls for product columns: image, name, status, SKU, stock, price, type, views, and date.

Assessment against linked issues

Objective Addressed Explanation
Admin should be able to enable Min-Max capabilities for vendors. (2652) The changes do not include functionality for enabling Min-Max capabilities.
Vendors should be able to set the Min-Max quantity for their products from the product edit page. (2652) The changes do not provide functionality for setting Min-Max quantities from the product edit page.
Vendors should be able to set the Min-Max amount from their store settings. (2652) The changes do not include the ability to set Min-Max amounts from the store settings.
The Min-Max quantity and amount set by the vendor should be reflected on the storefront when a customer places an order. (2652, 1732) The changes do not address reflecting Min-Max settings on the storefront.
The new system should allow combined amounts for minimum order amounts across multiple products. (1732) The changes do not address combining amounts for minimum order amounts across multiple products.

Poem

In the code, new hooks arise,
For products listed, a sweet surprise.
Columns now with actions bright,
Flexibility takes flight.
Though Min-Max waits another day,
Custom hooks have come to play.
🐇✨


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>.
    • 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 show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 (1)
templates/products/products-listing-row.php (1)

[!TIP]
Codebase Verification

The search results indicate multiple occurrences of the custom capability 'dokan_edit_product' across various files, but none of these instances show the capability being registered. This suggests that the capability might not be properly registered, which could lead to potential issues with permission checks.

  • templates/products/products-listing-row.php: Lines 48 and 54
  • includes/Rewrites.php: Line 46
  • includes/Product/functions.php: Line 46
  • includes/REST/ProductController.php: Line 46
  • includes/REST/ProductAttributeTermsController.php: Line 46
  • includes/REST/ProductAttributeController.php: Line 46
  • includes/Dashboard/Templates/Products.php: Line 46
  • includes/CatalogMode/Dashboard/ProductBulkEdit.php: Line 46
  • includes/Ajax.php: Line 46

Please ensure that the custom capability 'dokan_edit_product' is registered properly within the plugin.

Analysis chain

Line range hint 46-46: Verify the registration of the custom capability 'dokan_edit_product'.

Also applies to: 54-54

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the registration of the custom capability 'dokan_edit_product'.

# Test: Search for the capability registration. Expect: At least one occurrence.
rg --type php $'add_cap.*dokan_edit_product'

Length of output: 45



Script:

#!/bin/bash
# Description: Search for the usage of the custom capability 'dokan_edit_product' across the codebase.

# Test: Search for the capability string 'dokan_edit_product'. Expect: At least one occurrence.
rg --type php 'dokan_edit_product'

Length of output: 4550

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0c90ac8 and de9176c.
Files selected for processing (1)
  • templates/products/products-listing-row.php (7 hunks)
Additional Context Used
GitHub Check Runs (1)
Run PHPCS inspection success (6)

templates/products/products-listing-row.php: [warning] 46-46:
Found unknown capability "dokan_edit_product" in function call to current_user_can(). Please check the spelling of the capability. If this is a custom capability, please verify the capability is registered with WordPress via a call to WP_Role(s)->add_cap().
Custom capabilities can be made known to this sniff by setting the "custom_capabilities" property in the PHPCS ruleset.


templates/products/products-listing-row.php: [warning] 54-54:
Found unknown capability "dokan_edit_product" in function call to current_user_can(). Please check the spelling of the capability. If this is a custom capability, please verify the capability is registered with WordPress via a call to WP_Role(s)->add_cap().
Custom capabilities can be made known to this sniff by setting the "custom_capabilities" property in the PHPCS ruleset.

Additional comments not posted (9)
templates/products/products-listing-row.php (9)

51-51: Added do_action for the 'image' column enhances extensibility by allowing custom actions to be hooked at this point.


67-67: Added do_action for the 'name' column allows for additional customization specific to the product name display.


71-71: The do_action addition for the 'status' column is a good practice for allowing status-specific hooks.


84-84: Adding a do_action for the 'sku' column provides flexibility for developers to add custom functionality related to the SKU.


94-94: The do_action in the 'stock' column is useful for extending stock display functionalities.


104-104: Introduction of do_action in the 'price' column allows for dynamic modifications or additions to the price display.


127-127: The do_action for the 'type' column is a strategic addition for plugins that might want to extend the product type functionalities.


131-131: Adding do_action for the 'views' column enables custom actions based on the product views.


180-180: The do_action in the 'date' column is a beneficial addition for extending functionalities related to the product date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The min/max feature in Dashboard > Settings is incomplete and misleading
2 participants