diff --git a/.distignore b/.distignore new file mode 100644 index 0000000..1649ea4 --- /dev/null +++ b/.distignore @@ -0,0 +1,30 @@ +# A set of files you probably don't want in your WordPress.org distribution +.distignore +.editorconfig +.git +.gitignore +.gitlab-ci.yml +.travis.yml +.DS_Store +Thumbs.db +behat.yml +bin +circle.yml +composer.json +composer.lock +Gruntfile.js +package.json +phpunit.xml +phpunit.xml.dist +multisite.xml +multisite.xml.dist +phpcs.xml +phpcs.xml.dist +README.md +wp-cli.local.yml +tests +vendor +node_modules +*.sql +*.tar.gz +*.zip diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..79207a4 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,22 @@ +# This file is for unifying the coding style for different editors and IDEs +# editorconfig.org + +# WordPress Coding Standards +# https://make.wordpress.org/core/handbook/coding-standards/ + +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = tab +indent_size = 4 + +[{.jshintrc,*.json,*.yml}] +indent_style = space +indent_size = 2 + +[{*.txt,wp-config-sample.php}] +end_of_line = crlf diff --git a/.gitignore b/.gitignore index 219e9cd..721fab6 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,9 @@ node_modules .project .settings .idea/* +*.sql +*.tar.gz +*.zip +wp-cli.local.yml +Thumbs.db +coverage/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..9ea1c4c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,56 @@ +sudo: false + +language: php + +notifications: + email: + on_success: never + on_failure: change + +branches: + only: + - master + +cache: + directories: + - vendor + - $HOME/.composer/cache + +matrix: + include: + - php: 7.1 + env: WP_VERSION=latest + - php: 7.0 + env: WP_VERSION=latest + - php: 5.6 + env: WP_VERSION=4.7 + - php: 5.6 + env: WP_VERSION=latest + - php: 5.6 + env: WP_VERSION=trunk +# - php: 5.6 +# env: WP_TRAVISCI=phpcs + +before_script: + - export PATH="$HOME/.composer/vendor/bin:$PATH" + - | + if [[ ! -z "$WP_VERSION" ]] ; then + bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION + composer global require "phpunit/phpunit=5.7.*" + fi + - | + if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then + composer global require wp-coding-standards/wpcs + phpcs --config-set installed_paths $HOME/.composer/vendor/wp-coding-standards/wpcs + fi + +script: + - | + if [[ ! -z "$WP_VERSION" ]] ; then + phpunit + WP_MULTISITE=1 phpunit + fi + - | + if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then + phpcs + fi diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..30ace6a --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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. But first, please read +. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 681e4a8..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2016 Media News Group - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file diff --git a/bin/install-wp-tests.sh b/bin/install-wp-tests.sh new file mode 100755 index 0000000..73bb4c7 --- /dev/null +++ b/bin/install-wp-tests.sh @@ -0,0 +1,127 @@ +#!/usr/bin/env bash + +if [ $# -lt 3 ]; then + echo "usage: $0 [db-host] [wp-version] [skip-database-creation]" + exit 1 +fi + +DB_NAME=$1 +DB_USER=$2 +DB_PASS=$3 +DB_HOST=${4-localhost} +WP_VERSION=${5-latest} +SKIP_DB_CREATE=${6-false} + +WP_TESTS_DIR=${WP_TESTS_DIR-/tmp/wordpress-tests-lib} +WP_CORE_DIR=${WP_CORE_DIR-/tmp/wordpress/} + +download() { + if [ `which curl` ]; then + curl -s "$1" > "$2"; + elif [ `which wget` ]; then + wget -nv -O "$2" "$1" + fi +} + +if [[ $WP_VERSION =~ [0-9]+\.[0-9]+(\.[0-9]+)? ]]; then + WP_TESTS_TAG="tags/$WP_VERSION" +elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then + WP_TESTS_TAG="trunk" +else + # http serves a single offer, whereas https serves multiple. we only want one + download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json + grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json + LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//') + if [[ -z "$LATEST_VERSION" ]]; then + echo "Latest WordPress version could not be found" + exit 1 + fi + WP_TESTS_TAG="tags/$LATEST_VERSION" +fi + +set -ex + +install_wp() { + + if [ -d $WP_CORE_DIR ]; then + return; + fi + + mkdir -p $WP_CORE_DIR + + if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then + mkdir -p /tmp/wordpress-nightly + download https://wordpress.org/nightly-builds/wordpress-latest.zip /tmp/wordpress-nightly/wordpress-nightly.zip + unzip -q /tmp/wordpress-nightly/wordpress-nightly.zip -d /tmp/wordpress-nightly/ + mv /tmp/wordpress-nightly/wordpress/* $WP_CORE_DIR + else + if [ $WP_VERSION == 'latest' ]; then + local ARCHIVE_NAME='latest' + else + local ARCHIVE_NAME="wordpress-$WP_VERSION" + fi + download https://wordpress.org/${ARCHIVE_NAME}.tar.gz /tmp/wordpress.tar.gz + tar --strip-components=1 -zxmf /tmp/wordpress.tar.gz -C $WP_CORE_DIR + fi + + download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php +} + +install_test_suite() { + # portable in-place argument for both GNU sed and Mac OSX sed + if [[ $(uname -s) == 'Darwin' ]]; then + local ioption='-i .bak' + else + local ioption='-i' + fi + + # set up testing suite if it doesn't yet exist + if [ ! -d $WP_TESTS_DIR ]; then + # set up testing suite + mkdir -p $WP_TESTS_DIR + svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes + svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data + fi + + if [ ! -f wp-tests-config.php ]; then + download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php + # remove all forward slashes in the end + WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::") + sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php + fi + +} + +install_db() { + + if [ ${SKIP_DB_CREATE} = "true" ]; then + return 0 + fi + + # parse DB_HOST for port or socket references + local PARTS=(${DB_HOST//\:/ }) + local DB_HOSTNAME=${PARTS[0]}; + local DB_SOCK_OR_PORT=${PARTS[1]}; + local EXTRA="" + + if ! [ -z $DB_HOSTNAME ] ; then + if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then + EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp" + elif ! [ -z $DB_SOCK_OR_PORT ] ; then + EXTRA=" --socket=$DB_SOCK_OR_PORT" + elif ! [ -z $DB_HOSTNAME ] ; then + EXTRA=" --host=$DB_HOSTNAME --protocol=tcp" + fi + fi + + # create database + mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA +} + +install_wp +install_test_suite +install_db diff --git a/composer.json b/composer.json index fac5b26..7a663bf 100644 --- a/composer.json +++ b/composer.json @@ -3,5 +3,5 @@ "type": "wordpress-plugin", "description": "Get better control over your transients", "homepage": "https://github.com/dfmedia/DFM-Transients", - "license": "MIT" + "license": "GPLv3" } diff --git a/dfm-transients.php b/dfm-transients.php index 0e14b31..ad33872 100644 --- a/dfm-transients.php +++ b/dfm-transients.php @@ -3,9 +3,9 @@ * Plugin Name: Transient Control * Plugin URI: https://github.com/dfmedia/DFM-Transients * Description: Better control for transients -* Version: 1.1.3 +* Version: 1.2.0 * Author: Ryan Kanner, Digital First Media -* License: MIT +* License: GPL-3 */ if ( ! defined( 'ABSPATH' ) ) { diff --git a/includes/class-dfm-async-handler.php b/includes/class-dfm-async-handler.php index 39703ce..49bdf72 100644 --- a/includes/class-dfm-async-handler.php +++ b/includes/class-dfm-async-handler.php @@ -48,10 +48,16 @@ function __construct( $transient, $modifier, $lock_key = '' ) { } + /** + * Sends off a request to process and update the transient data asynchronously + * + * @return array|void|WP_Error + * @access public + */ public function spawn_event() { // Prevents infinite loops if we are debugging transients in the init hook, or another hook that would run - // when handling the asyc post data + // when handling the async post data $is_async_action = ( isset( $_POST['async_action'] ) ) ? true : false; if ( true === $is_async_action ) { @@ -75,7 +81,7 @@ public function spawn_event() { ); $url = admin_url( 'admin-post.php' ); - wp_safe_remote_post( $url, $request_args ); + return wp_safe_remote_post( $url, $request_args ); } diff --git a/includes/class-dfm-transient-scheduler.php b/includes/class-dfm-transient-scheduler.php index 7277ef2..306385f 100644 --- a/includes/class-dfm-transient-scheduler.php +++ b/includes/class-dfm-transient-scheduler.php @@ -95,21 +95,21 @@ public function run_update() { // Bail if a transient name wasn't passed for some reason if ( empty( $transient_name ) ) { - die(); + return; } $verify_nonce = new DFM_Async_Nonce( $transient_name ); // Bail if we couldn't verify the nonce as legit if ( false === $verify_nonce->verify( $nonce ) ) { - die(); + return; } $transient_obj = new DFM_Transients( $transient_name, $modifier ); // Bail if another process is already trying to update this transient. if ( $transient_obj->is_locked() && ! $transient_obj->owns_lock( $lock_key ) ) { - die(); + return; } if ( ! $transient_obj->is_locked() ) { @@ -121,8 +121,6 @@ public function run_update() { $transient_obj->unlock_update(); - die(); - } } diff --git a/includes/class-dfm-transients.php b/includes/class-dfm-transients.php index f03b0ff..4c42956 100644 --- a/includes/class-dfm-transients.php +++ b/includes/class-dfm-transients.php @@ -42,7 +42,7 @@ class DFM_Transients { * The storage key for the transient * * @var string - * @access private + * @access public */ public $key = ''; @@ -58,9 +58,9 @@ class DFM_Transients { * Stores the key for the update lock * * @var string - * @access private + * @access public */ - private $lock_key = ''; + public $lock_key = ''; /** * Flag for if we are attempting a retry @@ -70,15 +70,30 @@ class DFM_Transients { */ private $doing_retry = false; + /** + * Stores the array of meta storage options, mostly for in_array checks + * + * @var $meta_types array + * @access private + */ + private $meta_types = [ 'post_meta', 'term_meta', 'user_meta' ]; + /** * DFM_Transients constructor. * * @param string $transient Name of the transient * @param string|int $modifier Unique modifier for the transient + * + * @throws Exception */ function __construct( $transient, $modifier ) { global $dfm_transients; + + if ( empty( $dfm_transients[ $transient ] ) ) { + throw new Exception( __( 'You are trying to retrieve a transient that doesn\'t exist', 'dfm-transient' ) ); + } + $this->transient = $transient; $this->modifier = $modifier; $this->transient_object = $dfm_transients[ $this->transient ]; @@ -96,10 +111,6 @@ function __construct( $transient, $modifier ) { */ public function get() { - if ( ! isset( $this->transient_object ) ) { - return new WP_Error( 'invalid-transient', __( 'You are trying to retrieve a transient that doesn\'t exist', 'dfm-transients' ) ); - } - switch ( $this->transient_object->cache_type ) { case 'transient': return $this->get_from_transient(); @@ -124,16 +135,14 @@ public function get() { * * @param string|array $data The data to add to the transient * @access public - * @return WP_Error|void + * @return void + * @throws Exception */ public function set( $data ) { - if ( ! isset( $this->transient_object ) ) { - return new WP_Error( 'invalid-transient', __( 'You are trying to set data to a transient that doesn\'t exist', 'dfm-transients' ) ); - } - if ( false === $data || is_wp_error( $data ) ) { $this->facilitate_retry(); + return; } switch ( $this->transient_object->cache_type ) { @@ -150,7 +159,7 @@ public function set( $data ) { $this->save_to_metadata( $data, 'user' ); break; default: - new WP_Error( 'invalid-cache-type', __( 'When registering your transient, you used an invalid cache type. Valid options are transient, post_meta, term_meta.', 'dfm-transients' ) ); + throw new Exception( __( 'When registering your transient, you used an invalid cache type. Valid options are transient, post_meta, term_meta.', 'dfm-transients' ) ); } } @@ -158,16 +167,13 @@ public function set( $data ) { /** * This method handles the deletion of a transient * - * @return WP_Error|void + * @return void * @access public + * @throws Exception */ public function delete() { - if ( ! isset( $this->transient_object ) ) { - return new WP_Error( 'invalid-transient', __( 'You are trying to retrieve a transient that doesn\'t exist', 'dfm-transients' ) ); - } - - switch( $this->transient_object->cache_type ) { + switch ( $this->transient_object->cache_type ) { case 'transient': $this->delete_from_transient(); break; @@ -181,7 +187,7 @@ public function delete() { $this->delete_from_metadata( 'user' ); break; default: - new WP_Error( 'invalid-cache-type', __( 'When registering your transient, you used an invalid cache type. Valid options are transient, post_meta, term_meta.', 'dfm-transients' ) ); + throw new Exception( __( 'When registering your transient, you used an invalid cache type. Valid options are transient, post_meta, term_meta.', 'dfm-transients' ) ); } } @@ -248,29 +254,7 @@ private function get_from_transient() { $data = get_transient( $this->key ); - if ( false === $data || ( defined( 'DFM_TRANSIENTS_HOT_RELOAD' ) && true === DFM_TRANSIENTS_HOT_RELOAD ) ) { - - if ( true === $this->doing_retry ) { - return false; - } - $data = call_user_func( $this->transient_object->callback, $this->modifier ); - $this->set( $data ); - } elseif ( $this->is_expired( $data ) && ! $this->is_locked() ) { - $this->lock_update(); - if ( $this->should_soft_expire() ) { - new DFM_Async_Handler( $this->transient, $this->modifier, $this->lock_key ); - } else { - $data = call_user_func( $this->transient_object->callback, $this->modifier ); - $this->set( $data ); - $this->unlock_update(); - } - } - - if ( $this->should_expire() && $this->should_soft_expire() && is_array( $data ) && array_key_exists( 'data', $data ) ) { - $data = $data['data']; - } - - return $data; + return $this->get_transient_data( $data ); } @@ -285,15 +269,27 @@ private function get_from_meta( $type ) { $data = get_metadata( $type, $this->modifier, $this->key, true ); - $data_exists = true; - if ( empty( $data ) ) { $data_exists = metadata_exists( $type, $this->modifier, $this->key ); + $data = ( false === $data_exists ) ? false : $data; } - if ( false === $data_exists || ( defined( 'DFM_TRANSIENTS_HOT_RELOAD' ) && true === DFM_TRANSIENTS_HOT_RELOAD ) ) { + return $this->get_transient_data( $data ); + + } - if ( true === $this->doing_retry ) { + /** + * Handles the low level retrieval and rehydrating of data if necessary for all cache types + * + * @param mixed $data The data beind returned from the get_transient or get_metadata functions + * @return bool|mixed + * @access private + */ + private function get_transient_data( $data ) { + + if ( false === $data || ( defined( 'DFM_TRANSIENTS_HOT_RELOAD' ) && true === DFM_TRANSIENTS_HOT_RELOAD ) ) { + + if ( true === $this->doing_retry() ) { return false; } $data = call_user_func( $this->transient_object->callback, $this->modifier ); @@ -422,24 +418,24 @@ private function facilitate_retry() { if ( false === $failed_num || 0 === $failed_num ) { $failures = 1; } else { - $failures = $failed_num; + $failures = $failed_num + 1; } - // Generate the new expiration time. This essentially just muliplies the amount of failures by itself, and + // Generate the new expiration time. This essentially just multiplies the amount of failures by itself, and // then multiplies it by one minute to get the expiration, so if it is retrying it for the 5th time, it will // do 5*5 (which is 25) so it will set the retry to 25 minutes. $new_expiration = ( pow( $failures, 2 ) * MINUTE_IN_SECONDS ); // Only set the new expiration if it's less than the original registered expiration. if ( $new_expiration < $max_expiration ) { - $this->transient_object->expiration = $new_expiration; + $this->transient_object->expiration = absint( $new_expiration ); } // Save the stale data with the new expiration $this->set( $current_data ); // Add 1 to the the failures in the cache. - wp_cache_set( $this->key . '_failed', ( $failures + 1 ), 'dfm_transients_retry', DAY_IN_SECONDS ); + wp_cache_set( $this->key . '_failed', $failures, 'dfm_transients_retry', DAY_IN_SECONDS ); } @@ -452,9 +448,13 @@ private function facilitate_retry() { */ private function hash_key( $key ) { - $hashed_key = md5( $key . $this->modifier ); + $hashed_key = md5( $key ); - if ( 'post_meta' === $this->transient_object->cache_type || 'term_meta' === $this->transient_object->cache_type ) { + if ( in_array( $this->transient_object->cache_type, $this->meta_types, true ) ) { + /** + * If the storage type is *_meta then prepend the prefix after we hash so we can + * still find it for debugging + */ $hashed_key = $this->prefix . $hashed_key; } @@ -472,21 +472,18 @@ private function cache_key() { $key = $this->transient_object->key; + if ( 'transient' === $this->transient_object->cache_type && ! empty( $this->modifier ) ) { + // Add the unique modifier to the key for regular transients + $key = $key . '_' . $this->modifier; + } + if ( $this->should_hash() ) { - $key = $this->hash_key( $key ); + return $this->hash_key( $key ); } - switch ( $this->transient_object->cache_type ) { - case 'post_meta': - case 'term_meta': - case 'user_meta': - $key = $this->prefix . $key; - break; - case 'transient': - if ( ! empty( $this->modifier ) ) { - $key = $key . '_' . $this->modifier; - } - break; + if ( in_array( $this->transient_object->cache_type, $this->meta_types, true ) ) { + // Add the prefix to transients stored in meta only so they can be identified + $key = $this->prefix . $key; } return $key; @@ -500,7 +497,7 @@ private function cache_key() { * @access private */ private function should_hash() { - return $this->transient_object->hash_key; + return (bool) $this->transient_object->hash_key; } /** @@ -510,7 +507,7 @@ private function should_hash() { * @access private */ private function should_expire() { - return $this->transient_object->expiration; + return (bool) $this->transient_object->expiration; } /** @@ -520,21 +517,31 @@ private function should_expire() { * @access private */ private function should_soft_expire() { - return $this->transient_object->soft_expiration; + return (bool) $this->transient_object->soft_expiration; } /** * Whether or not the transient data has expired * * @param array|string $data The data to check if it's expired + * @access private * @return bool */ - private function is_expired( $data ) { + protected function is_expired( $data ) { if ( ! empty( $this->transient_object->expiration ) && is_array( $data ) && $data['expiration'] < time() ) { return true; - } else { - return false; } + return false; + } + + /** + * Whether or not a retry is occurring + * + * @access private + * @return bool + */ + private function doing_retry() { + return (bool) $this->doing_retry; } } diff --git a/includes/template-tags.php b/includes/template-tags.php index 0cd7800..d727117 100644 --- a/includes/template-tags.php +++ b/includes/template-tags.php @@ -28,6 +28,7 @@ * @type string $expiration Unix timestamp of when the data should expire * @type bool $soft_expiration Whether or not we should do a soft expiration on the data * } + * @throws exception */ function dfm_register_transient( $transient, $args = array() ) { @@ -38,7 +39,7 @@ function dfm_register_transient( $transient, $args = array() ) { } if ( empty( $args['callback'] ) ) { - return new WP_Error( 'transient-callback-required', __( 'You must add a callback when registering a transient.', 'dfm-transients' ) ); + throw new Exception( __( 'You must add a callback when registering a transient', 'dfm-transients' ) ); } $default_args = array( diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 0000000..2c9e091 --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,17 @@ + + + Generally-applicable sniffs for WordPress plugins + + + + + + + . + + + + + */node_modules/* + */vendor/* + diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..edbf0c8 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,20 @@ + + + + ./tests/ + + + + + ./dfm-transients.php + ./includes/ + + + diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..eae1ca4 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,25 @@ +spawn_event(); + + /** + * Not the best assertion, but the return value from wp_safe_remote_post is the response + * from the request, which doesn't really contain any useful data + */ + $this->assertFalse( is_wp_error( $result ) ); + + } + + /** + * Test to make sure we halt execution if the async action is trying to trigger this method + * since that will cause an infinite loop + */ + public function testAsyncRequestNotPosted() { + + $async_obj = new DFM_Async_Handler( 'testTransient', '' ); + $_POST['async_action'] = 'true'; + + $result = $async_obj->spawn_event(); + + $this->assertNull( $result ); + + } + +} diff --git a/tests/test-class-dfm-async-nonce.php b/tests/test-class-dfm-async-nonce.php new file mode 100644 index 0000000..eb731e4 --- /dev/null +++ b/tests/test-class-dfm-async-nonce.php @@ -0,0 +1,62 @@ +create(); + $this->assertTrue( is_string( $actual ) ); + $this->assertEquals( 10, strlen( $actual ) ); + } + + /** + * Tests that nonces are actually unique + */ + public function testNonceUnique() { + $first_obj = new DFM_Async_Nonce( 'test' ); + $second_obj = new DFM_Async_Nonce( 'another test' ); + $first = $first_obj->create(); + $second = $second_obj->create(); + $this->assertNotEquals( $first, $second ); + } + + /** + * Tests that the verification of the nonce works correctly + */ + public function testShouldVerifyNonce() { + $nonce_obj = new DFM_Async_Nonce( 'testing' ); + $nonce = $nonce_obj->create(); + $this->assertTrue( $nonce_obj->verify( $nonce ) ); + } + + /** + * Tests that the any random string doesn't get verified by the nonce check + */ + public function testShouldNotVerifyNonce() { + $nonce_obj = new DFM_Async_Nonce( 'another_test' ); + $this->assertFalse( $nonce_obj->verify( 'some random string' ) ); + } + + /** + * Tests that an older nonce (older than 12 hours) still will get verified + */ + public function testShouldVerifyOldNonce() { + $nonce_obj = new DFM_Async_Nonce( 'some_test' ); + $i = wp_nonce_tick() - 1; + $nonce = substr( wp_hash( $i . 'dfm_some_test' . get_class( $nonce_obj ), 'nonce' ), -12, 10 ); + $this->assertTrue( $nonce_obj->verify( $nonce ) ); + } + + /** + * Tests that a nonce older than 24 hours does not get verified + */ + public function testShouldNotVerifyOldNonce() { + $nonce_obj = new DFM_Async_Nonce( 'some_other_test' ); + $i = wp_nonce_tick() - 2; + $nonce = substr( wp_hash( $i . 'dfm_some_test' . get_class( $nonce_obj ), 'nonce' ), -12, 10 ); + $this->assertFalse( $nonce_obj->verify( $nonce ) ); + } + +} diff --git a/tests/test-class-dfm-transient-hook.php b/tests/test-class-dfm-transient-hook.php new file mode 100644 index 0000000..555cb68 --- /dev/null +++ b/tests/test-class-dfm-transient-hook.php @@ -0,0 +1,127 @@ +assertTrue( has_filter( 'testHook' ) ); + } + + /** + * Test to make sure a non-async update gets updated correctly + */ + public function testNonAsyncHandlerUpdate() { + + $transient_name = 'testNonAsyncHandlerUpdate'; + dfm_register_transient( $transient_name, [ + 'expiration' => HOUR_IN_SECONDS, + 'callback' => function() { + return 'test data'; + }, + ] ); + + $hook_obj = new DFM_Transient_Hook( $transient_name, 'testHook', false ); + + $hook_obj->spawn(); + + $this->assertEquals( 'test data', get_transient( $transient_name ) ); + + } + + /** + * Tests to see that an update will fail if the update is locked by a different process + */ + public function testUpdateFailureBecauseOfLock() { + + $transient_name = 'testUpdateFailureBecauseOfLock'; + dfm_register_transient( $transient_name, [ + 'callback' => function() { + return 'test data'; + }, + ] ); + + /** + * Lock the update manually + */ + set_transient( 'dfm_lt_' . $transient_name, '1234' ); + + $hook_obj = new DFM_Transient_Hook( $transient_name, 'testHook', false ); + $hook_obj->spawn(); + + $this->assertFalse( get_transient( $transient_name ) ); + + } + + /** + * Tests to see that a non async update with multiple modifiers gets updated correctly + */ + public function testNonAsyncUpdateMultipleModifiers() { + + $transient_name = 'testNonAsyncUpdateMultipleModifiers'; + dfm_register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'modifier: ' . $modifier; + }, + ] ); + + $hook_obj = new DFM_Transient_Hook( $transient_name, 'testHook', false, function() { + return [ 1, 2, 3 ]; + } ); + + $hook_obj->spawn(); + + $this->assertEquals( 'modifier: 1', get_transient( $transient_name . '_1' ) ); + + } + + /** + * Tests to make sure the update process gets short-circuited if the callback for the hook + * returns false + */ + public function testShortCircuitHookUpdate() { + + $transient_name = 'testShortCircuitHookUpdate'; + dfm_register_transient( $transient_name, [ 'callback' => '__return_true' ] ); + + $hook_obj = new DFM_Transient_Hook( $transient_name, 'testHook', false, function() { + return false; + } ); + + $hook_obj->spawn(); + + $this->assertEquals( false, get_transient( $transient_name ) ); + + } + + /** + * Tests to make sure an async update gets scheduled properly + */ + public function testAsyncHandlerUpdate() { + + $hook_obj = new DFM_Transient_Hook( 'testTransient', 'testHook', true ); + $hook_obj->spawn(); + + global $wp_filter; + $this->assertEquals( 1, count( $wp_filter['shutdown']->callbacks[10] ) ); + + } + + /** + * Tests to make sure multiple async updated get scheduled properly + */ + public function testMultipleAsyncHandlerUpdates() { + + $hook_obj = new DFM_Transient_Hook( 'testTransient', 'testHook', true, function() { + return [ 1, 2, 3 ]; + } ); + + $hook_obj->spawn(); + + global $wp_filter; + $this->assertEquals( 3, count( $wp_filter['shutdown']->callbacks[10] ) ); + + } + +} diff --git a/tests/test-class-dfm-transient-scheduler.php b/tests/test-class-dfm-transient-scheduler.php new file mode 100644 index 0000000..6090a13 --- /dev/null +++ b/tests/test-class-dfm-transient-scheduler.php @@ -0,0 +1,158 @@ + '__return_true', + 'update_hooks' => [ 'test_hook', 'another_test_hook' ], + ] ); + + $scheduler_obj = new DFM_Transient_Scheduler(); + $scheduler_obj->get_transients(); + + $this->assertTrue( has_filter( 'admin_post_nopriv_dfm_' . $transient_name ) ); + + } + + /** + * Don't setup any hooks if no transients are registered + */ + public function testSetupHooksNotRun() { + + global $dfm_transients; + $dfm_transients = []; + + $scheduler_obj = $this->getMockBuilder( 'DFM_Transient_Scheduler' ) + ->setMethods( [ 'post_processing_hooks' ] ) + ->getMock(); + + /** + * Asserts that the post_processing_hooks method never gets called if no transients are + * registered + */ + $scheduler_obj->expects( $this->never() ) + ->method( 'post_processing_hooks' ); + + $actual = $scheduler_obj->get_transients(); + $this->assertNull( $actual ); + + } + + /** + * Test to make sure the update happens successfully + */ + public function testUpdateSuccessful() { + + $transient_name = 'testSetupHooks'; + dfm_register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'modifier: ' . $modifier; + }, + 'async_updates' => true, + ] ); + + $nonce_obj = new DFM_Async_Nonce( $transient_name ); + + $_POST['transient_name'] = $transient_name; + $_POST['modifier'] = '1'; + $_POST['_nonce'] = $nonce_obj->create(); + + $scheduler_obj = new DFM_Transient_Scheduler(); + + $scheduler_obj->run_update(); + + $expected = 'modifier: 1'; + $actual = get_transient( $transient_name . '_1' ); + $this->assertEquals( $expected, $actual ); + + } + + /** + * If no transient name is passed in the headers from the async handler, halt execution + */ + public function testUnsuccessfulUpdateWithoutName() { + + $transient_name = 'testUnsuccessfulUpdateWithoutName'; + dfm_register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'modifier: ' . $modifier; + }, + ] ); + + $nonce_obj = new DFM_Async_Nonce( $transient_name ); + + $_POST['transient_name'] = ''; //This should kill the request + $_POST['modifier'] = '1'; + $_POST['_nonce'] = $nonce_obj->create(); + + $scheduler_obj = new DFM_Transient_Scheduler(); + + $scheduler_obj->run_update(); + + $this->assertFalse( get_transient( $transient_name . '_1' ) ); + + } + + /** + * If the incorrect nonce is passed to the method from the handler, halt execution + */ + public function testUnsuccessfulUpdateWithoutNonce() { + + $transient_name = 'testUnsuccessfulUpdateWithoutNonce'; + dfm_register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'modifier: ' . $modifier; + }, + ] ); + + $nonce_obj = new DFM_Async_Nonce( $transient_name . '_test' ); + + $_POST['transient_name'] = $transient_name; //This should kill the request + $_POST['modifier'] = '1'; + $_POST['_nonce'] = $nonce_obj->create(); + + $scheduler_obj = new DFM_Transient_Scheduler(); + + $scheduler_obj->run_update(); + + $this->assertFalse( get_transient( $transient_name . '_1' ) ); + + } + + /** + * If the transient update process is locked by another process, halt execution + */ + public function testUnsuccessfulUpdateWithoutLock() { + + $transient_name = 'testUnsuccessfulUpdateWithoutLock'; + dfm_register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'modifier: ' . $modifier; + }, + ] ); + + /** + * Manually lock the transient from updating + */ + set_transient( 'dfm_lt_' . $transient_name . '_1', 'somevalue' ); + + $nonce_obj = new DFM_Async_Nonce( $transient_name ); + + $_POST['transient_name'] = $transient_name; //This should kill the request + $_POST['modifier'] = '1'; + $_POST['_nonce'] = $nonce_obj->create(); + + $scheduler_obj = new DFM_Transient_Scheduler(); + + $scheduler_obj->run_update(); + + $this->assertFalse( get_transient( $transient_name . '_1' ) ); + + } + +} diff --git a/tests/test-class-dfm-transients.php b/tests/test-class-dfm-transients.php new file mode 100644 index 0000000..24017f6 --- /dev/null +++ b/tests/test-class-dfm-transients.php @@ -0,0 +1,639 @@ +setExpectedException( 'Exception', 'You are trying to retrieve a transient that doesn\'t exist' ); + $this->expectException( new DFM_Transients( 'NonExistentTransient', '' ) ); + + } + + /** + * Tests that the update locking feature works as expected + */ + public function testLockUpdate() { + + $transient_name = 'testLockUpdate'; + + $this->register_transient( $transient_name ); + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $expected = $transient_obj->lock_key; + + $transient_obj->lock_update(); + + $actual = get_transient( 'dfm_lt_' . $transient_obj->key ); + + $this->assertEquals( $expected, $actual ); + $this->assertEquals( true, $transient_obj->is_locked() ); + $this->assertEquals( true, $transient_obj->owns_lock( $actual ) ); + + $transient_obj->unlock_update(); + $expected = false; + $actual = get_transient( 'dfm_lt_' . $transient_obj->key );; + + $this->assertEquals( $expected, $actual ); + + } + + /** + * Test that a random string cannot be passed to indicate lock ownership + */ + public function testNotOwnsLock() { + + $transient_name = 'testNotOwnsLock'; + $this->register_transient( $transient_name ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $this->assertEquals( false, $transient_obj->owns_lock( 'test' ) ); + + } + + /** + * Tests that the transient key gets generated correctly with and without a modifier + */ + public function testTransientKey() { + + $method = $this->reflect_method( 'cache_key' ); + + $transient_name = 'testTransientKey'; + $this->register_transient( $transient_name ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + $this->assertEquals( $transient_name, $method->invoke( $transient_obj ) ); + + $modifier = 'test'; + $transient_obj_with_modifier = new DFM_Transients( $transient_name, $modifier ); + $this->assertEquals( $transient_name . '_' . $modifier, $method->invoke( $transient_obj_with_modifier ) ); + + } + + /** + * Tests the retry method + */ + public function testTransientRetryMethod() { + + $transient_name = 'testTransientRetryMethod'; + $this->register_transient( $transient_name, [ + 'callback' => function() { + return 'test value'; + }, + 'expiration' => HOUR_IN_SECONDS, + 'soft_expiration' => true, + ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $transient_obj->get(); + $expected = 'test value'; + $this->assertEquals( $expected, $actual ); + + $transient_obj->set( false ); + $failed_num = wp_cache_get( $transient_obj->key . '_failed', 'dfm_transients_retry' ); + $this->assertEquals( 1, $failed_num ); + + $this->assertEquals( $expected, $transient_obj->get() ); + + $transient_obj->set( new WP_Error( 'sample-error', 'something happened' ) ); + $this->assertEquals( $expected, $transient_obj->get() ); + $failed_num = wp_cache_get( $transient_obj->key . '_failed', 'dfm_transients_retry' ); + $this->assertEquals( 2, $failed_num ); + + $transient_data = get_transient( $transient_obj->key ); + $this->assertEquals( ( 1 * MINUTE_IN_SECONDS ) + time(), $transient_data['expiration'] ); + + } + + /** + * Tests to make sure the transient key for meta transients gets generated correctly + */ + public function testMetaTransientKey() { + + $method = $this->reflect_method( 'cache_key' ); + + $transient_name = 'testMetaTransientKey'; + $this->register_transient( $transient_name, [ 'cache_type' => 'post_meta' ] ); + $this->register_transient( $transient_name . 'Hashed', [ 'cache_type' => 'post_meta', 'hash_key' => true ] ); + + $transient_obj = new DFM_Transients( $transient_name, 1 ); + $this->assertEquals( 'dfm_transient_' . $transient_name, $method->invoke( $transient_obj ) ); + + $transient_obj_hashed = new DFM_Transients( $transient_name . 'Hashed', 1 ); + $this->assertEquals( 'dfm_transient_' . md5( $transient_name . 'Hashed' ), $method->invoke( $transient_obj_hashed ) ); + + } + + /** + * Tests to make sure key hashing is working correctly + */ + public function testShouldHashKey() { + + $should_hash_method = $this->reflect_method( 'should_hash' ); + $get_key_method = $this->reflect_method( 'cache_key' ); + + $transient_name = 'TestTransientHashKey'; + $this->register_transient( $transient_name, [ 'hash_key' => true ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $should_hash_actual = $should_hash_method->invoke( $transient_obj ); + + $this->assertTrue( $should_hash_actual ); + $this->assertEquals( md5( $transient_name ), $get_key_method->invoke( $transient_obj ) ); + + $transient_obj_modifier = new DFM_Transients( $transient_name, 'test_modifier' ); + $this->assertEquals( md5( $transient_name . '_test_modifier' ), $get_key_method->invoke( $transient_obj_modifier ) ); + + } + + /** + * Tests to make sure key hashing is not happening outside of the scope it is supposed to + */ + public function testShouldNotHashKey() { + + $should_hash_method = $this->reflect_method( 'should_hash' ); + $get_key_method = $this->reflect_method( 'cache_key' ); + + $transient_name = 'TestTransientNotHashKey'; + $this->register_transient( $transient_name, [ 'hash_key' => false ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $should_hash_actual = $should_hash_method->invoke( $transient_obj ); + + $this->assertFalse( $should_hash_actual ); + $this->assertEquals( $transient_name, $get_key_method->invoke( $transient_obj ) ); + + $transient_obj_modifier = new DFM_Transients( $transient_name, 'test_modifier' ); + $this->assertEquals( $transient_name . '_test_modifier', $get_key_method->invoke( $transient_obj_modifier ) ); + + } + + /** + * Tests to make sure the should_expire method is working properly + */ + public function testShouldExpire() { + + $method = $this->reflect_method( 'should_expire' ); + + $transient_name = 'TestTransientExpiration'; + $this->register_transient( $transient_name, [ 'expiration' => HOUR_IN_SECONDS ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $method->invoke( $transient_obj ); + + $this->assertTrue( $actual ); + + } + + /** + * Tests to make sure the should_expire method is not overreaching it's intended scope + */ + public function testShouldNotExpire() { + + $method = $this->reflect_method( 'should_expire' ); + + $transient_name = 'TestTransientNotExpiration'; + $this->register_transient( $transient_name, [ 'expiration' => false ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $method->invoke( $transient_obj ); + + $this->assertFalse( $actual ); + + } + + /** + * Tests to make sure the should_soft_expire method is working as intended + */ + public function testShouldSoftExpire() { + + $method = $this->reflect_method( 'should_soft_expire' ); + + $transient_name = 'TestSoftExpireTransient'; + $this->register_transient( $transient_name, [ 'soft_expiration' => true ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $method->invoke( $transient_obj ); + + $this->assertTrue( $actual ); + + } + + /** + * Tests to make sure the should_soft_expire method is not overreaching it's intended scope + */ + public function testShouldNotSoftExpire() { + + $method = $this->reflect_method( 'should_soft_expire' ); + + $transient_name = 'TestNotSoftExpireTransient'; + $this->register_transient( $transient_name, [ 'soft_expiration' => false ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $method->invoke( $transient_obj ); + + $this->assertFalse( $actual ); + + } + + /** + * Test to make sure an actual expired transient registers as expired with the is_expired method + */ + public function testTransientIsExpired() { + + $method = $this->reflect_method( 'is_expired' ); + + $transient_name = 'TestExpiredTransient'; + $this->register_transient( $transient_name, [ 'expiration' => 1 ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $method->invoke( $transient_obj, [ 'expiration' => time() - 1, 'data' => 'test' ] ); + + $this->assertTrue( $actual ); + + } + + /** + * Test to make sure an actual non-expired transient does not register as expired in the + * is_expired method + */ + public function testTransientNotExpired() { + + $method = $this->reflect_method( 'is_expired' ); + + $transient_name = 'TestNotExpiredTransient'; + $this->register_transient( $transient_name, [ 'expiration' => DAY_IN_SECONDS ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $actual = $method->invoke( $transient_obj, [ 'expiration' => time(), 'data' => 'test' ] ); + + $this->assertFalse( $actual ); + + } + + /** + * Test to retrieve a transient that has a modifier + */ + public function testGetTransientWithModifier() { + + $transient_name = 'testGetTransientWithModifier'; + $this->register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return $modifier . ' test value'; + }, + 'cache_type' => 'transient', + ] ); + + $transient_obj = new DFM_Transients( $transient_name, 'something' ); + $key = $transient_obj->key; + + $actual = $transient_obj->get(); + $expected = 'something test value'; + + $this->assertEquals( $actual, $expected ); + + $transient_obj->set( 'another test' ); + $this->assertEquals( 'another test', $transient_obj->get() ); + + $transient_obj->delete(); + $this->assertFalse( get_transient( $key ) ); + $this->assertEquals( $expected, $transient_obj->get() ); + + } + + /** + * Test to make sure retrieving a transient with a soft expiration works correctly + */ + public function testGetTransientWithSoftExpire() { + + $transient_name = 'testGetTransientWithSoftExpire'; + $this->register_transient( $transient_name, [ + 'soft_expiration' => true, + 'expiration' => DAY_IN_SECONDS, + 'callback' => function() { + return 'some string'; + }, + ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + $key = $transient_obj->key; + + $expected = 'some string'; + $actual = $transient_obj->get(); + $this->assertEquals( $expected, $actual ); + $this->assertArrayHasKey( 'data', get_transient( $key ) ); + $this->assertArrayHasKey( 'expiration', get_transient( $key ) ); + + $transient_obj->set( 'some other string' ); + $this->assertEquals( 'some other string', $transient_obj->get() ); + + $transient_obj->delete(); + $this->assertEquals( $expected, $transient_obj->get() ); + + } + + /** + * Test to make sure getting transient data from term meta works correctly + */ + public function testGetTransientFromTermMeta() { + + $term_arr = wp_insert_term( 'Test Term', 'category' ); + $term_id = (int) $term_arr['term_id']; + + $transient_name = 'testGetTransientFromTermMeta'; + $this->register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'term id: ' . $modifier; + }, + 'cache_type' => 'term_meta', + ] ); + + $transient_obj = new DFM_Transients( $transient_name, $term_id ); + $key = $transient_obj->key; + + $actual = $transient_obj->get(); + $expected = 'term id: ' . $term_id; + + $this->assertEquals( $expected, $actual ); + + $transient_obj->set( 'some test value' ); + $this->assertEquals( 'some test value', $transient_obj->get() ); + + $transient_obj->delete(); + $this->assertEquals( '', get_term_meta( $term_id, $key, true ) ); + $this->assertEquals( $expected, $transient_obj->get() ); + $this->assertEquals( $expected, get_term_meta( $term_id, $key, true ) ); + + } + + /** + * Test to make sure getting transient data from post meta works correctly + */ + public function testGetTransientFromPostMeta() { + + $post_id = $this->factory->post->create(); + $transient_name = 'testGetTransientFromPostMeta'; + + $this->register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'post id: ' . $modifier; + }, + 'cache_type' => 'post_meta', + ] ); + + $transient_obj = new DFM_Transients( $transient_name, $post_id ); + $key = $transient_obj->key; + + $actual = $transient_obj->get(); + $expected = 'post id: ' . $post_id; + $this->assertEquals( $expected, $actual ); + + $transient_obj->set( 'some test value' ); + $this->assertEquals( 'some test value', $transient_obj->get() ); + + $transient_obj->delete(); + $this->assertEquals( '', get_post_meta( $post_id, $key, true ) ); + $this->assertEquals( $expected, $transient_obj->get() ); + $this->assertEquals( $expected, get_post_meta( $post_id, $key, true ) ); + + } + + /** + * Test to make sure getting transient data from meta with an expiration works correctly + */ + public function testGetTransientFromMetaWithExpiration() { + + $post_id = $this->factory->post->create(); + $transient_name = 'testGetTransientFromMetaWithExpiration'; + + $this->register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'post id: ' . $modifier; + }, + 'cache_type' => 'post_meta', + 'expiration' => DAY_IN_SECONDS, + 'soft_expiration' => true, + 'hash_key' => true, + ] ); + + $transient_obj = new DFM_Transients( $transient_name, $post_id ); + $key = $transient_obj->key; + + $actual = $transient_obj->get(); + $expected = 'post id: ' . $post_id; + $this->assertEquals( $expected, $actual ); + + $transient_obj->set( 'some test value' ); + $this->assertEquals( 'some test value', $transient_obj->get() ); + $this->assertArrayHasKey( 'data', get_post_meta( $post_id, $key, true ) ); + $this->assertArrayHasKey( 'expiration', get_post_meta( $post_id, $key, true ) ); + + $transient_obj->delete(); + $this->assertEquals( '', get_post_meta( $post_id, $key, true ) ); + $this->assertEquals( $expected, $transient_obj->get() ); + $this->assertEquals( $expected, get_post_meta( $post_id, $key, true )['data'] ); + + } + + /** + * Test to make sure getting transient data from user meta works correctly + */ + public function testGetTransientFromUserMeta() { + + $user_id = $this->factory->user->create(); + $transient_name = 'testGetTransientFromUserMeta'; + + $this->register_transient( $transient_name, [ + 'callback' => function( $modifier ) { + return 'user id: ' . $modifier; + }, + 'cache_type' => 'user_meta', + ] ); + + $transient_obj = new DFM_Transients( $transient_name, $user_id ); + $key = $transient_obj->key; + + $actual = $transient_obj->get(); + $expected = 'user id: ' . $user_id; + $this->assertEquals( $actual, $expected ); + + $transient_obj->set( 'some test value' ); + $this->assertEquals( 'some test value', $transient_obj->get() ); + + $transient_obj->delete(); + $this->assertEquals( '', get_user_meta( $user_id, $key, true ) ); + $this->assertEquals( $expected, $transient_obj->get() ); + $this->assertEquals( $expected, get_user_meta( $user_id, $key, true ) ); + + } + + /** + * Test for retrieving a transient while the code is doing a retry + */ + public function testGetTransientDataDuringRetry() { + + $transient_name = 'testGetTransientDataDuringRetry'; + $this->register_transient( $transient_name ); + + $transient_obj = $this->getMockBuilder( 'DFM_Transients' ) + ->setConstructorArgs( [ $transient_name, '' ] ) + ->setMethods( [ 'doing_retry' ] ) + ->getMock(); + + $transient_obj->expects( $this->any() ) + ->method( 'doing_retry' ) + ->will( $this->returnValue( true ) ); + + $actual = $transient_obj->get(); + $this->assertFalse( $actual ); + + } + + /** + * Test to make sure getting transient data from a transient cache with a soft expiration + * works correctly + */ + public function testUpdateForSoftExpiredData() { + + $transient_name = 'testUpdateForSoftExpiredData'; + $this->register_transient( $transient_name, [ + 'soft_expiration' => true, + 'expiration' => HOUR_IN_SECONDS, + 'callback' => function() { + return 'test data'; + } + ] ); + + $transient_obj = $this->getMockBuilder( 'DFM_Transients' ) + ->setConstructorArgs( [ $transient_name, '' ] ) + ->setMethods( [ 'is_expired' ] ) + ->getMock(); + + $transient_obj->expects( $this->any() ) + ->method( 'is_expired' ) + ->will( $this->returnValue( true ) ); + + $expected = 'some string'; + $transient_obj->set( $expected ); + $actual = $transient_obj->get(); + $this->assertEquals( $expected, $actual ); + + /** + * Removing this core hook so we can better tell if our async handler is actually getting + * added to the shutdown hook + */ + remove_action( 'shutdown', 'wp_ob_end_flush_all', 1 ); + $this->assertTrue( has_filter( 'shutdown' ) ); + + } + + /** + * Tests to make sure data with a hard expiration gets regenerated properly + */ + public function testUpdateForHardExpiredData() { + + $transient_name = 'testUpdateForHardExpiredData'; + $this->register_transient( $transient_name, [ + 'expiration' => HOUR_IN_SECONDS, + 'callback' => function() { + return 'test data'; + } + ] ); + + $transient_obj = $this->getMockBuilder( 'DFM_Transients' ) + ->setConstructorArgs( [ $transient_name, '' ] ) + ->setMethods( [ 'is_expired' ] ) + ->getMock(); + + $transient_obj->expects( $this->any() ) + ->method( 'is_expired' ) + ->will( $this->returnValue( true ) ); + + $expected = 'test data'; + $transient_obj->set( 'some other data' ); + $actual = $transient_obj->get(); + + $this->assertEquals( $expected, $actual ); + + } + + /** + * Tests to make sure if we try to get data from a transient that was registered with a + * non-existent type it throws an error + */ + public function testGetTransientFromNonExistentType() { + + $transient_name = 'testGetTransientFromNonExistentType'; + $this->register_transient( $transient_name, [ 'cache_type' => 'none' ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $this->assertTrue( is_wp_error( $transient_obj->get() ) ); + + $this->setExpectedException( 'Exception', 'When registering your transient, you used an invalid cache type. Valid options are transient, post_meta, term_meta.' ); + $this->expectException( $transient_obj->set( 'test' ) ); + + + } + + /** + * Tests to make sure if we try to get delete data from a transient that was registered with a + * non-existent type it throws an error + */ + public function testDeleteTransientFromNonExistentType() { + + $transient_name = 'testDeleteTransientFromNonExistentType'; + $this->register_transient( $transient_name, [ 'cache_type' => 'none' ] ); + + $transient_obj = new DFM_Transients( $transient_name, '' ); + + $this->setExpectedException( 'Exception', 'When registering your transient, you used an invalid cache type. Valid options are transient, post_meta, term_meta.' ); + $this->expectException( $transient_obj->delete() ); + + } + + /** + * Helper method to reflect a method within a class + * + * @param string $method_name Name of the method you want to reflect + * @return ReflectionMethod + */ + private function reflect_method( $method_name ) { + + $method = new ReflectionMethod( 'DFM_Transients', $method_name ); + $method->setAccessible( true ); + + return $method; + + } + + /** + * Helper function to register a transient + * + * @param string $name Name of the transient to register + * @param array $args Arguments to register for the transient + */ + private function register_transient( $name, $args = [] ) { + + $defaults = [ + 'callback' => '__return_false', + ]; + + dfm_register_transient( $name, wp_parse_args( $args, $defaults ) ); + + } + +} diff --git a/tests/test-template-tags.php b/tests/test-template-tags.php new file mode 100644 index 0000000..f4d55e6 --- /dev/null +++ b/tests/test-template-tags.php @@ -0,0 +1,177 @@ +assertEquals( (object) $expected_args, $dfm_transients[ $transient_name ] ); + + } + + /** + * Test to make sure an error gets thrown when you try to register a transient without a name + */ + public function testUnsuccessfulRegistration() { + + $transient_name = 'testTransientWithoutCallback'; + + $this->setExpectedException( 'Exception', 'You must add a callback when registering a transient' ); + $this->expectException( dfm_register_transient( $transient_name, [] ) ); + + } + + /** + * Simple get transient test + */ + public function testGetTransient() { + + $transient_name = 'testTransientGet'; + $transient_value = 'test value'; + $r = set_transient( $transient_name, $transient_value ); + + $this->assertTrue( $r ); + + dfm_register_transient( $transient_name, [ + 'cache_type' => 'transient', + 'callback' => function() { + return 'test value'; + }, + ] ); + + $actual = dfm_get_transient( $transient_name ); + + $this->assertEquals( $transient_value, $actual ); + + dfm_delete_transient( $transient_name ); + + $this->assertFalse( get_transient( $transient_name ) ); + + } + + /** + * Test to get a transient that has no initial value + */ + public function testGetTransientWithNoInitialValue() { + + $transient_name = 'testTransientGetWithoutValue'; + $expected = 'test value'; + + dfm_register_transient( $transient_name, [ + 'cache_type' => 'transient', + 'callback' => function() { + return 'test value'; + }, + ] ); + + $actual = dfm_get_transient( $transient_name ); + + $this->assertEquals( $expected, $actual ); + + dfm_delete_transient( $transient_name ); + $this->assertFalse( get_transient( $transient_name ) ); + + } + + /** + * Test to get a transient from post meta + */ + public function testGetTransientPostMeta() { + + $transient_name = 'testTransientGetFromPostMeta'; + $expected = 'test value'; + + $post_id = $this->factory->post->create(); + + update_post_meta( $post_id, 'dfm_transient_' . $transient_name, $expected ); + + dfm_register_transient( $transient_name, [ 'cache_type' => 'post_meta', 'callback' => '__return_true' ] ); + $actual = dfm_get_transient( $transient_name, $post_id ); + + $this->assertEquals( $expected, $actual ); + + } + + /** + * Helper method for the register test data provider + * + * @return array + */ + public function providerRegisterTest() { + return [ + [ + 'testTransient1', + [ + 'hash_key' => false, + 'cache_type' => 'transient', + 'callback' => '__return_true', + 'async_updates' => false, + 'update_hooks' => [], + 'expiration' => false, + 'soft_expiration' => false, + ], + [ + 'key' => 'testTransient1', + 'hash_key' => false, + 'cache_type' => 'transient', + 'callback' => '__return_true', + 'async_updates' => false, + 'update_hooks' => [], + 'expiration' => false, + 'soft_expiration' => false, + ], + ], + [ + 'testTransient2', + [ + 'key' => 'testTransient2Key', + 'hash_key' => false, + 'cache_type' => 'term_meta', + 'callback' => '__return_true', + 'async_updates' => true, + 'update_hooks' => [ 'update_post' ], + 'expiration' => HOUR_IN_SECONDS, + 'soft_expiration' => true, + ], + [ + 'key' => 'testTransient2Key', + 'hash_key' => false, + 'cache_type' => 'term_meta', + 'callback' => '__return_true', + 'async_updates' => true, + 'update_hooks' => [ 'update_post' ], + 'expiration' => HOUR_IN_SECONDS, + 'soft_expiration' => true, + ], + ], + [ + 'testTransient3', + [ + 'callback' => '__return_true', + ], + [ + 'key' => 'testTransient3', + 'hash_key' => false, + 'cache_type' => 'transient', + 'callback' => '__return_true', + 'async_updates' => false, + 'update_hooks' => false, + 'expiration' => false, + 'soft_expiration' => false, + ], + ], + ]; + } + +}