From a7a92cfda9ebfab0ef28649bcd834e70dc6e7319 Mon Sep 17 00:00:00 2001 From: David Herrera Date: Tue, 3 May 2022 01:48:48 -0400 Subject: [PATCH] Add initial functionality and tests --- .gitattributes | 27 ++ .github/pull_request_template.md | 23 ++ .github/workflows/phpcs.yml | 43 +++ .github/workflows/phpunit.yml | 38 +++ .gitignore | 4 + .php-cs-fixer.dist.php | 29 ++ CHANGELOG.md | 7 + LICENSE | 339 ++++++++++++++++++++ README.md | 135 +++++++- composer.json | 43 +++ phpcs.xml | 24 ++ phpunit.xml | 12 + src/Alley/Internals/Traverser.php | 179 +++++++++++ src/Alley/reshape.php | 77 +++++ src/Alley/traverse.php | 28 ++ tests/Reshape/ReshapeTest.php | 215 +++++++++++++ tests/Traverse/Fixtures/ArrayAccessible.php | 75 +++++ tests/Traverse/TraverseTest.php | 191 +++++++++++ 18 files changed, 1488 insertions(+), 1 deletion(-) create mode 100644 .gitattributes create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/phpcs.yml create mode 100644 .github/workflows/phpunit.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 composer.json create mode 100644 phpcs.xml create mode 100644 phpunit.xml create mode 100644 src/Alley/Internals/Traverser.php create mode 100644 src/Alley/reshape.php create mode 100644 src/Alley/traverse.php create mode 100644 tests/Reshape/ReshapeTest.php create mode 100644 tests/Traverse/Fixtures/ArrayAccessible.php create mode 100644 tests/Traverse/TraverseTest.php diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..ff89b16 --- /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. +# +/.php_cs-fixer.dist.php export-ignore +/phpcs.xml export-ignore +/phpunit.xml export-ignore +/.github 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..4148e92 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +## Summary + +As titled. + +## Notes for reviewers + +None. + +## Changelog entries + +### Added + +- Initial release. + +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml new file mode 100644 index 0000000..1df75e9 --- /dev/null +++ b/.github/workflows/phpcs.yml @@ -0,0 +1,43 @@ +name: PHPCS + +on: + pull_request: + +jobs: + coding-standards: + runs-on: ubuntu-latest + strategy: + fail-fast: true + matrix: + php: [8.1] + + name: Coding Standards + 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@v2 + + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + tools: composer:v2 + coverage: none + + - name: Validate Composer config + run: composer validate --strict + + - 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 phpcs diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml new file mode 100644 index 0000000..1e1c087 --- /dev/null +++ b/.github/workflows/phpunit.yml @@ -0,0 +1,38 @@ +name: PHPUnit + +on: + pull_request: + +jobs: + tests: + 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@v2 + + - 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 phpunit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3028208 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +vendor +composer.lock +.php_cs.cache +.phpunit.result.cache diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..5da6564 --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,29 @@ + + * + * 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, + '@PHP80Migration' => 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 index a10302f..e469e7b 100644 --- a/README.md +++ b/README.md @@ -1 +1,134 @@ -# traverse-reshape +# traverse/reshape + +`traverse()` and `reshape()` are companion functions that safely break down arrays or objects and put them back together in new shapes. + +## traverse + +Traverse an array or an object using a delimiter to find one value or many values. + +```php + [ + 'red' => [ + 'gala', + 'mcintosh', + ], + 'green' => [ + 'granny_smith', + ], + ], +]; + +$obj = (object) [ + 'apples' => (object) [ + 'red' => [ + 'gala', + 'mcintosh', + ], + 'green' => [ + 'granny_smith', + ], + ], +]; + + +$green = \Alley\traverse($arr, 'apples.green'); +// ['granny_smith'] + +$red = \Alley\traverse($obj, 'apples.red'); +// ['gala', 'mcintosh'] + +[$red, $green] = \Alley\traverse($obj, ['apples.red', 'apples.green']); +// ['gala', 'mcintosh'], ['granny_smith'] + +[[$red, $green]] = \Alley\traverse( + $obj, + [ + 'apples' => [ + 'red', + 'green', + ], + ], +); +// ['gala', 'mcintosh'], ['granny_smith'] +// note the extra depth of the return value -- values are nested according to the nesting of the given paths + +[$red] = \Alley\traverse($obj, ['apples' => 'red']); +// ['gala', 'mcintosh'] + +$sweet = \Alley\traverse($arr, 'apples.green.sweet'); +// NULL + +$pears = \Alley\traverse($arr, 'pears'); +// NULL + +$req = getRemoteData(); +[$title, $date] = \Alley\traverse($req, ['title', 'date']); +// $title and $date variables are guaranteed defined regardless of $req + +[[$red, $green], $title] = \Alley\traverse( + [$arr, $req], + [ + '0.apples' => ['red', 'green'], + '1.title', + ] +); +``` + +## reshape + +Declare the shape of a new array or object whose values are extracted from a source array or object with `traverse()`. + +Shapes can be multidimensional. Paths that do not resolve in the source will be `null` in the result. If a path is given without a key, the key will be inferred from the path. Passing an object for a shape returns an object instead of an array. + +```php + 1, + 'title' => [ + 'rendered' => 'Hello world!', + ], + 'content' => [ + 'rendered' => '

Welcome to WordPress. This is your first post. Edit or delete it, then start writing!

', + ], + 'categories' => [1], + 'tags' => [], + '_links' => [ + 'self' => [ + [ + 'href' => 'https://www.example.com/wp-json/wp/v2/posts/1', + ], + ], + ], +]; + +\Alley\reshape( + $original, + [ + 'title' => 'title.rendered', + 'dek' => 'meta.dek', + 'content.rendered', + 'term_ids' => (object) [ + 'category' => 'categories', + 'post_tag' => 'tags', + ], + 'json' => '_links.self.0.href', + ] +); + +/* + [ + 'title' => 'Hello world!', + 'dek' => NULL, + 'rendered' => '

Welcome to WordPress...', + 'term_ids' => (object) [ + 'category' => [1], + 'post_tag' => [], + ], + 'json' => 'https://www.example.com/...', + ] +*/ +``` diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..2e8c8b2 --- /dev/null +++ b/composer.json @@ -0,0 +1,43 @@ +{ + "name": "alleyinteractive/traverse-reshape", + "description": "Safely break down arrays or objects, and put them back together in new shapes.", + "type": "library", + "license": "GPL-2.0-or-later", + "authors": [ + { + "name": "Alley", + "email": "info@alley.co" + } + ], + "autoload": { + "psr-4": { + "Alley\\": "src/Alley/" + }, + "files": [ + "src/Alley/reshape.php", + "src/Alley/traverse.php" + ] + }, + "autoload-dev": { + "psr-4": { + "Alley\\Tests\\": "tests/" + } + }, + "config": { + "optimize-autoloader": true, + "classmap-authoritative": true + }, + "require": { + "php": "^7.4 || ^8.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^2.19", + "phpunit/phpunit": "^9.5", + "squizlabs/php_codesniffer": "^3.6" + }, + "scripts": { + "fixer": "php-cs-fixer fix --allow-risky=yes", + "phpcs": "phpcs", + "phpunit": "phpunit" + } +} diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..d510032 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,24 @@ + + + The coding standard for traverse/reshape. + + src/ + tests/ + vendor/ + + + + + + + + + + + + + diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..15c33d0 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,12 @@ + + + tests + + + diff --git a/src/Alley/Internals/Traverser.php b/src/Alley/Internals/Traverser.php new file mode 100644 index 0000000..ca70d63 --- /dev/null +++ b/src/Alley/Internals/Traverser.php @@ -0,0 +1,179 @@ + + * + * 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\Internals; + +/** + * Contains the implementation details for the `traverse()` functions. + * + * Internals are not subject to semantic-versioning constraints. + */ +final class Traverser +{ + /** + * Data source. + * + * @var array|object + */ + private $source; + + /** + * Path or array of paths to data. + * + * @var array|string + */ + private $path; + + /** + * Path delimiter. + * + * @var string + */ + private string $delimiter; + + /** + * Found result. + * + * @var mixed + */ + private $result = null; + + /** + * Constructor. + * + * @param array|object $source Data source. + * @param string|array $path The path or array of paths. + * @param string $delimiter Delimiter. + */ + public function __construct($source, $path, string $delimiter) + { + $this->source = $source; + $this->path = $path; + $this->delimiter = $delimiter; + } + + /** + * Create an instance and return the traversed value. + * + * @param mixed ...$args Constructor arguments. + * @return mixed + */ + public static function createAndGet(...$args) + { + $instance = new self(...$args); + return $instance->get(); + } + + /** + * Get the traversed value. + * + * @return mixed + */ + public function get() + { + $this->run(); + + return $this->result; + } + + /** + * Run the traversal. + */ + private function run() + { + if (\is_array($this->path)) { + $this->result = \array_reduce(\array_keys($this->path), [$this, 'reducePaths'], []); + return; + } + + if (!\is_string($this->path) && !\is_int($this->path)) { + return; + } + + /* + * Convert the path supplied to this instance into an array using the + * delimiter supplied by this instance: + * + * - `0` becomes `[ 0 ]` + * - `foo` becomes `[ 'foo' ]` + * - `foo.bar` becomes `[ 'foo', 'bar' ]` if the delimiter is `.` + */ + $path_pieces = \explode($this->delimiter, $this->path); + + /* + * Take the first element from the newly generated array of path pieces, + * and use it as a key to try to find the matching value in the source + * data supplied to this instance. If there is no matching array key or + * object property in the source data, stop. + */ + $key = \array_shift($path_pieces); + + if (\is_array($this->source) || $this->source instanceof \ArrayAccess) { + if (!isset($this->source[$key])) { + /* + * `isset()` is used instead of `array_key_exists()` for + * compatibility with `\ArrayAccess`. Nothing is lost by the + * fact that `isset()` returns false for a null value because + * the default value for `$result` is also null, and attempting + * to continue traversing null would still return null. + */ + return; + } + + $this->result = $this->source[$key]; + } elseif (\is_object($this->source)) { + if (!isset($this->source->{$key})) { + return; + } + + $this->result = $this->source->{$key}; + } + + // If there are no more path pieces left to traverse, stop. + if (0 === \count($path_pieces)) { + return; + } + + /* + * Otherwise, there are more pieces left from the path supplied to the + * instance. Traverse the value found for the previous key, using the + * remaining path pieces and the delimiter to create a new string path. + * This process repeats until there are no more path pieces. + */ + $this->result = self::createAndGet($this->result, \implode($this->delimiter, $path_pieces), $this->delimiter); + } + + /** + * `array_reduce()` callback to reduce an array of paths into the array of values. + * + * @param array $carry Traversal result. + * @param string|int $key Key in the array of paths to fetch. + * @return array Updated array of results. + */ + private function reducePaths(array $carry, $key): array + { + $source = $this->source; + + /* + * If the key is a non-numeric string, traverse the value in the + * original source at the path specified by the key. + */ + if (!\is_numeric($key)) { + $source = self::createAndGet($source, $key, $this->delimiter); + } + + $carry[] = self::createAndGet($source, $this->path[$key], $this->delimiter); + + return $carry; + } +} diff --git a/src/Alley/reshape.php b/src/Alley/reshape.php new file mode 100644 index 0000000..a5abf63 --- /dev/null +++ b/src/Alley/reshape.php @@ -0,0 +1,77 @@ + + * + * 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; + +/** + * Reshape an array or object into new keys with values traversed from within the original. + * + * @param array|object $source Data source. + * @param array|object $shape An array or object of the new keys for the data and the paths to traverse in + * the source data to find the new values. Multidimensional values can be created + * by passing a fully-formed shape as a value in the array or object. A string value + * without a named key will use the final segment of the string as the key and the + * full string path as the value. + * @param string $delimiter Delimiter. Default is a '.'. + * @return array|object A new associative array or object from the keys and traversal paths of $shape. + */ +function reshape($source, $shape, string $delimiter = '.') +{ + /* + * If a string is included in $shape without a string key, use the last segment + * of the string as the reshaped key and the full string as the path. + */ + $final = \array_reduce( + \array_keys((array) $shape), + function ($carry, $key) use ($shape, $delimiter) { + $path = traverse($shape, (string) $key); + + if (\is_int($key)) { + $key_pieces = \explode($delimiter, $path); + $key = \array_pop($key_pieces); + } + + // Later keys replace earlier ones but remain in their given position in the shape. + unset($carry[$key]); + + return $carry + [$key => $path]; + }, + [] + ); + + // Create the desired shape now to preserve the order of its keys during the final merge. + $out = \array_fill_keys(\array_keys($final), null); + + // Key-value pairs for values that are strings and can be traversed in bulk. + $deferred = []; + + foreach ($final as $key => $path) { + if (\is_string($path)) { + $deferred[$key] = $path; + } else { + // Fill in nested arrays now. + $out[$key] = reshape($source, $path, $delimiter); + } + } + + // Merge the remaining keys on top. + $out = \array_merge( + $out, + \array_combine( + \array_keys($deferred), + traverse($source, \array_values($deferred), $delimiter) + ) + ); + + return is_object($shape) ? (object) $out : $out; +} diff --git a/src/Alley/traverse.php b/src/Alley/traverse.php new file mode 100644 index 0000000..bca9e46 --- /dev/null +++ b/src/Alley/traverse.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; + +/** + * Pluck one or many values from nested arrays or objects using 'dot' notation. + * + * @param array|object $source Data source. + * @param string|array $path The path or array of paths to values separated by $delimiter. + * Any path in array of paths can itself be an array of paths. + * @param string $delimiter Delimiter. Default is a '.'. + * @return mixed The value or values if found or null. + */ +function traverse($source, $path, string $delimiter = '.') +{ + return Internals\Traverser::createAndGet($source, $path, $delimiter); +} diff --git a/tests/Reshape/ReshapeTest.php b/tests/Reshape/ReshapeTest.php new file mode 100644 index 0000000..c6eda61 --- /dev/null +++ b/tests/Reshape/ReshapeTest.php @@ -0,0 +1,215 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Alley\Tests\Reshape; + +use PHPUnit\Framework\TestCase; + +use function Alley\reshape; + +final class ReshapeTest extends TestCase +{ + /** + * `reshape()` should assign the given key in the shape the value at the + * given path if it exists. + */ + public function testReshapeDescendIntoArray() + { + $original = [ + 'foo' => [ + 'bar' => 'baz', + ], + ]; + + $this->assertSame( + [ + 'apple' => 'baz', + 'banana' => null, + ], + reshape( + $original, + [ + 'apple' => 'foo.bar', + 'banana' => 'baz.bat', + ] + ) + ); + } + + /** + * `reshape()` should create nested arrays when the given shape has them. + */ + public function testReshapeIntoMultidimensionalArray() + { + $original = [ + 'ny' => 'albany', + 'nd' => [ + 'cap' => 'bismarck', + ], + 'sd' => [ + 'cap' => 'pierre', + ], + ]; + + $expected = [ + 'new york' => [ + 'capital' => 'albany', + ], + 'dakotas' => [ + 'north' => [ + 'capital' => 'bismarck', + ], + 'south' => [ + 'capital' => 'pierre', + ], + ], + ]; + + $this->assertSame( + $expected, + reshape( + $original, + [ + 'new york' => [ + 'capital' => 'ny', + ], + 'dakotas' => [ + 'north' => [ + 'capital' => 'nd.cap', + ], + 'south' => [ + 'capital' => 'sd.cap', + ], + ], + ] + ) + ); + } + + /** + * `reshape()` should return an object when the shape is an object. + */ + public function testReshapeIntoObject() + { + $original = [ + 'foo' => [ + 'bar' => 'baz', + ], + ]; + + $actual = reshape( + $original, + (object) [ + 'apple' => 'foo.bar', + 'banana' => 'baz.bat', + ] + ); + + $this->assertIsObject($actual); + $this->assertSame('baz', $actual->apple); + $this->assertSame(null, $actual->banana); + } + + /** + * `reshape()` should infer a key from an indexed path to a value within the shape. + */ + public function testReshapeWithShorthandPaths() + { + $original = [ + 'title' => 'hello, world!', + 'specs' => [ + 'language' => 'php', + 'version' => '9.9', + ], + ]; + + $expected = [ + 'title' => 'hello, world!', + 'language' => 'php', + 'ver' => '9.9', + ]; + + $this->assertSame( + $expected, + reshape( + $original, + [ + 'title', + 'specs.language', + 'ver' => 'specs.version', + ] + ) + ); + } + + /** + * Test that multiple sources can be combined into a single source and then reshaped. + */ + public function testReshapeMultipleSources() + { + $a = [ + 'carrier' => 'delta', + 'aircraft' => 'A380', + ]; + + $b = (object)[ + 'carrier' => 'southwest', + 'aircraft' => '737', + ]; + + $this->assertSame( + [ + 'carrier' => 'southwest', + 'aircraft' => 'A380', + ], + reshape( + [$a, $b], + [ + '1.carrier', + '0.aircraft', + ] + ) + ); + } + + /** + * Test that `reshape()` uses the last of a duplicate key in the given shape. + */ + public function testReshapeKeyCollision() + { + $original = [ + 'united states' => [ + 'capital' => 'washington, d.c.', + 'currency' => 'usd', + 'states' => [ + 'alaska' => [ + 'capital' => 'juneau', + ], + ], + ], + ]; + + $this->assertSame( + [ + 'currency' => 'usd', + 'capital' => 'juneau', + ], + reshape( + $original, + [ + 'capital' => ['united states' => 'capital'], + 'united states.currency', + 'united states.states.alaska.capital', + ] + ) + ); + } +} diff --git a/tests/Traverse/Fixtures/ArrayAccessible.php b/tests/Traverse/Fixtures/ArrayAccessible.php new file mode 100644 index 0000000..863250b --- /dev/null +++ b/tests/Traverse/Fixtures/ArrayAccessible.php @@ -0,0 +1,75 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Alley\Tests\Traverse\Fixtures; + +/** + * Implements ArrayAccess using the example internals from https://www.php.net/manual/en/class.arrayaccess.php. + */ +final class ArrayAccessible implements \ArrayAccess +{ + /** + * Internal container. + * + * @var array + */ + private array $container = []; + + /** + * Set offset. + * + * @param mixed $offset Offset key. + * @param mixed $value Value. + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (\is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Whether offset exists. + * + * @param mixed $offset Offset key. + * @return bool + */ + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Unset offset. + * + * @param mixed $offset Offset key. + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Get offset. + * + * @param mixed $offset Offset key. + * @return mixed Offset value or null. + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } +} diff --git a/tests/Traverse/TraverseTest.php b/tests/Traverse/TraverseTest.php new file mode 100644 index 0000000..fde9540 --- /dev/null +++ b/tests/Traverse/TraverseTest.php @@ -0,0 +1,191 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Alley\Tests\Traverse; + +use Alley\Tests\Traverse\Fixtures\ArrayAccessible; +use PHPUnit\Framework\TestCase; + +use function Alley\traverse; + +final class TraverseTest extends TestCase +{ + /** + * Test `traverse()` against an array. + */ + public function testTraverseArray() + { + $arr = [ + 'alpha' => [ + 'bravo' => [ + 'charlie' => 'delta', + ], + ], + ]; + + $this->assertSame(['charlie' => 'delta'], traverse($arr, 'alpha.bravo')); + $this->assertSame('delta', traverse($arr, 'alpha.bravo.charlie')); + $this->assertSame('delta', traverse($arr, 'alpha/bravo/charlie', '/')); + $this->assertNull(traverse($arr, 'alpha.bravo.charlie.delta')); + $this->assertNull(traverse($arr, 'zebra')); + } + + /** + * Test `traverse` against an object. + */ + public function testTraverseObject() + { + $charlie = (object)[ + 'charlie' => 'delta', + ]; + + $object = (object)[ + 'alpha' => (object)[ + 'bravo' => $charlie, + ], + ]; + + $this->assertSame($charlie, traverse($object, 'alpha.bravo')); + $this->assertSame('delta', traverse($object, 'alpha.bravo.charlie')); + $this->assertSame('delta', traverse($object, 'alpha/bravo/charlie', '/')); + $this->assertNull(traverse($object, 'alpha.bravo.charlie.delta')); + $this->assertNull(traverse($object, 'zebra')); + } + + /** + * Test `traverse` against an ArrayAccess instance. + */ + public function testTraverseArrayAccess() + { + $charlie = new ArrayAccessible(); + $charlie['charlie'] = 'delta'; + + $bravo = new ArrayAccessible(); + $bravo['bravo'] = $charlie; + + $object = new ArrayAccessible(); + $object['alpha'] = $bravo; + + $this->assertSame($charlie, traverse($object, 'alpha.bravo')); + $this->assertSame('delta', traverse($object, 'alpha.bravo.charlie')); + $this->assertSame('delta', traverse($object, 'alpha/bravo/charlie', '/')); + $this->assertNull(traverse($object, 'alpha.bravo.charlie.delta')); + $this->assertNull(traverse($object, 'zebra')); + } + + /** + * Test `traverse()` against a value with mixed types. + */ + public function testTraverseMixedTypes() + { + $source = [ + 'alpha' => (object)[ + 'bravo' => [ + 'charlie' => 'delta', + ], + ], + ]; + + $this->assertSame(['charlie' => 'delta'], traverse($source, 'alpha.bravo')); + $this->assertSame('delta', traverse($source, 'alpha.bravo.charlie')); + $this->assertSame('delta', traverse($source, 'alpha/bravo/charlie', '/')); + $this->assertNull(traverse($source, 'alpha.bravo.charlie.delta')); + $this->assertNull(traverse($source, 'zebra')); + } + + /** + * Test the ability to fetch multiple values with `traverse()`. + */ + public function testTraverseMultiplePaths() + { + $arr = [ + 'alpha' => 'bravo', + 'charlie' => 'delta', + 'echo' => [ + 'foxtrot' => 'golf', + 'hotel' => 'india', + ], + ]; + + $this->assertSame( + ['bravo', 'delta'], + traverse($arr, ['alpha', 'charlie']) + ); + + $this->assertSame( + ['delta', ['golf', 'india']], + traverse( + $arr, + [ + 'charlie', + [ + 'echo.foxtrot', + 'echo.hotel', + ], + ] + ) + ); + } + + /** + * Test that passing a string array key to `traverse()` will cause the data + * source to be traversed to the location in key before fetching values. + */ + public function testTraversePathInKey() + { + $arr = [ + 'alpha' => 'bravo', + 'charlie' => 'delta', + 'echo' => [ + 'foxtrot' => 'golf', + 'hotel' => 'india', + ], + 'juliette' => [ + 'kilo' => [ + 'lima' => [ + 'mike' => 'november', + 'oscar' => 'papa', + ], + ], + ], + ]; + + + $this->assertSame( + ['delta', ['golf', 'india']], + traverse( + $arr, + [ + 'charlie', + 'echo' => ['foxtrot', 'hotel'], + ] + ) + ); + + $this->assertSame( + [['november', 'papa']], + traverse( + $arr, + [ + 'juliette.kilo.lima' => ['mike', 'oscar'], + ] + ) + ); + } + + /** + * Test that `traverse()` handles a malformed path. + */ + public function testTraverseInvalidPath() + { + $this->assertNull(traverse([], true)); + } +}