diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..c693cb5 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +.travis.yml export-ignore +.gitattributes export-ignore +.gitignore export-ignore +tests export-ignore +phpunit.xml.dist export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1527848 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +vendor/ +phpunit.xml +composer.lock +*.cache +.idea \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2a30067 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +language: php + +php: + - 7.2 + - 7.4 + - 8.0.1 + +before_script: + - composer install + +script: + - ./vendor/bin/phpunit --testdox tests \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..20d40b6 --- /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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 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: + + Copyright (C) + 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/README.md b/README.md new file mode 100644 index 0000000..d3a8adc --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# json-ast : JSON to AST parser in PHP + +[![Latest Stable Version](https://img.shields.io/packagist/v/midhundevasia/json-ast.svg?style=flat-square)](https://packagist.org/packages/midhundevasia/json-ast) +[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.0-8892BF.svg?style=flat-square)](https://php.net/) +[![Build Status](https://travis-ci.com/midhundevasia/json-ast.svg?branch=master)](https://travis-ci.com/midhundevasia/json-ast) + +## Install + $ composer require midhundevasia/json-ast + +## Usage + parse( + '{"hello" : "World"}', + ['loc' => true, 'source' => null] + ); + + +## Tests + $ ./vendor/bin/phpunit --testdox tests + +## Todo + - write more test cases + - code coverage + +## License +json-ast is licensed under GNU General Public License (GPLv3) - see the `LICENSE` file for details. + +## Credits +Inspired from following repositories. + + https://github.com/vtrushin/json-to-ast + https://github.com/vtrushin/code-error-fragment + +##### Development + $ vendor/bin/phpcbf src + $ vendor/bin/php-cs-fixer fix src diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..2b297b1 --- /dev/null +++ b/composer.json @@ -0,0 +1,35 @@ +{ + "name": "midhundevasia/json-ast", + "type": "library", + "version" : "0.0.1", + "description": "JSON to AST parser in PHP", + "homepage": "https://github.com/midhundevasia/json-ast", + "license": ["GPL-3.0+"], + "authors": [ + { + "name": "Midhun Devasia", + "email": "hello@midhundev.asia", + "homepage": "http://midhundev.asia" + } + ], + "keywords": [ + "json", "json-ast", "ast parser", "json ast", "json parser" + ], + "support": { + "issues": "https://github.com/midhundevasia/json-ast/issues" + }, + "require": { + "php": ">=7.2" + }, + "require-dev": { + "phpunit/phpunit": "^8", + "squizlabs/php_codesniffer": "^3.0@dev", + "friendsofphp/php-cs-fixer": "^2.19@dev" + }, + "autoload": { + "psr-4": { "JsonAst\\": "src/" }, + "exclude-from-classmap": [ + "/tests/" + ] + } +} diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..86ff143 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,31 @@ + + + + + + + + + + ./tests/ + + + + + + ./src + + ./tests + ./vendor + + + + + \ No newline at end of file diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php new file mode 100644 index 0000000..9f77603 --- /dev/null +++ b/src/Exception/Exception.php @@ -0,0 +1,25 @@ +getMessage() . PHP_EOL; + } + + public function getError() + { + + } + + protected function setErrorMessage($message, $input, $line, $column, $source) + { + $code = (new CodeFragment)::getFragment($input, $line, $column, []); + $message = $line ? $message . "\n" . $code : $message; + return $message; + } +} diff --git a/src/Exception/ParserException.php b/src/Exception/ParserException.php new file mode 100644 index 0000000..8749842 --- /dev/null +++ b/src/Exception/ParserException.php @@ -0,0 +1,61 @@ +unexpectedEnd($input, $tokenList, $source); + break; + + case self::UNEXPECTED_TOKEN: + $this->unexpectedToken($input, $tokenList, $index, $source); + break; + } + } + + public function unexpectedEnd($input, $tokenList, $source) + { + $loc = count($tokenList) > 0 + ? $tokenList[count($tokenList) - 1]['loc']['end'] + : ['line' => 1, 'column' => 1]; + + @set_exception_handler(array($this, 'exceptionHandler')); + throw new \Exception( + $this->setErrorMessage( + 'Unexpected end of input', + $input, + $loc['line'], + $loc['column'], + $source + ) + ); + } + + public function unexpectedToken($input, $tokenList, $index, $source) + { + $line = $tokenList[$index]['loc']['start']['line']; + $column = $tokenList[$index]['loc']['start']['column']; + $startOffset = $tokenList[$index]['loc']['start']['offset']; + $endOffset = $tokenList[$index]['loc']['end']['offset']; + @set_exception_handler(array($this, 'exceptionHandler')); + $token = substr($input, $startOffset , 1); + throw new \Exception( + $this->setErrorMessage( + sprintf( + 'Unexpected token <%s> at %d:%d', $token, $line, $column + ), + $input, + $line, + $column, + $source + ) + ); + } +} diff --git a/src/Exception/TokenizerException.php b/src/Exception/TokenizerException.php new file mode 100644 index 0000000..a045a20 --- /dev/null +++ b/src/Exception/TokenizerException.php @@ -0,0 +1,40 @@ +line = $line; + $this->column = $column; + $this->input = $input; + $this->source = $source; + + switch ($type) { + case self::UNEXPECTED_SYMBOL: + $this->unexpectedSymbol($message, $input, $source); + break; + } + } + + public function unexpectedSymbol($symbol) + { + @set_exception_handler(array($this, 'exceptionHandler')); + throw new \Exception( + $this->setErrorMessage( + sprintf( + 'Unexpected symbol <%s> at %d:%d', + $symbol, + $this->line, + $this->column + ), + $this->input, + $this->line, + $this->column, + $this->source + ) + ); + } +} diff --git a/src/Helper/CodeFragment.php b/src/Helper/CodeFragment.php new file mode 100644 index 0000000..e2dfcb6 --- /dev/null +++ b/src/Helper/CodeFragment.php @@ -0,0 +1,67 @@ + 2, + 'tabSize' => 4 + ], + $settings + ); + $lines = preg_split('/\r\n?|\n|\f/', $code); + $startLinePos = max(1, $linePos - $settings['extraLines']) - 1; + $endLinePos = min($linePos + $settings['extraLines'], count($lines)); + $maxNumLength = strlen($endLinePos); + $previousLines = self::printLines($lines, $startLinePos, $linePos, $maxNumLength, $settings); + $targetLineBeforeCursor = self::printLine( + substr( + $lines[$linePos - 1], + 0, + $columnPos - 1 + ), + $linePos, + $maxNumLength, + $settings + ); + + $cursorLine = str_repeat(' ', strlen($targetLineBeforeCursor)) . '^'; + $nextLines = self::printLines($lines, $linePos, $endLinePos, $maxNumLength, $settings); + + return implode( + "\n", + array_filter( + [$previousLines, $cursorLine, $nextLines], + function ($value) { + return $value ?? false; + } + ) + ); + } + + private static function printLines($lines, $start, $end, $maxNumLength, $settings) + { + $code = array_slice($lines, $start, $end); + array_walk( + $code, + function (&$line, $index, $data) { + $line = self::printLine($line, $data['start'] + $index + 1, $data['max'], $data['settings']); + }, + ['start' => $start, 'end' => $end, 'max' => $maxNumLength, 'settings' => $settings] + ); + + return implode("\n", $code); + } + + private static function printLine($line, $position, $maxNumLength, $settings) + { + $formattedNum = str_pad($position, $maxNumLength, ' '); + $tabReplacement = str_repeat(' ', $settings['tabSize']); + + return $formattedNum . ' | ' . preg_replace('/\t/', $tabReplacement, $line); + } +} diff --git a/src/Helper/Location.php b/src/Helper/Location.php new file mode 100644 index 0000000..a32340f --- /dev/null +++ b/src/Helper/Location.php @@ -0,0 +1,30 @@ + [ + 'line' => $startLine, + 'column' => $startColumn, + 'offset' => $startOffset + ], + 'end' => [ + 'line' => $endLine, + 'column' => $endColumn, + 'offset' => $endOffset + ], + 'source' => $source ?? null + ]; + } +} diff --git a/src/Helper/NumberHelper.php b/src/Helper/NumberHelper.php new file mode 100644 index 0000000..a014f49 --- /dev/null +++ b/src/Helper/NumberHelper.php @@ -0,0 +1,30 @@ += '1' && $char <= '9'); + } + + public static function isExp($char) + { + return ($char === 'e' || $char === 'E'); + } + + public static function isDigit($char) + { + return ($char >= '0' && $char <= '9'); + } + + public static function isHex($char) + { + return ( + self::isDigit($char) + || ($char >= 'a' && $char <= 'f') + || ($char >= 'A' && $char <= 'F') + ); + } +} diff --git a/src/Parser.php b/src/Parser.php new file mode 100644 index 0000000..88f1080 --- /dev/null +++ b/src/Parser.php @@ -0,0 +1,455 @@ + '\b', // Backspace + 'f' => '\f', // Form feed + 'n' => '\n', // New line + 'r' => '\r', // Carriage return + 't' => '\t' // Horizontal tab + ]; + + const PASS_ESCAPES = ['"', '\\', '/']; + + public function parse($input, $config = []) + { + $config = array_merge(['loc' => true, 'source' => null], $config); + $tokenizer = new Tokenizer(); + $tokenList = $tokenizer->tokenize($input, $config); + + if (empty($tokenList)) { + new ParserException( + ParserException::UNEXPECTED_END, + $input, + $tokenList, + null, + $config['source'] + ); + } + $value = $this->parseValue($input, $tokenList, 0, $config); + + if ($value['index'] === count($tokenList)) { + return $value['value']; + } + + new ParserException( + ParserException::UNEXPECTED_TOKEN, + $input, + $tokenList, + $value['index'], + $config['source'] + ); + } + + protected function parseValue($input, $tokens, $index, $config) + { + // value: literal | object | array + $value = ( + $this->parseLiteral(...func_get_args()) ?? + $this->parseObject(...func_get_args()) ?? + $this->parseArray(...func_get_args()) + ); + + if ($value) { + return $value; + } else { + new ParserException( + ParserException::UNEXPECTED_TOKEN, + $input, + $tokens, + $index, + $config['source'] + ); + } + } + + protected function parseLiteral($input, $tokenList, $index, $config) + { + // literal: STRING | NUMBER | TRUE | FALSE | NULL + $token = $tokenList[$index]; + $value = null; + + switch ($token['type']) { + case TokenTypes::T_STRING: + $value = $this->parseString( + substr( + $input, + $token['loc']['start']['offset'] + 1, + ($token['loc']['end']['offset'] - 1) - ($token['loc']['start']['offset'] + 1) + ) + ); + break; + + case TokenTypes::T_NUMBER: + $value = $token['value']; + break; + + case TokenTypes::T_TRUE: + $value = true; + break; + case TokenTypes::T_FALSE: + $value = false; + break; + + case TokenTypes::T_NULL: + $value = null; + break; + + default: + return null; + } + + $literal = [ + 'type' => 'Literal', + 'value' => $value, + 'raw' => $token['value'] + ]; + + if ($config['loc']) { + $literal['loc'] = $token['loc']; + } + + return [ + 'value' => $literal, + 'index' => $index + 1 + ]; + } + + protected function parseString($string) + { + $result = ''; + + for ($i = 0; $i < strlen($string); $i++) { + $char = substr($string, $i, 1); + + if ($char === '\\') { + $i++; + $nextChar = substr($string, $i, 1); + if ($nextChar === 'u') { + $result .= $this->parseHexEscape(substr($string, $i + 1, 4)); + $i += 4; + } elseif (self::PASS_ESCAPES[$nextChar] >= 0) { + $result .= $nextChar; + } elseif (in_array($nextChar, self::PASS_ESCAPES)) { + $result .= self::PASS_ESCAPES[$nextChar]; + } else { + break; + } + } else { + $result .= $char; + } + } + + return $result; + } + + protected function parseHexEscape($hexCode) + { + $charCode = 0; + + for ($i = 0; $i < 4; $i++) { + $charCode = $charCode * 16 + intval($hexCode[$i], 16); + } + + return chr($charCode); + } + + public function parseObject($input, $tokens, $index, $config) + { + // object: LEFT_BRACE (property (COMMA property)*)? RIGHT_BRACE + $startToken = ''; + $object = [ + 'type' => 'Object', + 'children' => [] + ]; + + $state = ObjectStates::START; + + while ($index < count($tokens)) { + $token = $tokens[$index]; + + switch ($state) { + case ObjectStates::START: + if ($token['type'] === TokenTypes::T_LEFT_BRACE) { + $startToken = $token; + $state = ObjectStates::OPEN_OBJECT; + $index++; + } else { + return null; + } + break; + + case ObjectStates::OPEN_OBJECT: + if ($token['type'] === TokenTypes::T_RIGHT_BRACE) { + if ($config['loc']) { + $object['loc'] = Location::loc( + $startToken['loc']['start']['line'], + $startToken['loc']['start']['column'], + $startToken['loc']['start']['offset'], + $token['loc']['end']['line'], + $token['loc']['end']['column'], + $token['loc']['end']['offset'], + $config['source'] + ); + } + + return [ + 'value' => $object, + 'index' => $index + 1 + ]; + } else { + $property = $this->parseProperty($input, $tokens, $index, $config); + $object['children'][] = $property['value']; + $state = ObjectStates::PROPERTY; + $index = $property['index']; + } + break; + + case ObjectStates::PROPERTY: + if ($token['type'] === TokenTypes::T_RIGHT_BRACE) { + if ($config['loc']) { + $object['loc'] = Location::loc( + $startToken['loc']['start']['line'], + $startToken['loc']['start']['column'], + $startToken['loc']['start']['offset'], + $token['loc']['end']['line'], + $token['loc']['end']['column'], + $token['loc']['end']['offset'], + $config['source'] + ); + } + + return [ + 'value' => $object, + 'index' => $index + 1 + ]; + } elseif ($token['type'] === TokenTypes::T_COMMA) { + $state = ObjectStates::COMMA; + $index++; + } else { + new ParserException( + ParserException::UNEXPECTED_TOKEN, + $input, + $tokens, + $index, + $config['source'] + ); + } + break; + + case ObjectStates::COMMA: + $property = $this->parseProperty($input, $tokens, $index, $config); + if ($property) { + $index = $property['index']; + $object['children'][] = $property['value']; + $state = ObjectStates::PROPERTY; + } else { + new ParserException( + ParserException::UNEXPECTED_TOKEN, + $input, + $tokens, + $index, + $config['source'] + ); + } + break; + } + } + + new ParserException( + ParserException::UNEXPECTED_END, + $input, + $tokens, + $index, + $config['source'] + ); + } + + protected function parseProperty($input, $tokens, $index, $config) + { + // property: STRING COLON value + $startToken = ''; + $property = [ + 'type' => 'Property', + 'key' => null, + 'value' => null + ]; + + $state = PropertyStates::START; + + while ($index < count($tokens)) { + $token = $tokens[$index]; + + switch ($state) { + case PropertyStates::START: + if ($token['type'] === TokenTypes::T_STRING) { + $key = [ + 'type' => 'Identifier', + 'value' => $this->parseString( + substr( + $input, + $token['loc']['start']['offset'] + 1, + ($token['loc']['end']['offset'] - 1) - ($token['loc']['start']['offset'] + 1) + ) + ), + 'raw' => $token['value'] + ]; + + if ($config['loc']) { + $key['loc'] = $token['loc']; + } + + $startToken = $token; + $property['key'] = $key; + $state = PropertyStates::KEY; + $index++; + } else { + return null; + } + break; + + case PropertyStates::KEY: + if ($token['type'] === TokenTypes::T_COLON) { + $state = PropertyStates::COLON; + $index++; + } else { + new ParserException( + ParserException::UNEXPECTED_TOKEN, + $input, + $tokens, + $index, + $config['source'] + ); + } + break; + + case PropertyStates::COLON: + $value = $this->parseValue($input, $tokens, $index, $config); + $property['value'] = $value['value']; + if ($config['loc']) { + $property['loc'] = Location::loc( + $startToken['loc']['start']['line'], + $startToken['loc']['start']['column'], + $startToken['loc']['start']['offset'], + $token['loc']['end']['line'], + $token['loc']['end']['column'], + $token['loc']['end']['offset'], + $config['source'] + ); + } + + return [ + 'value' => $property, + 'index' => $value['index'] + ]; + } + } + } + + public function parseArray($input, $tokenList, $index, $config) + { + // array: LEFT_BRACKET (value (COMMA value)*)? RIGHT_BRACKET + $startToken = ''; + $array = [ + 'type' => 'Array', + 'children' => [] + ]; + $state = ArrayStates::START; + $token = ''; + + while ($index < count($tokenList)) { + $token = $tokenList[$index]; + + switch ($state) { + case ArrayStates::START: + if ($token['type'] === TokenTypes::T_LEFT_BRACKET) { + $startToken = $token; + $state = ArrayStates::OPEN_ARRAY; + $index++; + } else { + return null; + } + break; + + case ArrayStates::OPEN_ARRAY: + if ($token['type'] === TokenTypes::T_RIGHT_BRACKET) { + if ($config['loc']) { + $array['loc'] = Location::loc( + $startToken['loc']['start']['line'], + $startToken['loc']['start']['column'], + $startToken['loc']['start']['offset'], + $token['loc']['end']['line'], + $token['loc']['end']['column'], + $token['loc']['end']['offset'], + $config['source'] + ); + } + return [ + 'value' => $array, + 'index' => $index +1 + ]; + } else { + $value = $this->parseValue($input, $tokenList, $index, $config); + $index = $value['index']; + $array['children'][] = $value['value']; + $state = ArrayStates::VALUE; + } + break; + + case ArrayStates::VALUE: + if ($token['type'] === TokenTypes::T_RIGHT_BRACKET) { + if ($config['loc']) { + $array['loc'] = Location::loc( + $startToken['loc']['start']['line'], + $startToken['loc']['start']['column'], + $startToken['loc']['start']['offset'], + $token['loc']['end']['line'], + $token['loc']['end']['column'], + $token['loc']['end']['offset'], + $config['source'] + ); + } + return [ + 'value' => $array, + 'index' => $index + 1 + ]; + } else { + new ParserException( + ParserException::UNEXPECTED_TOKEN, + $input, + $tokenList, + $index, + $config['source'] + ); + } + break; + + case ArrayStates::COMMA: + $value = $this->parseValue($input, $tokenList, $index, $config); + $index = $value['index']; + $array['children'][] = $value['value']; + $state = ArrayStates::VALUE; + break; + + } + } + + new ParserException( + ParserException::UNEXPECTED_END, + $input, + $tokenList, + $index, + $config['source'] + ); + } +} diff --git a/src/State/ArrayStates.php b/src/State/ArrayStates.php new file mode 100644 index 0000000..e0ca55e --- /dev/null +++ b/src/State/ArrayStates.php @@ -0,0 +1,11 @@ + TokenTypes::T_LEFT_BRACE, + '}' => TokenTypes::T_RIGHT_BRACE, + '[' => TokenTypes::T_LEFT_BRACKET, + ']' => TokenTypes::T_RIGHT_BRACKET, + ':' => TokenTypes::T_COLON, + ',' => TokenTypes::T_COMMA + ]; + + private const keywordTokensMap = [ + 'true' => TokenTypes::T_TRUE, + 'false' => TokenTypes::T_FALSE, + 'null' => TokenTypes::T_NULL + ]; + + private const ESCAPES = [ + '"' => 0, + '\\' => 1, + '/' => 2, + 'b' => 3, + 'f' => 4, + 'n' => 5, + 'r' => 6, + 't' => 7, + 'u' => 8 + ]; + + public function tokenize($input, $config = []) + { + if (empty($input)) { + return []; + } + + $line = 1; + $column = 1; + $index = 0; + $tokens = []; + + while ($index < strlen($input)) { + $args = [$input, $index, $line, $column]; + $whitespace = $this->parseWhitespace(...$args); + + if (!empty($whitespace)) { + $index = $whitespace['index']; + $line = $whitespace['line']; + $column = $whitespace['column']; + continue; + } + + $matched = ( + $this->parseChar(...$args) ?? + $this->parseKeyword(...$args) ?? + $this->parseString(...$args) ?? + $this->parseNumber(...$args) + ); + + if (!empty($matched)) { + $token = [ + 'type' => $matched['type'], + 'value' => $matched['value'], + 'loc' => Location::loc( + $line, + $column, + $index, + $matched['line'], + $matched['column'], + $matched['index'], + $config['source'] + ) + ]; + + $tokens[] = $token; + $index = $matched['index']; + $line = $matched['line']; + $column = $matched['column']; + } else { + new TokenizerException( + substr($input, $index, 1), + TokenizerException::UNEXPECTED_SYMBOL, + $input, + $line, + $column, + $config['source'] + ); + } + } + + return $tokens; + } + + protected function parseWhitespace($input, $index, $line, $column) + { + $char = substr($input, $index, 1); + // CR Unix + if ($char === "\r") { + $index++; + $line++; + $column = 1; + if (substr($input, $index, 1) === "\n") { + $index++; + } + } elseif ($char === "\n") { + // LF (MacOS) + $index++; + $line++; + $column = 1; + } elseif ($char === "\t" || $char === ' ') { + $index++; + $column++; + } else { + return null; + } + + return ['index' => $index, 'line' => $line, 'column' => $column]; + } + + protected function parseChar($input, $index, $line, $column) + { + $char = substr($input, $index, 1); + if (array_key_exists($char, self::punctuatorTokensMap)) { + return [ + 'type' => self::punctuatorTokensMap[$char], + 'line' => $line, + 'column' => $column + 1, + 'index' => $index + 1, + 'value' => null + ]; + } + + return null; + } + + protected function parseKeyword($input, $index, $line, $column) + { + foreach (self::keywordTokensMap as $name => $_) { + if (substr($input, $index, strlen($name)) === $name) { + return [ + 'type' => self::keywordTokensMap[$name], + 'line' => $line, + 'column' => $column + strlen($name), + 'index' => $index + strlen($name), + 'value' => $name + ]; + } + } + + return null; + } + + protected function parseString($input, $index, $line, $column) + { + $startIndex = $index; + $buffer = ''; + $state = StringStates::START; + + while ($index < strlen($input)) { + $char = substr($input, $index, 1); + switch ($state) { + case StringStates::START: + if ($char === '"') { + $index++; + $state = StringStates::START_QUOTE_OR_CHAR; + } else { + return null; + } + break; + + case StringStates::START_QUOTE_OR_CHAR: + if ($char === '\\') { + $buffer .= $char; + $index++; + $state = StringStates::ESCAPE; + } elseif ($char === '"') { + $index++; + return [ + 'type' => TokenTypes::T_STRING, + 'line' => $line, + 'column' => $column + $index - $startIndex, + 'index' => $index, + 'value' => substr($input, $startIndex, ($index - $startIndex)) + ]; + } else { + $buffer .= $char; + $index++; + } + break; + + case StringStates::ESCAPE: + if (array_key_exists($char, self::ESCAPES)) { + $buffer .= $char; + $index++; + if ($char === 'u') { + for ($i = 0; $i < 4; $i++) { + $currentChar = substr($input, $index, 1); + if ($currentChar && NumberHelper::isHex($currentChar)) { + $buffer .= $currentChar; + $index++; + } else { + return null; + } + } + } + $state = StringStates::START_QUOTE_OR_CHAR; + } else { + return null; + } + break; + } + } + } + + public function parseNumber($input, $index, $line, $column) + { + $startIndex = $index; + $passedValueIndex = $index; + $state = NumberStates::START; + + while ($index < strlen($input)) { + $char = substr($input, $index, 1); + switch ($state) { + case NumberStates::START: + if ($char === '-') { + $state = NumberStates::MINUS; + } elseif ($char === '0') { + $passedValueIndex = $index + 1; + $state = NumberStates::ZERO; + } elseif (NumberHelper::isDigit1to9($char)) { + $passedValueIndex = $index + 1; + $state = NumberStates::DIGIT; + } else { + return null; + } + + break; + + case NumberStates::MINUS: + if ($char === '0') { + $passedValueIndex = $index + 1; + $state = NumberStates::ZERO; + } elseif (NumberHelper::isDigit1to9($char)) { + $passedValueIndex = $index + 1; + $state = NumberStates::DIGIT; + } else { + return null; + } + break; + + case NumberStates::ZERO: + if ($char === '.') { + $state = NumberStates::POINT; + } elseif (NumberHelper::isExp($char)) { + $state = NumberStates::EXP; + } else { + break 2; + } + break; + + case NumberStates::DIGIT: + if (NumberHelper::isDigit($char)) { + $passedValueIndex = $index + 1; + } elseif ($char === '.') { + $state = NumberStates::POINT; + } elseif (NumberHelper::isExp($char)) { + $state = NumberStates::EXP; + } else { + break 2; + } + break; + + case NumberStates::POINT: + if (NumberHelper::isDigit($char)) { + $passedValueIndex = $index + 1; + $state = NumberStates::DIGIT_FRACTION; + } else { + break 2; + } + break; + + case NumberStates::DIGIT_FRACTION: + if (NumberHelper::isDigit($char)) { + $passedValueIndex = $index + 1; + } elseif (NumberHelper::isExp($char)) { + $state = NumberStates::EXP; + } else { + break 2; + } + break; + + case NumberStates::EXP: + if ($char === '+' || $char === '-') { + $state = NumberStates::EXP_DIGIT_OR_SIGN; + } elseif (NumberHelper::isDigit($char)) { + $passedValueIndex = $index + 1; + $state = NumberStates::EXP_DIGIT_OR_SIGN; + } else { + break 2; + } + break; + + case NumberStates::EXP_DIGIT_OR_SIGN: + if (NumberHelper::isDigit($char)) { + $passedValueIndex = $index + 1; + } else { + break 2; + } + break; + } + + $index++; + } + + if ($passedValueIndex > 0) { + return [ + 'type' => TokenTypes::T_NUMBER, + 'line' => $line, + 'column' => $column + $passedValueIndex - $startIndex, + 'index' => $passedValueIndex, + 'value' => substr($input, $startIndex, $passedValueIndex - $startIndex) + ]; + } + + return null; + } +} diff --git a/tests/Fixtures/Invalid/array-trailing-comma.json b/tests/Fixtures/Invalid/array-trailing-comma.json new file mode 100644 index 0000000..e8b1a17 --- /dev/null +++ b/tests/Fixtures/Invalid/array-trailing-comma.json @@ -0,0 +1 @@ +[1,] diff --git a/tests/Fixtures/Invalid/empty.json b/tests/Fixtures/Invalid/empty.json new file mode 100644 index 0000000..e69de29 diff --git a/tests/Fixtures/Invalid/redundant-symbols.json b/tests/Fixtures/Invalid/redundant-symbols.json new file mode 100644 index 0000000..4fe7b84 --- /dev/null +++ b/tests/Fixtures/Invalid/redundant-symbols.json @@ -0,0 +1 @@ +{"a": 1}}}}} \ No newline at end of file diff --git a/tests/Fixtures/Invalid/unexpcted_symbol.json b/tests/Fixtures/Invalid/unexpcted_symbol.json new file mode 100644 index 0000000..a56fef0 --- /dev/null +++ b/tests/Fixtures/Invalid/unexpcted_symbol.json @@ -0,0 +1 @@ +<.> \ No newline at end of file diff --git a/tests/Fixtures/InvalidJson.json b/tests/Fixtures/InvalidJson.json new file mode 100644 index 0000000..e69de29 diff --git a/tests/Fixtures/ValidJson.json b/tests/Fixtures/ValidJson.json new file mode 100644 index 0000000..1ec5e96 --- /dev/null +++ b/tests/Fixtures/ValidJson.json @@ -0,0 +1,5 @@ +{ + "a": { + "b" : "c" + } +} \ No newline at end of file diff --git a/tests/ParserTest.php b/tests/ParserTest.php new file mode 100644 index 0000000..770f989 --- /dev/null +++ b/tests/ParserTest.php @@ -0,0 +1,54 @@ +assertInstanceOf( + Parser::class, + new Parser + ); + } + + public function testParseInvalidJson(): void + { + $this->assertInstanceOf( + Parser::class, + new Parser + ); + } + + public function testUnexpectedEndOfInputOnEmpty() + { + $this->expectExceptionMessage('Unexpected end of input'); + $parser = new Parser(); + $parser->parse( + file_get_contents(__DIR__ . '/Fixtures/Invalid/empty.json'), + ['loc' => true] + ); + } + + public function testUnexpectedTokenException() + { + $this->expectExceptionMessage('Unexpected token <}> at 1:9'); + $parser = new Parser(); + $parser->parse( + file_get_contents(__DIR__ . '/Fixtures/Invalid/redundant-symbols.json'), + ['loc' => true] + ); + } + + public function testUnexpectedTokenExceptionOnArrayTrailingComma() + { + $this->expectExceptionMessage('Unexpected token <,> at 1:3'); + $parser = new Parser(); + $parser->parse( + file_get_contents(__DIR__ . '/Fixtures/Invalid/array-trailing-comma.json'), + ['loc' => true] + ); + } +} diff --git a/tests/TokenizerTest.php b/tests/TokenizerTest.php new file mode 100644 index 0000000..7b0ce3d --- /dev/null +++ b/tests/TokenizerTest.php @@ -0,0 +1,35 @@ + null, 'source' => true]; + $tokenizer = new Tokenizer(); + $this->assertIsArray( + $tokenizer->tokenize('', $config) + ); + } + + public function testTokenizeValidJson(): void + { + $config = ['loc' => null, 'source' => true]; + $tokenizer = new Tokenizer(); + $this->assertNotEmpty( + $tokenizer->tokenize('{"df": true}', $config) + ); + } + + public function testUnexpectedTokenException() + { + $this->expectExceptionMessage('Unexpected symbol <<> at 1:1'); + $tokenizer = new Tokenizer(); + $tokenizer->tokenize( + file_get_contents(__DIR__ . '/Fixtures/Invalid/unexpcted_symbol.json'), + $config = ['loc' => null, 'source' => true] + ); + } +} \ No newline at end of file