Refactor seller registration to enable bypassing nonce verification

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)

Full PR Link

Closes

Closes #2279

How to test the changes in this Pull Request:

Steps or issue link

Changelog entry

Enable to bypass the nonce verification

Verify nonce through method call which enable third-party developers to override the nonce check if necessary.

Bypass nonce: add_filter( 'dokan_register_nonce_check', '__return_false' );

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

Documentation
- Added detailed Test-Driven Development (TDD) guidelines in the new docs/tdd/readme.md.
- Introduced docs/tdd/factories.md for efficient test data creation using factory classes.
Refactor
- Centralized nonce validation logic in the registration process for enhanced code maintainability.
New Features
- Implemented comprehensive test factories for orders, customers, sellers, products, and coupons to streamline unit testing.
- Introduced helper classes for managing WooCommerce coupons, customers, and orders in tests.
- Added methods in DokanTestCase for fixture creation and database assertions.
Tests
- Enhanced PHPUnit configuration for better test management.
- Introduced multiple new test classes and methods to assert various functionalities in the Dokan plugin.

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The updates encompass enhancements mainly in test infrastructure and refinement of the registration process. Key additions include TDD documentation, efficient test data creation through factories, and refactored nonce validation logic. These changes aim to streamline testing and ensure robust, maintainable code, including crucial adjustments for integration with the Blocksy theme.

Changes

Files	Change Summary
`composer.json`	Updated PSR-4 autoload mappings and added scripts for running PHPUnit tests.
`docs/tdd/factories.md`, `docs/tdd/readme.md`	Added documentation on test data factories and TDD workflow.
`includes/Registration.php`	Refactored nonce validation logic by adding a centralized `validate_nonce` method and updated related methods.
`phpunit.xml`	Updated file paths in PHPUnit configuration.
`tests/php/DokanTestCase.php`	Introduced abstract class `DokanTestCase` with methods for creating fixtures and asserting database states.
`tests/php/CommissionTest.php`, `.../CustomFactoriesTest.php`	Updated namespaces, class names, and formatting for tests. Added `CustomFactoriesTest` class with methods for creating various test entities.
`tests/php/Factories/*.php`	Added new factories (e.g., `ProductFactory`, `OrderFactory`, `CouponFactory`, etc.) to facilitate creation and manipulation of test data objects.
`tests/php/Helpers/*.php`	Introduced new helper classes (e.g., `WC_Helper_Coupon`, `WC_Helper_Customer`, `WC_Helper_Order`) for managing WooCommerce entities in tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BlocksyTheme
    participant DokanRegistration

    User->>BlocksyTheme: Register using modal
    BlocksyTheme->>DokanRegistration: Initiate vendor registration
    DokanRegistration->>DokanRegistration: validate_nonce
    DokanRegistration->>DokanRegistration: set_new_vendor_names
    DokanRegistration->DokanRegistration: save_vendor_info
    DokanRegistration->>BlocksyTheme: Registration success response
    BlocksyTheme->>User: Vendor registered

Assessment against linked issues

Objective	Addressed	Explanation
Add hook `dokan_register_nonce_check` to `set_new_vendor_names` and `save_vendor_info` (#2279)	✅

Amidst the code and tests, lines did appear,
A rabbit worked hard, with focus so clear. 🐇
Factories sprouted, to ease the dev’s plight,
Ensuring code's sturdy, in day or in night.
Dokan now stronger, with nonce safe and sound,
Bugs bounced away, in tests they were found.

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?

- [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 .` - `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](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.

getdokan / dokan