docs: document using Smooth Generator in PHPUnit tests - #218
Open
faisalahammad wants to merge 1 commit into
Open
docs: document using Smooth Generator in PHPUnit tests#218faisalahammad wants to merge 1 commit into
faisalahammad wants to merge 1 commit into
Conversation
Add docs/using-in-phpunit.md with prerequisites, per-generator code examples, return-value handling, and gotchas for calling generators from a PHPUnit test suite. Link it from the README. Closes woocommerce#151
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
All Submissions:
Changes proposed in this Pull Request:
Adds documentation on using Smooth Generator inside PHPUnit tests, addressing issue #151. The generators are already callable as static methods (
Product::generate(),Product::batch(),Router::generate_batch()) and the plugin's own test suite uses them this way, but there was no guidance for extension developers who want the same in their own suites.New file
docs/using-in-phpunit.mdcovers: prerequisites (WP + WooCommerce bootstrapped, plugin loaded), a quick start, per-generator code examples (products, orders, customers, coupons, bookings, terms, router), return-value and assertion patterns, thesmoothgenerator_*_generatedaction hooks, and gotchas (batch counts can be shorter than requested, Term's positional taxonomy argument, orders need products, bookings need WC Bookings, no image-disable flag, 100 batch cap, emails auto-disabled). The README links to it.Closes #151.
How to test the changes in this Pull Request:
docs/using-in-phpunit.md.includes/Generator/*.phpandincludes/Router.php.WP_UnitTestCasethat boots WooCommerce and run it.Other information:
composer phpcspasses for changed content.)Changelog entry
Add documentation for using Smooth Generator inside PHPUnit tests.
FOR PR REVIEWER ONLY: