diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f7c0249 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,27 @@ +# +# Exclude these files from release archives. +# +# This will also make the files unavailable when using Composer with `--prefer-dist`. +# If you develop using Composer, use `--prefer-source`. +# +# Via WPCS. +# +/phpcs.xml export-ignore +/phpunit.xml export-ignore +/.github export-ignore +/.php-cs-fixer.dist.php export-ignore +/tests export-ignore + +# +# Auto detect text files and perform LF normalization. +# +# http://davidlaing.com/2012/09/19/customise-your-gitattributes-to-become-a-git-ninja/ +# +* text=auto + +# +# The above will handle all files not found below. +# +*.md text +*.php text +*.inc text diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..544b9ad --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ +## Summary + +As titled. + +## Notes for reviewers + +None. + +## Changelog entries + +### Added + +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security diff --git a/.github/workflows/composer.yml b/.github/workflows/composer.yml new file mode 100644 index 0000000..0051ebf --- /dev/null +++ b/.github/workflows/composer.yml @@ -0,0 +1,31 @@ +name: Composer Validation + +on: + pull_request: + +jobs: + validate: + runs-on: ubuntu-latest + strategy: + fail-fast: true + matrix: + php: [8.1] + steps: + - name: Cancel previous runs of this workflow (pull requests only) + if: ${{ github.event_name == 'pull_request' }} + uses: styfle/cancel-workflow-action@0.5.0 + with: + access_token: ${{ github.token }} + + - name: Check out code + uses: actions/checkout@v3 + + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + tools: composer:v2 + coverage: none + + - name: Run Composer config validation + run: composer validate --strict diff --git a/.github/workflows/cs.yml b/.github/workflows/cs.yml new file mode 100644 index 0000000..11fd39a --- /dev/null +++ b/.github/workflows/cs.yml @@ -0,0 +1,41 @@ +name: Coding Standards + +on: + pull_request: + +jobs: + cs: + runs-on: ubuntu-latest + strategy: + fail-fast: true + matrix: + php: [7.4] + steps: + - name: Cancel previous runs of this workflow (pull requests only) + if: ${{ github.event_name == 'pull_request' }} + uses: styfle/cancel-workflow-action@0.5.0 + with: + access_token: ${{ github.token }} + + - name: Check out code + uses: actions/checkout@v3 + + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + tools: composer:v2 + coverage: none + + - name: Install composer dependencies + uses: nick-invision/retry@v1 + with: + timeout_minutes: 5 + max_attempts: 5 + command: composer install + + - name: Run PHPCS + run: composer run-script phpcs + + - name: Run PHP-CS-Fixer + run: vendor/bin/php-cs-fixer fix -v --dry-run --stop-on-violation --using-cache=no --allow-risky=yes diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..89c37b1 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,56 @@ +name: Tests + +on: + pull_request: + +jobs: + phpunit: + runs-on: ubuntu-latest + strategy: + fail-fast: true + matrix: + php: [8.1, 8.0, 7.4] + wp_version: ["latest"] + can_fail: [false] + multisite: [0,1] + services: + mysql: + image: mysql:5.7 + env: + MYSQL_ALLOW_EMPTY_PASSWORD: yes + ports: + - 3306:3306 + options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3 + continue-on-error: ${{ matrix.can_fail }} + + name: WordPress ${{ matrix.wp_version }} @ PHP ${{ matrix.php }} (WP_MULTISITE=${{ matrix.multisite }}) + env: + CACHEDIR: /tmp + WP_CORE_DIR: /tmp/wordpress + WP_VERSION: ${{ matrix.wp_version }} + WP_MULTISITE: ${{ matrix.multisite }} + WP_DB_HOST: 127.0.0.1 + WP_DB_USER: root + WP_DB_PASSWORD: '""' + + steps: + - name: Check out code + uses: actions/checkout@v3 + + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: json, mysqli, curl, dom, exif, fileinfo, hash, imagick, mbstring, openssl, pcre, xml, zip + tools: composer:v2 + coverage: none + + - name: Install Composer dependencies + uses: nick-invision/retry@v2 + with: + timeout_minutes: 5 + max_attempts: 5 + command: composer install + + - name: Run PHPUnit + run: composer run-script phpunit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f733455 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +vendor +composer.lock +.php_cs.cache +.phpunit.result.cache +.php-cs-fixer.cache diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..b3cb98d --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,36 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +$finder = PhpCsFixer\Finder::create()->in( + [ + __DIR__ . '/src/', + __DIR__ . '/tests/', + ] +); + +$config = new PhpCsFixer\Config(); +$config->setRules( + [ + '@PHP81Migration' => true, + // Enabled by '@PHP81Migration' but generates invalid spacing for WordPress. + 'method_argument_space' => false, + + 'final_class' => true, + 'native_constant_invocation' => true, + 'native_function_casing' => true, + 'native_function_invocation' => true, + 'native_function_type_declaration_casing' => true, + ] +); +$config->setFinder( $finder ); + +return $config; diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..03c1c05 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +This library adheres to [Semantic Versioning](https://semver.org/) and [Keep a CHANGELOG](https://keepachangelog.com/en/1.0.0/). + +## 1.0.0 + +Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e427b2f --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# Find One + +The `find_one()` family of functions are wrappers for common WordPress retrieval functions like `get_posts()` or `get_terms()` that reduce the return value of those retrieval functions into a single result. + +For example, to find one item in a `person` post type: + +```php + 'twitter', + 'meta_value' => '@potatomaster', + 'post_type' => 'person', + ] +); +``` + +which is equivalent to: + +```php + 'twitter', + 'meta_value' => '@potatomaster', + 'post_type' => 'person', + 'posts_per_page' => 1, + 'suppress_filters' => false, + ] +); + +if ( ! empty( $person[0] ) ) { + $person = $person[0]; +} +``` + +Taxonomy terms can be searched for similarly: + +```php + 'potatomaster', + 'taxonomy' => 'category', + ] +); +``` + +which is equivalent to: + +```php + 1, + 'slug' => 'potatomaster', + 'taxonomy' => 'category', + ] +); + +if ( ! empty( $category[0] ) ) { + $category = $category[0]; +} +``` + +The underlying `find_result()` function accepts the fully qualified class name of the object to search for and the array of query results: + +```php + + + PHP_CodeSniffer standard for Find One. + + src/ + tests/ + vendor/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + tests/ + + + + + diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..9807d5a --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,12 @@ + + + tests/Alley/WP/ + + diff --git a/src/Alley/WP/find-one.php b/src/Alley/WP/find-one.php new file mode 100644 index 0000000..fa6685c --- /dev/null +++ b/src/Alley/WP/find-one.php @@ -0,0 +1,119 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +namespace Alley\WP; + +/** + * Query for and return one post. + * + * @param array $args Query arguments. + * @return mixed|null A \WP_Post object, an alternate return type if requested + * in $args, or null. + */ +function find_one_post( array $args ) { + return find_result( + \WP_Post::class, + get_posts( // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.get_posts_get_posts + array_merge( + $args, + [ + 'posts_per_page' => 1, + 'suppress_filters' => false, + ] + ) + ) + ); +} + +/** + * Query for and return one term. + * + * @param array $args Query arguments. + * @return mixed|null A \WP_Term object, an alternate return type if requested + * in $args, or null. + */ +function find_one_term( array $args ) { + return find_result( + \WP_Term::class, + get_terms( + array_merge( + $args, + [ + 'number' => 1, + ] + ) + ) + ); +} + +/** + * Query for and return one comment. + * + * @param array $args Query arguments. + * @return mixed|null A \WP_Comment object, an alternate return type if + * requested in $args, or null. + */ +function find_one_comment( array $args ) { + return find_result( + \WP_Comment::class, + get_comments( + array_merge( + $args, + [ + 'number' => 1, + ] + ) + ) + ); +} + +/** + * Query for and return one user. + * + * @param array $args Query arguments. + * @return mixed|null A \WP_User object, an alternate return type if requested + * in $args, or null. + */ +function find_one_user( array $args ) { + return find_result( + \WP_User::class, + get_users( + array_merge( + $args, + [ + 'number' => 1, + ] + ) + ) + ); +} + +/** + * Query for and return one site. + * + * @param array $args Query arguments. + * @return mixed|null A \WP_Site object, an alternate return type if requested + * in $args, or null. + */ +function find_one_site( array $args ) { + return find_result( + \WP_Site::class, + get_sites( + array_merge( + $args, + [ + 'number' => 1, + ] + ) + ) + ); +} diff --git a/src/Alley/WP/find-result.php b/src/Alley/WP/find-result.php new file mode 100644 index 0000000..3517faf --- /dev/null +++ b/src/Alley/WP/find-result.php @@ -0,0 +1,45 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +namespace Alley\WP; + +/** + * Returns the first item in the given array if the item is an instance of a + * specific class or is a non-object. + * + * @param string $class If the result plucked from $results is an object, the + * name of the class the object must be an instance of + * for it to be returned. + * @param array $results The array of results from the WordPress query + * function to retrieve the result from. + * @return mixed|null An object of the given $class; a non-object if the item + * plucked from $results is not an object; null if no + * result is found. + */ +function find_result( string $class, $results ) { + if ( ! $results || ! \is_array( $results ) ) { + return null; + } + + $result = reset( $results ); + + if ( ! \is_object( $result ) ) { + // For example, queries that return only IDs or `id=>parent`. + return $result; + } + + if ( ! ( $result instanceof $class ) ) { + return null; + } + + return $result; +} diff --git a/tests/Alley/WP/Fixtures/class-noop.php b/tests/Alley/WP/Fixtures/class-noop.php new file mode 100644 index 0000000..0e62edd --- /dev/null +++ b/tests/Alley/WP/Fixtures/class-noop.php @@ -0,0 +1,23 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +namespace Alley\WP\Fixtures; + +/** + * A class that does nothing but can be instantiated and referenced. + */ +final class Noop { + /** + * Called when a script tries to call this object as a function. + */ + public function __invoke() {} +} diff --git a/tests/Alley/WP/test-find-one.php b/tests/Alley/WP/test-find-one.php new file mode 100644 index 0000000..9c75d09 --- /dev/null +++ b/tests/Alley/WP/test-find-one.php @@ -0,0 +1,131 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +namespace Alley\WP; + +use Mantle\Testkit\Test_Case; + +/** + * Unit tests for the `find_one()` functions. + */ +final class Test_Find_One extends Test_Case { + /** + * Test that `find_one_post()` finds an expected \WP_Post object. + */ + public function test_find_one_post_finds_post() { + $post_id = static::factory()->post->create( + [ + 'post_status' => 'draft', + ] + ); + + $actual = find_one_post( + [ + 'p' => $post_id, + 'post_status' => 'draft', + ] + ); + + $this->assertInstanceOf( \WP_Post::class, $actual ); + $this->assertSame( $post_id, $actual->ID ); + } + + /** + * Test that `find_one_term()` finds an expected \WP_Term object. + */ + public function test_find_one_term_finds_term() { + $term_id = static::factory()->term->create( + [ + 'name' => 'data1', + ] + ); + + $actual = find_one_term( + [ + 'hide_empty' => false, + 'name' => 'data1', + ] + ); + + $this->assertInstanceOf( \WP_Term::class, $actual ); + $this->assertSame( $term_id, $actual->term_id ); + } + + /** + * Test that `find_one_comment()` finds an expected \WP_Comment object. + */ + public function test_find_one_comment_finds_comment() { + $url = 'https://alley.co'; + + $comment_id = static::factory()->comment->create( + [ + 'comment_author_url' => $url, + ] + ); + + $actual = find_one_comment( + [ + 'comment_author_url' => $url, + ] + ); + + $this->assertInstanceOf( \WP_Comment::class, $actual ); + $this->assertSame( $comment_id, (int) $actual->comment_ID ); + } + + /** + * Test that `find_one_user()` finds an expected \WP_User object. + */ + public function test_find_one_user_finds_user() { + $user_id = static::factory()->user->create( + [ + 'user_login' => 'data1', + ] + ); + + $actual = find_one_user( + [ + 'login' => 'data1', + ] + ); + + $this->assertInstanceOf( \WP_User::class, $actual ); + $this->assertSame( $user_id, $actual->ID ); + } + + /** + * Test that `find_one_site()` finds an expected \WP_Site object. + */ + public function test_find_one_site_finds_site() { + if ( ! is_multisite() ) { + $this->markTestSkipped( __METHOD__ . ' requires Multisite' ); + } + + // WordPress < 5.0 doesn't ensure paths are wrapped in slashes. + $path = '/data1/'; + + $blog_id = static::factory()->blog->create( + [ + 'path' => $path, + ] + ); + + $actual = find_one_site( + [ + 'path__in' => [ $path, '/data2/' ], + ] + ); + + $this->assertInstanceOf( \WP_Site::class, $actual ); + $this->assertSame( $blog_id, (int) $actual->blog_id ); + } +} diff --git a/tests/Alley/WP/test-find-result.php b/tests/Alley/WP/test-find-result.php new file mode 100644 index 0000000..f9396ce --- /dev/null +++ b/tests/Alley/WP/test-find-result.php @@ -0,0 +1,66 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +namespace Alley\WP; + +use Alley\WP\Fixtures\Noop; +use Mantle\Testkit\Test_Case; + +/** + * Unit tests for `find_result()`. + */ +final class Test_Find_Result extends Test_Case { + /** + * Test that `find_result()` plucks the expected value from the given args. + * + * @dataProvider data_find_result + * + * @param array $args Function arguments. + * @param mixed $expected Expected return value. + */ + public function test_find_result( $args, $expected ) { // phpcs:ignore Generic.NamingConventions.ConstructorName.OldStyle + $this->assertSame( $expected, find_result( ...$args ) ); + } + + /** + * Data provider with arguments for test_find_result(). + * + * @return array Array of data. + */ + public function data_find_result() { + $noop = new Noop(); + $post = 123; + + return [ + [ + [ Noop::class, [ $noop ] ], + $noop, + ], + [ + [ Noop::class, [ new \stdClass() ] ], + null, + ], + [ + [ Noop::class, [ $post ] ], + $post, + ], + [ + [ Noop::class, [] ], + null, + ], + [ + [ Noop::class, true ], + null, + ], + ]; + } +} diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..67c95ea --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,13 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @package wp-find-one + */ + +\Mantle\Testing\install();