checkmate (empty) → 0.1.0
raw patch · 17 files changed
+1665/−0 lines, 17 filesdep +QuickCheckdep +basedep +bytestringsetup-changed
Dependencies added: QuickCheck, base, bytestring, checkmate, containers, diff-parse, directory, file-embed, filepath, github, hlint, hspec, hspec-megaparsec, interpolatedstring-perl6, megaparsec, monad-parallel, optparse-applicative, quickcheck-text, range, temporary, text
Files
- LICENSE +674/−0
- README.md +9/−0
- Setup.hs +2/−0
- app/Main.hs +195/−0
- checkmate.cabal +121/−0
- src/Checkmate/Check.hs +37/−0
- src/Checkmate/Diff.hs +11/−0
- src/Checkmate/Discover.hs +76/−0
- src/Checkmate/Parser/CheckFile.hs +58/−0
- src/Checkmate/Parser/IndentBlock.hs +111/−0
- test/Checkmate/CheckSpec.hs +26/−0
- test/Checkmate/DiffSpec.hs +24/−0
- test/Checkmate/DiscoverSpec.hs +146/−0
- test/Checkmate/Parser/CheckFileSpec.hs +105/−0
- test/Checkmate/Parser/IndentBlockSpec.hs +57/−0
- test/HLint.hs +12/−0
- test/Spec.hs +1/−0
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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+<http://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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ README.md view
@@ -0,0 +1,9 @@+Checkmate+=========++[![Build Status][ci-badge]][ci]++Generate checklists relevant to a given patch.++[ci-badge]: https://travis-ci.org/spoqa/checkmate.svg?branch=master+[ci]: https://travis-ci.org/spoqa/checkmate
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ app/Main.hs view
@@ -0,0 +1,195 @@+{-# LANGUAGE OverloadedStrings #-}+import Data.Foldable+import Data.Maybe+import Data.Semigroup ((<>))+import Prelude hiding (error)+import System.Environment+import System.Exit+import System.IO++import Data.Text hiding (find)+import Data.Text.Encoding+import Data.Text.IO as TIO+import GitHub.Auth+import GitHub.Data.Comments+import GitHub.Data.Definitions+import GitHub.Data.Id+import GitHub.Data.Issues+import GitHub.Data.Name+import GitHub.Data.Repos+import GitHub.Data.URL+import GitHub.Endpoints.Issues.Comments (comments', createComment, editComment)+import GitHub.Endpoints.Users (userInfoCurrent')+import Options.Applicative+import System.Directory++import Checkmate.Check+import Checkmate.Discover++type Command = App -> Checklist -> IO ()++data App = App+ { inputFilePath :: FilePath+ , appCommand :: Command+ }++withInputFile :: App -> (Handle -> IO r) -> IO r+withInputFile App { inputFilePath = "-" } action' = do+ let i = stdin+ r <- action' i+ hClose i+ return r+withInputFile App { inputFilePath = i } action' =+ withFile i ReadMode action'++appP :: Parser App+appP = App+ <$> strOption ( long "input-file"+ <> short 'i'+ <> metavar "FILE"+ <> showDefault+ <> value "-"+ <> help "A diff text to extract a checklist from"+ )+ <*> subparser ( command "commonmark" commonmarkPI+ <> command "gfm" gfmPI+ <> command "github" githubPI+ )++commonmarkPI :: ParserInfo Command+commonmarkPI = info (pure cmd) $+ progDesc "Print a checklist as CommonMark (i.e. Markdown) format."+ where+ cmd :: Command+ cmd _ = TIO.putStr . toCommonMark++gfmPI :: ParserInfo Command+gfmPI = info (pure cmd) $+ progDesc "Print a checklist as GitHub Flavored Markdown format."+ where+ cmd :: Command+ cmd _ = TIO.putStr . toGFMarkdown++githubPI :: ParserInfo Command+githubPI = info (parser <**> helper) $+ progDesc $ "Create a checklist comment on the corresponding pull " +++ "reuqest on GitHub."+ where+ cmd :: Maybe (Name Owner)+ -> Name Repo+ -> Id Issue+ -> Token+ -> Maybe Text+ -> Command+ cmd owner' repo pr accessToken endpoint _ checklist = do+ user <- userInfoCurrent' auth >>= error+ let owner = fromMaybe (N . untagName $ userLogin user) owner'+ prComments <- comments' (Just auth) owner repo pr >>= error+ let checklistComment = find (isChecklist user) prComments+ leave = case checklistComment of+ Nothing -> createComment auth owner repo pr+ Just IssueComment { issueCommentId = cid } ->+ editComment auth owner repo $ Id cid+ Comment { commentHtmlUrl = leftCommentUrl } <-+ leave (signature `append` toGFMarkdown checklist) >>= error+ case leftCommentUrl of+ Just (URL u) -> TIO.putStrLn u+ _ -> return ()+ where+ auth :: Auth+ auth = case endpoint of+ Nothing -> OAuth accessToken+ Just e -> EnterpriseOAuth e accessToken+ signature :: Text+ signature = "<!-- COMMENT BY CHECKMATE -->\n"+ isChecklist :: User -> IssueComment -> Bool+ isChecklist User { userId = uid }+ IssueComment { issueCommentBody = cBody+ , issueCommentUser =+ SimpleUser { simpleUserId = authorId }+ } =+ uid == authorId && isPrefixOf signature cBody+ error :: Either Error a -> IO a+ error (Right v) = return v+ error (Left (HTTPError httpError)) = printError $ pack $ show httpError+ error (Left (ParseError message)) = printError message+ error (Left (JsonError message)) = printError message+ error (Left (UserError message)) = printError message+ parser :: Parser Command+ parser = cmd+ <$> option (Just . (N :: Text -> Name Owner) . pack <$> str)+ ( long "owner"+ <> long "login"+ <> short 'l'+ <> metavar "LOGIN"+ <> value Nothing+ <> help ("Owner of GitHub repository of a pull request to " +++ "create a checklist comment. \"foo\" of " +++ "\"github.com/foo/bar\". The currently authenticated " +++ "user (through -t/--access-token/--token) by default")+ )+ <*> option ((N :: Text -> Name Repo) . pack <$> str)+ ( long "repository"+ <> long "repo"+ <> short 'r'+ <> metavar "REPO"+ <> help ("Name of GitHub repository of a pull request to create " +++ "a checklist comment. \"bar\" of \"github.com/foo/bar\"")+ )+ <*> option ((Id :: Int -> Id Issue) <$> (auto :: ReadM Int))+ ( long "pull-request"+ <> long "pr"+ <> short 'p'+ <> metavar "NUM"+ <> help "No. of pull request to create a checklist comment"+ )+ <*> option (encodeUtf8 . pack <$> str)+ ( long "access-token"+ <> long "token"+ <> short 't'+ <> metavar "TOKEN"+ <> help "GitHub OAuth access token"+ )+ <*> option (Just . dropWhileEnd (== '/') . pack <$> str)+ ( long "enterprise-endpoint"+ <> short 'e'+ <> metavar "URL"+ <> value Nothing+ <> help "API endpoint URL for GitHub Enterprise (if applicable)"+ )++appPI :: ParserInfo App+appPI = info (appP <**> helper)+ ( fullDesc+ <> progDesc "Generate checklists relevant to a given patch."+ )++toCommonMark' :: Checklist -> Text -> Text+toCommonMark' checklist itemPrefix =+ "### Checklist \x1f914\n\n" `append` intercalate+ "\n"+ [ " - " `append` itemPrefix `append` replace "\n" "\n " t+ | Check { checkText = t } <- toList checklist+ ]++toGFMarkdown :: Checklist -> Text+toGFMarkdown = (`toCommonMark'` "[ ] ")++toCommonMark :: Checklist -> Text+toCommonMark = (`toCommonMark'` "")++printError :: Text -> IO a+printError message = do+ prog <- getProgName+ die $ prog ++ ": error: " ++ unpack message++main :: IO ()+main = do+ app@App { appCommand = cmd' } <- execParser appPI+ cwd <- getCurrentDirectory+ diff <- withInputFile app TIO.hGetContents+ case parseDiff diff of+ Left msg -> System.IO.putStrLn msg+ Right deltas -> do+ checklist <- discover cwd deltas+ cmd' app checklist
+ checkmate.cabal view
@@ -0,0 +1,121 @@+-- This file has been generated from package.yaml by hpack version 0.17.1.+--+-- see: https://github.com/sol/hpack++name: checkmate+version: 0.1.0+synopsis: Generate checklists relevant to a given patch+category: Development+stability: alpha+homepage: https://github.com/spoqa/checkmate#readme+bug-reports: https://github.com/spoqa/checkmate/issues+author: Hong Minhee+maintainer: hong.minhee@gmail.com+copyright: (c) 2017 Hong Minhee+license: GPL-3+license-file: LICENSE+build-type: Simple+cabal-version: >= 1.10++extra-source-files:+ README.md++source-repository head+ type: git+ location: https://github.com/spoqa/checkmate++library+ hs-source-dirs:+ src+ ghc-options: -Wall -fwarn-incomplete-uni-patterns+ build-depends:+ base >= 4.7 && < 5+ , diff-parse >= 0.2.1 && < 0.3.0+ , directory == 1.3.*+ , filepath >= 1.4.1.1 && < 2.0.0+ , megaparsec >= 5.3.1 && < 5.4.0+ , range >= 0.1.2 && < 0.2.0+ , text == 1.*+ , containers >= 0.5.7.1 && < 0.6.0.0+ , monad-parallel >= 0.7.2.2 && < 0.8.0.0+ exposed-modules:+ Checkmate.Check+ Checkmate.Diff+ Checkmate.Discover+ Checkmate.Parser.CheckFile+ Checkmate.Parser.IndentBlock+ default-language: Haskell2010++executable checkmate+ main-is: Main.hs+ hs-source-dirs:+ app+ ghc-options: -Wall -fwarn-incomplete-uni-patterns -threaded -rtsopts -with-rtsopts=-N -static -optl-static -optl-pthread -optc-Os -fPIC+ build-depends:+ base >= 4.7 && < 5+ , diff-parse >= 0.2.1 && < 0.3.0+ , directory == 1.3.*+ , filepath >= 1.4.1.1 && < 2.0.0+ , megaparsec >= 5.3.1 && < 5.4.0+ , range >= 0.1.2 && < 0.2.0+ , text == 1.*+ , checkmate+ , github == 0.16.*+ , optparse-applicative >= 0.13.2.0 && < 0.15.0.0+ default-language: Haskell2010++test-suite hlint+ type: exitcode-stdio-1.0+ main-is: HLint.hs+ hs-source-dirs:+ test+ ghc-options: -Wall+ build-depends:+ base >= 4.7 && < 5+ , diff-parse >= 0.2.1 && < 0.3.0+ , directory == 1.3.*+ , filepath >= 1.4.1.1 && < 2.0.0+ , megaparsec >= 5.3.1 && < 5.4.0+ , range >= 0.1.2 && < 0.2.0+ , text == 1.*+ , hlint >= 2.0.9 && < 3+ other-modules:+ Checkmate.CheckSpec+ Checkmate.DiffSpec+ Checkmate.DiscoverSpec+ Checkmate.Parser.CheckFileSpec+ Checkmate.Parser.IndentBlockSpec+ Spec+ default-language: Haskell2010++test-suite spec+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ hs-source-dirs:+ test+ ghc-options: -Wall -fno-warn-incomplete-uni-patterns -fno-warn-missing-signatures -rtsopts -threaded -with-rtsopts=-N -Wno-orphans+ build-depends:+ base >= 4.7 && < 5+ , diff-parse >= 0.2.1 && < 0.3.0+ , directory == 1.3.*+ , filepath >= 1.4.1.1 && < 2.0.0+ , megaparsec >= 5.3.1 && < 5.4.0+ , range >= 0.1.2 && < 0.2.0+ , text == 1.*+ , bytestring >= 0.10.8.1 && < 0.11+ , checkmate+ , file-embed >= 0.0.10 && < 0.1.0+ , hspec >= 2.4.4 && < 3.0.0+ , hspec-megaparsec >= 0.3.1 && < 0.4.0+ , interpolatedstring-perl6 == 1.*+ , QuickCheck >= 2.9.2 && < 3.0.0+ , quickcheck-text >= 0.1.2.1 && < 0.2.0.0+ , temporary >= 1.2.1 && < 1.3.0.0+ other-modules:+ Checkmate.CheckSpec+ Checkmate.DiffSpec+ Checkmate.DiscoverSpec+ Checkmate.Parser.CheckFileSpec+ Checkmate.Parser.IndentBlockSpec+ HLint+ default-language: Haskell2010
+ src/Checkmate/Check.hs view
@@ -0,0 +1,37 @@+module Checkmate.Check+ ( Check (Check, checkOrderIndex, checkScope, checkText)+ , Checklist+ , Scope (Directory, FileBlock, scopePath, scopeRange)+ , union+ ) where++import Data.Set hiding (toList)+import Data.Text+import Data.Range.Range hiding (union)+import System.FilePath++data Scope+ = FileBlock { scopePath :: FilePath, scopeRange :: Range Int }+ | Directory { scopePath :: FilePath }+ deriving (Show)++instance Eq Scope where+ FileBlock pathA rangeA == FileBlock pathB rangeB =+ equalFilePath pathA pathB && rangeA == rangeB+ Directory pathA == Directory pathB =+ equalFilePath pathA pathB+ _ == _ = False++data Check+ = Check { checkScope :: Scope+ , checkOrderIndex :: Int+ , checkText :: Text+ } deriving (Eq, Show)++instance Ord Check where+ compare a b =+ compare (tup a) (tup b)+ where+ tup (Check scope orderIndex text) = (scopePath scope, orderIndex, text)++type Checklist = Set Check
+ src/Checkmate/Diff.hs view
@@ -0,0 +1,11 @@+module Checkmate.Diff+ ( rangeFromDiffRange+ ) where++import Data.Range.Range as Range+import Text.Diff.Parse.Types as DT++rangeFromDiffRange :: DT.Range -> Range.Range Int+rangeFromDiffRange (DT.Range start lineLen)+ | lineLen < 2 = Range.SingletonRange start+ | otherwise = Range.SpanRange start $ start + (lineLen - 1)
+ src/Checkmate/Discover.hs view
@@ -0,0 +1,76 @@+module Checkmate.Discover+ ( discover+ , discoverDirectory+ , discoverFile+ , parseDiff+ ) where++import Control.Monad.Parallel as P+import Data.Range.Range as Range+import Data.Set as S+import Data.Text+import System.Directory+import System.FilePath+import Text.Diff.Parse (parseDiff)+import Text.Diff.Parse.Types++import Checkmate.Check+import Checkmate.Diff+import Checkmate.Parser.CheckFile+import Checkmate.Parser.IndentBlock++checkFileName :: FilePath+checkFileName = "CHECK"++discover :: FilePath -> FileDeltas -> IO Checklist+discover baseDirPath deltas = do+ checklists <- P.sequence $ fmap (discoverFile baseDirPath) deltas+ dirChecklists <- forM deltas $ \ FileDelta { fileDeltaDestFile = p } -> do+ let dirPath' = takeDirectory $ unpack p+ discoverDirectory baseDirPath dirPath'+ return . unions $ checklists ++ dirChecklists++discoverDirectory :: FilePath -> FilePath -> IO Checklist+discoverDirectory baseDirPath dirPath = do+ dirExist <- doesDirectoryExist dirPath'+ if not dirExist then return S.empty else do+ checkFileExist <- doesFileExist checkFilePath+ checklist <-+ if checkFileExist+ then do+ result <- parseCheckFile checkFilePath+ return $ case result of+ Left _ -> S.empty+ Right checklist -> checklist+ else return S.empty+ parentChecklist <-+ if dirPath == "." || dirPath == "" || parent == dirPath+ then return S.empty+ else discoverDirectory baseDirPath parent+ return $ S.union checklist parentChecklist+ where+ dirPath' :: FilePath+ dirPath' = baseDirPath </> dirPath+ checkFilePath :: FilePath+ checkFilePath = dirPath' </> checkFileName+ parent :: FilePath+ parent = takeDirectory dirPath++discoverFile :: FilePath -> FileDelta -> IO Checklist+discoverFile _ FileDelta { fileDeltaContent = Binary } = return S.empty+discoverFile baseDirPath FileDelta { fileDeltaContent = Hunks hunks+ , fileDeltaDestFile = filePathT+ } = do+ result <- parseSourceFile filePath+ return $ case result of+ Left _ -> S.empty+ Right checklist -> fromList+ [ c+ | c@Check { checkScope = FileBlock _ range } <- toList checklist+ , Prelude.any (rangesOverlap range) ranges+ ]+ where+ filePath :: FilePath+ filePath = baseDirPath </> unpack filePathT+ ranges :: [Range.Range Int]+ ranges = [rangeFromDiffRange r | Hunk { hunkDestRange = r } <- hunks]
+ src/Checkmate/Parser/CheckFile.hs view
@@ -0,0 +1,58 @@+module Checkmate.Parser.CheckFile+ ( parseCheckFile+ , parseCheckFileText+ , parser+ ) where++import Control.Monad++import Data.Set+import qualified Data.Text as T+import Data.Text.IO+import System.FilePath+import Text.Megaparsec+import Text.Megaparsec.Text++import Checkmate.Check++parseCheckFile :: FilePath+ -> IO (Either (ParseError (Token T.Text) Dec) Checklist)+parseCheckFile filePath = do+ input <- Data.Text.IO.readFile filePath+ return $ parseCheckFileText filePath input++parseCheckFileText :: FilePath+ -> T.Text+ -> Either (ParseError (Token T.Text) Dec) Checklist+parseCheckFileText filePath =+ parse (parser $ takeDirectory filePath) filePath++parser :: FilePath -> Parser Checklist+parser dirPath = do+ space+ checkTexts <- many checkP+ eof+ return $ Data.Set.fromList+ [Check (Directory dirPath) i ct | (i, ct) <- zip [1..] checkTexts]+ where+ bulletP :: Parser ()+ bulletP = do+ skipMany (spaceChar <|> tab)+ bullet <- choice [ string "*"+ , string "+"+ , string "-"+ , string "CHECK"+ , some digitChar >> (string "." <|> string ")")+ ]+ skipSome (spaceChar <|> tab)+ unless (bullet == "CHECK") $ void . optional $ do+ void $ string "CHECK"+ skipSome (spaceChar <|> tab)+ checkP :: Parser T.Text+ checkP = do+ bulletP+ texts <- (`sepBy1` try (eol >> notFollowedBy bulletP)) $ do+ chars <- many $ noneOf "\n"+ return $ T.pack chars+ let texts' = texts :: [T.Text]+ return $ T.strip $ T.intercalate (T.singleton '\n') texts'
+ src/Checkmate/Parser/IndentBlock.hs view
@@ -0,0 +1,111 @@+module Checkmate.Parser.IndentBlock+ ( parser+ , parseSourceCode+ , parseSourceFile+ ) where++import Control.Monad+import Data.List++import Data.Range.Range+import Data.Set+import Data.Text+import Data.Text.IO+import Text.Megaparsec+import Text.Megaparsec.Text++import Checkmate.Check++parseSourceFile :: FilePath+ -> IO (Either (ParseError (Token Text) Dec) Checklist)+parseSourceFile filePath = do+ input <- Data.Text.IO.readFile filePath+ return $ parseSourceCode filePath input++parseSourceCode :: FilePath+ -> Text+ -> Either (ParseError (Token Text) Dec) Checklist+parseSourceCode = parse parser ++data Line = CheckComment Text | Line | EmptyLine deriving (Eq, Ord, Show)++parser :: Parser Checklist+parser = do+ lines' <- line `sepEndBy` eol+ eof+ let checkData = analyzeIndents 0 [] lines'+ sorted = sort checkData+ checks = [ Check (FileBlock path $ mkRange fromTo) i text+ | (i, (path, fromTo, _, text)) <- Data.List.zip [1..] sorted+ ]+ return $ Data.Set.fromList checks+ where+ mkRange :: (Int, Int) -> Range Int+ mkRange (from, to)+ | from >= to = SingletonRange from+ | otherwise = SpanRange from to+ indent :: Parser Int+ indent = choice+ [ tab >> return 8+ , char ' ' >> return 1+ ]+ someSpaces :: Parser ()+ someSpaces = skipMany $ oneOf " \t"+ checkKeyword :: Parser ()+ checkKeyword = do+ someSpaces+ void $ string "CHECK"+ someSpaces+ lineCommentCheck :: Parser Text+ lineCommentCheck = do+ choice [void $ oneOf "#%'", void $ string "//", void $ string "--"]+ checkKeyword+ chars <- many $ noneOf "\n"+ return $ pack chars+ blockCommentPairs :: [(String, String)]+ blockCommentPairs =+ [ ("/*", "*/"), ("{-", "-}"), ("<!--", "-->"), ("<#", "#>")+ , ("%{", "%}")+ ]+ blockCommentCheck :: Parser Text+ blockCommentCheck = choice $ fmap blockComment blockCommentPairs+ blockComment :: (String, String) -> Parser Text+ blockComment (start, end) = do+ void $ string start+ checkKeyword+ chars <- manyTill anyChar (string end)+ return $ pack chars+ line :: Parser (FilePath, Int, Int, Line)+ line = do+ SourcePos filePath lineNo _ <- getPosition+ widths <- many indent+ lineT <- choice+ [ try $ fmap CheckComment lineCommentCheck+ , try $ fmap CheckComment blockCommentCheck+ , try (some (noneOf "\n") >> return Line)+ , return EmptyLine+ ]+ return (filePath, read . show . unPos $ lineNo, sum widths, lineT)+ analyzeIndents :: Int+ -> [(FilePath, (Int, Int), Int, Text)]+ -> [(FilePath, Int, Int, Line)]+ -> [(FilePath, (Int, Int), Int, Text)]+ analyzeIndents _ prev [] = prev+ analyzeIndents prevDepth prev ((_, _, _, EmptyLine) : rest) =+ -- Indent blocks usually continue through empty lines+ -- (i.e. /^[ \t]{0}$/)+ analyzeIndents prevDepth prev rest+ analyzeIndents prevDepth prev ((filePath, lineNo, depth, lineT) : rest) =+ dedented ++ analyzeIndents depth next rest+ where+ isDedented :: (FilePath, (Int, Int), Int, Text) -> Bool+ isDedented (_, _, checkDepth, _) =+ prevDepth > depth && checkDepth > depth+ (dedented, inScope) = Data.List.partition isDedented prev+ next :: [(FilePath, (Int, Int), Int, Text)]+ next =+ [ (path, (from, lineNo), d, t)+ | (path, (from, _), d, t) <- inScope+ ] ++ case lineT of+ CheckComment t -> [(filePath, (lineNo, lineNo), depth, t)]+ _ -> []
+ test/Checkmate/CheckSpec.hs view
@@ -0,0 +1,26 @@+{-# LANGUAGE FlexibleInstances #-}+module Checkmate.CheckSpec (spec) where++import Data.Range.Range+import System.FilePath+import Test.Hspec++import Checkmate.Check++spec :: Spec+spec =+ describe "Scope" $ do+ let p = "foo" </> "bar"+ r = SingletonRange 1+ it "doesn't equal if two values' data constructors are different" $ do+ FileBlock p r `shouldNotBe` Directory p+ FileBlock p r `shouldNotBe` Directory (p </> "baz")+ it "doesn't equal if two FileBlocks have different scopeRange" $ do+ FileBlock p r `shouldNotBe` FileBlock p (SingletonRange 2)+ FileBlock p r `shouldNotBe`+ FileBlock (p </> "baz") (SingletonRange 2)+ it "equals if two values' scopePaths refer to the same path" $ do+ Directory p `shouldBe` Directory p+ FileBlock p r `shouldBe` FileBlock p r+ Directory p `shouldBe` Directory ("." </> p)+ FileBlock p r `shouldBe` FileBlock ("." </> p) r
+ test/Checkmate/DiffSpec.hs view
@@ -0,0 +1,24 @@+module Checkmate.DiffSpec (spec) where++import Data.Range.Range as Range+import Test.Hspec+import Test.QuickCheck+import Text.Diff.Parse.Types as DT++import Checkmate.Diff (rangeFromDiffRange)++instance Arbitrary DT.Range where+ arbitrary = do+ NonZero start <- arbitrary+ NonZero lineLen <- arbitrary+ return $ DT.Range (abs start) (abs lineLen)++spec :: Spec+spec =+ specify "rangeFromDiffRange" $ property $ \ dr@(DT.Range start lineLen) ->+ let r = rangeFromDiffRange dr+ in+ Range.inRange r start &&+ not (Range.inRange r $ start - 1) &&+ Range.inRange r (start + lineLen - 1) &&+ not (Range.inRange r $ start + lineLen)
+ test/Checkmate/DiscoverSpec.hs view
@@ -0,0 +1,146 @@+{-# LANGUAGE OverloadedLists #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE TemplateHaskell #-}+module Checkmate.DiscoverSpec (spec) where++import Control.Monad++import Data.ByteString+import Data.FileEmbed+import Data.Range.Range (Range (..))+import Data.Text+import System.Directory+import System.FilePath+import System.IO.Temp+import Test.Hspec+import Text.Diff.Parse (parseDiff)+import Text.Diff.Parse.Types++import Checkmate.Check+import Checkmate.Discover++fixtures :: [(FilePath, ByteString)]+fixtures = $(embedDir "test/fixtures/")++diffTextFixture :: Text+diffTextFixture = $(embedStringFile "test/fixtures/patch.diff")++diffFixture :: FileDeltas+Right diffFixture = parseDiff diffTextFixture++rootChecklistFixture :: FilePath -> Checklist+rootChecklistFixture dirPath =+ [ Check { checkScope = dir+ , checkOrderIndex = 1+ , checkText = "Sample check A"+ }+ , Check { checkScope = dir+ , checkOrderIndex = 2+ , checkText = "sample check B"+ }+ , Check { checkScope = dir+ , checkOrderIndex = 3+ , checkText = "Sample check C"+ }+ ]+ where+ dir :: Scope+ dir = Directory dirPath++subdirChecklistFixture :: FilePath -> Checklist+subdirChecklistFixture dirPath =+ [ Check { checkScope = dir+ , checkOrderIndex = 1+ , checkText = "sub-dir check A"+ }+ , Check { checkScope = dir+ , checkOrderIndex = 2+ , checkText = "sub-dir check B"+ }+ ] `union` rootChecklistFixture dirPath+ where+ dir :: Scope+ dir = Directory $ dirPath </> "subdir"++pyChecklistFixture :: FilePath -> Checklist+pyChecklistFixture d =+ [ Check { checkScope = FileBlock { scopePath = pyPath+ , scopeRange = SpanRange 2 23+ }+ , checkOrderIndex = 1+ , checkText = "module-level check"+ }+ , Check { checkScope = FileBlock { scopePath = pyPath+ , scopeRange = SpanRange 11 15+ }+ , checkOrderIndex = 3+ , checkText = "function-level check 2"+ }+ , Check { checkScope = FileBlock { scopePath = pyPath+ , scopeRange = SpanRange 14 15+ }+ , checkOrderIndex = 4+ , checkText = "nested function-level check"+ }+ ]+ where+ pyPath :: FilePath+ pyPath = d </> "sample.py"++jsChecklistFixture :: FilePath -> Checklist+jsChecklistFixture d =+ [ Check { checkScope = FileBlock { scopePath = jsPath+ , scopeRange = SpanRange 2 18+ }+ , checkOrderIndex = 1+ , checkText = "global check"+ }+ , Check { checkScope = FileBlock { scopePath = jsPath+ , scopeRange = SpanRange 10 17+ }+ , checkOrderIndex = 3+ , checkText = "function-level check 2"+ }+ , Check { checkScope = FileBlock { scopePath = jsPath+ , scopeRange = SpanRange 13 14+ }+ , checkOrderIndex = 4+ , checkText = "closure check"+ }+ ]+ where+ jsPath :: FilePath+ jsPath = d </> "subdir" </> "inner_sample.js"++withFixtureDir :: (FilePath -> IO a) -> IO a+withFixtureDir action =+ withSystemTempDirectory "checkmate-test" $ \ dirPath -> do+ forM_ fixtures $ \ (filePath, contents) -> do+ let path = dirPath </> filePath+ parent = takeDirectory path+ -- `parent` can differ from `dirPath` when `filePath` has '/'+ createDirectoryIfMissing True parent+ Data.ByteString.writeFile path contents+ action dirPath++spec :: Spec+spec = do+ specify "discover" $+ withFixtureDir $ \ dirPath -> do+ checklist <- discover dirPath diffFixture+ let expected = subdirChecklistFixture dirPath+ `union` pyChecklistFixture dirPath+ `union` jsChecklistFixture dirPath+ checklist `shouldBe` expected+ specify "discoverDirectory" $+ withFixtureDir $ \ dirPath -> do+ subdirChecks <- discoverDirectory dirPath "subdir"+ subdirChecks `shouldBe` subdirChecklistFixture dirPath+ rootChecks <- discoverDirectory dirPath "."+ rootChecks `shouldBe` rootChecklistFixture dirPath+ specify "discoverFile" $+ withFixtureDir $ \ dirPath -> do+ pyChecks <- discoverFile dirPath $ Prelude.head diffFixture+ pyChecks `shouldBe` pyChecklistFixture dirPath+ jsChecks <- discoverFile dirPath $ Prelude.last diffFixture+ jsChecks `shouldBe` jsChecklistFixture dirPath
+ test/Checkmate/Parser/CheckFileSpec.hs view
@@ -0,0 +1,105 @@+{-# LANGUAGE OverloadedLists #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE QuasiQuotes #-}+module Checkmate.Parser.CheckFileSpec (spec) where++import Control.Monad+import System.IO (hClose)++import Data.Text+import Data.Text.IO+import Test.Hspec+import Test.Hspec.Megaparsec+import Text.InterpolatedString.Perl6+import Text.Megaparsec+import System.FilePath+import System.IO.Temp++import Checkmate.Check+import Checkmate.Parser.CheckFile++spec :: Spec+spec = do+ parserSpec "parser" $ \ text ->+ return (".", parse (parser ".") ("." </> "CHECK") text)+ parserSpec "parseCheckFileText" $ \ text ->+ return (".", parseCheckFileText ("." </> "CHECK") text)+ parserSpec "parseCheckFileText" $ \ text ->+ withSystemTempFile "checkmate-test" $ \ filePath handle -> do+ hPutStr handle text+ hClose handle+ result <- parseCheckFile filePath+ return (takeDirectory filePath, result)++parserSpec :: String+ -> ( Text -> IO ( FilePath+ , Either (ParseError (Token Text) Dec) Checklist+ )+ )+ -> Spec+parserSpec specName parseFn =+ describe specName $ do+ it "returns [] if a given text is empty" $ do+ (_, parsed) <- parse' ""+ parsed `shouldParse` []+ let bulletStyles =+ [ ("CHECK", "CHECK", "CHECK", "CHECK")+ , ("bullet \"*\"", "*", "*", "*")+ , ("bullet \"-\"", "-", "-", "-")+ , ("bullet \"+\"", "+", "+", "+")+ , ("digit \"1.\"", "1.", "2.", "3.")+ , ("digit \"1)\"", "1)", "2)", "3)")+ ] :: [(Text, Text, Text, Text)]+ forM_ bulletStyles $ \ (styleName, b1, b2, b3) -> do+ it [qq|interprets $styleName line as a Check|] $ do+ (dir, parsed) <- parse' [qq|$b1 foo|]+ parsed `shouldParse` [Check dir 1 "foo"]+ let nl = "\n" :: Text+ it [qq|interprets multiple $styleName lines as [Check]|] $ do+ (ad, a) <- parse' [qq|$b1 foo$nl$b2 bar$nl|]+ a `shouldParse` [Check ad 1 "foo", Check ad 2 "bar"]+ (bd, b) <- parse' [qq|$b1 foo$nl$b2 bar$nl$b3 baz|]+ b `shouldParse` [ Check bd 1 "foo"+ , Check bd 2 "bar"+ , Check bd 3 "baz"+ ]+ it [qq|interprets multiple lines as a Check until it's followed + by another $styleName|] $ do+ (ad, a) <- parse' [qq|$b1 foo{nl}bar{nl}qux$nl|]+ a `shouldParse` [Check ad 1 "foo\nbar\nqux"]+ (bd, b) <- parse' [qq|$b1 foo{nl}bar$nl$b2 qux$nl|]+ b `shouldParse` [Check bd 1 "foo\nbar", Check bd 2 "qux"]+ it "ignores the leading spaces/empty lines" $ do+ (_, a) <- parse' " "+ a `shouldParse` []+ (_, b) <- parse' "\t"+ b `shouldParse` []+ (_, c) <- parse' "\n"+ c `shouldParse` []+ (_, d) <- parse' "\r\n"+ d `shouldParse` []+ (_, e) <- parse' "\n\n"+ e `shouldParse` []+ (_, f) <- parse' " \t \n\n"+ f `shouldParse` []+ (dir, g) <- parse' (mconcat [" \t \n\n", b1, " foo"])+ g `shouldParse` [Check dir 1 "foo"]+ it "parses well even if bullet styles are mixed" $ do+ (dir, parsed) <- parse'+ "CHECK foo\nbar\n- baz\nqux\n* quz\n+ a\n1. b\n2) c\nCHECK d"+ parsed `shouldParse`+ [ Check dir 1 "foo\nbar"+ , Check dir 2 "baz\nqux"+ , Check dir 3 "quz"+ , Check dir 4 "a"+ , Check dir 5 "b"+ , Check dir 6 "c"+ , Check dir 7 "d"+ ]+ where+ parse' :: Text -> IO ( Scope+ , Either (ParseError (Token Text) Dec) Checklist+ )+ parse' text = do+ (dir, result) <- parseFn text+ return (Directory dir, result)
+ test/Checkmate/Parser/IndentBlockSpec.hs view
@@ -0,0 +1,57 @@+{-# LANGUAGE OverloadedLists #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE QuasiQuotes #-}+{-# LANGUAGE TemplateHaskell #-}+module Checkmate.Parser.IndentBlockSpec (spec) where++import System.IO (hClose)++import Data.FileEmbed+import Data.Range.Range+import Data.Text+import Data.Text.IO+import Test.Hspec+import Test.Hspec.Megaparsec+import Text.Megaparsec+import System.IO.Temp++import Checkmate.Check+import Checkmate.Parser.IndentBlock++pythonFixture :: Text+pythonFixture = $(embedStringFile "test/fixtures/sample.py")++spec :: Spec+spec = do+ parserSpec "parser" $ \ text -> do+ let path = "sample.txt"+ return (path, parse parser path text)+ parserSpec "parseSourceCode" $ \ text -> do+ let path = "sample.txt"+ return (path, parseSourceCode path text)+ parserSpec "parseSourceFile" $ \ text ->+ withSystemTempFile "checkmate-test" $ \ filePath handle -> do+ hPutStr handle text+ hClose handle+ parsed <- parseSourceFile filePath+ return (filePath, parsed)++parserSpec+ :: String+ -> (Text -> IO (FilePath, Either (ParseError (Token Text) Dec) Checklist))+ -> Spec+parserSpec specName parse' = describe specName $ do+ it "returns an empty set if a given text is empty" $ do+ (_, parsed) <- parse' ""+ parsed `shouldParse` []+ it "parses test/fixtures/sample.py" $ do+ (path, parsed) <- parse' pythonFixture+ let s = FileBlock path+ parsed `shouldParse`+ [ Check (s $ SpanRange 2 23) 1 "module-level check"+ , Check (s $ SpanRange 6 7) 2 "function-level check"+ , Check (s $ SpanRange 11 15) 3 "function-level check 2"+ , Check (s $ SpanRange 14 15) 4 "nested function-level check"+ , Check (s $ SpanRange 19 23) 5 "class-level check"+ , Check (s $ SpanRange 22 23) 6 "method-level check"+ ]
+ test/HLint.hs view
@@ -0,0 +1,12 @@+import Language.Haskell.HLint+import System.Exit++arguments :: [String]+arguments = ["app", "src", "test"]++main :: IO ()+main = do+ hlints <- hlint arguments+ case hlints of+ [] -> exitSuccess+ _ -> exitFailure
+ test/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}