diff --git a/LICENSE b/LICENSE index 285ce03..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,30 +1,674 @@ -Copyright Jonathan Lamothe (c) 2019 + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -All rights reserved. + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: + Preamble - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. - * Redistributions in binary form must reproduce the above - copyright notice, this list of conditions and the following - disclaimer in the documentation and/or other materials provided - with the distribution. + 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. - * Neither the name of Jonathan Lamothe nor the names of other - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. + 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. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/app/Main.hs b/app/Main.hs index de1c1ab..d14a9f7 100644 --- a/app/Main.hs +++ b/app/Main.hs @@ -1,6 +1,30 @@ +{- + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + module Main where -import Lib +import Control.Monad.Trans.State (evalStateT) +import UI.NCurses (runCurses) + +import Mtlstats main :: IO () -main = someFunc +main = runCurses $ initState >>= evalStateT mainLoop diff --git a/package.yaml b/package.yaml index 818e894..aeff1f1 100644 --- a/package.yaml +++ b/package.yaml @@ -1,7 +1,7 @@ name: mtlstats version: 0.0.0 github: "mtlstats/mtlstats" -license: BSD3 +license: GPL-3 author: "Jonathan Lamothe" maintainer: "jlamothe1980@gmail.com" copyright: "Rhéal Lamothe" @@ -22,8 +22,12 @@ description: Please see the README on GitHub at = 4.7 && < 5 - aeson >= 1.4.4.0 && < 1.5 +- extra >= 1.6.17 && < 1.7 - microlens-th >= 0.4.2.3 && < 0.5 +- ncurses >= 0.2.16 && < 0.3 +- random >= 1.1 && < 1.2 - raw-strings-qq >= 1.1 && < 1.2 +- transformers >= 0.5.6.2 && < 0.6 - bytestring - microlens @@ -31,7 +35,7 @@ library: source-dirs: src executables: - mtlstats-exe: + mtlstats: main: Main.hs source-dirs: app ghc-options: diff --git a/src/Lib.hs b/src/Lib.hs deleted file mode 100644 index d36ff27..0000000 --- a/src/Lib.hs +++ /dev/null @@ -1,6 +0,0 @@ -module Lib - ( someFunc - ) where - -someFunc :: IO () -someFunc = putStrLn "someFunc" diff --git a/src/Mtlstats.hs b/src/Mtlstats.hs new file mode 100644 index 0000000..bc790ce --- /dev/null +++ b/src/Mtlstats.hs @@ -0,0 +1,48 @@ +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +module Mtlstats (initState, mainLoop) where + +import Control.Monad (void) +import Control.Monad.Extra (whenM) +import Control.Monad.Trans.Class (lift) +import Control.Monad.Trans.State (get) +import Data.Maybe (fromJust) +import qualified UI.NCurses as C + +import Mtlstats.Events +import Mtlstats.Types +import Mtlstats.UI + +-- | Initializes the progran +initState :: C.Curses ProgState +initState = do + C.setEcho False + void $ C.setCursorMode C.CursorInvisible + return newProgState + +-- | Main program loop +mainLoop :: Action () +mainLoop = do + get >>= lift . draw + w <- lift C.defaultWindow + whenM (lift (fromJust <$> C.getEvent w Nothing) >>= handleEvent) + mainLoop diff --git a/src/Mtlstats/Actions.hs b/src/Mtlstats/Actions.hs new file mode 100644 index 0000000..89e129b --- /dev/null +++ b/src/Mtlstats/Actions.hs @@ -0,0 +1,46 @@ +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +module Mtlstats.Actions + ( startNewSeason + , resetYtd + , startNewGame + ) where + +import Lens.Micro (over, (&), (.~), (?~), (%~)) + +import Mtlstats.Types + +-- | Starts a new season +startNewSeason :: ProgState -> ProgState +startNewSeason = (progMode .~ NewSeason) . (database . dbGames .~ 0) + +-- | Resets all players year-to-date stats +resetYtd :: ProgState -> ProgState +resetYtd + = (database . dbPlayers %~ map (pYtd .~ newPlayerStats)) + . (database . dbGoalies %~ map (gYtd .~ newGoalieStats)) + +-- | Starts a new game +startNewGame :: ProgState -> ProgState +startNewGame + = (progMode .~ NewGame newGameState) + . (database . dbGames %~ succ) diff --git a/src/Mtlstats/Events.hs b/src/Mtlstats/Events.hs new file mode 100644 index 0000000..bebbc02 --- /dev/null +++ b/src/Mtlstats/Events.hs @@ -0,0 +1,46 @@ +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +{-# LANGUAGE LambdaCase #-} + +module Mtlstats.Events (handleEvent) where + +import Control.Monad.Trans.State (gets, modify) +import Lens.Micro ((^.), (.~)) +import Lens.Micro.Extras (view) +import qualified UI.NCurses as C + +import Mtlstats.Actions +import Mtlstats.Menu +import Mtlstats.Types + +-- | Event handler +handleEvent + :: C.Event + -- ^ The event being handled + -> Action Bool +handleEvent e = gets (view progMode) >>= \case + MainMenu -> menuHandler mainMenu e + NewSeason -> menuHandler newSeasonMenu e >> return True + NewGame gs + | null $ gs ^. gameType -> + menuHandler gameTypeMenu e >> return True + | otherwise -> undefined diff --git a/src/Mtlstats/Menu.hs b/src/Mtlstats/Menu.hs new file mode 100644 index 0000000..a910ca8 --- /dev/null +++ b/src/Mtlstats/Menu.hs @@ -0,0 +1,79 @@ +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +module Mtlstats.Menu ( + -- * Menu Functions + drawMenu, + menuHandler, + -- * Menus + mainMenu, + newSeasonMenu, + gameTypeMenu +) where + +import Control.Monad.Trans.State (modify) +import Lens.Micro ((^.), (.~), (?~)) +import qualified UI.NCurses as C + +import Mtlstats.Actions +import Mtlstats.Types +import Mtlstats.Types.Menu + +-- | The draw function for a 'Menu' +drawMenu :: Menu a -> C.Update () +drawMenu = C.drawString . show + +-- | The event handler for a 'Menu' +menuHandler :: Menu a -> C.Event -> Action a +menuHandler m (C.EventCharacter c) = + case filter (\i -> i ^. miKey == c) $ m ^. menuItems of + i:_ -> i ^. miAction + [] -> return $ m ^. menuDefault +menuHandler m _ = return $ m ^. menuDefault + +-- | The main menu +mainMenu :: Menu Bool +mainMenu = Menu "*** MAIN MENU ***" True + [ MenuItem '1' "New Season" $ + modify startNewSeason >> return True + , MenuItem '2' "New Game" $ + modify startNewGame >> return True + , MenuItem '3' "Exit" $ + return False + ] + +-- | The new season menu +newSeasonMenu :: Menu () +newSeasonMenu = Menu "*** SEASON TYPE ***" () + [ MenuItem '1' "Regular Season" $ + modify $ resetYtd . startNewGame + , MenuItem '2' "Playoffs" $ + modify startNewGame + ] + +-- | The game type menu (home/away) +gameTypeMenu :: Menu () +gameTypeMenu = Menu "*** GAME TYPE ***" () + [ MenuItem '1' "Home Game" $ + modify $ progMode . gameTypeL ?~ HomeGame + , MenuItem '2' "Away Game" $ + modify $ progMode . gameTypeL ?~ AwayGame + ] diff --git a/src/Mtlstats/Types.hs b/src/Mtlstats/Types.hs index a885370..6aeb018 100644 --- a/src/Mtlstats/Types.hs +++ b/src/Mtlstats/Types.hs @@ -1,12 +1,54 @@ -{-# LANGUAGE OverloadedStrings, TemplateHaskell #-} +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +{-# LANGUAGE LambdaCase, OverloadedStrings, TemplateHaskell #-} module Mtlstats.Types ( -- * Types + Action, + ProgState (..), + GameState (..), + ProgMode (..), + GameType (..), + Database (..), Player (..), PlayerStats (..), Goalie (..), GoalieStats (..), -- * Lenses + -- ** ProgState Lenses + database, + progMode, + -- ** GameState Lenses + gameType, + homeScore, + awayScore, + -- ** ProgMode Lenses + gameTypeL, + homeScoreL, + awayScoreL, + -- ** Database Lenses + dbPlayers, + dbGoalies, + dbGames, -- ** Player Lenses pNumber, pName, @@ -31,14 +73,21 @@ module Mtlstats.Types ( gsLosses, gsTies, -- * Constructors + newProgState, + newGameState, + newDatabase, newPlayer, newPlayerStats, newGoalie, newGoalieStats, - -- * Helper functions + -- * Helper Functions + -- ** ProgState Helpers + teamScore, + -- ** Player Helpers pPoints ) where +import Control.Monad.Trans.State (StateT) import Data.Aeson ( FromJSON , ToJSON @@ -51,8 +100,70 @@ import Data.Aeson , (.:) , (.=) ) -import Lens.Micro ((^.)) +import Lens.Micro (Lens', lens, (&), (^.), (.~)) import Lens.Micro.TH (makeLenses) +import UI.NCurses (Curses) + +-- | Action which maintains program state +type Action a = StateT ProgState Curses a + +-- | Represents the program state +data ProgState = ProgState + { _database :: Database + -- ^ The data to be saved + , _progMode :: ProgMode + -- ^ The program's mode + } deriving (Eq, Show) + +-- | The game state +data GameState = GameState + { _gameType :: Maybe GameType + -- ^ The type of game (home/away) + , _homeScore :: Maybe Int + -- ^ The home team's score + , _awayScore :: Maybe Int + -- ^ The away team's score + } deriving (Eq, Show) + +-- | The program mode +data ProgMode + = MainMenu + | NewSeason + | NewGame GameState + deriving (Eq, Show) + +-- | The type of game +data GameType + = HomeGame + | AwayGame + deriving (Eq, Show) + +-- | Represents the database +data Database = Database + { _dbPlayers :: [Player] + -- ^ The list of players + , _dbGoalies :: [Goalie] + -- ^ The list of goalies + , _dbGames :: Int + -- ^ The number of games recorded + } deriving (Eq, Show) + +instance FromJSON Database where + parseJSON = withObject "Database" $ \v -> Database + <$> v .: "players" + <*> v .: "goalies" + <*> v .: "games" + +instance ToJSON Database where + toJSON (Database players goalies games) = object + [ "players" .= players + , "goalies" .= goalies + , "games" .= games + ] + toEncoding (Database players goalies games) = pairs $ + "players" .= players <> + "goalies" .= goalies <> + "games" .= games -- | Represents a (non-goalie) player data Player = Player @@ -197,11 +308,64 @@ instance ToJSON GoalieStats where "losses" .= l <> "ties" .= t +makeLenses ''ProgState +makeLenses ''GameState +makeLenses ''Database makeLenses ''Player makeLenses ''PlayerStats makeLenses ''Goalie makeLenses ''GoalieStats +gameTypeL :: Lens' ProgMode (Maybe GameType) +gameTypeL = lens + (\case + NewGame gs -> gs ^. gameType + _ -> Nothing) + (\m gt -> case m of + NewGame gs -> NewGame $ gs & gameType .~ gt + _ -> NewGame $ newGameState & gameType .~ gt) + +homeScoreL :: Lens' ProgMode (Maybe Int) +homeScoreL = lens + (\case + NewGame gs -> gs ^. homeScore + _ -> Nothing) + (\m hs -> case m of + NewGame gs -> NewGame $ gs & homeScore .~ hs + _ -> NewGame $ newGameState & homeScore .~ hs) + +awayScoreL :: Lens' ProgMode (Maybe Int) +awayScoreL = lens + (\case + NewGame gs -> gs ^. awayScore + _ -> Nothing) + (\m as -> case m of + NewGame gs -> NewGame $ gs & awayScore .~ as + _ -> NewGame $ newGameState & awayScore .~ as) + +-- | Constructor for a 'ProgState' +newProgState :: ProgState +newProgState = ProgState + { _database = newDatabase + , _progMode = MainMenu + } + +-- | Constructor for a 'GameState' +newGameState :: GameState +newGameState = GameState + { _gameType = Nothing + , _homeScore = Nothing + , _awayScore = Nothing + } + +-- | Constructor for a 'Database' +newDatabase :: Database +newDatabase = Database + { _dbPlayers = [] + , _dbGoalies = [] + , _dbGames = 0 + } + -- | Constructor for a 'Player' newPlayer :: Int @@ -253,6 +417,13 @@ newGoalieStats = GoalieStats , _gsTies = 0 } +-- | Determines the team's points +teamScore :: ProgState -> Maybe Int +teamScore s = case s ^. progMode . gameTypeL of + Just HomeGame -> s ^. progMode . homeScoreL + Just AwayGame -> s ^. progMode . awayScoreL + Nothing -> Nothing + -- | Calculates a player's points pPoints :: PlayerStats -> Int pPoints s = s^.psGoals + s^.psAssists diff --git a/src/Mtlstats/Types/Menu.hs b/src/Mtlstats/Types/Menu.hs new file mode 100644 index 0000000..8385070 --- /dev/null +++ b/src/Mtlstats/Types/Menu.hs @@ -0,0 +1,73 @@ +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +{-# LANGUAGE TemplateHaskell #-} + +module Mtlstats.Types.Menu ( + -- * Types + Menu (..), + MenuItem (..), + -- * Lenses + -- ** Menu Lenses + menuTitle, + menuDefault, + menuItems, + -- ** MenuItem Lenses + miKey, + miDescription, + miAction, +) where + +import Lens.Micro ((^.)) +import Lens.Micro.TH (makeLenses) +import qualified UI.NCurses as C + +import Mtlstats.Types + +-- | Defines a menu +data Menu a = Menu + { _menuTitle :: String + -- ^ The menu title + , _menuDefault :: a + -- ^ The value to return on incorrect selection or other event + , _menuItems :: [MenuItem a] + -- ^ The list of items in the menu + } + +-- | Defines a menu item +data MenuItem a = MenuItem + { _miKey :: Char + -- ^ The key that selects the menu item + , _miDescription :: String + -- ^ The description of the menu item + , _miAction :: Action a + -- ^ The action to be performed when selected + } + +makeLenses ''Menu +makeLenses ''MenuItem + +instance Show (Menu a) where + show m = m ^. menuTitle ++ "\n" ++ items + where items = unlines $ map show $ m ^. menuItems + +instance Show (MenuItem a) where + show i = [i ^. miKey] ++ ") " ++ i ^. miDescription diff --git a/src/Mtlstats/UI.hs b/src/Mtlstats/UI.hs new file mode 100644 index 0000000..c73962d --- /dev/null +++ b/src/Mtlstats/UI.hs @@ -0,0 +1,42 @@ +{- | + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +module Mtlstats.UI (draw) where + +import Lens.Micro ((^.)) +import qualified UI.NCurses as C + +import Mtlstats.Menu +import Mtlstats.Types + +-- | Drawing function +draw :: ProgState -> C.Curses () +draw s = do + w <- C.defaultWindow + C.updateWindow w $ do + C.clear + case s ^. progMode of + MainMenu -> drawMenu mainMenu + NewSeason -> drawMenu newSeasonMenu + NewGame gs + | null $ gs ^. gameType -> drawMenu gameTypeMenu + | otherwise ->undefined + C.render diff --git a/stack.yaml b/stack.yaml index 5e2d792..678c723 100644 --- a/stack.yaml +++ b/stack.yaml @@ -39,7 +39,8 @@ packages: # - git: https://github.com/commercialhaskell/stack.git # commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a # -# extra-deps: [] +extra-deps: +- ncurses-0.2.16@sha256:8ad9fe6562a80d28166d76adbac1eb4d40c6511fe4e9272ed6e1166dc2f1cdf1,3575 # Override default flag values for local packages and extra-deps # flags: {} diff --git a/stack.yaml.lock b/stack.yaml.lock index 3bab3b8..a782f19 100644 --- a/stack.yaml.lock +++ b/stack.yaml.lock @@ -3,7 +3,14 @@ # For more information, please see the documentation at: # https://docs.haskellstack.org/en/stable/lock_files -packages: [] +packages: +- completed: + hackage: ncurses-0.2.16@sha256:8ad9fe6562a80d28166d76adbac1eb4d40c6511fe4e9272ed6e1166dc2f1cdf1,3575 + pantry-tree: + size: 674 + sha256: 093bdc85ed518c81724f5b6b81c24ab4ebdd231551861f4feaa43361136f70b7 + original: + hackage: ncurses-0.2.16@sha256:8ad9fe6562a80d28166d76adbac1eb4d40c6511fe4e9272ed6e1166dc2f1cdf1,3575 snapshots: - completed: size: 523443 diff --git a/test/ActionsSpec.hs b/test/ActionsSpec.hs new file mode 100644 index 0000000..c046718 --- /dev/null +++ b/test/ActionsSpec.hs @@ -0,0 +1,139 @@ +{- + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +module ActionsSpec (spec) where + +import Control.Monad (replicateM) +import Lens.Micro ((&), (.~), (?~), (^.)) +import System.Random (randomRIO) +import Test.Hspec (Spec, context, describe, it, shouldBe, shouldNotBe) + +import Mtlstats.Actions +import Mtlstats.Types + +spec :: Spec +spec = describe "Mtlstats.Actions" $ do + startNewSeasonSpec + startNewGameSpec + resetYtdSpec + +startNewSeasonSpec :: Spec +startNewSeasonSpec = describe "startNewSeason" $ do + let + s = newProgState + & database . dbGames .~ 1 + & startNewSeason + + it "should set the progState to NewSeason" $ + s ^. progMode `shouldBe` NewSeason + + it "should set the number of games to 0" $ + s ^. database . dbGames `shouldBe` 0 + +startNewGameSpec :: Spec +startNewGameSpec = describe "startNewGame" $ do + let s = startNewGame newProgState + + it "should increment the number of games" $ + s ^. database . dbGames `shouldBe` 1 + + it "should set the mode to NewGame" $ + s ^. progMode `shouldBe` NewGame newGameState + +resetYtdSpec :: Spec +resetYtdSpec = describe "resetYtd" $ + it "should reset the year-to-date stats for all players" $ do + ps <- replicateM 2 makePlayer + gs <- replicateM 2 makeGoalie + let + s = newProgState + & database . dbPlayers .~ ps + & database . dbGoalies .~ gs + & resetYtd + mapM_ + (\p -> do + let + ytd = p ^. pYtd + lt = p ^. pLifetime + ytd ^. psGoals `shouldBe` 0 + ytd ^. psAssists `shouldBe` 0 + ytd ^. psPMin `shouldBe` 0 + lt ^. psGoals `shouldNotBe` 0 + lt ^. psAssists `shouldNotBe` 0 + lt ^. psPMin `shouldNotBe` 0) $ + s ^. database . dbPlayers + mapM_ + (\g -> do + let + ytd = g ^. gYtd + lt = g ^. gLifetime + ytd ^. gsGames `shouldBe` 0 + ytd ^. gsMinsPlayed `shouldBe` 0 + ytd ^. gsGoalsAllowed `shouldBe` 0 + ytd ^. gsGoalsAgainst `shouldBe` 0 + ytd ^. gsWins `shouldBe` 0 + ytd ^. gsLosses `shouldBe` 0 + ytd ^. gsTies `shouldBe` 0 + lt ^. gsGames `shouldNotBe` 0 + lt ^. gsMinsPlayed `shouldNotBe` 0 + lt ^. gsGoalsAllowed `shouldNotBe` 0 + lt ^. gsGoalsAgainst `shouldNotBe` 0 + lt ^. gsWins `shouldNotBe` 0 + lt ^. gsLosses `shouldNotBe` 0 + lt ^. gsTies `shouldNotBe` 0) $ + s ^. database . dbGoalies + +makePlayer :: IO Player +makePlayer = Player + <$> makeNum + <*> makeName + <*> makeName + <*> makePlayerStats + <*> makePlayerStats + +makeGoalie :: IO Goalie +makeGoalie = Goalie + <$> makeNum + <*> makeName + <*> makeGoalieStats + <*> makeGoalieStats + +makePlayerStats :: IO PlayerStats +makePlayerStats = PlayerStats + <$> makeNum + <*> makeNum + <*> makeNum + +makeGoalieStats :: IO GoalieStats +makeGoalieStats = GoalieStats + <$> makeNum + <*> makeNum + <*> makeNum + <*> makeNum + <*> makeNum + <*> makeNum + <*> makeNum + +makeNum :: IO Int +makeNum = randomRIO (1, 10) + +makeName :: IO String +makeName = replicateM 10 $ randomRIO ('A', 'Z') diff --git a/test/Spec.hs b/test/Spec.hs index e758ceb..aa86ce6 100644 --- a/test/Spec.hs +++ b/test/Spec.hs @@ -1,6 +1,30 @@ +{- + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + import Test.Hspec (hspec) +import qualified ActionsSpec as Actions import qualified TypesSpec as Types main :: IO () -main = hspec Types.spec +main = hspec $ do + Types.spec + Actions.spec diff --git a/test/Types/MenuSpec.hs b/test/Types/MenuSpec.hs new file mode 100644 index 0000000..5d9c826 --- /dev/null +++ b/test/Types/MenuSpec.hs @@ -0,0 +1,47 @@ +{- + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + +module Types.MenuSpec (spec) where + +import Test.Hspec (Spec, describe, it, shouldBe) + +import Mtlstats.Types.Menu + +spec :: Spec +spec = describe "Mtlstats.Types.Menu" + menuSpec + +menuSpec :: Spec +menuSpec = describe "Menu" + showSpec + +showSpec :: Spec +showSpec = describe "show" $ + it "should display correctly" $ let + menu = Menu "Foo" () + [ MenuItem '1' "Item 1" $ return () + , MenuItem '2' "Item 2" $ return () + ] + expected = + "Foo\n\ + \1) Item 1\n\ + \2) Item 2\n" + in show menu `shouldBe` expected diff --git a/test/TypesSpec.hs b/test/TypesSpec.hs index 34833a9..a97554a 100644 --- a/test/TypesSpec.hs +++ b/test/TypesSpec.hs @@ -1,19 +1,59 @@ +{- + +mtlstats +Copyright (C) 2019 Rhéal Lamothe + + +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 . + +-} + {-# LANGUAGE OverloadedStrings, QuasiQuotes #-} module TypesSpec (spec) where import Data.Aeson (decode, encode) import Data.ByteString.Lazy (ByteString) -import Lens.Micro ((&), (.~)) +import Lens.Micro ((&), (^.), (.~), (?~)) import Test.Hspec (Spec, context, describe, it, shouldBe) import Text.RawString.QQ (r) import Mtlstats.Types +import qualified Types.MenuSpec as Menu + spec :: Spec spec = describe "Mtlstats.Types" $ do - pPointsSpec playerSpec + pPointsSpec goalieSpec + databaseSpec + gameTypeLSpec + homeScoreLSpec + awayScoreLSpec + teamScoreSpec + Menu.spec + +playerSpec :: Spec +playerSpec = describe "Player" $ do + + describe "decode" $ + it "should decode" $ + decode playerJSON `shouldBe` Just player + + describe "encode" $ + it "should encode" $ + decode (encode player) `shouldBe` Just player pPointsSpec :: Spec pPointsSpec = describe "pPoints" $ mapM_ @@ -33,17 +73,6 @@ pPointsSpec = describe "pPoints" $ mapM_ , ( 2, 3, 5 ) ] -playerSpec :: Spec -playerSpec = describe "Player" $ do - - describe "decode" $ - it "should decode" $ - decode playerJSON `shouldBe` Just player - - describe "encode" $ - it "should encode" $ - decode (encode player) `shouldBe` Just player - goalieSpec :: Spec goalieSpec = describe "Goalie" $ do @@ -55,6 +84,127 @@ goalieSpec = describe "Goalie" $ do it "should encode" $ decode (encode goalie) `shouldBe` Just goalie +databaseSpec :: Spec +databaseSpec = describe "Database" $ do + + describe "decode" $ + it "should decode" $ + decode dbJSON `shouldBe` Just db + + describe "encode" $ + it "should encode" $ + decode (encode db) `shouldBe` Just db + +gameTypeLSpec :: Spec +gameTypeLSpec = describe "gameTypeL" $ do + + context "getter" $ do + + context "unexpected mode" $ + it "should return Nothing" $ + MainMenu ^. gameTypeL `shouldBe` Nothing + + mapM_ + (\t -> context (show t) $ + it ("should return " ++ show t) $ let + gs = newGameState & gameType ?~ t + m = NewGame gs + in m ^. gameTypeL `shouldBe` Just t) + [HomeGame, AwayGame] + + context "setter" $ do + + context "unexpected mode" $ + mapM_ + (\t -> context (show t) $ + it ("should set to " ++ show t) $ let + m = MainMenu & gameTypeL ?~ t + in m ^. gameTypeL `shouldBe` Just t) + [HomeGame, AwayGame] + + context "expected mode" $ + mapM_ + (\t -> context (show t) $ + it ("should set to " ++ show t) $ let + m = NewGame newGameState & gameTypeL ?~ t + in m ^. gameTypeL `shouldBe` Just t) + [HomeGame, AwayGame] + +homeScoreLSpec = describe "homeScoreL" $ do + + context "getter" $ do + + context "unexpected mode" $ + it "should return Nothing" $ + MainMenu ^. homeScoreL `shouldBe` Nothing + + context "expected mode" $ + it "should return 0" $ let + gs = newGameState & homeScore ?~ 0 + m = NewGame gs + in m ^. homeScoreL `shouldBe` Just 0 + + context "setter" $ do + + context "unexpected mode" $ + it "should set home score" $ let + m = MainMenu & homeScoreL ?~ 0 + in m ^. homeScoreL `shouldBe` Just 0 + + context "expected mode" $ + it "should set home score" $ let + m = NewGame newGameState & homeScoreL ?~ 0 + in m ^. homeScoreL `shouldBe` Just 0 + +awayScoreLSpec :: Spec +awayScoreLSpec = describe "awayScoreL" $ do + + context "getter" $ do + + context "unexpected mode" $ + it "should return Nothing" $ + MainMenu ^. awayScoreL `shouldBe` Nothing + + context "expected mode" $ + it "should return 0" $ let + gs = newGameState & awayScore ?~ 0 + m = NewGame gs + in m ^. awayScoreL `shouldBe` Just 0 + + context "setter" $ do + + context "unexpected mode" $ + it "should set the away score" $ let + m = MainMenu & awayScoreL ?~ 0 + in m ^. awayScoreL `shouldBe` Just 0 + + context "expected mode" $ + it "should set the away score" $ let + m = NewGame newGameState & awayScoreL ?~ 0 + in m ^. awayScoreL `shouldBe` Just 0 + +teamScoreSpec :: Spec +teamScoreSpec = describe "teamScore" $ do + let + m t = NewGame $ newGameState + & gameType ?~ t + & homeScore ?~ 1 + & awayScore ?~ 2 + s t = newProgState + & progMode .~ m t + + context "unexpected state" $ + it "should return Nothing" $ + teamScore newProgState `shouldBe` Nothing + + context "HomeGame" $ + it "should return 1" $ + teamScore (s HomeGame) `shouldBe` Just 1 + + context "AwayGame" $ + it "should return 2" $ + teamScore (s AwayGame) `shouldBe` Just 2 + player :: Player player = newPlayer 1 "Joe" "centre" & pYtd . psGoals .~ 2 @@ -81,6 +231,12 @@ goalie = newGoalie 1 "Joe" & gLifetime . gsLosses .~ 14 & gLifetime . gsTies .~ 15 +db :: Database +db = newDatabase + & dbPlayers .~ [player] + & dbGoalies .~ [goalie] + & dbGames .~ 1 + playerJSON :: ByteString playerJSON = [r| { "number": 1 @@ -121,3 +277,12 @@ goalieJSON = [r| , "ties": 15 } }|] + +dbJSON :: ByteString +dbJSON = [r| + { "players": + [ |] <> playerJSON <> [r| ] + , "goalies": + [ |] <> goalieJSON <> [r| ] + , "games": 1 + }|]