From cd73eba5f7a2b6eb28128f9238584fb17402aad5 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Fri, 15 Jul 2022 21:14:18 -0400 Subject: [PATCH 01/12] Add initial functionality and tests --- .gitattributes | 27 ++ .github/pull_request_template.md | 21 ++ .github/workflows/composer.yml | 31 +++ .github/workflows/cs.yml | 41 +++ .github/workflows/tests.yml | 38 +++ .gitignore | 5 + .php-cs-fixer.dist.php | 30 ++ CHANGELOG.md | 7 + LICENSE | 339 +++++++++++++++++++++++ README.md | 162 +++++++++++ composer.json | 41 +++ phpcs.xml | 24 ++ phpunit.xml | 11 + src/Alley/Validator/AlwaysValid.php | 29 ++ src/Alley/Validator/BaseValidator.php | 28 ++ src/Alley/Validator/Comparison.php | 118 ++++++++ src/Alley/Validator/OneOf.php | 69 +++++ src/Alley/Validator/Type.php | 110 ++++++++ tests/Alley/Validator/ComparisonTest.php | 170 ++++++++++++ tests/Alley/Validator/OneOfTest.php | 35 +++ tests/Alley/Validator/TypeTest.php | 158 +++++++++++ 21 files changed, 1494 insertions(+) create mode 100644 .gitattributes create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/composer.yml create mode 100644 .github/workflows/cs.yml create mode 100644 .github/workflows/tests.yml create mode 100644 .gitignore create mode 100644 .php-cs-fixer.dist.php create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 composer.json create mode 100644 phpcs.xml create mode 100644 phpunit.xml create mode 100644 src/Alley/Validator/AlwaysValid.php create mode 100644 src/Alley/Validator/BaseValidator.php create mode 100644 src/Alley/Validator/Comparison.php create mode 100644 src/Alley/Validator/OneOf.php create mode 100644 src/Alley/Validator/Type.php create mode 100644 tests/Alley/Validator/ComparisonTest.php create mode 100644 tests/Alley/Validator/OneOfTest.php create mode 100644 tests/Alley/Validator/TypeTest.php diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1f5f3ab --- /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. +# +/.github export-ignore +/.php-cs-fixer.dist.php export-ignore +/phpcs.xml export-ignore +/phpunit.xml 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..cee15a2 --- /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: [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: 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..522563c --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,38 @@ +name: Tests + +on: + pull_request: + +jobs: + phpunit: + runs-on: ubuntu-latest + strategy: + fail-fast: true + matrix: + php: [8.1, 8.0, 7.4] + can_fail: [false] + + name: PHP ${{ matrix.php }} + env: + CACHEDIR: /tmp/test-cache + steps: + - 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@v2 + with: + timeout_minutes: 5 + max_attempts: 5 + command: composer install + + - name: Run PHPUnit + shell: bash + 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..3cf4a38 --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +$finder = PhpCsFixer\Finder::create()->in([ + __DIR__ . '/src/', + __DIR__ . '/tests/', +]); + +$config = new PhpCsFixer\Config(); +$config->setRules([ + '@PSR12' => true, + '@PHP81Migration' => true, + + '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..d83defc --- /dev/null +++ b/README.md @@ -0,0 +1,162 @@ +# Laminas Validator Extensions + +This package provides additional validation classes for [the Laminas Validator framework](https://docs.laminas.dev/laminas-validator/), plus a custom base validation class. + +For more information about what validators do, how to use them, and how to write your own, [visit the Laminas documentation](https://docs.laminas.dev/laminas-validator/). + +## Base Validator + +The abstract `Alley\Validator\BaseValidator` class standardizes the implementation of custom validators with `\Laminas\Validator\AbstractValidator`. + +When extending `BaseValidator`, validation logic goes into a new `testValue()` method, which is responsible only for applying the logic and adding any validation errors. It's no longer necessary to call `setValue()` prior to evaluating the input, and `isValid()` will return `true` if there are no failure messages after evaluating the input and `false` if there are any messages. + +Before: + +```php + "'%value%' is not a floating point value", + ]; + + public function isValid($value) + { + $this->setValue($value); + + if (! is_float($value)) { + $this->error(self::FLOAT); + return false; + } + + return true; + } +} +``` + +After: + +```php + "'%value%' is not a floating point value", + ]; + + public function testValue($value): void + { + if (! is_float($value)) { + $this->error(self::FLOAT); + } + } +} +``` + +## Validators + +### `AlwaysValid` + +`\Alley\Validator\AlwaysValid` marks all input as valid. It can be used to satisfy type requirements when full validation needs to be disabled or is impractical. + +#### Supported options + +None. + +#### Basic usage + +```php +isValid(42); // true +$valid->isValid(false); // true +$valid->isValid('abcdefghijklmnopqrstuvwxyz'); // true +``` + +### `Comparison` + +`\Alley\Validator\Comparison` compares input to another value using a PHP [comparison operator](https://www.php.net/manual/en/language.operators.comparison.php). The input passes validation if the comparison is true. Input is placed on the left side of the operator. + +#### Supported options + +The following options are supported for `\Alley\Validator\Comparison`: + +- `compared`: The value the inputs are compared to. It is placed on the right side of the operator. +- `operator`: The PHP comparison operator used to compare the input and `compared`. + +#### Basic usage + +```php + '<=', + 'compared' => 100, + ] +); +$valid->isValid(101); // false + +$valid = new \Alley\Validator\Comparison( + [ + 'operator' => '!==', + 'compared' => false, + ] +); +$valid->isValid(true); // true +``` + +### `OneOf` + +`Alley\Validator\OneOf` validates whether an array of scalar values of contains the input. The input passes validation if it is found within the array. + +`OneOf` is a simpler version of `\Laminas\Validator\InArray` that accepts only scalar values in the haystack and does only strict comparisons. In return, it produces a friendlier error message that lists the allowed values. + +`OneOf` contains a `::create()` named constructor for initializing a validator directly from the haystack. + +#### Supported Options + +The following options are supported for `\Alley\Validator\OneOf`: + +- `haystack`: The array to be searched for the input. + +#### Basic Usage + +```php +isValid('four'); // false +$valid->getMessages(); // ['notOneOf' => 'Must be one of [one, two, three] but is four.'] +``` + +### `Type` + +`\Alley\Validator\Type` allows you to validate whether the input is of the given PHP type. The input passes if it is the expected type. + +This validator is inspired by PHPUnit's `\PHPUnit\Framework\Constraint\IsType` class. + +#### Supported options + +The following options are supported for `\Alley\Validator\Type`: + +- `type`: The expected PHP type. Supported types are `array`, `bool`, `boolean`, `callable`, `double`, `float`, `int`, `integer`, `iterable`, `null`, `numeric`, `object`, `real`, `resource`, `string`, and `scalar`. + +#### Basic usage + +```php + 'callable']); +$valid->isValid('date_create_immutable'); // true + +$valid = new \Alley\Validator\Type(['type' => 'bool']); +$valid->isValid([]); // false +``` diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..bf77af7 --- /dev/null +++ b/composer.json @@ -0,0 +1,41 @@ +{ + "name": "alleyinteractive/laminas-validator-extensions", + "description": "Additional validation classes for the laminas-validator framework.", + "type": "library", + "license": "GPL-2.0-or-later", + "authors": [ + { + "name": "Alley", + "email": "info@alley.co" + } + ], + "autoload": { + "psr-4": { + "Alley\\": "src/Alley/" + } + }, + "autoload-dev": { + "psr-4": { + "Alley\\": "tests/Alley/" + } + }, + "config": { + "optimize-autoloader": true, + "classmap-authoritative": true + }, + "require": { + "php": "^7.4 || ^8.0", + "laminas/laminas-validator": "^2.20" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3.8", + "phpunit/phpunit": "^9.5", + "squizlabs/php_codesniffer": "^3.6" + }, + "scripts": { + "fixer": "php-cs-fixer -v fix --allow-risky=yes", + "phpcbf": "phpcbf", + "phpcs": "phpcs", + "phpunit": "phpunit" + } +} diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..0e7fee8 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,24 @@ + + + The coding standard for laminas-validator-extensions. + + src/ + tests/ + vendor/ + + + + + + + + + + + + + diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..b2138be --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,11 @@ + + + tests + + diff --git a/src/Alley/Validator/AlwaysValid.php b/src/Alley/Validator/AlwaysValid.php new file mode 100644 index 0000000..f7a5d89 --- /dev/null +++ b/src/Alley/Validator/AlwaysValid.php @@ -0,0 +1,29 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use Laminas\Validator\ValidatorInterface; + +final class AlwaysValid implements ValidatorInterface +{ + public function isValid($value) + { + return true; + } + + public function getMessages() + { + return []; + } +} diff --git a/src/Alley/Validator/BaseValidator.php b/src/Alley/Validator/BaseValidator.php new file mode 100644 index 0000000..f5eebf2 --- /dev/null +++ b/src/Alley/Validator/BaseValidator.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use Laminas\Validator\AbstractValidator; + +abstract class BaseValidator extends AbstractValidator +{ + final public function isValid($value) + { + $this->setValue($value); + $this->testValue($value); + return \count($this->getMessages()) === 0; + } + + abstract protected function testValue($value): void; +} diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php new file mode 100644 index 0000000..174ed2c --- /dev/null +++ b/src/Alley/Validator/Comparison.php @@ -0,0 +1,118 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use Laminas\Validator\Exception; + +final class Comparison extends BaseValidator +{ + private const SUPPORTED_OPERATORS = [ + '==', + '===', + '!=', + '<>', + '!==', + '<', + '>', + '<=', + '>=', + ]; + + private const OPERATOR_ERRORS = [ + '==' => 'notEqual', + '===' => 'notIdentical', + '!=' => 'isEqual', + '<>' => 'isEqual', + '!==' => 'isIdentical', + '<' => 'notLessThan', + '>' => 'notGreaterThan', + '<=' => 'notLessThanOrEqualTo', + '>=' => 'notGreaterThanOrEqualTo', + ]; + + /** + * @var mixed + */ + protected $compared; + + private string $operator = '==='; + + protected $messageTemplates = [ + 'notEqual' => 'Must be equal to %compared% but is %value%.', + 'notIdentical' => 'Must be identical to %compared% but is %value%.', + 'isEqual' => 'Must not be equal to %compared% but is %value%.', + 'isIdentical' => 'Must not be identical to %compared%.', + 'notLessThan' => 'Must be less than %compared% but is %value%.', + 'notGreaterThan' => 'Must be greater than %compared% but is %value%.', + 'notLessThanOrEqualTo' => 'Must be less than or equal to %compared% but is %value%.', + 'notGreaterThanOrEqualTo' => 'Must be greater than or equal to %compared% but is %value%.', + ]; + + protected $messageVariables = [ + 'compared' => 'compared', + ]; + + protected function testValue($value): void + { + switch ($this->operator) { + case '==': + $result = $value == $this->compared; + break; + case '!=': + case '<>': + $result = $value != $this->compared; + break; + case '!==': + $result = $value !== $this->compared; + break; + case '<': + $result = $value < $this->compared; + break; + case '>': + $result = $value > $this->compared; + break; + case '<=': + $result = $value <= $this->compared; + break; + case '>=': + $result = $value >= $this->compared; + break; + case '===': + default: + $result = $value === $this->compared; + break; + } + + if (! $result) { + $this->error(self::OPERATOR_ERRORS[$this->operator]); + } + } + + protected function setCompared($compared) + { + $this->compared = $compared; + } + + protected function setOperator(string $operator) + { + $oneOf = OneOf::create(self::SUPPORTED_OPERATORS); + $valid = $oneOf->isValid($operator); + + if (! $valid) { + throw new Exception\InvalidArgumentException($oneOf->getMessages()[0]); + } + + $this->operator = $operator; + } +} diff --git a/src/Alley/Validator/OneOf.php b/src/Alley/Validator/OneOf.php new file mode 100644 index 0000000..97086d3 --- /dev/null +++ b/src/Alley/Validator/OneOf.php @@ -0,0 +1,69 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use Laminas\Validator\Exception\InvalidArgumentException; +use Laminas\Validator\InArray; + +final class OneOf extends BaseValidator +{ + public const NOT_ONE_OF = 'notOneOf'; + + protected $messageTemplates = [ + self::NOT_ONE_OF => "Must be one of %haystack% but is %value%.", + ]; + + protected $messageVariables = [ + 'haystack' => ['options' => 'haystack'], + ]; + + private InArray $origin; + + public static function create(array $haystack): self + { + return new self(['origin' => new InArray([ + 'haystack' => $haystack, + 'strict' => InArray::COMPARE_STRICT, + ])]); + } + + protected function testValue($value): void + { + if (! $this->origin->isValid($value)) { + $this->error(self::NOT_ONE_OF); + } + } + + protected function setOrigin(InArray $origin) + { + foreach ($origin->getHaystack() as $value) { + if (! \is_scalar($value)) { + throw new InvalidArgumentException( + 'Haystack must contain only scalar values but contains ' . strtoupper(\gettype($value)) + ); + } + } + + $this->origin = $origin; + } + + public function __get($name) + { + if ('options' === $name) { + return ['haystack' => $this->origin->getHaystack()]; + } + + return null; + } +} diff --git a/src/Alley/Validator/Type.php b/src/Alley/Validator/Type.php new file mode 100644 index 0000000..79494b8 --- /dev/null +++ b/src/Alley/Validator/Type.php @@ -0,0 +1,110 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use Laminas\Validator\Exception\InvalidArgumentException; + +final class Type extends BaseValidator +{ + public const NOT_OF_TYPE = 'notOfType'; + + private const SUPPORTED_TYPES = [ + 'array', + 'bool', + 'boolean', + 'double', + 'float', + 'int', + 'integer', + 'null', + 'numeric', + 'object', + 'real', + 'resource', + 'string', + 'scalar', + 'callable', + 'iterable', + ]; + + protected string $type = 'null'; + + protected $messageTemplates = [ + self::NOT_OF_TYPE => "Must be of PHP type '%type%' but %value% is not.", + ]; + + protected $messageVariables = [ + 'type' => 'type', + ]; + + protected function testValue($value): void + { + switch ($this->type) { + case 'array': + $result = \is_array($value); + break; + case 'bool': + case 'boolean': + $result = \is_bool($value); + break; + case 'int': + case 'integer': + $result = \is_int($value); + break; + case 'double': + case 'float': + case 'real': + $result = \is_float($value); + break; + case 'numeric': + $result = is_numeric($value); + break; + case 'object': + $result = \is_object($value); + break; + case 'resource': + $result = \is_resource($value); + break; + case 'string': + $result = \is_string($value); + break; + case 'scalar': + $result = \is_scalar($value); + break; + case 'callable': + $result = \is_callable($value); + break; + case 'iterable': + $result = is_iterable($value); + break; + case 'null': + default: + $result = \is_null($value); + break; + } + + if (!$result) { + $this->error(self::NOT_OF_TYPE); + } + } + + protected function setType(string $type) + { + if (! \in_array($type, self::SUPPORTED_TYPES, true)) { + throw new InvalidArgumentException('Not an allowed type.'); + } + + $this->type = $type; + } +} diff --git a/tests/Alley/Validator/ComparisonTest.php b/tests/Alley/Validator/ComparisonTest.php new file mode 100644 index 0000000..cf8975f --- /dev/null +++ b/tests/Alley/Validator/ComparisonTest.php @@ -0,0 +1,170 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use PHPUnit\Framework\TestCase; + +final class ComparisonTest extends TestCase +{ + /** + * @dataProvider dataValidInput + */ + public function testValidInput($value, $options) + { + $validator = new Comparison($options); + $this->assertTrue($validator->isValid($value)); + } + + public function dataValidInput() + { + return [ + '==' => [ + 42, + [ + 'operator' => '==', + 'compared' => '42', + ], + ], + '===' => [ + 42, + [ + 'operator' => '===', + 'compared' => 42, + ], + ], + '!=' => [ + 43, + [ + 'operator' => '<>', + 'compared' => '42', + ], + ], + '!==' => [ + 43, + [ + 'operator' => '!==', + 'compared' => 42, + ], + ], + '<' => [ + 41, + [ + 'operator' => '<', + 'compared' => 42, + ], + ], + '>' => [ + 43, + [ + 'operator' => '>', + 'compared' => 42, + ], + ], + '<=' => [ + 42, + [ + 'operator' => '<=', + 'compared' => 42, + ], + ], + '>=' => [ + 42, + [ + 'operator' => '>=', + 'compared' => 42, + ], + ], + ]; + } + + /** + * @dataProvider dataInvalidInput + */ + public function testInvalidInput($value, $options, $messages) + { + $validator = new Comparison($options); + $this->assertFalse($validator->isValid($value)); + $this->assertSame($messages, $validator->getMessages()); + } + + public function dataInvalidInput() + { + return [ + '==' => [ + 43, + [ + 'operator' => '==', + 'compared' => '42', + ], + ['notEqual' => 'Must be equal to 42 but is 43.'], + ], + '===' => [ + '42', + [ + 'operator' => '===', + 'compared' => 42, + ], + ['notIdentical' => 'Must be identical to 42 but is 42.'], + ], + '!=' => [ + 42, + [ + 'operator' => '<>', + 'compared' => '42', + ], + ['isEqual' => 'Must not be equal to 42 but is 42.'], + ], + '!==' => [ + 42, + [ + 'operator' => '!==', + 'compared' => 42, + ], + ['isIdentical' => 'Must not be identical to 42.'], + ], + '<' => [ + 43, + [ + 'operator' => '<', + 'compared' => 42, + ], + ['notLessThan' => 'Must be less than 42 but is 43.'], + ], + '>' => [ + 41, + [ + 'operator' => '>', + 'compared' => 42, + ], + ['notGreaterThan' => 'Must be greater than 42 but is 41.'], + ], + '<=' => [ + 43, + [ + 'operator' => '<=', + 'compared' => 42, + ], + ['notLessThanOrEqualTo' => 'Must be less than or equal to 42 but is 43.'], + ], + '>=' => [ + 41, + [ + 'operator' => '>=', + 'compared' => 42, + ], + ['notGreaterThanOrEqualTo' => 'Must be greater than or equal to 42 but is 41.'], + ], + ]; + } +} diff --git a/tests/Alley/Validator/OneOfTest.php b/tests/Alley/Validator/OneOfTest.php new file mode 100644 index 0000000..c467c2e --- /dev/null +++ b/tests/Alley/Validator/OneOfTest.php @@ -0,0 +1,35 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use PHPUnit\Framework\TestCase; + +final class OneOfTest extends TestCase +{ + public function testValidInput() + { + $validator = OneOf::create(['a', 'b', 'c']); + $this->assertTrue($validator->isValid('a')); + } + + public function testInvalidInput() + { + $validator = OneOf::create(['a', 'b', 'c']); + $this->assertFalse($validator->isValid('z')); + $this->assertSame( + ['notOneOf' => 'Must be one of [a, b, c] but is z.'], + $validator->getMessages(), + ); + } +} diff --git a/tests/Alley/Validator/TypeTest.php b/tests/Alley/Validator/TypeTest.php new file mode 100644 index 0000000..35dc2c8 --- /dev/null +++ b/tests/Alley/Validator/TypeTest.php @@ -0,0 +1,158 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Alley\Validator; + +use PHPUnit\Framework\TestCase; + +final class TypeTest extends TestCase +{ + /** + * @dataProvider dataValidInput + */ + public function testValidInput($value, $options) + { + $validator = new Type($options); + $this->assertTrue($validator->isValid($value)); + } + + public function dataValidInput() + { + return [ + 'array' => [ + [], + ['type' => 'array'], + ], + 'bool' => [ + true, + ['type' => 'bool'], + ], + 'float' => [ + 4.2, + ['type' => 'float'], + ], + 'int' => [ + 42, + ['type' => 'int'], + ], + 'null' => [ + null, + ['type' => 'null'], + ], + 'numeric' => [ + '42', + ['type' => 'numeric'], + ], + 'object' => [ + new \stdClass(), + ['type' => 'object'], + ], + 'resource' => [ + \STDOUT, + ['type' => 'resource'], + ], + 'string' => [ + '42', + ['type' => 'string'], + ], + 'scalar' => [ + 'foo', + ['type' => 'scalar'], + ], + 'callable' => [ + 'intval', + ['type' => 'callable'], + ], + 'iterable' => [ + [], + ['type' => 'iterable'], + ], + ]; + } + + /** + * @dataProvider dataInvalidInput + */ + public function testInvalidInput($value, $options, $messages) + { + $validator = new Type($options); + $this->assertFalse($validator->isValid($value)); + $this->assertSame($messages, $validator->getMessages()); + } + + public function dataInvalidInput() + { + return [ + 'array' => [ + 42, + ['type' => 'array'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'array' but 42 is not."], + ], + 'bool' => [ + 42, + ['type' => 'bool'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'bool' but 42 is not."], + ], + 'float' => [ + 42, + ['type' => 'float'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'float' but 42 is not."], + ], + 'int' => [ + '42', + ['type' => 'int'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'int' but 42 is not."], + ], + 'null' => [ + 42, + ['type' => 'null'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'null' but 42 is not."], + ], + 'numeric' => [ + 'forty-two', + ['type' => 'numeric'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'numeric' but forty-two is not."], + ], + 'object' => [ + 42, + ['type' => 'object'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'object' but 42 is not."], + ], + 'resource' => [ + 42, + ['type' => 'resource'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'resource' but 42 is not."], + ], + 'string' => [ + 42, + ['type' => 'string'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'string' but 42 is not."], + ], + 'scalar' => [ + fn () => null, + ['type' => 'scalar'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'scalar' but Closure object is not."], + ], + 'callable' => [ + 42, + ['type' => 'callable'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'callable' but 42 is not."], + ], + 'iterable' => [ + 42, + ['type' => 'iterable'], + [Type::NOT_OF_TYPE => "Must be of PHP type 'iterable' but 42 is not."], + ], + ]; + } +} From 3dca540efe3a539c130b60c7f478911dcaa6ee28 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Sat, 16 Jul 2022 15:56:26 -0400 Subject: [PATCH 02/12] Rearrange properties for clarity --- src/Alley/Validator/Comparison.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php index 174ed2c..5ae32d3 100644 --- a/src/Alley/Validator/Comparison.php +++ b/src/Alley/Validator/Comparison.php @@ -41,13 +41,6 @@ final class Comparison extends BaseValidator '>=' => 'notGreaterThanOrEqualTo', ]; - /** - * @var mixed - */ - protected $compared; - - private string $operator = '==='; - protected $messageTemplates = [ 'notEqual' => 'Must be equal to %compared% but is %value%.', 'notIdentical' => 'Must be identical to %compared% but is %value%.', @@ -63,6 +56,13 @@ final class Comparison extends BaseValidator 'compared' => 'compared', ]; + /** + * @var mixed + */ + protected $compared; + + private string $operator = '==='; + protected function testValue($value): void { switch ($this->operator) { From 06889ba0dddaf42b0f9bb517402deb51c63601f6 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Sat, 16 Jul 2022 15:57:54 -0400 Subject: [PATCH 03/12] Document `testValue()` --- src/Alley/Validator/BaseValidator.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/Alley/Validator/BaseValidator.php b/src/Alley/Validator/BaseValidator.php index f5eebf2..6eb69ea 100644 --- a/src/Alley/Validator/BaseValidator.php +++ b/src/Alley/Validator/BaseValidator.php @@ -24,5 +24,11 @@ final public function isValid($value) return \count($this->getMessages()) === 0; } + /** + * Apply validation logic and add any validation errors. + * + * @param mixed $value + * @return void + */ abstract protected function testValue($value): void; } From e576316da450e9f1e243a71f23c7651b948322c0 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 10:11:33 -0400 Subject: [PATCH 04/12] Declare `isValid()` return type --- src/Alley/Validator/BaseValidator.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Alley/Validator/BaseValidator.php b/src/Alley/Validator/BaseValidator.php index 6eb69ea..ba6e981 100644 --- a/src/Alley/Validator/BaseValidator.php +++ b/src/Alley/Validator/BaseValidator.php @@ -17,7 +17,7 @@ abstract class BaseValidator extends AbstractValidator { - final public function isValid($value) + final public function isValid($value): bool { $this->setValue($value); $this->testValue($value); From 75cd5245129be2a6d35ca6f0ff605f2bcd93ffa0 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 12:54:19 -0400 Subject: [PATCH 05/12] Use a single instance to validate operator --- src/Alley/Validator/Comparison.php | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php index 5ae32d3..283c818 100644 --- a/src/Alley/Validator/Comparison.php +++ b/src/Alley/Validator/Comparison.php @@ -14,6 +14,7 @@ namespace Alley\Validator; use Laminas\Validator\Exception; +use Laminas\Validator\ValidatorInterface; final class Comparison extends BaseValidator { @@ -63,6 +64,15 @@ final class Comparison extends BaseValidator private string $operator = '==='; + private ValidatorInterface $operatorValidator; + + public function __construct($options = null) + { + $this->operatorValidator = OneOf::create(self::SUPPORTED_OPERATORS); + + parent::__construct($options); + } + protected function testValue($value): void { switch ($this->operator) { @@ -106,11 +116,10 @@ protected function setCompared($compared) protected function setOperator(string $operator) { - $oneOf = OneOf::create(self::SUPPORTED_OPERATORS); - $valid = $oneOf->isValid($operator); + $valid = $this->operatorValidator->isValid($operator); if (! $valid) { - throw new Exception\InvalidArgumentException($oneOf->getMessages()[0]); + throw new Exception\InvalidArgumentException($this->operatorValidator->getMessages()[0]); } $this->operator = $operator; From 0787032d101ae7ff868ba62c0a31d5dac8d07fa2 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 17:29:03 -0400 Subject: [PATCH 06/12] Standardize on `$options` param with setter validation --- src/Alley/Validator/Comparison.php | 26 ++++++++--------- src/Alley/Validator/OneOf.php | 47 +++++++++++++++++++----------- src/Alley/Validator/Type.php | 26 +++++++++++++---- 3 files changed, 62 insertions(+), 37 deletions(-) diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php index 283c818..51f62d2 100644 --- a/src/Alley/Validator/Comparison.php +++ b/src/Alley/Validator/Comparison.php @@ -13,7 +13,7 @@ namespace Alley\Validator; -use Laminas\Validator\Exception; +use Laminas\Validator\Exception\InvalidArgumentException; use Laminas\Validator\ValidatorInterface; final class Comparison extends BaseValidator @@ -30,6 +30,11 @@ final class Comparison extends BaseValidator '>=', ]; + /** + * Error message codes for the given operators. + * + * @var string[] + */ private const OPERATOR_ERRORS = [ '==' => 'notEqual', '===' => 'notIdentical', @@ -54,15 +59,13 @@ final class Comparison extends BaseValidator ]; protected $messageVariables = [ - 'compared' => 'compared', + 'compared' => ['options' => 'compared'], ]; - /** - * @var mixed - */ - protected $compared; - - private string $operator = '==='; + protected $options = [ + 'compared' => null, + 'operator' => '===', + ]; private ValidatorInterface $operatorValidator; @@ -109,17 +112,12 @@ protected function testValue($value): void } } - protected function setCompared($compared) - { - $this->compared = $compared; - } - protected function setOperator(string $operator) { $valid = $this->operatorValidator->isValid($operator); if (! $valid) { - throw new Exception\InvalidArgumentException($this->operatorValidator->getMessages()[0]); + throw new InvalidArgumentException($this->operatorValidator->getMessages()[0]); } $this->operator = $operator; diff --git a/src/Alley/Validator/OneOf.php b/src/Alley/Validator/OneOf.php index 97086d3..71b84f3 100644 --- a/src/Alley/Validator/OneOf.php +++ b/src/Alley/Validator/OneOf.php @@ -13,8 +13,11 @@ namespace Alley\Validator; +use Laminas\Validator\Callback; use Laminas\Validator\Exception\InvalidArgumentException; +use Laminas\Validator\Explode; use Laminas\Validator\InArray; +use Laminas\Validator\ValidatorInterface; final class OneOf extends BaseValidator { @@ -28,7 +31,22 @@ final class OneOf extends BaseValidator 'haystack' => ['options' => 'haystack'], ]; - private InArray $origin; + protected $options = [ + 'origin' => null, + 'haystack' => [], + ]; + + private ValidatorInterface $haystackValidator; + + public function __construct($options = null) + { + $this->haystackValidator = new Explode([ + 'validator' => new Callback('is_scalar'), + 'breakOnFirstFailure' => true, + ]); + + parent::__construct($options); + } public static function create(array $haystack): self { @@ -40,30 +58,25 @@ public static function create(array $haystack): self protected function testValue($value): void { - if (! $this->origin->isValid($value)) { + if (! $this->options['origin']) { + throw new InvalidArgumentException('No haystack given'); + } + + if (! $this->options['origin']->isValid($value)) { $this->error(self::NOT_ONE_OF); } } protected function setOrigin(InArray $origin) { - foreach ($origin->getHaystack() as $value) { - if (! \is_scalar($value)) { - throw new InvalidArgumentException( - 'Haystack must contain only scalar values but contains ' . strtoupper(\gettype($value)) - ); - } - } + $haystack = $origin->getHaystack(); + $valid = $this->haystackValidator->isValid($haystack); - $this->origin = $origin; - } - - public function __get($name) - { - if ('options' === $name) { - return ['haystack' => $this->origin->getHaystack()]; + if (! $valid) { + throw new InvalidArgumentException('Haystack must contain only scalar values.'); } - return null; + $this->options['origin'] = $origin; + $this->options['haystack'] = $haystack; } } diff --git a/src/Alley/Validator/Type.php b/src/Alley/Validator/Type.php index 79494b8..5100167 100644 --- a/src/Alley/Validator/Type.php +++ b/src/Alley/Validator/Type.php @@ -14,6 +14,7 @@ namespace Alley\Validator; use Laminas\Validator\Exception\InvalidArgumentException; +use Laminas\Validator\ValidatorInterface; final class Type extends BaseValidator { @@ -38,16 +39,27 @@ final class Type extends BaseValidator 'iterable', ]; - protected string $type = 'null'; - protected $messageTemplates = [ self::NOT_OF_TYPE => "Must be of PHP type '%type%' but %value% is not.", ]; protected $messageVariables = [ - 'type' => 'type', + 'type' => ['options' => 'type'], + ]; + + protected $options = [ + 'type' => 'null', ]; + private ValidatorInterface $typeValidator; + + public function __construct($options = null) + { + $this->typeValidator = OneOf::create(self::SUPPORTED_TYPES); + + parent::__construct($options); + } + protected function testValue($value): void { switch ($this->type) { @@ -101,10 +113,12 @@ protected function testValue($value): void protected function setType(string $type) { - if (! \in_array($type, self::SUPPORTED_TYPES, true)) { - throw new InvalidArgumentException('Not an allowed type.'); + $valid = $this->typeValidator->isValid($type); + + if (! $valid) { + throw new InvalidArgumentException($this->typeValidator->getMessages()[0]); } - $this->type = $type; + $this->options['type'] = $type; } } From 97ec970c54dadfb1c892b298b7cd866bd497e312 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 17:30:02 -0400 Subject: [PATCH 07/12] Minor README edits --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d83defc..f007d08 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ For more information about what validators do, how to use them, and how to write The abstract `Alley\Validator\BaseValidator` class standardizes the implementation of custom validators with `\Laminas\Validator\AbstractValidator`. -When extending `BaseValidator`, validation logic goes into a new `testValue()` method, which is responsible only for applying the logic and adding any validation errors. It's no longer necessary to call `setValue()` prior to evaluating the input, and `isValid()` will return `true` if there are no failure messages after evaluating the input and `false` if there are any messages. +When extending `BaseValidator`, validation logic goes into a new `testValue()` method, which is responsible only for applying the logic and adding any validation errors. It's no longer necessary to call `setValue()` prior to evaluating the input, and `isValid()` will return `true` if there are no error messages after evaluating the input and `false` if there are any messages. Before: @@ -115,11 +115,11 @@ $valid->isValid(true); // true ### `OneOf` -`Alley\Validator\OneOf` validates whether an array of scalar values of contains the input. The input passes validation if it is found within the array. +`Alley\Validator\OneOf` validates whether an array of scalar values contains the input. `OneOf` is a simpler version of `\Laminas\Validator\InArray` that accepts only scalar values in the haystack and does only strict comparisons. In return, it produces a friendlier error message that lists the allowed values. -`OneOf` contains a `::create()` named constructor for initializing a validator directly from the haystack. +`OneOf` contains a `::create()` named constructor for initializing an instance directly from the haystack. #### Supported Options From 89ed97008b519b85ac768bd7089e4c71844680be Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 19:53:59 -0400 Subject: [PATCH 08/12] Do away with internal `InArray` --- src/Alley/Validator/Comparison.php | 2 +- src/Alley/Validator/OneOf.php | 20 ++------------------ src/Alley/Validator/Type.php | 2 +- tests/Alley/Validator/OneOfTest.php | 11 +++++++++-- 4 files changed, 13 insertions(+), 22 deletions(-) diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php index 51f62d2..543fbd8 100644 --- a/src/Alley/Validator/Comparison.php +++ b/src/Alley/Validator/Comparison.php @@ -71,7 +71,7 @@ final class Comparison extends BaseValidator public function __construct($options = null) { - $this->operatorValidator = OneOf::create(self::SUPPORTED_OPERATORS); + $this->operatorValidator = new OneOf(['haystack' => self::SUPPORTED_OPERATORS]); parent::__construct($options); } diff --git a/src/Alley/Validator/OneOf.php b/src/Alley/Validator/OneOf.php index 71b84f3..a8b1d89 100644 --- a/src/Alley/Validator/OneOf.php +++ b/src/Alley/Validator/OneOf.php @@ -16,7 +16,6 @@ use Laminas\Validator\Callback; use Laminas\Validator\Exception\InvalidArgumentException; use Laminas\Validator\Explode; -use Laminas\Validator\InArray; use Laminas\Validator\ValidatorInterface; final class OneOf extends BaseValidator @@ -32,7 +31,6 @@ final class OneOf extends BaseValidator ]; protected $options = [ - 'origin' => null, 'haystack' => [], ]; @@ -48,35 +46,21 @@ public function __construct($options = null) parent::__construct($options); } - public static function create(array $haystack): self - { - return new self(['origin' => new InArray([ - 'haystack' => $haystack, - 'strict' => InArray::COMPARE_STRICT, - ])]); - } - protected function testValue($value): void { - if (! $this->options['origin']) { - throw new InvalidArgumentException('No haystack given'); - } - - if (! $this->options['origin']->isValid($value)) { + if (! in_array($value, $this->options['haystack'], true)) { $this->error(self::NOT_ONE_OF); } } - protected function setOrigin(InArray $origin) + protected function setHaystack(array $haystack) { - $haystack = $origin->getHaystack(); $valid = $this->haystackValidator->isValid($haystack); if (! $valid) { throw new InvalidArgumentException('Haystack must contain only scalar values.'); } - $this->options['origin'] = $origin; $this->options['haystack'] = $haystack; } } diff --git a/src/Alley/Validator/Type.php b/src/Alley/Validator/Type.php index 5100167..47bc924 100644 --- a/src/Alley/Validator/Type.php +++ b/src/Alley/Validator/Type.php @@ -55,7 +55,7 @@ final class Type extends BaseValidator public function __construct($options = null) { - $this->typeValidator = OneOf::create(self::SUPPORTED_TYPES); + $this->typeValidator = new OneOf(['haystack' => self::SUPPORTED_TYPES]); parent::__construct($options); } diff --git a/tests/Alley/Validator/OneOfTest.php b/tests/Alley/Validator/OneOfTest.php index c467c2e..1c8e669 100644 --- a/tests/Alley/Validator/OneOfTest.php +++ b/tests/Alley/Validator/OneOfTest.php @@ -13,23 +13,30 @@ namespace Alley\Validator; +use Laminas\Validator\Exception\InvalidArgumentException; use PHPUnit\Framework\TestCase; final class OneOfTest extends TestCase { public function testValidInput() { - $validator = OneOf::create(['a', 'b', 'c']); + $validator = new OneOf(['haystack' => ['a', 'b', 'c']]); $this->assertTrue($validator->isValid('a')); } public function testInvalidInput() { - $validator = OneOf::create(['a', 'b', 'c']); + $validator = new OneOf(['haystack' => ['a', 'b', 'c']]); $this->assertFalse($validator->isValid('z')); $this->assertSame( ['notOneOf' => 'Must be one of [a, b, c] but is z.'], $validator->getMessages(), ); } + + public function testInvalidHaystack() + { + $this->expectException(InvalidArgumentException::class); + new OneOf(['haystack' => [fn() => null]]); + } } From 55f916ef255ec13ea6c80d7c9d0522c5bf611cfb Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 20:00:43 -0400 Subject: [PATCH 09/12] Spacing and namespace fixes --- src/Alley/Validator/OneOf.php | 2 +- tests/Alley/Validator/OneOfTest.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Alley/Validator/OneOf.php b/src/Alley/Validator/OneOf.php index a8b1d89..9c685d4 100644 --- a/src/Alley/Validator/OneOf.php +++ b/src/Alley/Validator/OneOf.php @@ -48,7 +48,7 @@ public function __construct($options = null) protected function testValue($value): void { - if (! in_array($value, $this->options['haystack'], true)) { + if (! \in_array($value, $this->options['haystack'], true)) { $this->error(self::NOT_ONE_OF); } } diff --git a/tests/Alley/Validator/OneOfTest.php b/tests/Alley/Validator/OneOfTest.php index 1c8e669..566d0ad 100644 --- a/tests/Alley/Validator/OneOfTest.php +++ b/tests/Alley/Validator/OneOfTest.php @@ -37,6 +37,6 @@ public function testInvalidInput() public function testInvalidHaystack() { $this->expectException(InvalidArgumentException::class); - new OneOf(['haystack' => [fn() => null]]); + new OneOf(['haystack' => [fn () => null]]); } } From 7db1e0141ed7f3002fb6d374269113a366b58a29 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Wed, 20 Jul 2022 21:22:12 -0400 Subject: [PATCH 10/12] Fix missed references to properties --- src/Alley/Validator/Comparison.php | 22 +++++++++++----------- src/Alley/Validator/Type.php | 2 +- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php index 543fbd8..7f19b41 100644 --- a/src/Alley/Validator/Comparison.php +++ b/src/Alley/Validator/Comparison.php @@ -78,37 +78,37 @@ public function __construct($options = null) protected function testValue($value): void { - switch ($this->operator) { + switch ($this->options['operator']) { case '==': - $result = $value == $this->compared; + $result = $value == $this->options['compared']; break; case '!=': case '<>': - $result = $value != $this->compared; + $result = $value != $this->options['compared']; break; case '!==': - $result = $value !== $this->compared; + $result = $value !== $this->options['compared']; break; case '<': - $result = $value < $this->compared; + $result = $value < $this->options['compared']; break; case '>': - $result = $value > $this->compared; + $result = $value > $this->options['compared']; break; case '<=': - $result = $value <= $this->compared; + $result = $value <= $this->options['compared']; break; case '>=': - $result = $value >= $this->compared; + $result = $value >= $this->options['compared']; break; case '===': default: - $result = $value === $this->compared; + $result = $value === $this->options['compared']; break; } if (! $result) { - $this->error(self::OPERATOR_ERRORS[$this->operator]); + $this->error(self::OPERATOR_ERRORS[$this->options['operator']]); } } @@ -120,6 +120,6 @@ protected function setOperator(string $operator) throw new InvalidArgumentException($this->operatorValidator->getMessages()[0]); } - $this->operator = $operator; + $this->options['operator'] = $operator; } } diff --git a/src/Alley/Validator/Type.php b/src/Alley/Validator/Type.php index 47bc924..be6b67f 100644 --- a/src/Alley/Validator/Type.php +++ b/src/Alley/Validator/Type.php @@ -62,7 +62,7 @@ public function __construct($options = null) protected function testValue($value): void { - switch ($this->type) { + switch ($this->options['type']) { case 'array': $result = \is_array($value); break; From 862a302a830c76b208e3f355d14cec9a135dd837 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Thu, 21 Jul 2022 13:26:52 -0400 Subject: [PATCH 11/12] Clarify a few lists and variables --- src/Alley/Validator/Comparison.php | 17 ++++++----------- src/Alley/Validator/OneOf.php | 6 +++--- src/Alley/Validator/Type.php | 14 +++++++------- 3 files changed, 16 insertions(+), 21 deletions(-) diff --git a/src/Alley/Validator/Comparison.php b/src/Alley/Validator/Comparison.php index 7f19b41..39bab00 100644 --- a/src/Alley/Validator/Comparison.php +++ b/src/Alley/Validator/Comparison.php @@ -30,12 +30,7 @@ final class Comparison extends BaseValidator '>=', ]; - /** - * Error message codes for the given operators. - * - * @var string[] - */ - private const OPERATOR_ERRORS = [ + private const OPERATOR_ERROR_CODES = [ '==' => 'notEqual', '===' => 'notIdentical', '!=' => 'isEqual', @@ -67,11 +62,11 @@ final class Comparison extends BaseValidator 'operator' => '===', ]; - private ValidatorInterface $operatorValidator; + private ValidatorInterface $operatorOptionValidator; public function __construct($options = null) { - $this->operatorValidator = new OneOf(['haystack' => self::SUPPORTED_OPERATORS]); + $this->operatorOptionValidator = new OneOf(['haystack' => self::SUPPORTED_OPERATORS]); parent::__construct($options); } @@ -108,16 +103,16 @@ protected function testValue($value): void } if (! $result) { - $this->error(self::OPERATOR_ERRORS[$this->options['operator']]); + $this->error(self::OPERATOR_ERROR_CODES[$this->options['operator']]); } } protected function setOperator(string $operator) { - $valid = $this->operatorValidator->isValid($operator); + $valid = $this->operatorOptionValidator->isValid($operator); if (! $valid) { - throw new InvalidArgumentException($this->operatorValidator->getMessages()[0]); + throw new InvalidArgumentException($this->operatorOptionValidator->getMessages()[0]); } $this->options['operator'] = $operator; diff --git a/src/Alley/Validator/OneOf.php b/src/Alley/Validator/OneOf.php index 9c685d4..aba2488 100644 --- a/src/Alley/Validator/OneOf.php +++ b/src/Alley/Validator/OneOf.php @@ -34,11 +34,11 @@ final class OneOf extends BaseValidator 'haystack' => [], ]; - private ValidatorInterface $haystackValidator; + private ValidatorInterface $haystackOptionValidator; public function __construct($options = null) { - $this->haystackValidator = new Explode([ + $this->haystackOptionValidator = new Explode([ 'validator' => new Callback('is_scalar'), 'breakOnFirstFailure' => true, ]); @@ -55,7 +55,7 @@ protected function testValue($value): void protected function setHaystack(array $haystack) { - $valid = $this->haystackValidator->isValid($haystack); + $valid = $this->haystackOptionValidator->isValid($haystack); if (! $valid) { throw new InvalidArgumentException('Haystack must contain only scalar values.'); diff --git a/src/Alley/Validator/Type.php b/src/Alley/Validator/Type.php index be6b67f..23f269d 100644 --- a/src/Alley/Validator/Type.php +++ b/src/Alley/Validator/Type.php @@ -24,19 +24,19 @@ final class Type extends BaseValidator 'array', 'bool', 'boolean', + 'callable', 'double', 'float', 'int', 'integer', + 'iterable', 'null', 'numeric', 'object', 'real', 'resource', - 'string', 'scalar', - 'callable', - 'iterable', + 'string', ]; protected $messageTemplates = [ @@ -51,11 +51,11 @@ final class Type extends BaseValidator 'type' => 'null', ]; - private ValidatorInterface $typeValidator; + private ValidatorInterface $typeOptionValidator; public function __construct($options = null) { - $this->typeValidator = new OneOf(['haystack' => self::SUPPORTED_TYPES]); + $this->typeOptionValidator = new OneOf(['haystack' => self::SUPPORTED_TYPES]); parent::__construct($options); } @@ -113,10 +113,10 @@ protected function testValue($value): void protected function setType(string $type) { - $valid = $this->typeValidator->isValid($type); + $valid = $this->typeOptionValidator->isValid($type); if (! $valid) { - throw new InvalidArgumentException($this->typeValidator->getMessages()[0]); + throw new InvalidArgumentException($this->typeOptionValidator->getMessages()[0]); } $this->options['type'] = $type; From 92e13f77d23de8d795491cf6e2a8ce36d0510691 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Thu, 21 Jul 2022 14:25:42 -0400 Subject: [PATCH 12/12] Remove unnecessary variable --- .github/workflows/tests.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 522563c..c54518c 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -13,8 +13,6 @@ jobs: can_fail: [false] name: PHP ${{ matrix.php }} - env: - CACHEDIR: /tmp/test-cache steps: - name: Check out code uses: actions/checkout@v3