diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/configifier.cabal b/configifier.cabal new file mode 100644 --- /dev/null +++ b/configifier.cabal @@ -0,0 +1,104 @@ +name: configifier +version: 0.0.2 +synopsis: + parser for config files, shell variables, command line args. +description: + + WARNING NOT READY FOR USE YET. JUST PUTTING IT OUT THERE TO HAVE A DISCUSSION. + . + Read runtime configuration from files, command line, and shell + environment in a uniform, canonical, and flexible way. Inspired + by, among others, Configurator, cmdargs, optparse-applicative. + +license: AGPL-3 +license-file: LICENSE +author: Matthias Fischmann , Andres Löh +maintainer: Matthias Fischmann +copyright: zerobuzz.net +category: Configuration, Data +build-type: Simple +cabal-version: >=1.10 + +Source-Repository head + type: git + location: https://github.com/zerobuzz/configifier + +flag profiling + default: False + +library + hs-source-dirs: + src + default-language: + Haskell2010 + exposed-modules: + Data.Configifier + build-depends: + base >=4.7 && <4.8 + + , aeson >=0.8 && <0.9 + , case-insensitive >=1.2 && <1.3 + , containers >=0.5 && <0.6 + , mtl >=2.2.1 && <2.3 + , regex-easy >=0.1.0.0 && <0.2 + , safe >=0.3 && <0.4 + , string-conversions >=0.3 && <0.4 + , unordered-containers >=0.2 && <0.3 + , vector >=0.10 && <0.11 + , yaml >=0.8 && <0.9 + +executable configifier-example + default-language: + Haskell2010 + hs-source-dirs: + examples + main-is: + Main.hs + other-modules: + ghc-options: + -Wall -threaded -rtsopts + if flag(profiling) + ghc-options: + -auto-all -caf-all -fforce-recomp + build-depends: + base + , configifier + + , bytestring >=0.10 && <0.11 + , pretty-show >=1.6.8 && <1.7 + , string-conversions >=0.3.0.3 && <0.4 + , text >=1.2 && <1.3 + , yaml >=0.8 && <0.9 + +test-suite tests + default-language: + Haskell2010 + type: + exitcode-stdio-1.0 + hs-source-dirs: + tests + main-is: + Spec.hs + other-modules: + Data.ConfigifierSpec + , Spec + , Test.Arbitrary + ghc-options: + -Wall -threaded -rtsopts + cpp-options: + -DGHC_GENERICS + build-depends: + base + , configifier + + , aeson >= 0.8.0.2 && < 0.9 + , aeson-pretty >= 0.7.2 && < 0.8 + , case-insensitive >= 1.2.0.3 && < 1.3 + , hspec >= 2.1.3 && < 2.2 + , hspec-discover >= 2.1.3 && < 2.2 + , pretty-show >= 1.6.8 && < 1.7 + , QuickCheck >= 2.7.6 && < 2.8 + , scientific >= 0.3.3.5 && < 0.4 + , string-conversions >= 0.3.0.3 && < 0.4 + , unordered-containers >= 0.2.5.1 && < 0.3 + , vector >= 0.10.12.2 && < 0.11 diff --git a/examples/Main.hs b/examples/Main.hs new file mode 100644 --- /dev/null +++ b/examples/Main.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE GADTs #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverlappingInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE PolyKinds #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE StandaloneDeriving #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE UndecidableInstances #-} + +{-# OPTIONS #-} + +module Main +where + +import Control.Applicative +import Data.String.Conversions +import Data.Typeable +import Prelude +import Text.Show.Pretty (ppShow) +import System.Environment + +import qualified Data.ByteString as SBS +import qualified Data.Text.IO as ST +import qualified Data.Yaml as Yaml + +import Data.Configifier + + +-- * the config types + +type Cfg = + "bla" :> Int + :| "blu" :> SubCfg :>: "description of blu" + :| "uGH" :> [Cfg'] :>: "... and something about uGH" + +type Cfg' = + "go" :> ST + :| "blu" :> SubCfg + +type SubCfg = + "lii" :> Bool :>: "lii-desc" + + +-- | you can write sample configs in haskell syntax. (it's not very +-- convenient, so luckily it's not usually required either. see test +-- suite on how to access fields in cfg from here on.) +defaultCfg :: Cfg +defaultCfg = + entry 3 + :| entry False + :| entry [ entry "drei" :| entry True + , entry "vier" :| entry False + ] + + +main :: IO () +main = do + sources <- sequence + [ ConfigFileYaml <$> SBS.readFile "examples/config.yaml" + , ShellEnv <$> getEnvironment + , CommandLine <$> getArgs + ] + + -- putStrLn $ ppShow sources + + ST.putStrLn $ docs (Proxy :: Proxy Cfg) + + case configify sources of + Left e -> print e + Right (cfg :: Cfg) -> do + putStrLn $ ppShow cfg + putStrLn . cs . Yaml.encode $ cfg + + putStrLn "accessing config values:" + print $ (cfg >. (Proxy :: Proxy '["bla"])) + print $ (cfg >. (Proxy :: Proxy '["blu", "lii"])) + print $ (>. (Proxy :: Proxy '["go"])) <$> (cfg >. (Proxy :: Proxy '["uGH"])) diff --git a/src/Data/Configifier.hs b/src/Data/Configifier.hs new file mode 100644 --- /dev/null +++ b/src/Data/Configifier.hs @@ -0,0 +1,498 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE EmptyDataDecls #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE GADTs #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverlappingInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE PolyKinds #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE ViewPatterns #-} + +{-# LANGUAGE UndecidableInstances #-} -- should only be required to run 'HasParseCommandLine'; remove later! + +{-# OPTIONS #-} + +module Data.Configifier +where + +import Control.Applicative ((<$>), (<*>), (<|>)) +import Control.Exception (assert) +import Control.Monad.Error.Class (catchError) +import Data.Aeson (ToJSON, FromJSON, Value(Object, Null), object, toJSON) +import Data.CaseInsensitive (mk) +import Data.Char (toUpper) +import Data.Function (on) +import Data.List (nubBy, intercalate, sort) +import Data.Maybe (catMaybes) +import Data.String.Conversions (ST, SBS, cs, (<>)) +import Data.Typeable (Typeable, Proxy(Proxy)) +import GHC.TypeLits (Symbol, KnownSymbol, symbolVal) +import Safe (readMay) + +-- (FIXME: can i replace aeson entirely with yaml? right now, the mix +-- of use of both is rather chaotic.) + +import qualified Data.Aeson as Aeson +import qualified Data.Aeson.Types as Aeson +import qualified Data.HashMap.Strict as HashMap +import qualified Data.Set as Set +import qualified Data.Vector as Vector +import qualified Data.Yaml as Yaml +import qualified Text.Regex.Easy as Regex + + +-- * type combinators + +-- | the equivalent of record field selectors. +data (s :: Symbol) :> (t :: *) = L t + deriving (Eq, Ord, Show, Typeable) +infixr 9 :> + +-- | descriptive strings for documentation. (the way we use this is +-- still a little awkward. use tuple of name string and descr string? +-- or a type class "path" with a type family that translates both @"" +-- :>: ""@ and @""@ to @""@?) +data a :>: (s :: Symbol) = D a + deriving (Eq, Ord, Show, Typeable) +infixr 8 :>: + +-- | @cons@ for record fields. +data a :| b = a :| b + deriving (Eq, Ord, Show, Typeable) +infixr 6 :| + + +-- * constructing config values + +class Entry a b where + entry :: a -> b + +instance (a ~ b) => Entry a b where + entry = id + +instance Entry a b => Entry a (s :> b) where + entry = L . entry + +instance Entry a b => Entry a (b :>: s) where + entry = D . entry + + +-- * sources + +data Source = + ConfigFileYaml SBS + | ShellEnv [(String, String)] + | CommandLine [String] + deriving (Eq, Ord, Show, Typeable) + +data ConfigFile +data ShellEnv +data CommandLine + +data Error = + InvalidJSON String + | ShellEnvNoParse (String, String) + | ShellEnvSegmentNotFound String + | CommandLinePrimitiveParseError String + | CommandLinePrimitiveOther Error + deriving (Eq, Ord, Show, Typeable) + +configify :: forall cfg . + ( FromJSON cfg + , HasParseConfigFile cfg + , HasParseShellEnv cfg + , HasParseCommandLine cfg + ) => [Source] -> Either Error cfg +configify sources = sequence (_get <$> sources) >>= _parse . merge + where + proxy = Proxy :: Proxy cfg + + _get :: Source -> Either Error Aeson.Value + _get (ConfigFileYaml sbs) = parseConfigFile proxy sbs + _get (ShellEnv env) = parseShellEnv proxy env + _get (CommandLine args) = parseCommandLine proxy args + + _parse :: Aeson.Value -> Either Error cfg + _parse = either (Left . InvalidJSON) (Right) . Aeson.parseEither Aeson.parseJSON + + +-- * json / yaml + +class HasParseConfigFile cfg where + parseConfigFile :: Proxy cfg -> SBS -> Either Error Aeson.Value + +instance HasParseConfigFile cfg where + parseConfigFile Proxy sbs = either (Left . InvalidJSON) (Right) (Yaml.decodeEither sbs) + +instance (KnownSymbol path, FromJSON v) => FromJSON (path :> v) where + parseJSON = Aeson.withObject "config object" $ \ m -> + let proxy = Proxy :: Proxy path + key = cs $ symbolVal proxy + in L <$> m Aeson..: key + +instance (FromJSON o1, FromJSON o2) + => FromJSON (o1 :| o2) where + parseJSON value = (:|) <$> (Aeson.parseJSON value :: Aeson.Parser o1) + <*> (Aeson.parseJSON value :: Aeson.Parser o2) + +instance (KnownSymbol path, KnownSymbol descr, FromJSON v) => FromJSON (path :> v :>: descr) where + parseJSON = Aeson.withObject "config object" $ \ m -> + let key = cs $ symbolVal (Proxy :: Proxy path) + in D . L <$> m Aeson..: key + +instance (KnownSymbol path, ToJSON v) => ToJSON (path :> v) where + toJSON (L v) = object [cs (symbolVal (Proxy :: Proxy path)) Aeson..= toJSON v] + +instance (ToJSON o1, ToJSON o2) => ToJSON (o1 :| o2) where + toJSON (o1 :| o2) = toJSON o1 <<>> toJSON o2 + +instance (KnownSymbol path, KnownSymbol descr, ToJSON v) => ToJSON (path :> v :>: descr) where + toJSON (D l) = toJSON l + + +-- * shell env. + +type Env = [(String, String)] + +class HasParseShellEnv a where + parseShellEnv :: Proxy a -> Env -> Either Error Aeson.Value + +class HasParseShellEnv' a where + parseShellEnv' :: Proxy a -> Env -> Either Error Aeson.Pair + +instance HasParseShellEnv Int where + parseShellEnv Proxy [("", s)] = Aeson.Number <$> _catch (readMay s) + where + _catch = maybe (Left $ ShellEnvNoParse ("Int", s)) Right + +instance HasParseShellEnv Bool where + parseShellEnv Proxy [("", s)] = Aeson.Bool <$> _catch (readMay s) + where + _catch = maybe (Left $ ShellEnvNoParse ("Bool", s)) Right + +instance HasParseShellEnv ST where + parseShellEnv Proxy [("", s)] = Right . Aeson.String $ cs s + +-- | since shell env is not ideally suitable for providing +-- arbitrary-length lists of sub-configs, we cheat: if a value is fed +-- into a place where a list of values is expected, a singleton list +-- is constructed implicitly. +instance HasParseShellEnv a => HasParseShellEnv [a] where + parseShellEnv Proxy = fmap (Aeson.Array . Vector.fromList . (:[])) . parseShellEnv (Proxy :: Proxy a) + +-- | the sub-object structure of the config file is represented by '_' +-- in the shell variable names. (i think it's still ok to have '_' in +-- your config variable names instead of caml case; this parser first +-- chops off matching names, then worries about trailing '_'.) +instance (KnownSymbol path, HasParseShellEnv v) => HasParseShellEnv (path :> v) where + parseShellEnv Proxy env = do + let key = symbolVal (Proxy :: Proxy path) + env' = catMaybes $ _crop <$> env + + _crop :: (String, String) -> Maybe (String, String) + _crop (k, v) = case splitAt (length key) k of + (key', s@"") | mk key == mk key' -> Just (s, v) + (key', '_':s@(_:_)) | mk key == mk key' -> Just (s, v) + _ -> Nothing + + if null env' + then Left $ ShellEnvSegmentNotFound key + else do + val :: Aeson.Value <- parseShellEnv (Proxy :: Proxy v) env' + return $ object [cs key Aeson..= val] + +instance (KnownSymbol path, HasParseShellEnv v, HasParseShellEnv o) => HasParseShellEnv (path :> v :| o) where + parseShellEnv Proxy env = mergeAndCatch + [ parseShellEnv (Proxy :: Proxy o) env + , parseShellEnv (Proxy :: Proxy (path :> v)) env + ] + +instance (KnownSymbol path, KnownSymbol descr, HasParseShellEnv v) => HasParseShellEnv (path :> v :>: descr) where + parseShellEnv Proxy = parseShellEnv (Proxy :: Proxy (path :> v)) + +instance (KnownSymbol path, KnownSymbol descr, HasParseShellEnv v, HasParseShellEnv o) => HasParseShellEnv (path :> v :>: descr :| o) where + parseShellEnv Proxy = parseShellEnv (Proxy :: Proxy (path :> v :| o)) + + +-- * cli + +type Args = [String] + +class HasParseCommandLine cfg where + parseCommandLine :: Proxy cfg -> [String] -> Either Error Aeson.Value + +instance (HasParseShellEnv cfg) => HasParseCommandLine cfg where + parseCommandLine = primitiveParseCommandLine + + +-- | Very basic fist approach: read @/--(key)(=|\s+)(value)/@; +-- construct shell env from keys and names, and use 'parseShellEnv' on +-- the command line. If it doesn't like the syntax used in the +-- command line, it will crash. I hope for this to get much fancier +-- in the future. +primitiveParseCommandLine :: (HasParseShellEnv cfg) => Proxy cfg -> [String] -> Either Error Aeson.Value +primitiveParseCommandLine proxy args = + convertParseError (lastWins <$> parseArgs args) + >>= convertShellEnvError . parseShellEnv proxy + where + convertParseError = either (Left . CommandLinePrimitiveParseError) Right + convertShellEnvError = either (Left . CommandLinePrimitiveOther) Right + lastWins = reverse . nubBy ((==) `on` fst) . reverse + +parseArgs :: Args -> Either String Env +parseArgs [] = Right [] +parseArgs (h:[]) = parseArgsWithEqSign h +parseArgs (h:h':t) = ((++) <$> parseArgsWithEqSign h <*> parseArgs (h':t)) + <|> ((++) <$> parseArgsWithSpace h h' <*> parseArgs t) + +parseArgsWithEqSign :: String -> Either String Env +parseArgsWithEqSign s = case cs s Regex.=~- "^--([^=]+)=(.*)$" of + [_, k, v] -> Right [(cs k, cs v)] + bad -> Left $ "could not parse last arg: " ++ show (s, bad) + +parseArgsWithSpace :: String -> String -> Either String Env +parseArgsWithSpace s v = case cs s Regex.=~- "^--([^=]+)$" of + [_, k] -> Right [(cs k, cs v)] + bad -> Left $ "could not parse long-arg with value: " ++ show (s, v, bad) + + +-- * accessing config values + +-- ** data types + +-- | Type-level lookup of a path in a configuration type. +-- A path is represented as a list of symbols. +type family Val (a :: *) (p :: [Symbol]) :: Maybe * where + Val a '[] = Just a + Val (a :| b) (p ': ps) = OrElse (Val a (p ': ps)) (Val b (p ': ps)) + Val (a :>: s) (p ': ps) = Val a (p ': ps) + Val (p :> t) (p ': ps) = Val t ps + Val a p = Nothing + +-- | This is '<|>' on 'Maybe' lifted to the type level. +type family OrElse (x :: Maybe k) (y :: Maybe k) :: Maybe k where + OrElse (Just x) y = Just x + OrElse Nothing y = y + +-- | A 'CMaybe' is a static version of 'Maybe', i.e., we know at +-- compile time whether we have 'Just' or 'Nothing'. +data CMaybe (a :: Maybe *) where + CNothing :: CMaybe Nothing + CJust :: a -> CMaybe (Just a) + +-- | This is a version of '<|>' on 'Maybe' for 'CMaybe'. +combine :: CMaybe a -> CMaybe b -> CMaybe (OrElse a b) +combine (CJust x) _ = CJust x +combine CNothing y = y + + +-- ** exposed interface + +-- | This is a wrapper around 'sel' that hides the interal use of +-- 'CMaybe'. As we expect, this version will just cause a type error +-- if it is applied to an illegal path. +(>.) :: forall a p r . (Sel a p, ValE a p ~ Done r) => a -> Proxy p -> r +(>.) cfg p = case sel cfg p of + CJust x -> x + _ -> error "inaccessible" + +-- | FIXME: is it possible to remove 'CMaybe' from the signature and +-- return @Val a p@ instead? +class Sel a p where + sel :: a -> Proxy p -> CMaybe (Val a p) + + +-- ** implementation of 'Sel' + +instance Sel a '[] where + sel x _ = CJust x + +instance Sel a (p ': ps) => Sel (a :>: s) (p ': ps) where + sel (D x) _ = sel x (Proxy :: Proxy (p ': ps)) + +instance Sel t ps => Sel (p :> t) (p ': ps) where + sel (L x) _ = sel x (Proxy :: Proxy ps) + +instance (Sel a (p ': ps), Sel b (p ': ps)) => Sel (a :| b) (p ': ps) where + sel (x :| y) _ = combine (sel x (Proxy :: Proxy (p ': ps))) (sel y (Proxy :: Proxy (p ': ps))) + +-- | We need the 'Val' constraint here because overlapping instances +-- and closed type families aren't fully compatible. GHC won't be +-- able to recognize that we've already excluded the other cases and +-- not reduce 'Val' automatically. But the constraint should always +-- resolve, unless we've made a mistake, and the worst outcome if we +-- did are extra type errors, not run-time errors. +instance (Val a ps ~ Nothing) => Sel a ps where + sel _ _ = CNothing + + +-- ** better errors + +data Exc a b = Fail a | Done b + +data LookupFailed a p + +type ValE (a :: *) (p :: [Symbol]) = ToExc (LookupFailed a p) (Val a p) + +type family ToExc (a :: k) (x :: Maybe l) :: Exc k l where + ToExc a Nothing = Fail a + ToExc a (Just x) = Done x + + +-- * merge configs + +-- | Merge two json trees such that the latter overwrites nodes in the +-- former. 'Null' is considered as non-existing. Otherwise, right +-- values overwrite left values. +(<<>>) :: Aeson.Value -> Aeson.Value -> Aeson.Value +(<<>>) (Object m) (Object m') = object $ f <$> ks + where + ks :: [ST] + ks = Set.toList . Set.fromList $ HashMap.keys m ++ HashMap.keys m' + + f :: ST -> Aeson.Pair + f k = k Aeson..= + case (k `HashMap.lookup` m, k `HashMap.lookup` m') of + (Just v, Just v') -> v <<>> v' + (Nothing, Just v') -> v' + (Just v, Nothing) -> v + (Nothing, Nothing) -> assert False $ error "internal error in (<<>>)" + +(<<>>) v Null = v +(<<>>) _ v' = v' + +merge :: [Aeson.Value] -> Aeson.Value +merge = foldl (<<>>) Aeson.Null + +mergeAndCatch :: [Either Error Aeson.Value] -> Either Error Aeson.Value +mergeAndCatch = foldl (\ ev ev' -> (<<>>) <$> c'tcha ev <*> c'tcha ev') (Right Null) + where + -- (this name is a sound from the samurai jack title tune. it + -- has nothing to do with this, but it sounds nice. go watch + -- samurai jack!) + c'tcha = (`catchError` \ _ -> return Null) + + +-- * docs. + +docs :: ( HasToDoc a + , HasRenderDoc ConfigFile + , HasRenderDoc ShellEnv + , HasRenderDoc CommandLine + ) => Proxy a -> ST +docs proxy = renderDoc (Proxy :: Proxy ConfigFile) (toDoc proxy) + <> renderDoc (Proxy :: Proxy ShellEnv) (toDoc proxy) + <> renderDoc (Proxy :: Proxy CommandLine) (toDoc proxy) + +data Doc = + DocDict [(String, Maybe String, Doc)] + | DocList Doc + | DocBase String + deriving (Eq, Ord, Show, Read, Typeable) + +concatDoc :: Doc -> Doc -> Doc +concatDoc (DocDict xs) (DocDict ys) = DocDict . sort $ xs ++ ys +concatDoc bad bad' = error $ "concatDoc: " ++ show (bad, bad') + + +class HasToDoc a where + toDoc :: Proxy a -> Doc + +_makeDocPair :: (KnownSymbol path, KnownSymbol descr, HasToDoc v) + => Proxy path -> Maybe (Proxy descr) -> Proxy v -> Doc +_makeDocPair pathProxy descrProxy vProxy = DocDict [(symbolVal pathProxy, symbolVal <$> descrProxy, toDoc vProxy)] + +instance (KnownSymbol path, HasToDoc v) => HasToDoc (path :> v) where + toDoc Proxy = _makeDocPair (Proxy :: Proxy path) (Nothing :: Maybe (Proxy path)) (Proxy :: Proxy v) + +instance (KnownSymbol path, KnownSymbol descr, HasToDoc v) => HasToDoc (path :> v :>: descr) where + toDoc Proxy = _makeDocPair (Proxy :: Proxy path) (Just (Proxy :: Proxy descr)) (Proxy :: Proxy v) + +instance (HasToDoc o1, HasToDoc o2) => HasToDoc (o1 :| o2) where + toDoc Proxy = toDoc (Proxy :: Proxy o1) `concatDoc` toDoc (Proxy :: Proxy o2) + +instance HasToDoc a => HasToDoc [a] where + toDoc Proxy = DocList . toDoc $ (Proxy :: Proxy a) + +instance HasToDoc ST where + toDoc Proxy = DocBase "string" + +instance HasToDoc Int where + toDoc Proxy = DocBase "number" + +instance HasToDoc Bool where + toDoc Proxy = DocBase "boolean" + + +class HasRenderDoc t where + renderDoc :: Proxy t -> Doc -> ST + +instance HasRenderDoc ConfigFile where + renderDoc Proxy doc = cs . unlines $ + "" : + "Config File" : + "-----------" : + "" : + f doc ++ + "" : + [] + where + f :: Doc -> [String] + f (DocDict xs) = concat $ map g xs + f (DocList x) = indent "- " $ f x + f (DocBase base) = [base] + + g :: (String, Maybe String, Doc) -> [String] + g (key, Just mDescr, subdoc) = ("# " <> mDescr) : (key <> ":") : indent " " (f subdoc) + g (key, Nothing, subdoc) = (key <> ":") : indent " " (f subdoc) + + indent :: String -> [String] -> [String] + indent start = lines . (start <>) . intercalate "\n " + +instance HasRenderDoc ShellEnv where + renderDoc Proxy doc = cs . unlines $ + "" : + "Shell Environment Variables" : + "---------------------------" : + "" : + (f [] doc) ++ + "" : + [] + where + f :: [(String, Maybe String)] -> Doc -> [String] + f acc (DocDict xs) = concat $ map (g acc) xs + f acc (DocList x) = f acc x + f (reverse -> acc) (DocBase base) = + shellvar : + (" type: " ++ base) : + (let xs = catMaybes (mkd <$> acc) in + if null xs then [] else " documented components:" : xs) ++ + "" : + [] + where + shellvar :: String + shellvar = map toUpper . intercalate "_" . map fst $ acc + + mkd :: (String, Maybe String) -> Maybe String + mkd (_, Nothing) = Nothing + mkd (key, Just descr) = Just $ " " ++ (toUpper <$> key) ++ ": " ++ descr + + g :: [(String, Maybe String )] -> (String, Maybe String, Doc) -> [String] + g acc (key, descr, subdoc) = f ((key, descr) : acc) subdoc + +instance HasRenderDoc CommandLine where + renderDoc Proxy _ = cs . unlines $ + "" : + "Command Line Arguments" : + "----------------------" : + "" : + "See `shell environment`. (Anything you can set with a shell" : + "variable, you can also set with a long arg.)" : + "" : + [] diff --git a/tests/Data/ConfigifierSpec.hs b/tests/Data/ConfigifierSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Data/ConfigifierSpec.hs @@ -0,0 +1,91 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE IncoherentInstances #-} +{-# LANGUAGE OverlappingInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS #-} + +module Data.ConfigifierSpec +where + +import Control.Applicative +import Data.Proxy +import Data.String.Conversions +import Debug.Trace +import Prelude +import Test.Hspec +import Test.QuickCheck +import Text.Show.Pretty + +import qualified Data.Aeson as Aeson +import qualified Data.Aeson.Encode.Pretty as Aeson + +import Data.Configifier + +import Test.Arbitrary () + + +tests :: IO () +tests = hspec spec + +spec :: Spec +spec = describe "Configifier" $ do + misc + +misc :: Spec +misc = describe "misc" $ do + describe "<<>>" $ do + it "does not crash" . property $ \ a b -> (length . show $ a <<>> b) > 0 + + describe "(>.)" $ do + it "works (unit)" $ do + (cfg >. (Proxy :: Proxy '["bla"])) `shouldBe` 3 + (cfg >. (Proxy :: Proxy '["blu", "lii"])) `shouldBe` False + (>. (Proxy :: Proxy '["go"])) <$> (cfg >. (Proxy :: Proxy '["uGH"])) `shouldBe` ["drei","vier"] + + describe "FromJSON, ToJSON" $ do + it "is mutually inverse" $ do + simpleJSONTest False cfg + simpleJSONTest False subCfg + sequence_ (simpleJSONTest False <$> cfg's) + + describe "parseShellEnv" $ do + it "works" $ do + parseShellEnv (Proxy :: Proxy ("bla" :> Int)) [("BLA", "3")] `shouldBe` + (Right $ Aeson.object ["bla" Aeson..= Aeson.Number 3.0]) + +simpleJSONTest :: (Eq a, Aeson.FromJSON a, Aeson.ToJSON a, Show a) => Bool -> a -> IO () +simpleJSONTest noisy x = _trace $ x' `shouldBe` Aeson.Success x + where + x' = Aeson.fromJSON $ Aeson.toJSON x + _trace = if noisy + then trace $ cs (Aeson.encodePretty x) ++ "\n" ++ ppShow (x, x') + else id + +type Cfg = + "bla" :> Int :>: "description of bla" + :| "blu" :> SubCfg + :| "uGH" :> [Cfg'] :>: "... and something about uGH" + +type Cfg' = + "go" :> ST + :| "blu" :> SubCfg + +type SubCfg = + "lii" :> Bool + +cfg :: Cfg +cfg = + entry 3 + :| entry False -- Curiously, it's not ok to put 'subCfg' here. + :| entry cfg's + +cfg's :: [Cfg'] +cfg's = + [ entry "drei" :| entry True + , entry "vier" :| entry False + ] + +subCfg :: SubCfg +subCfg = entry False diff --git a/tests/Spec.hs b/tests/Spec.hs new file mode 100644 --- /dev/null +++ b/tests/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/tests/Test/Arbitrary.hs b/tests/Test/Arbitrary.hs new file mode 100644 --- /dev/null +++ b/tests/Test/Arbitrary.hs @@ -0,0 +1,49 @@ +{-# LANGUAGE BangPatterns #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeSynonymInstances #-} + +{-# OPTIONS_GHC -fno-warn-orphans #-} + +module Test.Arbitrary () where + +import Control.Applicative ((<$>), (<*>)) +import Data.Aeson +import Data.CaseInsensitive +import Data.Scientific +import Data.String.Conversions +import Test.QuickCheck + +import qualified Data.HashMap.Strict as HashMap +import qualified Data.Vector as Vector + + +-- | 25 most common adjectives according to the Oxford English +-- Dictionary. +readableStrings :: [String] +readableStrings = + "good" : "new" : "first" : "last" : "long" : "great" : "little" : + "own" : "other" : "old" : "right" : "big" : "high" : "different" : + "small" : "large" : "next" : "early" : "young" : "important" : + "few" : "public" : "bad" : "same" : "able" : + [] + +instance Arbitrary ST where + arbitrary = cs <$> elements readableStrings + +instance Arbitrary (CI ST) where + arbitrary = mk <$> arbitrary + +instance Arbitrary Value where + arbitrary = sized $ \ size -> let size' = size `div` 2 in oneof + [ return Null + , String . cs <$> elements readableStrings + , Number <$> (scientific <$> arbitrary <*> oneof [return 0, (`mod` 12) <$> arbitrary]) + , Bool <$> arbitrary + , Array . Vector.fromList <$> resize size' arbitrary + , object <$> resize size' arbitrary + ] + + shrink (Array v) = Array . Vector.fromList <$> shrink (Vector.toList v) + shrink (Object m) = Object . HashMap.fromList <$> shrink (HashMap.toList m) + shrink _ = []