diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..a7c44dd --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.{yml,yaml}] +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9e9519b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,19 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.github export-ignore +/.gitattributes export-ignore +/.gitignore export-ignore +/phpunit.xml.dist export-ignore +/art export-ignore +/docs export-ignore +/tests export-ignore +/.editorconfig export-ignore +/.php_cs.dist.php export-ignore +/psalm.xml export-ignore +/psalm.xml.dist export-ignore +/testbench.yaml export-ignore +/UPGRADING.md export-ignore +/phpstan.neon.dist export-ignore +/phpstan-baseline.neon export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..726b886 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +.idea +.php_cs +.php_cs.cache +.phpunit.result.cache +build +composer.lock +coverage +phpunit.xml +phpstan.neon +testbench.yaml +vendor +node_modules +.php-cs-fixer.cache diff --git a/.php_cs.dist.php b/.php_cs.dist.php new file mode 100644 index 0000000..8d8a790 --- /dev/null +++ b/.php_cs.dist.php @@ -0,0 +1,40 @@ +in([ + __DIR__ . '/src', + __DIR__ . '/tests', + ]) + ->name('*.php') + ->notName('*.blade.php') + ->ignoreDotFiles(true) + ->ignoreVCS(true); + +return (new PhpCsFixer\Config()) + ->setRules([ + '@PSR12' => true, + 'array_syntax' => ['syntax' => 'short'], + 'ordered_imports' => ['sort_algorithm' => 'alpha'], + 'no_unused_imports' => true, + 'not_operator_with_successor_space' => true, + 'trailing_comma_in_multiline' => true, + 'phpdoc_scalar' => true, + 'unary_operator_spaces' => true, + 'binary_operator_spaces' => true, + 'blank_line_before_statement' => [ + 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], + ], + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_var_without_name' => true, + 'class_attributes_separation' => [ + 'elements' => [ + 'method' => 'one', + ], + ], + 'method_argument_space' => [ + 'on_multiline' => 'ensure_fully_multiline', + 'keep_multiple_spaces_after_comma' => true, + ], + 'single_trait_insert_per_statement' => true, + ]) + ->setFinder($finder); diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8ed70cb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `Query Filter Builder` will be documented in this file + +## 1.0.0 - 2022-02-22 + +- initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4ae1c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..eac044d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + +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. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + +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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b245b33 --- /dev/null +++ b/README.md @@ -0,0 +1,167 @@ +# Query Filter Builder + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/henzeb/query-filter-builder.svg?style=flat-square)](https://packagist.org/packages/henzeb/query-filter-builder) +[![Total Downloads](https://img.shields.io/packagist/dt/henzeb/query-filter-builder.svg?style=flat-square)](https://packagist.org/packages/henzeb/query-filter-builder) + +Whenever you need filters on your API's endpoints, this package gives you +a nice and simple interface that allows you to add filters without the +need of a thousand parameters passed to your methods or writing SQL queries +inside your controllers. + +This comes with support for Laravel's query builder. No other builders as of yet. +If you'd like to contribute, see [Contributing](CONTRIBUTING.md). + +## Installation + +You can install the package via composer: + +```bash +composer require henzeb/query-filter-builder +``` + +## Usage +In your controller you may build up something like this, based on parameters +given by the user of your application. + +```php +use Henzeb\Query\Filters\Query; + +$filter = (new Query()) + ->nest( + (new Query) + ->nest( + (new Query) + ->is('animal', 'cat') + ->less('age', 10) + )->or() + ->nest( + (new Query) + ->is('animal', 'dog') + ->between('age', 5, 7) + ) + )->in('disease', 'diabetes', 'diarrhea') + ->limit(50) + ->offset(50); +``` +Building the query using Laravel's query builder, can be done as such: +```php +use DB; +use Henzeb\Query\Illuminate\Builders\Builder; + +$query = DB::table('patients') + ->where('vet_id', 1); + +$filter->build(new Builder($query)); +``` +This would result in the following query: +```sql +select * +from `patients` +where `vet_id` = ? + and ( + (`animal` = ? and `age` < ?) + or + (`animal` = ? and `age` between ? and ?) + ) + and `disease` in (?, ?) +limit 50 offset 50 +``` + +Note: a query filter can never start with `or`. This prevents data-leak +situations where one could get for example all records of it's own or the +dogs from another veterinarian: +```sql +select * from `patients` where `vet_id` = ? or `animal` = ? +``` +Where one could get all records of it's own or the dogs from another +veterinarian. + +### Custom filters +You can also create your own filters in case you need something specific. + +When building with Laravel, your custom filter could look like this: +```php +use Henzeb\Query\Illuminate\Filters\Contracts\Filter; + +use Illuminate\Database\Eloquent\Builder as EloquentBuilder; +use Illuminate\Database\Query\Builder as IlluminateBuilder; + +class OwnerCountFilter implements Filter +{ + public function __construct(private int $count) + { + } + + public function build(EloquentBuilder|IlluminateBuilder $builder): void + { + $builder->whereRaw( + '( + select count(1) + from `owners_patients` + where `owners_patients`.`patient_id` = `patients`.`id` + ) = ?', + [$this->count] + ); + } +} +``` +You can then call it like this: +```php +use Henzeb\Query\Filters\Query; +use App\Filters\YourCustomFilter; + +$filter = (new Query)->filter(OwnerCountFilter(1)); +``` +Which would result in a query like this: +```sql +select * +from `patients` +where `vet_id` = ? + and ( + ( + select count(1) + from `owners_patients` + where `owners_patients`.`patient_id` = `patients`.`id` + ) = ? + ) +``` + +## Creating your own builder. +Simply implement the `Henzeb\Query\Builders\Contracts\QueryBuilder` interface. + +### Custom filters +The custom filters approach might feel a bit strange. You must create your +own custom filter interface, as the default +`Henzeb\Query\Illuminate\Filters\Contracts\Filter` interface does not have any +methods. + +See `Henzeb\Query\Illuminate\Builders\Builder` for an example on proxying in +order to enable your IDE's typehinting. + +If you have a better approach, please let me know or submit a pull-request. + +### Testing + +```bash +composer test +``` + +### Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +### Security + +If you discover any security related issues, please email henzeberkheij@gmail.com instead of using the issue tracker. + +## Credits + +- [Henze Berkheij](https://github.com/henzeb) + +## License + +The GNU AGPLv. Please see [License File](LICENSE.md) for more information. diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..4cbefd2 --- /dev/null +++ b/composer.json @@ -0,0 +1,52 @@ +{ + "name": "henzeb/query-filter-builder", + "description": "A fancy way to build filters", + "keywords": [ + "henzeb", + "query", + "filter", + "builder", + "laravel", + "agnostic" + ], + "homepage": "https://github.com/henzeb/query-filter-builder", + "license": "AGPL-3.0-only", + "type": "library", + "authors": [ + { + "name": "Henze Berkheij", + "email": "henzeberkheij@gmail.com", + "role": "Developer" + } + ], + "require": { + "php": "^8.0" + }, + "require-dev": { + "illuminate/support": "^8.0|^9.0", + "mockery/mockery": "^1.5", + "orchestra/testbench": "^7.0", + "phpstan/phpstan": "^1.4", + "phpunit/phpunit": "^9.0" + }, + "autoload": { + "psr-4": { + "Henzeb\\Query\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "Henzeb\\Query\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "test-coverage-txt": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text", + "test-coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html coverage", + "test-dox": "vendor/bin/phpunit --testdox" + + }, + "config": { + "sort-packages": true + } +} diff --git a/src/Builders/Contracts/QueryBuilder.php b/src/Builders/Contracts/QueryBuilder.php new file mode 100644 index 0000000..35f3cf4 --- /dev/null +++ b/src/Builders/Contracts/QueryBuilder.php @@ -0,0 +1,86 @@ +shouldNotApply($action)) { + throw new Error('Cannot apply \'' . $action . '\' in current state'); + } + + if ($this->shouldApplyAnd($action)) { + $this->and(); + } + + $this->filters[] = ['action' => $action, 'parameters' => $parameters]; + + return $this; + } + + private function shouldNotApply(string $action): bool + { + if (!in_array($action, $this->operators)) { + return false; + } + + return empty($this->filters); + } + + private function isOperator(string $action): bool + { + return in_array(strtolower($action), $this->operators); + } + + private function shouldApplyAnd(string $action): bool + { + if ($this->isOperator($action)) { + return false; + } + + $previousFilter = end($this->filters); + + if (!$previousFilter) { + return false; + } + + if ($this->isOperator($previousFilter['action'])) { + return false; + } + + return true; + } + + public function is(string $key, float|bool|int|string $value): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function not(string $key, float|bool|int|string $value): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function empty(string $key): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function notEmpty(string $key): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function in(string $key, string|bool|int|float $in, string|bool|int|float ...$moreIn): QueryFilter + { + return $this->addFilter(__FUNCTION__, ['key' => $key, 'in' => [$in, ...$moreIn]]); + } + + public function notIn(string $key, string|bool|int|float $notIn, string|bool|int|float ...$moreNotIn): QueryFilter + { + return $this->addFilter(__FUNCTION__, ['key' => $key, 'notIn' => [$notIn, ...$moreNotIn]]); + } + + public function like(string $key, string $like): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function notLike(string $key, string $notLike): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function less(string $key, float|DateTime|int $less): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function greater(string $key, float|DateTime|int $greater): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function lessOrEqual(string $key, float|DateTime|int $lessOrEqual): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function greaterOrEqual(string $key, float|DateTime|int $greaterOrEqual): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function between(string $key, float|int $low, float|int $high): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function notBetween(string $key, float|int $low, float|int $high): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function dateBetween(string $key, DateTime $low, DateTime $high): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function dateNotBetween(string $key, DateTime $low, DateTime $high): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function filter(Filter $filter): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function limit(int $limit): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function offset(int $offset): QueryFilter + { + return $this->addFilter(__FUNCTION__, get_defined_vars()); + } + + public function and(): QueryFilter + { + return $this->addFilter(__FUNCTION__); + } + + public function or(): QueryFilter + { + return $this->addFilter(__FUNCTION__); + } + + public function nest(QueryFilter $query = null): QueryFilter + { + $newQuery = $query ?? new self; + + $this->addFilter(__FUNCTION__, [$newQuery]); + + return $query ? $this : $newQuery; + } + + public function build(QueryBuilder $builder): void + { + foreach ($this->filters as $filter) { + + if (empty($queryType) && $queryType = $this->isOperator($filter['action']) ? $filter['action'] : null) { + continue; + } + + $parameters = $this->flattenParameters($filter['parameters']); + $action = $this->parseMethodName($builder, $filter['action'], $queryType); + + $builder->$action(...$parameters); + + $queryType = null; + } + } + + private function flattenParameters(array $parameters): array + { + $return = array(); + + array_walk_recursive( + $parameters, + function ($a) use (&$return) { + $return[] = $a; + } + ); + + return array_values($return); + } + + private function parseMethodName(QueryBuilder $builder, string $action, ?string $queryType): string + { + if (!$queryType) { + return $action; + } + + $queryTypedMethod = strtolower($queryType) . ucfirst($action); + + if (method_exists($builder, $queryTypedMethod)) { + return $queryTypedMethod; + } + + return $action; + } +} diff --git a/src/Illuminate/Builders/Builder.php b/src/Illuminate/Builders/Builder.php new file mode 100644 index 0000000..07f278f --- /dev/null +++ b/src/Illuminate/Builders/Builder.php @@ -0,0 +1,246 @@ +builder; + } + + public function is(string $key, float|bool|int|string $value): void + { + $this->getBuilder()->where($key, $value); + } + + public function orIs(string $key, float|bool|int|string $value): void + { + $this->getBuilder()->orWhere($key, $value); + } + + public function not(string $key, float|bool|int|string $value): void + { + $this->getBuilder()->where($key, '!=', $value); + } + + public function orNot(string $key, float|bool|int|string $value): void + { + $this->getBuilder()->orWhere($key, '!=', $value); + } + + public function empty(string $key): void + { + $this->builder->whereNull($key); + } + + public function orEmpty(string $key): void + { + $this->builder->orWhereNull($key); + } + + public function notEmpty(string $key): void + { + $this->builder->whereNotNull($key); + } + + public function orNotEmpty(string $key): void + { + $this->builder->orWhereNotNull($key); + } + + public function in(string $key, string|float|int|bool $in, string|float|int|bool ...$moreIn): void + { + $this->getBuilder()->whereIn($key, [$in, ...$moreIn]); + } + + public function orIn(string $key, string|float|int|bool $in, string|float|int|bool ...$moreIn): void + { + $this->getBuilder()->orWhereIn($key, [$in, ...$moreIn]); + } + + public function notIn(string $key, string|float|int|bool $notIn, string|float|int|bool ...$moreNotIn): void + { + $this->getBuilder()->whereNotIn($key, [$notIn, ...$moreNotIn]); + } + + public function orNotIn(string $key, string|float|int|bool $notIn, string|float|int|bool ...$moreNotIn): void + { + $this->getBuilder()->orWhereNotIn($key, [$notIn, ...$moreNotIn]); + } + + public function like(string $key, string $like): void + { + $this->getBuilder()->where($key, 'like', $like); + } + + public function orLike(string $key, string $like): void + { + $this->getBuilder()->orWhere($key, 'like', $like); + } + + public function notLike(string $key, string $notLike): void + { + $this->getBuilder()->where($key, 'not like', $notLike); + } + + public function orNotLike(string $key, string $notLike): void + { + $this->getBuilder()->orWhere($key, 'not like', $notLike); + } + + public function less(string $key, float|DateTime|int $less): void + { + $this->getBuilder()->where($key, '<', $less); + } + + public function orLess(string $key, float|DateTime|int $less): void + { + $this->getBuilder()->orWhere($key, '<', $less); + } + + public function greater(string $key, float|DateTime|int $greater): void + { + $this->getBuilder()->where($key, '>', $greater); + } + + public function orGreater(string $key, float|DateTime|int $greater): void + { + $this->getBuilder()->orWhere($key, '>', $greater); + } + + public function lessOrEqual(string $key, float|DateTime|int $lessOrEqual): void + { + $this->getBuilder()->where($key, '<=', $lessOrEqual); + } + + public function orLessOrEqual(string $key, float|DateTime|int $lessOrEqual): void + { + $this->getBuilder()->orWhere($key, '<=', $lessOrEqual); + } + + public function greaterOrEqual(string $key, float|DateTime|int $greaterOrEqual): void + { + $this->getBuilder()->where($key, '>=', $greaterOrEqual); + } + + public function orGreaterOrEqual(string $key, float|DateTime|int $greaterOrEqual): void + { + $this->getBuilder()->orWhere($key, '>=', $greaterOrEqual); + } + + public function between(string $key, float|int $low, float|int $high): void + { + $this->getBuilder()->whereBetween($key, [$low, $high]); + } + + public function orBetween(string $key, float|int $low, float|int $high): void + { + $this->getBuilder()->orWhereBetween($key, [$low, $high]); + } + + public function notBetween(string $key, float|int $low, float|int $high): void + { + $this->getBuilder()->whereNotBetween($key, [$low, $high]); + } + + public function orNotBetween(string $key, float|int $low, float|int $high): void + { + $this->getBuilder()->orWhereNotBetween($key, [$low, $high]); + } + + public function dateBetween(string $key, DateTime $low, DateTime $high): void + { + $this->getBuilder()->whereBetween($key, [$low, $high]); + } + + public function orDateBetween(string $key, DateTime $low, DateTime $high): void + { + $this->getBuilder()->orWhereBetween($key, [$low, $high]); + } + + public function dateNotBetween(string $key, DateTime $low, DateTime $high): void + { + $this->getBuilder()->whereNotBetween($key, [$low, $high]); + } + + public function orDateNotBetween(string $key, DateTime $low, DateTime $high): void + { + $this->getBuilder()->orWhereNotBetween($key, [$low, $high]); + } + + public function limit(int $limit): void + { + $this->getBuilder()->limit($limit); + } + + public function offset(int $offset): void + { + $this->getBuilder()->offset($offset); + } + + public function nest(QueryFilter $query): void + { + $this->getBuilder()->where( + $this->getNestingClosure($query) + ); + } + + public function orNest(QueryFilter $query): void + { + $this->getBuilder()->orWhere( + $this->getNestingClosure($query) + ); + } + + public function filter(Filter $filter): void + { + $this->getBuilder()->where( + $this->getNestingClosure( + $this->filterProxy($filter) + ) + ); + } + + public function orFilter(Filter $filter): void + { + $this->getBuilder()->orWhere( + $this->getNestingClosure( + $this->filterProxy($filter) + ) + ); + } + + private function getNestingClosure(QueryFilter|IlluminateFilter $query): callable + { + return function (IlluminateBuilder|EloquentBuilder $queryBuilder) use ($query) { + $query->build($query instanceof QueryFilter ? new self($queryBuilder) : $queryBuilder); + return $queryBuilder; + }; + } + + public function filterProxy(Filter $filter): IlluminateFilter + { + if ($filter instanceof IlluminateFilter) { + return $filter; + } + + throw new TypeError( + '`' . self::class . ' expects `' . IlluminateFilter::class . '` but got `' . $filter::class . '`' + ); + } +} diff --git a/src/Illuminate/Filters/Contracts/Filter.php b/src/Illuminate/Filters/Contracts/Filter.php new file mode 100644 index 0000000..2a800df --- /dev/null +++ b/src/Illuminate/Filters/Contracts/Filter.php @@ -0,0 +1,11 @@ +where('owner', 'Jason'); + } +} diff --git a/tests/Helpers/DataProviders.php b/tests/Helpers/DataProviders.php new file mode 100644 index 0000000..3cc2c55 --- /dev/null +++ b/tests/Helpers/DataProviders.php @@ -0,0 +1,138 @@ + ['and'], + 'or' => ['or'], + ]; + } + + public function providesFilterTestcases(): array + { + return [ + 'is' => ['method' => 'is', 'parameters' => ['key' => 'animal', 'value' => 'cat']], + 'not' => ['method' => 'not', 'parameters' => ['key' => 'animal', 'value' => 'dog']], + + 'empty' => ['method' => 'empty', 'parameters' => ['key' => 'name']], + 'notEmpty' => ['method' => 'notEmpty', 'parameters' => ['key' => 'name']], + + 'in' => ['method' => 'in', 'parameters' => ['key' => 'animal', 'in' => ['dog']]], + 'in-multi' => ['method' => 'in', 'parameters' => ['key' => 'animal', 'in' => ['dog', 'cat']]], + + 'notIn' => ['method' => 'notIn', 'parameters' => ['key' => 'animal', 'notIn' => ['dog']]], + 'notIn-multi' => ['method' => 'notIn', 'parameters' => ['key' => 'animal', 'notIn' => ['dog', 'cat']]], + + 'like' => ['method' => 'like', 'parameters' => ['key' => 'animal', 'like' => '%dog%']], + 'notLike' => ['method' => 'notLike', 'parameters' => ['key' => 'animal', 'notLike' => '%dog%']], + + 'less-int' => ['method' => 'less', 'parameters' => ['key' => 'height', 'less' => 10]], + 'less-float' => ['method' => 'less', 'parameters' => ['key' => 'height', 'less' => 10.5]], + 'less-date' => ['method' => 'less', 'parameters' => ['key' => 'age', 'less' => new DateTime()]], + + 'greater-int' => ['method' => 'greater', 'parameters' => ['key' => 'height', 'greater' => 10]], + 'greater-float' => ['method' => 'greater', 'parameters' => ['key' => 'height', 'greater' => 10.5]], + 'greater-date' => ['method' => 'greater', 'parameters' => ['key' => 'age', 'greater' => new DateTime()]], + + 'lessOrEqual-int' => ['method' => 'lessOrEqual', 'parameters' => ['key' => 'height', 'lessOrEqual' => 10]], + 'lessOrEqual-float' => ['method' => 'lessOrEqual', 'parameters' => ['key' => 'height', 'lessOrEqual' => 10.5]], + 'lessOrEqual-date' => ['method' => 'lessOrEqual', 'parameters' => ['key' => 'age', 'lessOrEqual' => new DateTime()]], + + 'greaterOrEqual-int' => ['method' => 'greaterOrEqual', 'parameters' => ['key' => 'height', 'greaterOrEqual' => 10]], + 'greaterOrEqual-float' => ['method' => 'greaterOrEqual', 'parameters' => ['key' => 'height', 'greaterOrEqual' => 10.5]], + 'greaterOrEqual-date' => ['method' => 'greaterOrEqual', 'parameters' => ['key' => 'age', 'greaterOrEqual' => new DateTime()]], + + 'between' => ['method' => 'between', 'parameters' => ['key' => 'age', 'low' => 1, 'high' => 1]], + 'between-mixed-1' => ['method' => 'between', 'parameters' => ['key' => 'age', 'low' => 1, 'high' => 1.5]], + 'between-mixed-2' => ['method' => 'between', 'parameters' => ['key' => 'age', 'low' => 1.1, 'high' => 2]], + + 'notBetween' => ['method' => 'notBetween', 'parameters' => ['key' => 'age', 'low' => 1, 'high' => 1]], + 'notBetween-mixed-1' => ['method' => 'notBetween', 'parameters' => ['key' => 'age', 'low' => 1, 'high' => 1.5]], + 'notBetween-mixed-2' => ['method' => 'notBetween', 'parameters' => ['key' => 'age', 'low' => 1.1, 'high' => 2]], + + 'dateBetween' => ['method' => 'dateBetween', 'parameters' => ['key' => 'age', 'low' => new DateTime(), 'high' => new DateTime()]], + 'dateNotBetween' => ['method' => 'dateNotBetween', 'parameters' => ['key' => 'age', 'low' => new DateTime(), 'high' => new DateTime()]], + + 'filter-object' => ['method' => 'filter', 'parameters' => ['filter' => new OwnerFilter()]], + + 'limit' => ['method' => 'limit', 'parameters' => ['limit' => 100]], + 'offset' => ['method' => 'offset', 'parameters' => ['offset' => 50]], + ]; + } + + public function providesFilterWithQueryTestcases(): array + { + return array_merge_recursive( + $this->providesFilterTestcases(), + [ + 'is' => ['query' => '`animal` = ?'], + 'not' => ['query' => '`animal` != ?'], + 'empty' => ['query' => '`name` is null'], + 'notEmpty' => ['query' => '`name` is not null'], + 'in' => ['query' => '`animal` in (?)'], + 'in-multi' => ['query' => '`animal` in (?, ?)'], + 'notIn' => ['query' => '`animal` not in (?)'], + 'notIn-multi' => ['query' => '`animal` not in (?, ?)'], + 'like' => ['query' => '`animal` like ?'], + 'notLike' => ['query' => '`animal` not like ?'], + + 'less-int' => ['query' => '`height` < ?'], + 'less-float' => ['query' => '`height` < ?'], + 'less-date' => ['query' => '`age` < ?'], + + 'greater-int' => ['query' => '`height` > ?'], + 'greater-float' => ['query' => '`height` > ?'], + 'greater-date' => ['query' => '`age` > ?'], + + 'lessOrEqual-int' => ['query' => '`height` <= ?'], + 'lessOrEqual-float' => ['query' => '`height` <= ?'], + 'lessOrEqual-date' => ['query' => '`age` <= ?'], + + 'greaterOrEqual-int' => ['query' => '`height` >= ?'], + 'greaterOrEqual-float' => ['query' => '`height` >= ?'], + 'greaterOrEqual-date' => ['query' => '`age` >= ?'], + + 'between' => ['query' => '`age` between ? and ?'], + 'between-mixed-1' => ['query' => '`age` between ? and ?'], + 'between-mixed-2' => ['query' => '`age` between ? and ?'], + + 'notBetween' => ['query' => '`age` not between ? and ?'], + 'notBetween-mixed-1' => ['query' => '`age` not between ? and ?'], + 'notBetween-mixed-2' => ['query' => '`age` not between ? and ?'], + + 'dateBetween' => ['query' => '`age` between ? and ?'], + 'dateNotBetween' => ['query' => '`age` not between ? and ?'], + + 'filter-object' => ['query' => ['query'=>'(`owner` = ?)', 'parameters'=>['Jason']]], + + 'limit' => ['query' => 'limit 100', 'isLimit' => true], + 'offset' => ['query' => 'offset 50', 'isLimit' => true], + ] + ); + } + + /** + * @param array $parameters + * @return array + */ + protected function flattenArray(array $parameters): array + { + $return = array(); + + array_walk_recursive( + $parameters, + function ($a) use (&$return) { + $return[] = $a; + } + ); + + return $return; + } +} diff --git a/tests/Unit/Filters/QueryTest.php b/tests/Unit/Filters/QueryTest.php new file mode 100644 index 0000000..4c0c435 --- /dev/null +++ b/tests/Unit/Filters/QueryTest.php @@ -0,0 +1,275 @@ +makePartial(); + + if ($withGetFilters) { + $mock->expects('getFilters') + ->once() + ->andReturnUsing( + (function () { + return $this->filters; + })->bindTo($mock, Query::class)); + } + + return $mock; + } + + /** + * @param string $method + * @param array $parameters + * @return void + * + * @dataProvider providesFilterTestcases + */ + public function testShouldAddFilter(string $method, array $parameters): void + { + $queryFilter = $this->getMock(); + $expectedParameters = $parameters; + + $parameters = $this->flattenArray($parameters); + + $queryFilter->$method(...array_values($parameters)); + + $this->assertEquals( + [ + ['action' => $method, 'parameters' => $expectedParameters] + ], + $queryFilter->getFilters() + ); + } + + public function testShouldAutomaticallyAddAnd(): void + { + $mock = $this->getMock() + ->is('animal', 'cat') + ->is('age', 5); + + $this->assertEquals( + [ + [ + 'action' => 'is', + 'parameters' => [ + 'key' => 'animal', + 'value' => 'cat', + ], + ], + [ + 'action' => 'and', + 'parameters' => [], + ], + [ + 'action' => 'is', + 'parameters' => [ + 'key' => 'age', + 'value' => 5, + ] + ], + ], + $mock->getFilters() + ); + } + + /** + * @param string $method + * @return void + * + * @dataProvider providesOperators + */ + public function testShouldReplaceAnd(string $method): void + { + $mock = $this->getMock() + ->is('animal', 'cat') + ->$method() + ->is('age', 5); + + $this->assertEquals( + [ + [ + 'action' => 'is', + 'parameters' => [ + 'key' => 'animal', + 'value' => 'cat', + ], + ], + [ + 'action' => $method, + 'parameters' => [], + ], + [ + 'action' => 'is', + 'parameters' => [ + 'key' => 'age', + 'value' => 5, + ] + ], + ], + $mock->getFilters() + ); + } + + /** + * @param string $method + * @return void + * + * @dataProvider providesOperators + */ + public function testShouldNotBeAbleToStart(string $method): void + { + $query = $this->getMock(false); + + $this->expectError(); + + $query->$method(); + } + + public function testShouldBeAbleToNest(): void + { + $mock = $this->getMock(); + $mock->nest()->is('animal', 'cat')->is('age', 5); + $mock->or()->nest()->is('animal', 'dog')->is('age', 6); + + + $this->assertEquals([ + [ + 'action' => 'nest', + 'parameters' => [(new Query())->is('animal', 'cat')->is('age', 5)], + ], + [ + 'action' => 'or', + 'parameters' => [], + ], + [ + 'action' => 'nest', + 'parameters' => [(new Query())->is('animal', 'dog')->is('age', 6)], + ] + ], $mock->getFilters()); + } + + public function testShouldBeAbleToNestByPassingNewQuery(): void + { + $mock = $this->getMock(); + $mock->nest((new Query())->is('animal', 'cat')->is('age', 5)); + $mock->or()->nest((new Query())->is('animal', 'dog')->is('age', 6)); + + + $this->assertEquals([ + [ + 'action' => 'nest', + 'parameters' => [(new Query())->is('animal', 'cat')->is('age', 5)], + ], + [ + 'action' => 'or', + 'parameters' => [], + ], + [ + 'action' => 'nest', + 'parameters' => [(new Query())->is('animal', 'dog')->is('age', 6)], + ] + ], $mock->getFilters()); + } + + public function testChainingOfGroup(): void + { + $query = new Query(); + + $this->assertEquals($query::class, $query->nest()::class); + $this->assertNotEquals($query, $query->nest()); + } + + public function testChainingOfGroupWhenPassing(): void + { + $query = new Query(); + $nest = new Query(); + + $this->assertEquals($query, $query->nest($nest)); + } + + /** + * @return void + * @dataProvider providesFilterTestcases + */ + public function testShouldBuildSimple(string $method, $parameters) + { + $query = $this->getMock(false); + + $parameters = $this->flattenArray($parameters); + + $query->$method(...array_values($parameters)); + + $builder = Mockery::mock(QueryBuilder::class.'[empty]'); + + $builder->expects($method)->withArgs(array_values($parameters)); + + $query->build($builder); + } + + /** + * @param string $method + * @param $parameters + * @return void + * @dataProvider providesFilterTestcases + */ + public function testShouldBuildOr(string $method, $parameters): void + { + $queryFilter = $this->getMock(false); + $queryFilter->is('is', 'test'); + $queryFilter->or(); + $queryFilter->$method(...array_values($this->flattenArray($parameters))); + + $builder = Mockery::mock(QueryBuilder::class.'[empty]'); + $builder->expects('is')->once(); + + $orMethod = 'or' . ucfirst($method); + if (method_exists($builder, $orMethod)) { + $method = $orMethod; + } + + $builder->expects($method)->once(); + + $queryFilter->build($builder); + } + + public function testShouldAllowExtendingQuery(): void + { + $extendedQuery = $this->getMock(); + + $extendedQuery->expects('test') + ->once() + ->andReturnUsing((function () { + + $this->addFilter('testMethod', ['parameter' => 'test']); + + })->bindTo($extendedQuery)); + + $extendedQuery->test(); + + $this->assertEquals( + [ + [ + 'action' => 'testMethod', + 'parameters' => ['parameter' => 'test'] + ] + ], + $extendedQuery->getFilters() + ); + } +} diff --git a/tests/Unit/Illuminate/Builders/BuilderTest.php b/tests/Unit/Illuminate/Builders/BuilderTest.php new file mode 100644 index 0000000..75d150e --- /dev/null +++ b/tests/Unit/Illuminate/Builders/BuilderTest.php @@ -0,0 +1,185 @@ +from('animals'); + + $builder = new Builder($laravelBuilder); + + $flattenedParameters = $this->flattenArray($parameters); + + $builder->$method(...$flattenedParameters); + + array_shift($flattenedParameters); + + if(is_array($query)) { + $flattenedParameters = $query['parameters']; + $query = $query['query']; + } + + $this->assertEquals('select * from `animals` ' . ($noParameters ? '' : 'where ') . $query, $laravelBuilder->toSql()); + $this->assertEquals($laravelBuilder->getBindings(), $noParameters ? [] : array_values($flattenedParameters)); + } + + /** + * @param string $method + * @param array $parameters + * @param string $query + * @param bool $noParameters + * @return void + * + * @dataProvider providesFilterWithQueryTestcases + */ + public function testShouldBuildWithOr(string $method, array $parameters, array|string $query, bool $noParameters = false): void + { + $illuminateBuilder = DB::query()->from('animals')->whereRaw('true'); + + $builder = new Builder($illuminateBuilder); + + $flattenedParameters = $this->flattenArray($parameters); + if (!$noParameters) { + $method = 'or' . ucfirst($method); + } + $builder->$method(...$flattenedParameters); + + array_shift($flattenedParameters); + + if(is_array($query)) { + $flattenedParameters = $query['parameters']; + $query = $query['query']; + } + + $this->assertEquals('select * from `animals` where true ' . ($noParameters ? '' : 'or ') . $query, $illuminateBuilder->toSql()); + $this->assertEquals($illuminateBuilder->getBindings(), $noParameters ? [] : array_values($flattenedParameters)); + } + + /** + * @param string $method + * @param array $parameters + * @param string $query + * @param bool $noParameters + * @return void + * + * @dataProvider providesFilterWithQueryTestcases + */ + public function testShouldBuildWithGroup(string $method, array $parameters, array|string $query, bool $noParameters = false): void + { + $illuminateBuilder = DB::query()->from('animals')->whereRaw('true'); + $builder = new Builder($illuminateBuilder); + + $queryFilter = new Query(); + $parameters = $this->flattenArray($parameters); + $queryFilter->nest()->$method(...$parameters); + $queryFilter->build($builder); + + array_shift($parameters); + + if(is_array($query)) { + $parameters = $query['parameters']; + $query = $query['query']; + } + + $this->assertEquals('select * from `animals` where true' . ($noParameters ? '' : ' and (' . $query . ')'), $illuminateBuilder->toSql()); + $this->assertEquals($noParameters ? [] : $parameters, $illuminateBuilder->getBindings()); + } + + /** + * @param string $method + * @param array $parameters + * @param string $query + * @param bool $noParameters + * @return void + * + * @dataProvider providesFilterWithQueryTestcases + */ + public function testShouldBuildWithGroupOr(string $method, array $parameters, array|string $query, bool $noParameters = false): void + { + $laravelBuilder = DB::query()->from('animals'); + $builder = new Builder($laravelBuilder); + + $queryFilter = new Query(); + $parameters = $this->flattenArray($parameters); + $queryFilter->is('animal', 'horse')->or()->nest()->$method(...$parameters); + + $queryFilter->build($builder); + + array_shift($parameters); + + if(is_array($query)) { + $parameters = $query['parameters']; + $query = $query['query']; + } + + array_unshift($parameters, 'horse'); + + $this->assertEquals('select * from `animals` where `animal` = ?' . ($noParameters ? '' : ' or (' . $query . ')'), $laravelBuilder->toSql()); + $this->assertEquals($noParameters ? ['horse'] : $parameters, $laravelBuilder->getBindings()); + } + + public function testAcceptsEloquentBuilderInstance() + { + $model = new class extends Model { + protected $table = 'my_table'; + }; + + $query = $model->where('alive', true); + + $builder = new Builder($query); + $builder->is('animal', 'cat'); + + $this->assertEquals( + 'select * from `my_table` where `alive` = ? and `animal` = ?', + $query->toSql() + ); + } + + public function testShouldNotAllowNonIlluminateFilters() { + + $laravelBuilder = DB::query()->from('animals'); + + $myFilter = new class implements Filter { + + }; + + $this->expectError(); + + (new Builder($laravelBuilder))->filter($myFilter); + } + + public function testShouldNotAllowNonIlluminateFiltersWhenOr() { + + $laravelBuilder = DB::query()->from('animals'); + + $myFilter = new class implements Filter { + + }; + + $this->expectError(); + + (new Builder($laravelBuilder))->orFilter($myFilter); + } +}