diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,20 @@ +Next version + +* [BREAKING CHANGE: Enable `--pretty` by default for `dhall-to-json`](https://github.com/dhall-lang/dhall-haskell/issues/716) +* [BREAKING CHANGE: Enable `--omitNull` by default for `dhall-to-{json,yaml}`](https://github.com/dhall-lang/dhall-haskell/pull/1365) + * To recover the old behavior use the `--preserveNull` flag +* Add support for building against the `HsYAML` package [#1248](https://github.com/dhall-lang/dhall-haskell/pull/1248) / [#1417](https://github.com/dhall-lang/dhall-haskell/pull/1417) / [#1420](https://github.com/dhall-lang/dhall-haskell/pull/1420) + * To enable the use of `HsYAML`, enable the `-fgpl` `cabal configure` flag, + which means that anything built using that flag is GPLv3 licensed + * By default `dhall-json` builds against `aeson-yaml` which is BSD-3 + licensed + * The `yaml-to-dhall` executable is only available with the `-fgpl` flag, + meaning that it is necessarily GPLv3 licensed +* [New `--omissible-lists` flag for `{json,yaml}-to-dhall`](https://github.com/dhall-lang/dhall-haskell/pull/1414) + * This flag is sort of the inverse of the `--omitEmpty` flag, meaning that + missing YAML/JSON lists can be translated to present (but empty) Dhall + lists + 1.4.1 * [Enable `--records-strict` by default for `{json-yaml}-to-dhall`](https://github.com/dhall-lang/dhall-haskell/pull/1181) diff --git a/LICENSE b/LICENSE deleted file mode 100644 --- a/LICENSE +++ /dev/null @@ -1,27 +0,0 @@ -Copyright (c) 2018 Gabriel Gonzalez -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this -list of conditions and the following disclaimer. - -2. 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. - -3. Neither the name of the author nor the names of its contributors may be -used to endorse or promote products derived from this software without -specific prior written permission. - -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 HOLDER 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. diff --git a/LICENSE.BSD3 b/LICENSE.BSD3 new file mode 100644 --- /dev/null +++ b/LICENSE.BSD3 @@ -0,0 +1,30 @@ +The following license applies to this package when built without the +`-fgpl` Cabal configure flag + +Copyright (c) 2018 Gabriel Gonzalez +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the author nor the names of its contributors may be +used to endorse or promote products derived from this software without +specific prior written permission. + +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 HOLDER 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. diff --git a/LICENSE.GPLv3 b/LICENSE.GPLv3 new file mode 100644 --- /dev/null +++ b/LICENSE.GPLv3 @@ -0,0 +1,678 @@ +The following license applies to this package when built with the +`-fgpl` Cabal configure flag, including the `yaml-to-dhall` executable, +which cannot be built without that flag. + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/dhall-json.cabal b/dhall-json.cabal --- a/dhall-json.cabal +++ b/dhall-json.cabal @@ -1,10 +1,10 @@ Name: dhall-json -Version: 1.4.1 +Version: 1.5.0 Cabal-Version: >=1.8.0.2 Build-Type: Simple Tested-With: GHC == 7.10.3, GHC == 8.4.3, GHC == 8.6.1 License: BSD3 -License-File: LICENSE +License-Files: LICENSE.BSD3, LICENSE.GPLv3 Copyright: 2017 Gabriel Gonzalez Author: Gabriel Gonzalez Maintainer: Gabriel439@gmail.com @@ -24,20 +24,19 @@ Category: Compiler Extra-Source-Files: CHANGELOG.md - java/*.java tasty/data/*.dhall tasty/data/*.json tasty/data/*.txt tasty/data/*.yaml - Source-Repository head Type: git Location: https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-json -Flag yaml-pre-0_11 +Flag gpl + Description: Use GPL-licensed components like HsYAML, and enable yaml-to-dhall binary Default: False - Manual: False + Manual: True Library Hs-Source-Dirs: src @@ -47,11 +46,11 @@ aeson-pretty < 0.9 , bytestring < 0.11, containers , - dhall >= 1.26.0 && < 1.27, + dhall >= 1.27.0 && < 1.28, exceptions >= 0.8.3 && < 0.11, filepath < 1.5 , optparse-applicative >= 0.14.0.0 && < 0.16, - prettyprinter >= 1.2.0.1 && < 1.3 , + prettyprinter >= 1.2.0.1 && < 1.4 , scientific >= 0.3.0.0 && < 0.4 , text >= 0.11.1.0 && < 1.3 , unordered-containers < 0.3 , @@ -60,31 +59,32 @@ Dhall.JSON Dhall.JSONToDhall Dhall.Yaml - Dhall.YamlToDhall + if flag(gpl) + Exposed-Modules: + Dhall.YamlToDhall Other-Modules: Dhall.JSON.Util - - GHC-Options: -Wall - if flag(yaml-pre-0_11) + if flag(gpl) + CPP-Options: -DGPL Build-Depends: - yaml >= 0.5.0 && < 0.11 + HsYAML >= 0.2 && < 0.3, + HsYAML-aeson >= 0.2 && < 0.3 else Build-Depends: - libyaml >= 0.1.1.0 && < 0.2 , - yaml >= 0.11.0 && < 0.12 + aeson-yaml >= 1.0.2 && < 1.1 Executable dhall-to-json Hs-Source-Dirs: dhall-to-json Main-Is: Main.hs Build-Depends: - base , - aeson , + base , + aeson , aeson-pretty >= 0.8.5 && < 0.9 , - bytestring < 0.11, - dhall , - dhall-json , - optparse-applicative , + bytestring < 0.11, + dhall , + dhall-json , + optparse-applicative , text Other-Modules: Paths_dhall_json @@ -111,13 +111,13 @@ Build-Depends: base , aeson , - ansi-terminal >= 0.6.3.1 && < 0.10, + ansi-terminal >= 0.6.3.1 && < 0.11, bytestring < 0.11, dhall , dhall-json , exceptions >= 0.8.3 && < 0.11, optparse-applicative , - prettyprinter >= 1.2.0.1 && < 1.3 , + prettyprinter , prettyprinter-ansi-terminal >= 1.1.1 && < 1.2 , text < 1.3 if !impl(ghc >= 8.0) && !impl(eta >= 0.8.4) @@ -127,18 +127,20 @@ GHC-Options: -Wall Executable yaml-to-dhall + if !flag(gpl) + Buildable: False Hs-Source-Dirs: yaml-to-dhall Main-Is: Main.hs Build-Depends: base , aeson , - ansi-terminal >= 0.6.3.1 && < 0.10, - bytestring < 0.11 , + ansi-terminal >= 0.6.3.1 && < 0.11, + bytestring < 0.11, dhall , dhall-json , - exceptions >= 0.8.3 && < 0.11 , + exceptions >= 0.8.3 && < 0.11, optparse-applicative , - prettyprinter >= 1.2.0.1 && < 1.3 , + prettyprinter , prettyprinter-ansi-terminal >= 1.1.1 && < 1.2 , text < 1.3 if !impl(ghc >= 8.0) && !impl(eta >= 0.8.4) diff --git a/dhall-to-json/Main.hs b/dhall-to-json/Main.hs --- a/dhall-to-json/Main.hs +++ b/dhall-to-json/Main.hs @@ -41,7 +41,7 @@ ( Options <$> parseExplain <*> parsePretty - <*> Dhall.JSON.parseOmission + <*> Dhall.JSON.parsePreservationAndOmission <*> Dhall.JSON.parseConversion <*> parseApproximateSpecialDoubles <*> optional parseFile @@ -62,7 +62,7 @@ Options.flag' True ( Options.long "pretty" - <> Options.help "Pretty print generated JSON" + <> Options.help "Deprecated, will be removed soon. Pretty print generated JSON" ) compactFlag = @@ -73,7 +73,7 @@ ) defaultBehavior = - pure False + pure True parseVersion = Options.flag' diff --git a/dhall-to-yaml/Main.hs b/dhall-to-yaml/Main.hs --- a/dhall-to-yaml/Main.hs +++ b/dhall-to-yaml/Main.hs @@ -5,7 +5,7 @@ import Control.Applicative (optional, (<|>)) import Control.Exception (SomeException) import Data.Monoid ((<>)) -import Dhall.JSON (parseOmission, parseConversion) +import Dhall.JSON (parsePreservationAndOmission, parseConversion) import Dhall.Yaml (Options(..), dhallToYaml, parseDocuments, parseQuoted) import Options.Applicative (Parser, ParserInfo) @@ -24,7 +24,7 @@ Just <$> ( Options <$> parseExplain - <*> Dhall.JSON.parseOmission + <*> Dhall.JSON.parsePreservationAndOmission <*> parseDocuments <*> parseQuoted <*> Dhall.JSON.parseConversion diff --git a/java/Utils.java b/java/Utils.java deleted file mode 100644 --- a/java/Utils.java +++ /dev/null @@ -1,23 +0,0 @@ -import java.io.IOException; - -import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.dataformat.yaml.YAMLMapper; - -public class Utils { - - public static String jsonToYaml (String jsonString) throws - JsonProcessingException, IOException { - JsonNode jsonNodeTree = new ObjectMapper().readTree(jsonString); - String jsonAsYaml = new YAMLMapper().writeValueAsString(jsonNodeTree); - return jsonAsYaml; - } - - public static String yamlToJson (String yamlString) throws - JsonProcessingException, IOException { - JsonNode jsonNodeTree = new YAMLMapper().readTree(yamlString); - String yamlAsJson = new ObjectMapper().writeValueAsString(jsonNodeTree); - return yamlAsJson; - } -} diff --git a/src/Dhall/JSON.hs b/src/Dhall/JSON.hs --- a/src/Dhall/JSON.hs +++ b/src/Dhall/JSON.hs @@ -56,7 +56,11 @@ Dhall @List@s translate to JSON lists: > $ dhall-to-json <<< '[1, 2, 3] : List Natural' -> [1,2,3] +> [ +> 1, +> 2, +> 3 +> ] Dhall @Optional@ values translate to @null@ if absent and the unwrapped value otherwise: @@ -69,7 +73,10 @@ Dhall records translate to JSON records: > $ dhall-to-json <<< '{ foo = 1, bar = True }' -> {"foo":1,"bar":true} +> { +> "bar": true, +> "foo": 1 +> } Dhall unions translate to the wrapped value: @@ -85,7 +92,22 @@ > , MyType.Person { age = 35, name = "Alice" } > ] > $ dhall-to-json <<< "./config" -> [{"age":47,"name":"John"},{"location":"North Pole"},{"location":"Sahara Desert"},{"age":35,"name":"Alice"}] +> [ +> { +> "age": 47, +> "name": "John" +> }, +> { +> "location": "North Pole" +> }, +> { +> "location": "Sahara Desert" +> }, +> { +> "age": 35, +> "name": "Alice" +> } +> ] You can preserve the name of the alternative if you wrap the value in a record with three fields: @@ -95,7 +117,7 @@ * @field@: the name of the field that will store the name of the alternative - * @nesting@: A value of type @\< Inline : {} | Nested : Text \>@. + * @nesting@: A value of type @\< Inline | Nested : Text \>@. If @nesting@ is set to @Inline@ and the union literal stored in @contents@ contains a record then the name of the alternative is stored inline within @@ -122,7 +144,7 @@ > let Example = < Left : { foo : Natural } | Right : { bar : Bool } > > -> let Nesting = < Inline : {} | Nested : Text > +> let Nesting = < Inline | Nested : Text > > > in { field = "name" > , nesting = Nesting.Nested "value" @@ -153,9 +175,18 @@ > } > ] -> $ dhall-to-json <<< './example.dhall' -> {"foo":null,"bar":[1,true]} + By default, the fields that are evaluated to @null@ will be removed, + but here we're preserving them with the @--preserveNull@ flag. +> $ dhall-to-json --preserveNull <<< './example.dhall' +> { +> "bar": [ +> 1, +> true +> ], +> "foo": null +> } + Also, all Dhall expressions are normalized before translation to JSON: > $ dhall-to-json <<< "True == False" @@ -169,6 +200,7 @@ , omitNull , omitEmpty , parseOmission + , parsePreservationAndOmission , Conversion(..) , convertToHomogeneousMaps , parseConversion @@ -188,9 +220,9 @@ import Data.Monoid ((<>), mempty) import Data.Text (Text) import Data.Text.Prettyprint.Doc (Pretty) -import Dhall.Core (Binding(..), Expr) +import Data.Void (Void) +import Dhall.Core (Binding(..), DhallDouble(..), Expr) import Dhall.Import (SemanticCacheMode(..)) -import Dhall.TypeCheck (X) import Dhall.Map (Map) import Dhall.JSON.Util (pattern V) import Options.Applicative (Parser) @@ -224,10 +256,10 @@ this just returns the expression that failed -} data CompileError - = Unsupported (Expr X X) + = Unsupported (Expr Void Void) | SpecialDouble Double | BareNone - | InvalidInlineContents (Expr X X) (Expr X X) + | InvalidInlineContents (Expr Void Void) (Expr Void Void) instance Show CompileError where show BareNone = @@ -378,7 +410,7 @@ Right "{\"foo\":1,\"bar\":\"ABC\"}" -} dhallToJSON - :: Expr s X + :: Expr s Void -> Either CompileError Value dhallToJSON e0 = loop (Core.alphaNormalize (Core.normalize e0)) where @@ -386,7 +418,7 @@ Core.BoolLit a -> return (toJSON a) Core.NaturalLit a -> return (toJSON a) Core.IntegerLit a -> return (toJSON a) - Core.DoubleLit a -> return (toJSON a) + Core.DoubleLit (DhallDouble a) -> return (toJSON a) Core.TextLit (Core.Chunks [] a) -> do return (toJSON a) Core.ListLit _ a -> do @@ -503,7 +535,7 @@ ys <- traverse inner (Foldable.toList xs) return (Aeson.Object (HashMap.fromList ys)) - outer (Core.App (Core.Field (V 0) "number") (Core.DoubleLit n)) = do + outer (Core.App (Core.Field (V 0) "number") (Core.DoubleLit (DhallDouble n))) = do return (Aeson.toJSON n) outer (Core.App (Core.Field (V 0) "string") (Core.TextLit (Core.Chunks [] text))) = do return (toJSON text) @@ -512,7 +544,7 @@ outer value _ -> Left (Unsupported e) -getContents :: Expr s X -> Maybe (Text, Maybe (Expr s X)) +getContents :: Expr s Void -> Maybe (Text, Maybe (Expr s Void)) getContents (Core.App (Core.Field _ @@ -523,7 +555,7 @@ getContents (Core.Field _ alternativeName) = Just (alternativeName, Nothing) getContents _ = Nothing -isInlineNesting :: Expr s X -> Bool +isInlineNesting :: Expr s Void -> Bool isInlineNesting (Core.App (Core.Field (Core.Union @@ -602,6 +634,20 @@ ) <|> pure id +-- | Parser for command-line options related to preserving null fields. +parseNullPreservation :: Parser (Value -> Value) +parseNullPreservation = + Options.Applicative.flag + omitNull + id + ( Options.Applicative.long "preserveNull" + <> Options.Applicative.help "Preserve record fields that are null" + ) + +-- | Combines parsers for command-line options related to preserving & omitting null fields. +parsePreservationAndOmission :: Parser (Value -> Value) +parsePreservationAndOmission = parseNullPreservation <|> parseOmission <|> pure id + {-| Specify whether or not to convert association lists of type @List { mapKey: Text, mapValue : v }@ to records -} @@ -619,7 +665,7 @@ > { k0 = v0, k1 = v1 } -} -convertToHomogeneousMaps :: Conversion -> Expr s X -> Expr s X +convertToHomogeneousMaps :: Conversion -> Expr s Void -> Expr s Void convertToHomogeneousMaps NoConversion e0 = e0 convertToHomogeneousMaps (Conversion {..}) e0 = loop (Core.normalize e0) where @@ -790,7 +836,7 @@ where elements = Foldable.toList b - toKeyValue :: Expr s X -> Maybe (Text, Expr s X) + toKeyValue :: Expr s Void -> Maybe (Text, Expr s Void) toKeyValue (Core.RecordLit m) = do guard (Foldable.length m == 2) @@ -911,6 +957,12 @@ a' = loop a b' = loop b + Core.RecordCompletion a b -> + Core.RecordCompletion a' b' + where + a' = loop a + b' = loop b + Core.Merge a b c -> Core.Merge a' b' c' where @@ -1005,7 +1057,7 @@ handling them as specified according to the `SpecialDoubleMode` -} handleSpecialDoubles - :: SpecialDoubleMode -> Expr s X -> Either CompileError (Expr s X) + :: SpecialDoubleMode -> Expr s Void -> Either CompileError (Expr s Void) handleSpecialDoubles specialDoubleMode = Dhall.Optics.rewriteMOf Core.subExpressions rewrite where @@ -1015,7 +1067,7 @@ ForbidWithinJSON -> forbidWithinJSON ApproximateWithinJSON -> approximateWithinJSON - useYAMLEncoding (Core.DoubleLit n) + useYAMLEncoding (Core.DoubleLit (DhallDouble n)) | isInfinite n && 0 < n = return (Just (Core.TextLit (Core.Chunks [] "inf"))) | isInfinite n && n < 0 = @@ -1025,17 +1077,17 @@ useYAMLEncoding _ = return Nothing - forbidWithinJSON (Core.DoubleLit n) + forbidWithinJSON (Core.DoubleLit (DhallDouble n)) | isInfinite n || isNaN n = Left (SpecialDouble n) forbidWithinJSON _ = return Nothing - approximateWithinJSON (Core.DoubleLit n) + approximateWithinJSON (Core.DoubleLit (DhallDouble n)) | isInfinite n && n > 0 = - return (Just (Core.DoubleLit ( 1.7976931348623157e308 :: Double))) + return (Just (Core.DoubleLit (DhallDouble 1.7976931348623157e308))) | isInfinite n && n < 0 = - return (Just (Core.DoubleLit (-1.7976931348623157e308 :: Double))) + return (Just (Core.DoubleLit (DhallDouble (-1.7976931348623157e308)))) -- Do nothing for @NaN@, which already encodes to @null@ approximateWithinJSON _ = return Nothing diff --git a/src/Dhall/JSONToDhall.hs b/src/Dhall/JSONToDhall.hs --- a/src/Dhall/JSONToDhall.hs +++ b/src/Dhall/JSONToDhall.hs @@ -232,18 +232,18 @@ import qualified Data.Text as Text import Data.Text (Text) import qualified Data.Vector as Vector +import Data.Void (Void) import qualified Options.Applicative as O import Options.Applicative (Parser) import Dhall.JSON.Util (pattern V) import qualified Dhall.Core as D -import Dhall.Core (Expr(App), Chunks(..)) +import Dhall.Core (Expr(App), Chunks(..), DhallDouble(..)) import qualified Dhall.Import import qualified Dhall.Map as Map import qualified Dhall.Parser import Dhall.Parser (Src) import qualified Dhall.TypeCheck as D -import Dhall.TypeCheck (X) -- --------------- -- Command options @@ -255,6 +255,7 @@ <*> parseKVArr <*> parseKVMap <*> parseUnion + <*> parseOmissibleLists where parseStrict = O.flag' True @@ -275,6 +276,10 @@ ( O.long "no-keyval-maps" <> O.help "Disable conversion of homogeneous map objects to association lists" ) + parseOmissibleLists = O.switch + ( O.long "omissible-lists" + <> O.help "Tolerate missing list values, they are assumed empty" + ) -- | Parser for command options related to treating union types parseUnion :: Parser UnionConv @@ -303,25 +308,27 @@ -- | JSON-to-dhall translation options data Conversion = Conversion - { strictRecs :: Bool - , noKeyValArr :: Bool - , noKeyValMap :: Bool - , unions :: UnionConv + { strictRecs :: Bool + , noKeyValArr :: Bool + , noKeyValMap :: Bool + , unions :: UnionConv + , omissibleLists :: Bool } deriving Show data UnionConv = UFirst | UNone | UStrict deriving (Show, Read, Eq) -- | Default conversion options defaultConversion :: Conversion -defaultConversion = Conversion - { strictRecs = False - , noKeyValArr = False - , noKeyValMap = False - , unions = UFirst +defaultConversion = Conversion + { strictRecs = False + , noKeyValArr = False + , noKeyValMap = False + , unions = UFirst + , omissibleLists = False } -- | The 'Expr' type concretization used throughout this module -type ExprX = Expr Src X +type ExprX = Expr Src Void -- | Parse schema code to a valid Dhall expression and check that its type is actually Type resolveSchemaExpr :: Text -- ^ type code (schema) @@ -363,7 +370,7 @@ return (k, v) keyValMay _ = Nothing -{-| The main conversion function. Traversing/zipping Dhall /type/ and Aeson value trees together to produce a Dhall /term/ tree, given 'Conversion' options: +{-| The main conversion function. Traversing\/zipping Dhall /type/ and Aeson value trees together to produce a Dhall /term/ tree, given 'Conversion' options: >>> :set -XOverloadedStrings >>> import qualified Dhall.Core as D @@ -416,6 +423,9 @@ = loop t value | App D.Optional t' <- t = Right (App D.None t') + | App D.List _ <- t + , omissibleLists + = Right (D.ListLit (Just t) []) | otherwise = Left (MissingKey k t v) in D.RecordLit <$> Map.traverseWithKey f r @@ -470,6 +480,12 @@ (Seq.fromList es) in f <$> traverse (loop t) (toList a) + -- null ~> List + loop t@(App D.List _) (A.Null) + = if omissibleLists + then Right (D.ListLit (Just t) []) + else Left (Mismatch t A.Null) + -- number ~> Integer loop D.Integer (A.Number x) | Right n <- floatingOrInteger x :: Either Double Integer @@ -487,7 +503,7 @@ -- number ~> Double loop D.Double (A.Number x) - = Right (D.DoubleLit $ toRealFloat x) + = Right (D.DoubleLit $ DhallDouble $ toRealFloat x) -- string ~> Text loop D.Text (A.String t) @@ -551,7 +567,7 @@ outer (A.String s) = D.App (D.Field "json" "string") (D.TextLit (D.Chunks [] s)) outer (A.Number n) = - D.App (D.Field "json" "number") (D.DoubleLit (toRealFloat n)) + D.App (D.Field "json" "number") (D.DoubleLit (DhallDouble (toRealFloat n))) outer (A.Bool b) = D.App (D.Field "json" "bool") (D.BoolLit b) outer A.Null = @@ -597,7 +613,7 @@ data CompileError -- Dhall shema - = TypeError (D.TypeError Src X) + = TypeError (D.TypeError Src Void) | BadDhallType ExprX -- Expression type ExprX -- Whole expression diff --git a/src/Dhall/Yaml.hs b/src/Dhall/Yaml.hs --- a/src/Dhall/Yaml.hs +++ b/src/Dhall/Yaml.hs @@ -14,23 +14,25 @@ import Data.Text (Text) import Dhall.JSON (Conversion(..), SpecialDoubleMode(..), codeToValue) import Options.Applicative (Parser) +import Data.ByteString.Lazy (toStrict) import qualified Data.Aeson import qualified Data.ByteString import qualified Data.Vector import qualified Dhall import qualified Options.Applicative -#if defined(ETA_VERSION) -import Dhall.Yaml.Eta ( jsonToYaml ) +#if defined(GPL) +import qualified Data.YAML.Aeson +import qualified Data.YAML as Y +import qualified Data.YAML.Event as YE +import qualified Data.YAML.Token as YT +import qualified Data.YAML.Schema as YS +import qualified Data.Text as Text #else -import qualified Data.Yaml -# if MIN_VERSION_yaml(0,10,2) -import qualified Data.Text -import qualified Text.Libyaml -# endif +import qualified Data.Aeson.Yaml +import qualified Data.ByteString.Lazy #endif - data Options = Options { explain :: Bool , omission :: Data.Aeson.Value -> Data.Aeson.Value @@ -82,7 +84,6 @@ return $ jsonToYaml json documents quoted -#if !defined(ETA_VERSION) -- | Transform json representation into yaml jsonToYaml :: Data.Aeson.Value @@ -90,34 +91,51 @@ -> Bool -> ByteString jsonToYaml json documents quoted = - +#if defined(GPL) case (documents, json) of - (True, Data.Yaml.Array elems) + (True, Data.Aeson.Array elems) -> Data.ByteString.intercalate "\n---\n" - $ fmap (encodeYaml encodeOptions) + $ fmap (Data.ByteString.Lazy.toStrict. (Data.YAML.Aeson.encodeValue' schemaEncoder YT.UTF8). (:[])) $ Data.Vector.toList elems - _ -> encodeYaml encodeOptions json + _ -> Data.ByteString.Lazy.toStrict (Data.YAML.Aeson.encodeValue' schemaEncoder YT.UTF8 [json]) where -# if !MIN_VERSION_yaml(0,10,2) - encodeYaml = Data.Yaml.encode -# else - encodeYaml = Data.Yaml.encodeWith + defaultSchemaEncoder = YS.setScalarStyle style Y.coreSchemaEncoder - customStyle = \s -> case () of - () - | "\n" `Data.Text.isInfixOf` s -> ( noTag, literal ) - | otherwise -> ( noTag, Text.Libyaml.SingleQuoted ) - where - noTag = Text.Libyaml.NoTag - literal = Text.Libyaml.Literal + defaultEncodeStr s = case () of + () + | "\n" `Text.isInfixOf` s -> Right (YE.untagged, YE.Literal YE.Clip YE.IndentAuto, s) + | YS.isAmbiguous Y.coreSchemaResolver s -> Right (YE.untagged, YE.SingleQuoted, s) + | otherwise -> Right (YE.untagged, YE.Plain, s) - quotedOptions = Data.Yaml.setStringStyle - customStyle - Data.Yaml.defaultEncodeOptions + style s = case s of + Y.SNull -> Right (YE.untagged, YE.Plain, "null") + Y.SBool bool -> Right (YE.untagged, YE.Plain, YS.encodeBool bool) + Y.SFloat double -> Right (YE.untagged, YE.Plain, YS.encodeDouble double) + Y.SInt int -> Right (YE.untagged, YE.Plain, YS.encodeInt int) + Y.SStr text -> defaultEncodeStr text + Y.SUnknown t v -> Right (t, YE.SingleQuoted, v) - encodeOptions = if quoted - then quotedOptions - else Data.Yaml.defaultEncodeOptions -# endif + customStyle (Y.SStr s) = case () of + () + | "\n" `Text.isInfixOf` s -> Right (YE.untagged, YE.Literal YE.Clip YE.IndentAuto, s) + | otherwise -> Right (YE.untagged, YE.SingleQuoted, s) + customStyle scalar = (YS.schemaEncoderScalar defaultSchemaEncoder) scalar + + customSchemaEncoder = YS.setScalarStyle customStyle defaultSchemaEncoder + + schemaEncoder = if quoted + then customSchemaEncoder + else defaultSchemaEncoder +#else + Data.ByteString.Lazy.toStrict $ case (documents, json) of + (True, Data.Aeson.Array elems) + -> (if quoted + then Data.Aeson.Yaml.encodeQuotedDocuments + else Data.Aeson.Yaml.encodeDocuments + ) (Data.Vector.toList elems) + _ -> (if quoted + then Data.Aeson.Yaml.encodeQuoted + else Data.Aeson.Yaml.encode + ) json #endif diff --git a/src/Dhall/YamlToDhall.hs b/src/Dhall/YamlToDhall.hs --- a/src/Dhall/YamlToDhall.hs +++ b/src/Dhall/YamlToDhall.hs @@ -8,8 +8,14 @@ , dhallFromYaml ) where +import Control.Exception (Exception, throwIO) +import Data.Aeson (Value) import Data.ByteString (ByteString) - +import qualified Data.ByteString.Char8 as BS8 +import Data.Text (Text) +import Data.Void (Void) +import qualified Data.YAML.Aeson +import Dhall.Core (Expr) import Dhall.JSONToDhall ( CompileError(..) , Conversion(..) @@ -19,22 +25,8 @@ , showCompileError , typeCheckSchemaExpr ) - -import Control.Exception (Exception, throwIO) -import Data.Text (Text) -import Dhall.Core (Expr) import Dhall.Src (Src) -import Dhall.TypeCheck(X) -#if defined(ETA_VERSION) -import Dhall.Yaml.Eta ( yamlToJson, showYaml ) -#else -import Data.Aeson (Value) -import Data.Bifunctor (bimap) -import qualified Data.ByteString.Char8 as BS8 -import qualified Data.Yaml -#endif - -- | Options to parametrize conversion data Options = Options { schema :: Text @@ -55,7 +47,7 @@ -- | Transform yaml representation into dhall -dhallFromYaml :: Options -> ByteString -> IO (Expr Src X) +dhallFromYaml :: Options -> ByteString -> IO (Expr Src Void) dhallFromYaml Options{..} yaml = do value <- either (throwIO . userError) pure (yamlToJson yaml) @@ -67,12 +59,10 @@ either (throwIO . YAMLCompileError) pure dhall -#if !defined(ETA_VERSION) yamlToJson :: ByteString -> Either String Data.Aeson.Value -yamlToJson = - bimap Data.Yaml.prettyPrintParseException id . Data.Yaml.decodeEither' +yamlToJson s = case Data.YAML.Aeson.decode1Strict s of + Right v -> Right v + Left (pos, err) -> Left (show pos ++ err) showYaml :: Value -> String -showYaml value = BS8.unpack (Data.Yaml.encode value) -#endif - +showYaml value = BS8.unpack (Data.YAML.Aeson.encode1Strict value) diff --git a/tasty/Main.hs b/tasty/Main.hs --- a/tasty/Main.hs +++ b/tasty/Main.hs @@ -44,6 +44,7 @@ , testJSONToDhall "./tasty/data/emptyList" , testJSONToDhall "./tasty/data/emptyObjectStrongType" , testJSONToDhall "./tasty/data/emptyListStrongType" + , testCustomConversionJSONToDhall omissibleLists "./tasty/data/missingList" , Test.Tasty.testGroup "Nesting" [ testDhallToJSON "./tasty/data/nesting0" , testDhallToJSON "./tasty/data/nesting1" @@ -57,6 +58,7 @@ , testDhallToJSON "./tasty/data/unionKeys" ] ] + where omissibleLists = JSONToDhall.defaultConversion{JSONToDhall.omissibleLists = True} testDhallToJSON :: String -> TestTree testDhallToJSON prefix = Test.Tasty.HUnit.testCase prefix $ do @@ -92,8 +94,9 @@ Test.Tasty.HUnit.assertEqual message expectedValue actualValue -testJSONToDhall :: String -> TestTree -testJSONToDhall prefix = Test.Tasty.HUnit.testCase prefix $ do +testCustomConversionJSONToDhall :: JSONToDhall.Conversion -> String -> TestTree +testCustomConversionJSONToDhall conv prefix = + Test.Tasty.HUnit.testCase prefix $ do let inputFile = prefix <> ".json" let schemaFile = prefix <> "Schema.dhall" let outputFile = prefix <> ".dhall" @@ -114,7 +117,7 @@ _ <- Core.throws (Dhall.TypeCheck.typeOf schema) actualExpression <- do - Core.throws (JSONToDhall.dhallFromJSON JSONToDhall.defaultConversion schema value) + Core.throws (JSONToDhall.dhallFromJSON conv schema value) outputText <- Data.Text.IO.readFile outputFile @@ -131,6 +134,9 @@ "Conversion to Dhall did not generate the expected output" Test.Tasty.HUnit.assertEqual message expectedExpression actualExpression + +testJSONToDhall :: String -> TestTree +testJSONToDhall = testCustomConversionJSONToDhall JSONToDhall.defaultConversion testDhallToYaml :: Dhall.Yaml.Options -> String -> TestTree testDhallToYaml options prefix = Test.Tasty.HUnit.testCase prefix $ do diff --git a/tasty/data/missingList.dhall b/tasty/data/missingList.dhall new file mode 100644 --- /dev/null +++ b/tasty/data/missingList.dhall @@ -0,0 +1,1 @@ +{present = ["some-stuff"], null = [] : List Text, missing = [] : List Text} diff --git a/tasty/data/missingList.json b/tasty/data/missingList.json new file mode 100644 --- /dev/null +++ b/tasty/data/missingList.json @@ -0,0 +1,1 @@ +{"present": ["some-stuff"], "null": null} diff --git a/tasty/data/missingListSchema.dhall b/tasty/data/missingListSchema.dhall new file mode 100644 --- /dev/null +++ b/tasty/data/missingListSchema.dhall @@ -0,0 +1,1 @@ +{present : List Text, null : List Text, missing : List Text} diff --git a/tasty/data/normal.dhall b/tasty/data/normal.dhall --- a/tasty/data/normal.dhall +++ b/tasty/data/normal.dhall @@ -2,4 +2,5 @@ , text = ./yaml.txt as Text , int_value = 1 , bool_value = True +, yes = "y" } diff --git a/tasty/data/normal.yaml b/tasty/data/normal.yaml --- a/tasty/data/normal.yaml +++ b/tasty/data/normal.yaml @@ -1,5 +1,6 @@ bool_value: true +int_value: 1 +string_value: 2000-01-01 text: | Plain text -string_value: 2000-01-01 -int_value: 1 +yes: y diff --git a/tasty/data/quoted.dhall b/tasty/data/quoted.dhall --- a/tasty/data/quoted.dhall +++ b/tasty/data/quoted.dhall @@ -2,4 +2,5 @@ , text = ./yaml.txt as Text , int_value = 1 , bool_value = True +, yes = "y" } diff --git a/tasty/data/quoted.yaml b/tasty/data/quoted.yaml --- a/tasty/data/quoted.yaml +++ b/tasty/data/quoted.yaml @@ -1,5 +1,6 @@ 'bool_value': true +'int_value': 1 +'string_value': '2000-01-01' 'text': | Plain text -'string_value': '2000-01-01' -'int_value': 1 +'yes': 'y'