Separate plugin functionality into separate classes #3
Conversation
This file contains 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
Adding tests as a pre-cursor to refactoring classes to meet SRP. Tests are implemented using the latest PHPUnit version (9.5.x) and can be run as follows: From the plugin root folder, first install dependencies with composer, ie "composer install". The install the WP tests based on the following command. `bin/install-wp-tests.sh <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]`. For example, `bin/install-wp-tests.sh wordpress_tests root root localhost latest` should work. Use the following to run all tests: `vendor/bin/phpunit --testsuite tests`
This commit helps to separate functionality by separating the original class file into two separate files and classes, one for settings, and one for the output. Some additional code clean-up is included, such as removing the init type functions, such as add_actions, out of the construct. Also added some extended factory code for supporting the job_listing CPT for future integration testing.
The previous commit was missing an "add_option" in the set_up() for unit tests. This commit adds the option, fixed the tests to check for the default value, then deletes the option in the tear_down() method.
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.
Purpose for this PR:
This PR is intended to capture changes to the plugin's structure to follow WordPress best practices. No plugin functionality changes are included. In order to ensure the refactoring doesn't introduce errors, unit tests are also introduced to check functionality remains as intended.
Changes:
job_listingCPT, borrowed from WP Job Manager, tweaked tests, and the restructure of the main class into two separate classes. One class handles the settings, and the other the output.Still to be added:
Unit Testing:
composer installto include the PHPUnit dependencies../bin/install-wp-tests.sh <database-name> <database-user> <database-password> [<database-host>]. Example:./bin/install-wp-tests.sh wordpress_tests root root localhost latest, noting your user and password may depend on your local sql credentials.vendor/bin/phpunit --testsuite tests.