boilerplate (empty) → 0.0.1

raw patch · 17 files changed

+1856/−0 lines, 17 filesdep +HUnitdep +basedep +boilerplate

Dependencies added: HUnit, base, boilerplate, containers, directory, extra, filepath, ghc, ghc-paths, ghcflags, hsinspect, parsec, parsers, tasty, tasty-hspec, text, vector

Files

• LICENSE +674/−0
• boilerplate.cabal +95/−0
• exe/Main.hs +190/−0
• library/Boilerplate/ConfigParser.hs +49/−0
• library/Boilerplate/Doc.hs +43/−0
• library/Boilerplate/GhcParser.hs +122/−0
• library/Boilerplate/Interpreter.hs +124/−0
• library/Boilerplate/RuleFinder.hs +66/−0
• library/Boilerplate/RuleParser.hs +56/−0
• library/Boilerplate/Types.hs +66/−0
• test/Boilerplate/ConfigParserTests.hs +62/−0
• test/Boilerplate/DocTests.hs +42/−0
• test/Boilerplate/Example.hs +32/−0
• test/Boilerplate/GhcParserTests.hs +31/−0
• test/Boilerplate/InterpreterTests.hs +120/−0
• test/Boilerplate/RuleParserTests.hs +83/−0
• test/Driver.hs +1/−0

@@ -0,0 +1,674 @@+                    GNU GENERAL PUBLIC LICENSE+                       Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++                            Preamble++  The GNU General Public License is a free, copyleft license for+software and other kinds of works.++  The licenses for most software and other practical works are designed+to take away your freedom to share and change the works.  By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users.  We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors.  You can apply it to+your programs, too.++  When we speak of free software, we are referring to freedom, not+price.  Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++  To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights.  Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++  For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received.  You must make sure that they, too, receive+or can get the source code.  And you must show them these terms so they+know their rights.++  Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++  For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software.  For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++  Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so.  This is fundamentally incompatible with the aim of+protecting users' freedom to change the software.  The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable.  Therefore, we+have designed this version of the GPL to prohibit the practice for those+products.  If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++  Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary.  To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++  The precise terms and conditions for copying, distribution and+modification follow.++                       TERMS AND CONDITIONS++  0. Definitions.++  "This License" refers to version 3 of the GNU General Public License.++  "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++  "The Program" refers to any copyrightable work licensed under this+License.  Each licensee is addressed as "you".  "Licensees" and+"recipients" may be individuals or organizations.++  To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy.  The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++  A "covered work" means either the unmodified Program or a work based+on the Program.++  To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy.  Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++  To "convey" a work means any kind of propagation that enables other+parties to make or receive copies.  Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++  An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License.  If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++  1. Source Code.++  The "source code" for a work means the preferred form of the work+for making modifications to it.  "Object code" means any non-source+form of a work.++  A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++  The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form.  A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++  The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities.  However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work.  For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++  The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++  The Corresponding Source for a work in source code form is that+same work.++  2. Basic Permissions.++  All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met.  This License explicitly affirms your unlimited+permission to run the unmodified Program.  The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work.  This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++  You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force.  You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright.  Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++  Conveying under any other circumstances is permitted solely under+the conditions stated below.  Sublicensing is not allowed; section 10+makes it unnecessary.++  3. Protecting Users' Legal Rights From Anti-Circumvention Law.++  No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++  When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++  4. Conveying Verbatim Copies.++  You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++  You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++  5. Conveying Modified Source Versions.++  You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++    a) The work must carry prominent notices stating that you modified+    it, and giving a relevant date.++    b) The work must carry prominent notices stating that it is+    released under this License and any conditions added under section+    7.  This requirement modifies the requirement in section 4 to+    "keep intact all notices".++    c) You must license the entire work, as a whole, under this+    License to anyone who comes into possession of a copy.  This+    License will therefore apply, along with any applicable section 7+    additional terms, to the whole of the work, and all its parts,+    regardless of how they are packaged.  This License gives no+    permission to license the work in any other way, but it does not+    invalidate such permission if you have separately received it.++    d) If the work has interactive user interfaces, each must display+    Appropriate Legal Notices; however, if the Program has interactive+    interfaces that do not display Appropriate Legal Notices, your+    work need not make them do so.++  A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit.  Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++  6. Conveying Non-Source Forms.++  You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++    a) Convey the object code in, or embodied in, a physical product+    (including a physical distribution medium), accompanied by the+    Corresponding Source fixed on a durable physical medium+    customarily used for software interchange.++    b) Convey the object code in, or embodied in, a physical product+    (including a physical distribution medium), accompanied by a+    written offer, valid for at least three years and valid for as+    long as you offer spare parts or customer support for that product+    model, to give anyone who possesses the object code either (1) a+    copy of the Corresponding Source for all the software in the+    product that is covered by this License, on a durable physical+    medium customarily used for software interchange, for a price no+    more than your reasonable cost of physically performing this+    conveying of source, or (2) access to copy the+    Corresponding Source from a network server at no charge.++    c) Convey individual copies of the object code with a copy of the+    written offer to provide the Corresponding Source.  This+    alternative is allowed only occasionally and noncommercially, and+    only if you received the object code with such an offer, in accord+    with subsection 6b.++    d) Convey the object code by offering access from a designated+    place (gratis or for a charge), and offer equivalent access to the+    Corresponding Source in the same way through the same place at no+    further charge.  You need not require recipients to copy the+    Corresponding Source along with the object code.  If the place to+    copy the object code is a network server, the Corresponding Source+    may be on a different server (operated by you or a third party)+    that supports equivalent copying facilities, provided you maintain+    clear directions next to the object code saying where to find the+    Corresponding Source.  Regardless of what server hosts the+    Corresponding Source, you remain obligated to ensure that it is+    available for as long as needed to satisfy these requirements.++    e) Convey the object code using peer-to-peer transmission, provided+    you inform other peers where the object code and Corresponding+    Source of the work are being offered to the general public at no+    charge under subsection 6d.++  A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++  A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling.  In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage.  For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product.  A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++  "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source.  The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++  If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information.  But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++  The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed.  Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++  Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++  7. Additional Terms.++  "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law.  If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++  When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it.  (Additional permissions may be written to require their own+removal in certain cases when you modify the work.)  You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++  Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++    a) Disclaiming warranty or limiting liability differently from the+    terms of sections 15 and 16 of this License; or++    b) Requiring preservation of specified reasonable legal notices or+    author attributions in that material or in the Appropriate Legal+    Notices displayed by works containing it; or++    c) Prohibiting misrepresentation of the origin of that material, or+    requiring that modified versions of such material be marked in+    reasonable ways as different from the original version; or++    d) Limiting the use for publicity purposes of names of licensors or+    authors of the material; or++    e) Declining to grant rights under trademark law for use of some+    trade names, trademarks, or service marks; or++    f) Requiring indemnification of licensors and authors of that+    material by anyone who conveys the material (or modified versions of+    it) with contractual assumptions of liability to the recipient, for+    any liability that these contractual assumptions directly impose on+    those licensors and authors.++  All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10.  If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term.  If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++  If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++  Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++  8. Termination.++  You may not propagate or modify a covered work except as expressly+provided under this License.  Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++  However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++  Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++  Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License.  If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++  9. Acceptance Not Required for Having Copies.++  You are not required to accept this License in order to receive or+run a copy of the Program.  Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance.  However,+nothing other than this License grants you permission to propagate or+modify any covered work.  These actions infringe copyright if you do+not accept this License.  Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++  10. Automatic Licensing of Downstream Recipients.++  Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License.  You are not responsible+for enforcing compliance by third parties with this License.++  An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations.  If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++  You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License.  For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++  11. Patents.++  A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based.  The+work thus licensed is called the contributor's "contributor version".++  A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version.  For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++  Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++  In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement).  To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++  If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients.  "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++  If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++  A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License.  You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++  Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++  12. No Surrender of Others' Freedom.++  If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License.  If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all.  For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++  13. Use with the GNU Affero General Public License.++  Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work.  The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++  14. Revised Versions of this License.++  The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time.  Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++  Each version is given a distinguishing version number.  If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation.  If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++  If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++  Later license versions may give you additional or different+permissions.  However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++  15. Disclaimer of Warranty.++  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++  16. Limitation of Liability.++  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++  17. Interpretation of Sections 15 and 16.++  If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++                     END OF TERMS AND CONDITIONS++            How to Apply These Terms to Your New Programs++  If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++  To do so, attach the following notices to the program.  It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++    <one line to give the program's name and a brief idea of what it does.>+    Copyright (C) <year>  <name of author>++    This program is free software: you can redistribute it and/or modify+    it under the terms of the GNU General Public License as published by+    the Free Software Foundation, either version 3 of the License, or+    (at your option) any later version.++    This program is distributed in the hope that it will be useful,+    but WITHOUT ANY WARRANTY; without even the implied warranty of+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the+    GNU General Public License for more details.++    You should have received a copy of the GNU General Public License+    along with this program.  If not, see <https://www.gnu.org/licenses/>.++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:++    <program>  Copyright (C) <year>  <name of author>+    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+<https://www.gnu.org/licenses/>.++  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+<https://www.gnu.org/licenses/why-not-lgpl.html>.

@@ -0,0 +1,95 @@+cabal-version: 2.2+name:          boilerplate+version:       0.0.1+synopsis:      Generate Haskell boilerplate.+license:       GPL-3.0-or-later+license-file:  LICENSE+author:        Tseen She+maintainer:    Tseen She+copyright:     2020 Tseen She+tested-with:   GHC ^>=8.8.3+category:      Building+description:+  Generates boilerplate from templates and markers in Haskell source code.++source-repository head+  type:     git+  location: https://gitlab.com/tseenshe/boilerplate.git++-- https://www.haskell.org/cabal/users-guide/cabal-projectindex.html++flag ghcflags+  description: Generate .ghc.flags files during compilation+  manual:      True+  default:     False++common deps+  build-depends:+    , base        >=4.11 && <5+    , containers+    , directory+    , filepath+    , ghc+    , text++  ghc-options:      -Wall -Werror=missing-home-modules -Werror=orphans+  default-language: Haskell2010++  if flag(ghcflags)+    build-tool-depends: hsinspect:hsinspect ==0.0.13+    build-depends:      ghcflags+    ghc-options:        -fplugin GhcFlags.Plugin++executable boilerplate+  import:         deps+  hs-source-dirs: exe+  main-is:        Main.hs+  ghc-options:    -rtsopts -threaded -with-rtsopts=-N8+  build-depends:+    , boilerplate+    , parsec       >3.1 && <3.2++library+  import:          deps+  hs-source-dirs:  library+  build-depends:+    , ghc-paths+    , hsinspect  ^>=0.0.13+    , parsers    >0.12   && <0.13+    , vector     >0.12   && <0.13++  -- cabal-fmt: expand library+  exposed-modules:+    Boilerplate.ConfigParser+    Boilerplate.Doc+    Boilerplate.GhcParser+    Boilerplate.Interpreter+    Boilerplate.RuleFinder+    Boilerplate.RuleParser+    Boilerplate.Types++test-suite test+  import:             deps+  hs-source-dirs:     test+  type:               exitcode-stdio-1.0+  main-is:            Driver.hs++  -- cabal-fmt: expand test -Driver+  other-modules:+    Boilerplate.ConfigParserTests+    Boilerplate.DocTests+    Boilerplate.Example+    Boilerplate.GhcParserTests+    Boilerplate.InterpreterTests+    Boilerplate.RuleParserTests++  build-depends:+    , boilerplate+    , extra        ^>=1.7.8+    , HUnit        ^>=1.6.0+    , parsec+    , tasty        ^>=1.3.1+    , tasty-hspec  ^>=1.1.5++  build-tool-depends: tasty-discover:tasty-discover ^>=4.2.1+  ghc-options:        -threaded

@@ -0,0 +1,190 @@+{-# LANGUAGE CPP #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE TupleSections #-}++module Main where++import Boilerplate.ConfigParser+import Boilerplate.Doc+import Boilerplate.GhcParser+import Boilerplate.Interpreter+import Boilerplate.RuleFinder+import Boilerplate.RuleParser+import Boilerplate.Types+import qualified Config as GHC+import Control.Monad (when)+import Data.IORef (modifyIORef')+import Data.IORef (readIORef)+import Data.IORef (newIORef)+import Data.List (isPrefixOf)+import Data.Map.Strict (Map)+import qualified Data.Map.Strict as M+import Data.Maybe (mapMaybe)+import Data.Maybe (catMaybes)+import Data.Text (Text)+import qualified Data.Text as T+import qualified Data.Text.IO as T+import System.Environment (getArgs)+import System.Exit (ExitCode(..), exitWith)+import System.IO (stderr)+import System.IO (hPutStrLn)+import Text.Parsec (parse, setPosition)+import Text.Parsec.Pos (newPos)+import Text.Parsec.Text (parseFromFile)++version :: String+#ifdef CURRENT_PACKAGE_VERSION+version = CURRENT_PACKAGE_VERSION+#else+version = "unknown"+#endif++help :: String+help =+  "boilerplate [GLOBAL FLAGS] FILE\n\n" +++  "Global flags:\n\n" +++  " -h,--help               Show this help text\n" +++  " -v,--version            Print version information\n" +++  "    --ghc-version        Print ghc version information\n" +++  " -i,--inplace            Overwrite FILE in place\n" +++  "    --verbose            Print debugging information to stderr\n"++main :: IO ()+main = do+  args <- getArgs+  let hasAny :: Eq a => [a] -> [a] -> Bool+      hasAny [] _ = False+      hasAny _ [] = False+      hasAny as (x : xs) | elem x as = True+                         | otherwise = hasAny as xs++  when (hasAny ["-h", "--help"] args) $+    (putStrLn help) >> exitWith ExitSuccess+  when (hasAny ["-v", "--version"] args) $+    (putStrLn version) >> exitWith ExitSuccess+  when (elem "--ghc-version" args) $+    (putStrLn GHC.cProjectVersion) >> exitWith ExitSuccess++  when (null args) $+    (putStrLn "missing arguments") >> (exitWith $ ExitFailure 1)++  let inplace = hasAny ["-i", "--inplace"] args+      file = last $ filter (not . isPrefixOf "-") args+      verbose = elem "--verbose" args++  -- FIXME a --check-rule flag that just parses a rule++  content <- T.readFile file++  -- TODO all parsec errors should be formatted as path/to/file.hs:line:col:++  -- early exit when there is no work to do+  when (not $ T.isInfixOf "BOILERPLATE" content) $+    if inplace+    then exitWith ExitSuccess+    else (T.putStr content) >> exitWith ExitSuccess++  (types, comments) <- parseHaskell file++  let parseComment (Comment txt (Pos line col) end) =+        case parse (setPosition (newPos file line col) *> configCommentParser) file txt of+        Left msg -> do+          when (verbose && T.isInfixOf "BOILERPLATE" txt) $ do+            hPutStrLn stderr $ show msg+          pure $ Nothing+        Right c -> pure $ Just (c, end)++  configs <- catMaybes <$> traverse parseComment comments+  let targets = flip mapMaybe (threes configs) $ \case+        (One   ((Config t r c), s)) -> Just $ Action t r c s Nothing+        (Two   ((Config t r c), s) _) -> Just $ Action t r c s Nothing+        -- the ConfigStart is irrelevant for position detection, it is+        -- to make it easier for text editors to hide expansions.+        (Three ((Config t r c), s) (ConfigStart, _) (ConfigEnd, e)) -> Just $ Action t r c s (Just e)+        (Three ((Config t r c), s) _ _) -> Just $ Action t r c s Nothing+        _ -> Nothing++  ruleFiles <- findRules file++  when verbose $ do+    hPutStrLn stderr $ show types+    hPutStrLn stderr $ show targets+    hPutStrLn stderr $ show ruleFiles++  rulesCache <- newIORef M.empty++  let+    findRule :: Text -> IO Rule+    findRule rulename = do+      let pickRule (fqn, short, path) =+            if fqn == rulename || short == rulename+            then Just path+            else Nothing+      case mapMaybe pickRule ruleFiles of+        [] -> error "no rules"+        [ruleFile] -> do+          cached <- readIORef rulesCache+          case M.lookup ruleFile cached of+            Nothing -> do+              parsed <- parseFromFile ruleParser ruleFile+              case parsed of+                Left err -> error $ show err+                Right r -> r <$ modifyIORef' rulesCache (M.insert ruleFile r)+            Just hit -> do+              when verbose $+                hPutStrLn stderr $ "hit cache for " <> ruleFile+              pure hit+        many -> error $ "ambiguous rules" <> show many++    tpes :: Map Text Type+    tpes = M.fromList $ (\t -> (tycon t, t)) <$> types+      where+        tycon = \case+          ProductType tc _ _ _ -> tc+          RecordType tc _ _ _ -> tc+          SumType tc _ _ -> tc++    resolve (Action tycon rulenames custom start end) = do+      tpe <- case M.lookup tycon tpes of+        Nothing -> error $ "could not find the type definition for " <> show tycon+        Just a -> pure a+      rules' <- traverse findRule rulenames+      pure $ Action tpe rules' custom start end++  resolved <- traverse resolve targets++  when verbose $ do+    hPutStrLn stderr $ show resolved++  let+    interpret (Action tpe rules cus start end) =+      (\txt -> (start, end, prepare $ T.unlines txt)) <$>+        (traverse (\r -> interpretRule r tpe (M.fromList cus)) rules)+    interpreted = traverse interpret resolved+    prepare snippet = start_comment <> T.strip snippet <> end_comment+    start_comment = "\n{- BOILERPLATE START -}\n"+    end_comment = "\n{- BOILERPLATE END -}"++  replacement <- unDoc <$> case interpreted of+    Left err -> (putStrLn $ T.unpack err) >> (exitWith $ ExitFailure 1)+    Right good -> pure $ upsertMany (mkDoc content) good++  if inplace+  then T.writeFile file replacement+  else T.putStr replacement++data Three a = One a | Two a a | Three a a a++threes :: [a] -> [Three a]+threes = \case+  [] -> []+  [a] -> [One a]+  a1 : a2 : [] -> Two a1 a2 : (threes [a2])+  a1 : a2 : a3 : as -> Three a1 a2 a3 : (threes $ a2 : a3 : as)++type Target = Action Text Text+type Resolved = Action Type Rule++data Action tpe rule = Action tpe [rule] [(Text, Custom)] Pos (Maybe Pos)+  deriving (Eq, Show)

@@ -0,0 +1,49 @@+{-# LANGUAGE TupleSections #-}++module Boilerplate.ConfigParser (configParser, configCommentParser) where++import Boilerplate.Types+import Control.Applicative+import qualified Data.Map.Strict as M+import qualified Data.Text as T+import Text.Parser.Char+import Text.Parser.Combinators++-- parse the whole comment section to enhance locations in errors+configCommentParser :: CharParsing m => m Config+configCommentParser = (block <|> line) <* eof+  where+    block = between (string "{-" *> header) (try $ spaces *> string "-}") configParser+    line = string "--" *> header *> configParser <* spaces+    header = whitespace *> string "BOILERPLATE" *> whitespace+    whitespace = space *> spaces++configParser :: CharParsing m => m Config+configParser = try start <|> try end <|> config+  where+    start = ConfigStart <$ string "START"+    end = ConfigEnd <$ string "END"+    config = Config <$> conid <*> (whitespace *> rules) <*> option [] (try $ whitespace *> customs)+    whitespace = space <* spaces+    conid = (\c cs -> T.pack $ c : cs) <$> upper <*> many (noneOf " \t\n\r\f,")+    rules = sepBy1 conid (char ',' <* spaces)+    customs = sepEndBy1 custom whitespace -- consumes trailing whitespace+      where+        custom = (,) <$> (key <* spaces <* char '=' <* spaces) <*> customParser <?> "custom key/value"+        key = T.pack <$> some alphaNum <?> "custom key"++customParser :: CharParsing m => m Custom+customParser = (try nindexed <|> named <|> indexed <|> global) <?> "custom value"+  where+    nindexed = NamedIndexed <$> object array+    named = Named <$> object txt+    indexed = Indexed <$> array+    global = Global <$> txt++    object v = M.fromList <$> between (char '{' *> spaces) (spaces *> char '}') (sepBy kv comma)+      where kv = (,) <$> (symbol <* spaces <* char ':') <*> (spaces *> v)+    array = between (char '[' *> spaces) (spaces *> char ']') (sepBy txt comma)+    comma = try $ spaces *> char ',' <* spaces+    txt = quoted <|> symbol+      where quoted = T.pack <$> (many $ notChar '"') `surroundedBy` (char '"')+    symbol = T.pack <$> some alphaNum <?> "symbol"

@@ -0,0 +1,43 @@++module Boilerplate.Doc (Doc, mkDoc, unDoc, upsert, upsertMany) where++import Boilerplate.Types+import Data.Text (Text)+import qualified Data.Text as T+import Data.Vector (Vector)+import qualified Data.Vector as V++newtype Doc = Doc (Vector Text)++mkDoc :: Text -> Doc+mkDoc = Doc . V.fromList . T.lines++unDoc :: Doc -> Text+unDoc (Doc txt) = T.unlines . V.toList $ txt++-- from just after Pos to just before Pos, 1 indexed rows and columns+upsert :: Doc -> Pos -> Maybe Pos -> Text -> Doc+upsert (Doc lines') (Pos sline scol) to txt =+  Doc $ case splitAt' (sline - 1) lines' of+    (before, Nothing) -> V.snoc before txt+    (before, Just (line, after)) ->+      let (before', after') = T.splitAt scol line+       in case to of+          Nothing -> before <> V.cons (T.concat [before', txt, after']) after+          Just (Pos elin ecol) -> case splitAt' (elin - 1) lines' of+            (_, Nothing) -> V.snoc before $ T.concat [before', txt]+            (_, Just (line', after'')) ->+              let (_, after''') = T.splitAt (ecol - 1) line'+               in before <> V.cons (T.concat [before', txt, after''']) after''++splitAt' :: Int -> Vector a -> (Vector a, Maybe (a, Vector a))+splitAt' i v =+  let (before, after) = V.splitAt i v+   in if V.null after+      then (before, Nothing)+      else (before, Just (V.head after, V.tail after))++-- applies all the upserts in reverse order, if the regions do not overlap and+-- are ascending then this amounts to applying all the upserts in parallel.+upsertMany :: Doc -> [(Pos, Maybe Pos, Text)] -> Doc+upsertMany = foldr (\(from, to, txt) acc -> upsert acc from to txt)

@@ -0,0 +1,122 @@+{-# LANGUAGE CPP #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE TupleSections #-}++module Boilerplate.GhcParser (parseHaskell) where++import Boilerplate.Types+import Control.Exception (throwIO)+import Control.Monad (when)+import Control.Monad.IO.Class (liftIO)+import Data.List (isSuffixOf)+import Data.List (sortOn)+import Data.Maybe (mapMaybe)+import Data.Text (Text)+import qualified Data.Text as T+import DriverPipeline (preprocess)+import qualified DynFlags as GHC+import qualified FastString as GHC+import qualified GHC as GHC+import GHC.Paths (libdir)+import qualified HeaderInfo as GHC+import qualified HsInspect.Util as H+import qualified Lexer as GHC+import qualified Outputable as GHC+import qualified Parser+import qualified SrcLoc as GHC+import qualified StringBuffer as GHC+import System.Directory (removeFile)++-- FIXME move to hsinspect and share as a library+--+--and then a single boilerplate binary+--      could call out to a package-specific hsinspect? Would centralise all the+--      ghc logic at the expense of a more complex setup. Perhaps make hsinspect+--      available as a library to simplify this process, since this information+--      would be useful for all kinds of tools (e.g. documentation generation).+parseHaskell :: FilePath -> IO ([Type], [Comment])+parseHaskell file = do+  -- TODO construct the real session from .ghc.flags, or use a hardcoded ParserFlags+  env <- liftIO . GHC.runGhc (Just libdir) $ do+    dflags <- GHC.getSessionDynFlags+    -- enablesx comment parsing+    _ <- GHC.setSessionDynFlags $ GHC.gopt_set dflags GHC.Opt_KeepRawTokenStream+    GHC.getSession+  pstate <- mkCppState env file+  let showGhc :: GHC.Outputable a => a -> Text+      showGhc = T.pack . H.showGhc+  case GHC.unP Parser.parseModule pstate of+    -- ParseResult (Located (HsModule GhcPs))+    GHC.POk st (GHC.L _ hsmod) -> do+      -- http://hackage.haskell.org/package/ghc-8.8.3/docs/HsDecls.html#t:HsDecl+      -- [Located (HsDecl p)]+      let decls = GHC.hsmodDecls hsmod+          findType (GHC.L _ (GHC.TyClD _ (GHC.DataDecl _ tycon' (GHC.HsQTvs _ tparams') _ ddn))) =+            let+              tycon = showGhc tycon'+              tparams = renderTparam <$> tparams'+              renderField :: GHC.GenLocated l (GHC.ConDeclField GHC.GhcPs) -> (Text, Text)+              renderField (GHC.L _ field) = (showGhc . head $ GHC.cd_fld_names field, showGhc $ GHC.cd_fld_type field)+              renderArg :: GHC.LBangType GHC.GhcPs -> Text+              renderArg (GHC.L _ arg) = showGhc arg+              rhs = do+                (GHC.L _ ddl) <- GHC.dd_cons ddn+                case ddl of+                  GHC.ConDeclH98 _ cons _ _ _ (GHC.RecCon (GHC.L _ fields)) _ -> [(showGhc cons, Left $ renderField <$> fields)]+                  GHC.ConDeclH98 _ cons _ _ _ (GHC.InfixCon a1 a2) _ -> [(showGhc cons, Right $ [renderArg a1, renderArg a2])]+                  GHC.ConDeclH98 _ cons _ _ _ (GHC.PrefixCon args) _ -> [(showGhc cons, Right $ renderArg <$> args)]+                  _ -> [] -- GADTS++             in case rhs of+              [] -> Nothing+              [(cons, Right tpes)] -> Just $ ProductType tycon tparams cons tpes+              [(cons, Left fields)] -> Just $ RecordType tycon tparams cons fields+              mult -> Just . SumType tycon tparams $ render <$> mult+                where+                  render (cons, Right args) = (cons, args)+                  render (cons, Left fargs) = (cons, snd <$> fargs)++          findType _ = Nothing++          renderTparam :: GHC.GenLocated l (GHC.HsTyVarBndr GHC.GhcPs) -> Text+          renderTparam (GHC.L _ (GHC.UserTyVar _ p)) = showGhc p+          renderTparam (GHC.L _ (GHC.KindedTyVar _ p _)) = showGhc p+          renderTparam (GHC.L _ (GHC.XTyVarBndr _)) = "<unsupported>"++          extractComment (GHC.L (GHC.RealSrcSpan pos) c) =+            let start = Pos (GHC.srcSpanStartLine pos) (GHC.srcSpanStartCol pos)+                end = Pos (GHC.srcSpanEndLine pos) (GHC.srcSpanEndCol pos)+             in (\str -> Comment (T.pack str) start end) <$> case c of+            (GHC.AnnLineComment txt) -> Just txt+            (GHC.AnnBlockComment txt) -> Just txt+            _ -> Nothing+          extractComment _ = Nothing++          types = mapMaybe findType decls+          comments = mapMaybe extractComment $ GHC.comment_q st++      pure (types, sortOn (\(Comment _ s _) -> s) comments)++    GHC.PFailed _ _ err -> throwIO . userError $ "unable to parse " <> file <> " due to " <> GHC.showSDocUnsafe err++-- from hsinspect, share with parseHeader'++-- applies CPP rules to the input file and extracts the pragmas,+-- a more portable alternative to GHC.hGetStringBuffer+mkCppState :: GHC.HscEnv -> FilePath -> IO GHC.PState+mkCppState sess file = do+#if MIN_VERSION_GLASGOW_HASKELL(8,8,1,0)+  pp <- preprocess sess file Nothing Nothing+  let (dflags, tmp) = case pp of+        Left _ -> error $ "preprocessing failed " <> show file+        Right success -> success+#else+  (dflags, tmp) <- preprocess sess (file, Nothing)+#endif+  full <- GHC.hGetStringBuffer tmp+  when (".hscpp" `isSuffixOf` tmp) $+    liftIO . removeFile $ tmp+  let pragmas = GHC.getOptions dflags full file+      loc  = GHC.mkRealSrcLoc (GHC.mkFastString file) 1 1+  (dflags', _, _) <- GHC.parseDynamicFilePragma dflags pragmas+  pure $ GHC.mkPState dflags' full loc

@@ -0,0 +1,124 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE TupleSections #-}++module Boilerplate.Interpreter (interpretRule) where++import Boilerplate.Types+import Data.Map.Strict (Map)+import qualified Data.Map.Strict as M+import Data.Text (Text)+import qualified Data.Text as T++data Ctx = G -- ^^ global context+         | P Text [(Maybe Text, Text)] -- ^^ product-like thing: cons [(maybe fieldname, param type)]+         | F Text Int (Maybe Text) Text -- ^^ field in a product-like: cons idx fieldname param type+         | T Text -- ^^ type parameter field+  deriving (Eq, Show)++interpretRule :: Rule -> Type -> Map Text Custom -> Either Text Text+interpretRule (Rule atoms) tpe options = T.strip <$> interpretTree G atoms+  where+    interpretTree :: Ctx -> Tree -> Either Text Text+    interpretTree ctx t = T.concat <$> traverse (interpret ctx) t++    -- Several codepaths are impossible because of the way the Rule is parsed. We+    -- could have done some fancy type magic to avoid having to consider these+    -- cases, but it is far easier and simpler to just take the hit in the+    -- interpreter.+    impossible :: String -> a+    impossible ctx = error $ "impossible " <> ctx++    showt :: Show a => a -> Text+    showt = T.pack . show++    param :: Int -> Int -> Text+    param n p = "p_" <> showt n <> "_" <> showt p++    -- no context interpreter+    interpret ctx = \case+      Raw txt -> Right txt+      Type -> Right $ case tpe of+        ProductType tn _ _ _ -> tn+        RecordType tn _ _ _ -> tn+        SumType tn _ _ -> tn+      TParams empty prefix els sep suffix ->+        if null tparams+        then interpretTree G empty+        else (\p b -> p <> b <> suffix) <$> interpretTree G prefix <*> body+        where+          tparams = T <$> case tpe of+            ProductType _ tps _ _ -> tps+            RecordType _ tps _ _ -> tps+            SumType _ tps _ -> tps+          body = T.intercalate sep <$> traverse (flip interpretTree els) tparams+      TParam -> case ctx of+        T p -> Right p+        _ -> impossible "TParam"+      Product els ->+        let interpret' c ps = interpretTree (P c ps) els+         in case tpe of+        SumType _ _ _ -> Right T.empty+        ProductType _ _ cons params -> interpret' cons $ (Nothing,) <$> params+        RecordType _ _ cons params -> interpret' cons $ (\(a, b) -> (Just a, b)) <$> params+      Sum prefix els sep suffix -> case tpe of+        ProductType _ _ _ _ -> Right T.empty+        RecordType _ _ _ _ -> Right T.empty+        SumType _ _ tags -> (\b -> prefix <> b <> suffix) <$> body+          where+            tags' = (\(cons, tpes) -> P cons ((Nothing,) <$> tpes)) <$> tags+            body = T.intercalate sep <$> traverse (flip interpretTree els) tags'+      Uncons n -> case ctx of+        P cons [] -> Right cons+        P cons ps -> Right $ "(" <> body <> ")"+          where+            body = T.intercalate " " $ cons : ((param n . fst) <$> zip [1..] ps)+        _ -> impossible "Uncons"+      Cons -> case ctx of+        P cons _ -> Right cons+        F cons _ _ _ -> Right cons+        _ -> impossible "Cons"+      Field empty prefix els sep suffix -> case ctx of+        P _ [] -> interpretTree ctx empty+        P cons ps -> (\p b -> p <> b <> suffix) <$> interpretTree ctx prefix <*> body+          where+            fields = (\(n, (f, t)) -> F cons n f t) <$> zip [1..] ps+            body = T.intercalate sep <$> traverse (flip interpretTree els) fields+        _ -> impossible "Field"+      Param n ->  case ctx of+        F _ p _ _ -> Right $ param n p+        _ -> impossible "Param"+      FieldName -> case ctx of+        F _ _ n _ -> maybe (Left "field names are required") Right n+        _ -> impossible "FieldName"+      FieldType -> case ctx of+        F _ _ _ t -> Right t+        _ -> impossible "FieldType"+      Custom sym fallback ->+        let err = Left $ "missing required option '" <> sym <> "' which should be " <> ctx'+            ctx' = case ctx of+              G -> "a global value"+              T _ -> "a global value"+              P cons _ -> "a mapping for the data constructors of " <> cons+              F cons _ _ _ -> "an indexed sequence for fields of the data constructor " <> cons+         in case (M.lookup sym options, ctx) of+          (Just (Global txt), _) -> Right txt+          (Just (Indexed vs), F _ p _ _) -> maybe err Right $ atMay (p - 1) vs+          (Just (Named vs), F _ _ (Just f) _) -> maybe err Right $ M.lookup f vs+          (Just (NamedIndexed vs), F cons p _ _) -> maybe err Right $ atMay (p - 1) =<< M.lookup cons vs+          (Just (Named vs), P cons _) -> maybe err Right $ M.lookup cons vs+          _ -> case fallback of+            Nothing -> err+            Just t -> interpretTree ctx t+      Sugar (Instance tc) ->+        interpretTree ctx [+          Raw "instance ",+          TParams [] [Raw "("] [Raw tc, Raw " ", TParam] ", " ") => ", Raw tc, Raw " ",+          TParams [Type] [Raw "(", Type, Raw " "] [TParam] " " ")", Raw " where"]++atMay :: Int -> [a] -> Maybe a+atMay i as | i < 0 = Nothing+        | otherwise = f i as+    where f 0 (x : _) = Just x+          f i' (_ : as') = f (i' - 1) as'+          f _ [] = Nothing

@@ -0,0 +1,66 @@++module Boilerplate.RuleFinder (findRules) where++import Control.Monad (join)+import Data.Containers.ListUtils (nubOrdOn)+import qualified Data.List as L+import Data.Text (Text)+import qualified Data.Text as T+import Data.Traversable (for)+import qualified HsInspect.Util as H+import System.Directory (makeAbsolute)+import System.Directory (listDirectory)+import System.FilePath (takeBaseName)+import System.FilePath (makeRelative)+import System.FilePath (dropExtension)+import System.FilePath (pathSeparator)+import System.FilePath (takeDirectory, takeFileName, (</>))++-- Finds all .rule files that live in dominant directories named "boilerplate"+-- starting from the file. The files are sorted lexiographically within each+-- boilerplate directory, starting with the nearest directory and working+-- outwards.+--+-- Both fully qualified and short names are provided to make it easier for+-- callers to find a rule [(fqn, short, path)].+findRules :: FilePath -> IO [(Text, Text, FilePath)]+findRules file = do+  parent <- makeAbsolute $ takeDirectory file+  dirs <- locateDirs parent+  batches <- for dirs $ \dir -> do+    files <- H.walkSuffix ".rule" dir+    pure $ namer dir <$> L.sort files+  -- remove dupes when a direct ancestor is called `boilerplate`+  pure . nubOrdOn (\(_, _, c) -> c) $ join batches++locateDirs :: FilePath -> IO [FilePath]+locateDirs dir = do+  mdir <- locateDominatingFile ("boilerplate" ==) dir+  case mdir of+    Nothing -> pure []+    Just hit ->+      let grandparent = takeDirectory $ takeDirectory hit+       in if grandparent == dir+          then pure [hit]+          else (hit :) <$> locateDirs grandparent++namer :: FilePath -> FilePath -> (Text, Text, FilePath)+namer dir file =+  let fqn = replace pathSeparator '.' . dropExtension $ makeRelative dir file+      short = takeBaseName file+      replace from to = fmap (\c -> if c == from then to else c)+   in (T.pack fqn, T.pack short, file)++-- FIXME from hsinspect-lsp, move to the Utils module to share++-- same as locateDominating but returns the first file that matches the predicate+locateDominatingFile :: (String -> Bool) -> FilePath -> IO (Maybe FilePath)+locateDominatingFile p dir = do+  files <- listDirectory dir+  let parent = takeDirectory dir+  case L.find p $ takeFileName <$> files of+    Just file -> pure . Just $ dir </> file+    Nothing ->+      if parent == dir+       then pure Nothing+       else locateDominatingFile p parent

@@ -0,0 +1,56 @@+{-# LANGUAGE OverloadedStrings #-}++module Boilerplate.RuleParser (ruleParser) where++import Boilerplate.Types+import Control.Applicative+import qualified Data.Text as T+import Text.Parser.Char+import Text.Parser.Combinators++data Kind = RootTree | TParamTree | DataTree | FieldTree+  deriving (Show)++ruleParser :: CharParsing m => m Rule+ruleParser = Rule <$> (pTree RootTree <* eof)+  where+    tryText = try . text+    pN = read <$> option "1" (some digit)+    pTree tree = (many $ (pMagic' . choice $ contextual <> [pType, pCustom tree]) <|> pRaw) <?> (show tree)+      where+        contextual = case tree of+          RootTree -> [pTParams, pProduct, pSum, pSugarInstance]+          TParamTree -> [pTParam]+          DataTree -> [pUncons, pCons, pField]+          FieldTree -> [pCons, pParam, pFieldName, pFieldType]+    pRaw = Raw <$> T.pack <$> some pSourceChar <?> "haskell source"+    pRaw' = T.pack <$> many pSourceChar <?> "haskell source"+    pSourceChar = choice $ noneOf "{}\\" : (escaped <$> "{}\\")+      where escaped c = try $ char '\\' *> char c+    pMagic' fa = between (char '{') (char '}') fa+    pMagic fa = (pMagic' fa) <* spaces+    pMagic_ fa = spaces *> pMagic fa+    pType = Type <$ tryText "Type"+    pTParams = tryText "TParams" *> space *> (try pTParams1 <|> pTParams2)+      where+        pTParams1 = TParams <$> pMagic_ (pTree RootTree) <*> pMagic (pTree RootTree) <*> pMagic (pTree TParamTree) <*> pMagic pRaw' <*> pMagic pRaw'+        pTParams2 = (\el sep -> TParams [Raw ""] [Raw ""] el sep "") <$> pMagic_ (pTree TParamTree) <*> pMagic pRaw'+    pTParam = TParam <$ tryText "TParam"+    pProduct = tryText "Product" *> space *> (Product <$> pTree DataTree)+    pSum = tryText "Sum" *> space *> (try pSum1 <|> try pSum2 <|> pSum3)+      where+        pSum1 = (\t -> Sum "" t "" "") <$> pTree DataTree+        pSum2 = (\t s -> Sum "" t s "") <$> pMagic_ (pTree DataTree)  <*> pMagic pRaw'+        pSum3 = Sum <$> pMagic_ pRaw' <*> pMagic (pTree DataTree) <*> pMagic pRaw' <*> pMagic pRaw'+    pUncons = Uncons <$> (tryText "Uncons" *> pN)+    pCons = Cons <$ tryText "Cons"+    pField = tryText "Field" *> space *> (try pField1 <|> pField2)+      where+        pField1 = Field <$> pMagic_ (pTree DataTree) <*> pMagic (pTree DataTree) <*> pMagic (pTree FieldTree) <*> pMagic pRaw' <*> pMagic pRaw'+        pField2 = (\el sep -> Field [Raw ""] [Raw ""] el sep "") <$> pMagic_ (pTree FieldTree) <*> pMagic pRaw'+    pParam = Param <$> (tryText "Param" *> pN)+    pFieldName = FieldName <$ tryText "FieldName"+    pFieldType = FieldType <$ tryText "FieldType"+    pCustom tree = Custom <$> (tryText "Custom" *> space *> pId) <*> (optional $ space *> pTree tree)+      where pId = T.pack <$> some alphaNum+    pSugarInstance = Sugar . Instance . T.pack <$> (tryText "Instance" *> space *> (some alphaNum))

@@ -0,0 +1,66 @@++module Boilerplate.Types where++import Data.Map.Strict (Map)+import Data.Text (Text)++-- `BOILERPLATE ... BOILERPLATE END`+data Marker = Marker Text Int (Maybe Int) -- ^^ config (start position) (end position)+  deriving (Eq, Show)++-- line, col (1-indexed)+data Pos = Pos Int Int+  deriving (Eq, Ord, Show)++data Comment = Comment Text Pos Pos -- text start end+  deriving (Eq, Show)++data Config = Config Text [Text] [(Text, Custom)] -- ^^ type [rule] [custom key, value]+            | ConfigStart+            | ConfigEnd+  deriving (Eq, Show)+-- TODO (Text, Custom) could have a namespace++data Custom = Global Text -- ^^ available anywhere+            | Indexed [Text] -- ^^ applies to ordered product fields+            | Named (Map Text Text) -- ^^ applies to record fields and data constructors+            | NamedIndexed (Map Text [Text]) -- ^^ applies to ordered fields inside a sum type+  deriving (Eq, Show)++data Type = ProductType Text [Text] Text [Text]  -- ^^ type tparams cons [param types]+          | RecordType Text [Text] Text [(Text, Text)] -- ^^ type tparams cons [(fieldname, param type)]+          | SumType Text [Text] [(Text, [Text])] -- ^^ type tparams [(cons, param types)] (no records)+  deriving (Eq, Show)++type Tree = [Atom]++newtype Rule = Rule Tree+  deriving (Eq, Show)++-- TODO a lot of Text locations could be Tree: convert on demand+data Atom =+    Raw Text+  | Type+  | TParams Tree Tree Tree Text Text -- ^^ empty prefix elem sep suffix+  | TParam+  | Product Tree -- ^^ elem+  | Sum Text Tree Text Text -- ^^ prefix elem sep suffix+  | Uncons Int -- ^^ id+  | Cons+  | Field Tree Tree Tree Text Text -- ^^ empty prefix elem sep suffix+  | Param Int -- ^^ id+  | FieldName+  | FieldType+  | Custom Text (Maybe Tree) -- ^^ name fallback+  | Sugar Sugar+    deriving (Eq, Show)++data Sugar = Instance Text+  deriving (Eq, Show)++-- FIXME support for iterating parameters with free type params (in the+--      interpreter, filter fields by the type name and only include things with+--      a type parameter), e.g. Foldable.+--+-- TODO syntax sugar for a strict subset with semantics of Divisible, Decidable,+--      Applicative, Alt

@@ -0,0 +1,62 @@+{-# LANGUAGE OverloadedStrings #-}++module Boilerplate.ConfigParserTests where++import qualified Data.Text as T+import Test.HUnit (assertEqual)+import qualified Data.Map.Strict as M+import Data.Either.Extra (mapLeft)+import Boilerplate.ConfigParser+import Boilerplate.Types+import Data.Text (Text)+import Test.Tasty.Hspec+import Text.Parsec (parse)++shouldParseTo :: HasCallStack => Text -> Config -> Expectation+shouldParseTo input expected = do+  let parseConfig = mapLeft show . parse configParser "test"+      parseConfig' = mapLeft show . parse configCommentParser "test"+      shouldParse p i = assertEqual (T.unpack i) (p i) (Right expected)+  parseConfig  `shouldParse` input+  parseConfig' `shouldParse` ("{- BOILERPLATE " <> input <> " -}")+  parseConfig' `shouldParse` ("-- BOILERPLATE " <> input)++spec_config :: Spec+spec_config = do+  it "should parse a simple config" $ do+    "Foo FromJSON" `shouldParseTo` Config "Foo" ["FromJSON"] []++  it "should parse the start and end" $ do+    "START" `shouldParseTo` ConfigStart+    "END" `shouldParseTo` ConfigEnd++  it "should parse multiple rules" $ do+    "Foo FromJSON, ToJSON" `shouldParseTo` Config "Foo" ["FromJSON", "ToJSON"] []++  it "should parse fqn rule" $ do+    "Foo Data.Aeson.FromJSON, ToJSON" `shouldParseTo` Config "Foo" ["Data.Aeson.FromJSON", "ToJSON"] []++  it "should parse a custom symbol option" $ do+    "Foo FromJSON foo=bar" `shouldParseTo` Config "Foo" ["FromJSON"] [("foo", Global "bar")]++  it "should parse multiple options" $ do+    "Foo FromJSON foo=bar baz=gaz" `shouldParseTo` Config "Foo" ["FromJSON"] [("foo", Global "bar"), ("baz", Global "gaz")]++  it "should parse a custom string option" $ do+    "Foo FromJSON foo = \"bar baz\"" `shouldParseTo` Config "Foo" ["FromJSON"] [("foo", Global "bar baz")]++  it "should parse a custom array option" $ do+    "Foo FromJSON foo = [bar, baz]" `shouldParseTo` Config "Foo" ["FromJSON"] [("foo", Indexed ["bar", "baz"])]++  it "should parse a custom object of strings object" $ do+    "Foo FromJSON foo={ bar: foo, baz : faa }" `shouldParseTo`+      Config "Foo" ["FromJSON"] [("foo", Named $ M.fromList [("bar", "foo"), ("baz", "faa")])]++  it "should parse a custom object of array object" $ do+    "Foo FromJSON foo={ bar: [f, o, o], baz : [f,a,a] }" `shouldParseTo`+      Config "Foo" ["FromJSON"] [("foo", NamedIndexed $ M.fromList [("bar", ["f", "o", "o"]), ("baz", ["f", "a", "a"])])]++  it "should parse the README example" $ do+    "Coord FromJSON, ToJSON\n    field = [x, y]" `shouldParseTo`+      Config "Coord" ["FromJSON", "ToJSON"] [("field", Indexed ["x", "y"])]+

@@ -0,0 +1,42 @@+{-# LANGUAGE OverloadedStrings #-}++module Boilerplate.DocTests where++import Boilerplate.Doc+import Boilerplate.Types+import Data.Text (Text)+import Test.Tasty.Hspec++upsert' :: Text -> (Int, Int) -> Maybe (Int, Int) -> Text -> Text+upsert' orig start end new = unDoc $ upsert (mkDoc orig) (mkPos start) (mkPos <$> end) new+  where mkPos (l, c) = Pos l c++spec_doc :: Spec+spec_doc = do+  it "should upsert text at the start" $ do+    upsert' "foo\nbar\nbaz" (0, 0) Nothing "gaz\n" `shouldBe` "gaz\nfoo\nbar\nbaz\n"++  it "should upsert text at the end" $ do+    upsert' "foo\nbar\nbaz" (4, 0) Nothing "gaz\n" `shouldBe` "foo\nbar\nbaz\ngaz\n\n"+    upsert' "foo\nbar\nbaz" (4, 1) Nothing "gaz\n" `shouldBe` "foo\nbar\nbaz\ngaz\n\n"++  it "should upsert text in the center" $ do+    upsert' "foo\nbar\nbaz" (2, 0) Nothing "gaz\n" `shouldBe` "foo\ngaz\nbar\nbaz\n"++  it "should upsert text in the middle of a line" $ do+    upsert' "foo\nbar\nbaz" (2, 1) Nothing "gaz" `shouldBe` "foo\nbgazar\nbaz\n"+    upsert' "foo\nbar\nbaz" (2, 2) Nothing "gaz" `shouldBe` "foo\nbagazr\nbaz\n"++  it "should upsert and replace text beyond the region" $ do+    upsert' "foo\nbar\nbaz" (2, 1) (Just (4, 0)) "ozo" `shouldBe` "foo\nbozo\n"++  it "should upsert and replace text in the middle of a line" $ do+    upsert' "foo\nbar\nbaz" (2, 1) (Just (2, 3)) "ozo" `shouldBe` "foo\nbozor\nbaz\n"++  it "should upsert and replace text beyond a line" $ do+    upsert' "foo\nbar\nbaz" (2, 1) (Just (2, 5)) "ozo" `shouldBe` "foo\nbozo\nbaz\n"++  it "should upsert and replace text across multiple lines" $ do+    upsert' "foo\nbar\nbaz" (2, 1) (Just (3, 3)) "uz" `shouldBe` "foo\nbuzz\n"++

@@ -0,0 +1,32 @@+{-# LANGUAGE KindSignatures #-}++-- $foo+module Boilerplate.Example where++import Data.Text (Text)++{- this is a+   block comment+-}++-- | BOILERPLATE This is a doc string+data Coord1 = Coordy1 Double Double+{- BOILERPLATE Coord1 FromJSON, ToJSON -}++data Coord2 = Coordy2 { a :: Double, b :: Double}+-- BOILERPLATE Coord FromJSON, ToJSON field={a:x, b:y}+-- BOILERPLATE END++data Union = Wales String | England Int Int | Scotland++data Things a b = T a b Double++data Logger (m :: * -> *) = Logger { log :: Text -> m () }++data Action a = Admin [a] Text | User a Text++data InfixProd = Text :| Text++data InfixSum = Text :|| Text+              | Text :||| Text+

@@ -0,0 +1,31 @@+{-# LANGUAGE OverloadedStrings #-}++module Boilerplate.GhcParserTests where++import Boilerplate.GhcParser+import Boilerplate.Types+import Test.Tasty.Hspec++spec_ghc :: Spec+spec_ghc = do+  it "should parse the example data" $ do+    (types, markers) <- parseHaskell "test/Boilerplate/Example.hs"++    types `shouldBe` [+      ProductType "Coord1" [] "Coordy1" ["Double","Double"],+      RecordType "Coord2" [] "Coordy2" [("a","Double"),("b","Double")],+      SumType "Union" [] [("Wales",["String"]),("England",["Int","Int"]),("Scotland",[])],+      ProductType "Things" ["a","b"] "T" ["a","b","Double"],+      RecordType "Logger" ["m"] "Logger" [("log","Text -> m ()")],+      SumType "Action" ["a"] [("Admin",["[a]","Text"]),("User",["a","Text"])],+      ProductType "InfixProd" [] ":|" ["Text","Text"],+      SumType "InfixSum" [] [(":||",["Text","Text"]),(":|||",["Text","Text"])]]++    markers `shouldBe` [+      Comment "{-# LANGUAGE KindSignatures #-}" (Pos 1 1) (Pos 1 32),+      Comment "-- $foo" (Pos 3 1) (Pos 3 8),+      Comment "{- this is a\n   block comment\n-}" (Pos 8 1) (Pos 10 3),+      Comment "-- | BOILERPLATE This is a doc string" (Pos 12 1) (Pos 12 38),+      Comment "{- BOILERPLATE Coord1 FromJSON, ToJSON -}" (Pos 14 1) (Pos 14 42),+      Comment "-- BOILERPLATE Coord FromJSON, ToJSON field={a:x, b:y}" (Pos 17 1) (Pos 17 55),+      Comment "-- BOILERPLATE END" (Pos 18 1) (Pos 18 19)]

@@ -0,0 +1,120 @@+{-# LANGUAGE OverloadedStrings #-}++module Boilerplate.InterpreterTests where++import Boilerplate.Interpreter+import Boilerplate.RuleParserTests (ffunctorRule, fromJSONRule, toJSONRule)+import Boilerplate.Types+import Data.Map.Strict (Map)+import qualified Data.Map.Strict as M+import Data.Text (Text)+import Test.Tasty.Hspec++-- data Coord = Coordy Double Double+egProduct :: Type+egProduct = ProductType "Coord" [] "Coordy" ["Double", "Double"]++-- data Coord = Coordy { a :: Double, b :: Double}+egRecord :: Type+egRecord = RecordType "Coord" [] "Coordy" [("a", "Double"), ("b", "Double")]++-- data Union = Wales String | England Int Int | Scotland+egSum :: Type+egSum = SumType "Union" [] [ ("Wales", ["String"]), ("England", ["Int", "Int"]), ("Scotland", [])]++-- data Things a b = T a b Double+egPolyProduct :: Type+egPolyProduct = ProductType "Things" ["a", "b"] "T" ["a", "b", "Double"]++-- data Logger m = Logger { log :: Text -> m () }+egPolyRecord :: Type+egPolyRecord = RecordType "Logger" ["m"] "Logger" [("log", "Text -> m ()")]++-- data Action a = Admin [a] Text | User a Text+egPolySum :: Type+egPolySum = SumType "Action" ["a"] [("Admin", ["[a]", "Text"]), ("User", ["a", "Text"])]++custom :: Text -> Custom -> Map Text Custom+custom key value = M.fromList [(key, value)]++spec_interpreter :: Spec+spec_interpreter = do+  it "should interpret ToJSON for products" $ do+    let options = custom "field" $ Indexed ["x", "y"]+    interpretRule toJSONRule egProduct options `shouldBe`+      Right "instance ToJSON Coord where\n\+            \  toJSON (Coordy p_1_1 p_1_2) = object [\"x\" .= p_1_1, \"y\" .= p_1_2]\n\+            \  toEncoding (Coordy p_1_1 p_1_2) = pairs (\"x\" .= p_1_1 <> \"y\" .= p_1_2)"++  it "should interpret FromJSON for products" $ do+    let options = custom "field" $ Indexed ["x", "y"]+    interpretRule fromJSONRule egProduct options `shouldBe`+      Right "instance FromJSON Coord where\n\+            \  parseJSON = withObject \"Coord\" $ \\v ->\n\+            \    Coordy <$> v .: \"x\" <*> v .: \"y\""++  it "should interpret FromJSON for records" $ do+    interpretRule fromJSONRule egRecord M.empty `shouldBe`+      Right "instance FromJSON Coord where\n\+            \  parseJSON = withObject \"Coord\" $ \\v ->\n\+            \    Coordy <$> v .: \"a\" <*> v .: \"b\""++  it "should interpret ToJSON for polymorphic products" $ do+    let options = custom "field" $ Indexed ["x", "y", "z"]+    interpretRule toJSONRule egPolyProduct options `shouldBe`+      Right "instance (ToJSON a, ToJSON b) => ToJSON (Things a b) where\n\+            \  toJSON (T p_1_1 p_1_2 p_1_3) = object [\"x\" .= p_1_1, \"y\" .= p_1_2, \"z\" .= p_1_3]\n\+            \  toEncoding (T p_1_1 p_1_2 p_1_3) = pairs (\"x\" .= p_1_1 <> \"y\" .= p_1_2 <> \"z\" .= p_1_3)"++  it "should interpret FFunctor for polymorphic records" $ do+    interpretRule ffunctorRule egPolyRecord M.empty `shouldBe`+      Right "instance FFunctor Logger where\n\+            \  ffmap nt (Logger p_1_1) = Logger (nt ... p_1_1)"++  it "should interpret ToJSON for polymorphic sum" $ do+    let options = custom "field" $ Indexed ["x", "y", "z"]+    interpretRule toJSONRule egPolySum options `shouldBe`+      Right "instance (ToJSON a) => ToJSON (Action a) where\n\+            \  toJSON (Admin p_1_1 p_1_2) = object [\"Admin\" .= object [\"x\" .= p_1_1, \"y\" .= p_1_2]]\n\+            \  toJSON (User p_1_1 p_1_2) = object [\"User\" .= object [\"x\" .= p_1_1, \"y\" .= p_1_2]]"++  it "should interpret ToJSON for records without custom" $ do+    interpretRule toJSONRule egRecord M.empty `shouldBe`+      Right "instance ToJSON Coord where\n\+            \  toJSON (Coordy p_1_1 p_1_2) = object [\"a\" .= p_1_1, \"b\" .= p_1_2]\n\+            \  toEncoding (Coordy p_1_1 p_1_2) = pairs (\"a\" .= p_1_1 <> \"b\" .= p_1_2)"++  it "should interpret ToJSON for records with custom" $ do+    let options = custom "field" . Named $ M.fromList [("a", "aa"), ("b", "bb")]+    interpretRule toJSONRule egRecord options `shouldBe`+      Right "instance ToJSON Coord where\n\+            \  toJSON (Coordy p_1_1 p_1_2) = object [\"aa\" .= p_1_1, \"bb\" .= p_1_2]\n\+            \  toEncoding (Coordy p_1_1 p_1_2) = pairs (\"aa\" .= p_1_1 <> \"bb\" .= p_1_2)"++  it "should interpret ToJSON for sum types" $ do+    let options = custom "field" . NamedIndexed $ M.fromList [("Wales", ["foo"]), ("England", ["a", "b"]), ("Scotland", [])]+    interpretRule toJSONRule egSum options `shouldBe`+      Right "instance ToJSON Union where\n\+            \  toJSON (Wales p_1_1) = object [\"Wales\" .= object [\"foo\" .= p_1_1]]\n\+            \  toJSON (England p_1_1 p_1_2) = object [\"England\" .= object [\"a\" .= p_1_1, \"b\" .= p_1_2]]\n\+            \  toJSON Scotland = object [\"Scotland\" .= object []]"++  it "should interpret FromJSON for sum types" $ do+    let options = custom "field" . NamedIndexed $ M.fromList [("Wales", ["foo"]), ("England", ["a", "b"]), ("Scotland", [])]+    interpretRule fromJSONRule egSum options `shouldBe`+      Right "instance FromJSON Union where\n\+            \  parseJSON = withObject \"Union\" $ \\v ->\n\+            \    let withField key parse = (maybe (fail \"\") pure $ H.lookup key v) >>= (withObject (T.unpack key) parse)\n\+            \     in (withField \"Wales\" $ \\v' -> Wales <$> v' .: \"foo\")\n\+            \    <|> (withField \"England\" $ \\v' -> England <$> v' .: \"a\" <*> v' .: \"b\")\n\+            \    <|> (withField \"Scotland\" $ \\_ -> pure Scotland)\n\+            \    <|> (fail \"no valid type constructor tags\")"++  it "should interpret ToJSON for sum types, extra options" $ do+    let options = M.fromList [("field", NamedIndexed $ M.fromList [("Wales", ["foo"]), ("England", ["a", "b"]), ("Scotland", [])]),+                              ("tag", Named $ M.fromList [("Wales", "dragon"), ("England", "lion"), ("Scotland", "unicorn")])]+    interpretRule toJSONRule egSum options `shouldBe`+      Right "instance ToJSON Union where\n\+            \  toJSON (Wales p_1_1) = object [\"dragon\" .= object [\"foo\" .= p_1_1]]\n\+            \  toJSON (England p_1_1 p_1_2) = object [\"lion\" .= object [\"a\" .= p_1_1, \"b\" .= p_1_2]]\n\+            \  toJSON Scotland = object [\"unicorn\" .= object []]"

@@ -0,0 +1,83 @@+{-# LANGUAGE OverloadedStrings #-}++module Boilerplate.RuleParserTests where++import qualified Data.Text as T+import Boilerplate.Types+import Boilerplate.RuleParser+import Test.Tasty.Hspec+import Data.Either.Extra+import Text.Parsec (parse)+import Text.Parsec.Text (parseFromFile)++-- uses parsec+parseRule :: String -> Either String Rule+parseRule = mapLeft show . parse ruleParser "test" . T.pack++parseRuleFile :: FilePath -> IO (Either String Rule)+parseRuleFile file = do+  res <- parseFromFile ruleParser file+  pure $ mapLeft show res++-- uses ReadP, no errors but principle of least power+-- import Text.ParserCombinators.ReadP (readP_to_S)+-- parseRule :: String -> Maybe Rule+-- parseRule txt = listToMaybe $ fst <$> (filter (null . snd) . readP_to_S ruleParser $ txt)++shouldParseTo :: HasCallStack => String -> [Atom] -> Expectation+shouldParseTo input expected = (parseRule input) `shouldBe` (Right $ Rule expected)++shouldNotParse :: HasCallStack => String -> Expectation+shouldNotParse input = (parseRule input) `shouldSatisfy` isLeft++spec_rules :: Spec+spec_rules = do+  it "should parse plain text" $ do+    "hello world" `shouldParseTo` [Raw "hello world"]+  it "should parse escaped plain text" $ do+    "hello \\{world\\}" `shouldParseTo` [Raw "hello {world}"]+  it "should not parse unescaped plain text" $ do+    shouldNotParse "hello {world}"+  it "should parse Cons inside Product" $ do+    "{Product {Cons} = foo}" `shouldParseTo` [Product [Cons, Raw " = foo"]]+  it "should parse raw text inside a Product" $ do+    "{Product\n   foo :: {Type}}" `shouldParseTo` [Product [Raw "   foo :: ", Type]]+  it "should not parse Param outside a Field" $ do+    shouldNotParse "{Param} = foo"+    shouldNotParse "{Product {Param}} = foo"+    "{Product\n{Field {{Param}}{}}} = foo" `shouldParseTo`+      [Product [Field [Raw ""] [Raw ""] [Param 1] "" ""], Raw " = foo"]+  it "should parse long form Field inside Product" $ do+    "{Product  {Field {}{<$>}{v .: }{ <*> }{}}}" `shouldParseTo`+      [Product [Raw " ", Field [] [Raw "<$>"] [Raw "v .: "] " <*> " ""]]+  it "should parse Field and ParamN inside Product" $ do+    "{Product {Uncons1} {Uncons2} -> {Cons} {Field {{Param1} <> {Param2}}{ }}}" `shouldParseTo`+      [Product [Uncons 1, Raw " ", Uncons 2, Raw " -> ", Cons, Raw " ",+        Field [Raw ""] [Raw ""] [Param 1, Raw " <> ", Param 2] " " ""]]+  it "should parse Field and ParamN inside Sum" $ do+    "{Sum {{Uncons1} {Uncons2} -> {Cons} {Field {{Param1} <> {Param2}} { }}}{\n}}" `shouldParseTo`+      [Sum "" [Uncons 1, Raw " ", Uncons 2, Raw " -> ", Cons, Raw " ",+        Field [Raw ""] [Raw ""] [Param 1, Raw " <> ", Param 2] " " ""] "\n" ""]++  it "should parse the FromJSON example" $ do+    parsed <- parseRuleFile "boilerplate/Data/Aeson/FromJSON.rule"+    parsed `shouldBe` (Right fromJSONRule)++  it "should parse the ToJSON example" $ do+    parsed <- parseRuleFile "boilerplate/Data/Aeson/ToJSON.rule"+    parsed `shouldBe` (Right toJSONRule)++  it "should parse the FFunctor example" $ do+    parsed <- parseRuleFile "boilerplate/Data/FFunctor/FFunctor.rule"+    parsed `shouldBe` (Right ffunctorRule)++fromJSONRule :: Rule+fromJSONRule = Rule [Sugar (Instance "FromJSON"),Raw "\n  parseJSON = withObject \"",Type,Raw "\" $ \\v ->\n",Product [Raw "    ",Cons,Raw " ",Field [] [Raw "<$> "] [Raw "v .: \"",Custom "field" (Just [FieldName]),Raw "\""] " <*> " "",Raw "\n"],Sum "    let withField key parse = (maybe (fail \"\") pure $ H.lookup key v) >>= (withObject (T.unpack key) parse)\n     in " [Raw "(withField \"",Custom "tag" (Just [Cons]),Raw "\" $ ",Field [Raw "\\_ -> pure ",Cons] [Raw "\\v' -> ",Cons,Raw " <$> "] [Raw "v' .: \"",Custom "field" (Just [FieldName]),Raw "\""] " <*> " "",Raw ")"] "\n    <|> " "\n    <|> (fail \"no valid type constructor tags\")\n"]++toJSONRule :: Rule+toJSONRule = Rule [Sugar (Instance "ToJSON"),Raw "\n",Product [Raw "  toJSON ",Uncons 1,Raw " = object ",Field [Raw "[]"] [Raw "["] [Raw "\"",Custom "field" (Just [FieldName]),Raw "\" .= ",Param 1] ", " "]",Raw "\n  toEncoding ",Uncons 1,Raw " = pairs ",Field [Raw "mempty"] [Raw "("] [Raw "\"",Custom "field" (Just [FieldName]),Raw "\" .= ",Param 1] " <> " ")",Raw "\n"],Sum "" [Raw "  toJSON ",Uncons 1,Raw " = object [\"",Custom "tag" (Just [Cons]),Raw "\" .= object ",Field [Raw "[]"] [Raw "["] [Raw "\"",Custom "field" (Just [FieldName]),Raw "\" .= ",Param 1] ", " "]",Raw "]\n"] "" ""]++ffunctorRule :: Rule+ffunctorRule = Rule [Raw "instance FFunctor ",Type,Raw " where\n",+                     Product [Raw "  ffmap nt ",Uncons 1,Raw " = ",Cons,Raw " ",Field [Raw ""] [Raw ""] [Raw "(nt ... ",Param 1,Raw ")"] " " "",Raw "\n"],+                     Sum "" [Raw "  ffmap nt ",Uncons 1,Raw " = ",Cons,Raw " ",Field [Raw ""] [Raw ""] [Raw "(nt ... ",Param 1,Raw ")"] " " "",Raw "\n"] "" ""]

@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF tasty-discover #-}