gemmula 1.1.1 → 1.2.0
raw patch · 8 files changed
+432/−903 lines, 8 filesdep −raw-strings-qqsetup-changedPVP ok
version bump matches the API change (PVP)
Dependencies removed: raw-strings-qq
API changes (from Hackage documentation)
+ Text.Gemini: documentTitle :: GemDocument -> Maybe Text
Files
- ChangeLog.md +25/−10
- LICENSE +125/−621
- README.md +30/−8
- Setup.lhs +0/−4
- gemmula.cabal +20/−19
- src/Text/Gemini.hs +93/−106
- test/Main.hs +0/−135
- test/Test.hs +139/−0
ChangeLog.md view
@@ -1,20 +1,35 @@-# `gemmula` Change Log+# Change Log for gemmula +## 1.2.0 (August 05, 2024)++- Use `CRLF` line breaks instead of `LF`.+- Add `documentTitle` function.+- Escape line breaks while decoding and encoding.+- Relicense under LGPL v3.+- Rewrite tests.+- Rewrite decoding and encoding functions partially.+- Clean up documentations once more.+ ## 1.1.1 (July 23, 2024)-* Clean up documentations. +- Clean up documentations.+ ## 1.1.0 (January 13, 2024)-* Normalize the links with spaces while encoding.-* Ignore the empty lists while encoding.-* Clean up more documentations. +- Normalize the links with spaces while encoding.+- Ignore the empty lists while encoding.+- Clean up more documentations.+ ## 1.0.1 (January 08, 2024)-* Improve code readability and quality.-* Clean up some documentations. +- Improve code readability and quality.+- Clean up some documentations.+ ## 1.0.0 (December 19, 2023)-* Change the stability to `stable`.-* Use strict data types and functions instead of lazy ones. +- Change the stability to `stable`.+- Use strict data types and functions instead of lazy ones.+ ## 0.1.0.0 (November 29, 2023)-* Initial release!++- Initial release!
LICENSE view
@@ -1,661 +1,165 @@- GNU AFFERO GENERAL PUBLIC LICENSE- Version 3, 19 November 2007+ GNU LESSER GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - Preamble - The GNU 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".+ This version of the GNU Lesser General Public License incorporates+the terms and conditions of version 3 of the GNU General Public+License, supplemented by the additional permissions listed below. - 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.+ 0. Additional Definitions. - 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.+ As used herein, "this License" refers to version 3 of the GNU Lesser+General Public License, and the "GNU GPL" refers to version 3 of the GNU+General Public License. - 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.+ "The Library" refers to a covered work governed by this License,+other than an Application or a Combined Work as defined below. - 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.+ An "Application" is any work that makes use of an interface provided+by the Library, but which is not otherwise based on the Library.+Defining a subclass of a class defined by the Library is deemed a mode+of using an interface provided by the Library. - 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 "Combined Work" is a work produced by combining or linking an+Application with the Library. The particular version of the Library+with which the Combined Work was made is also called the "Linked+Version". - 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.+ The "Minimal Corresponding Source" for a Combined Work means the+Corresponding Source for the Combined Work, excluding any source code+for portions of the Combined Work that, considered in isolation, are+based on the Application, and not on the Linked Version. - 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.+ The "Corresponding Application Code" for a Combined Work means the+object code and/or source code for the Application, including any data+and utility programs needed for reproducing the Combined Work from the+Application, but excluding the System Libraries of the Combined Work. - 12. No Surrender of Others' Freedom.+ 1. Exception to Section 3 of the GNU GPL. - 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.+ You may convey a covered work under sections 3 and 4 of this License+without being bound by section 3 of the GNU GPL. - 13. Remote Network Interaction; Use with the GNU General Public License.+ 2. Conveying Modified Versions. - 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.+ If you modify a copy of the Library, and, in your modifications, a+facility refers to a function or data to be supplied by an Application+that uses the facility (other than as an argument passed when the+facility is invoked), then you may convey a copy of the modified+version: - 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.+ a) under this License, provided that you make a good faith effort to+ ensure that, in the event an Application does not supply the+ function or data, the facility still operates, and performs+ whatever part of its purpose remains meaningful, or - 14. Revised Versions of this License.+ b) under the GNU GPL, with none of the additional permissions of+ this License applicable to that copy. - 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.+ 3. Object Code Incorporating Material from Library Header Files. - 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.+ The object code form of an Application may incorporate material from+a header file that is part of the Library. You may convey such object+code under terms of your choice, provided that, if the incorporated+material is not limited to numerical parameters, data structure+layouts and accessors, or small macros, inline functions and templates+(ten or fewer lines in length), you do both of the following: - 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.+ a) Give prominent notice with each copy of the object code that the+ Library is used in it and that the Library and its use are+ covered by this License. - 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.+ b) Accompany the object code with a copy of the GNU GPL and this license+ document. - 15. Disclaimer of Warranty.+ 4. Combined Works. - 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.+ You may convey a Combined Work under terms of your choice that,+taken together, effectively do not restrict modification of the+portions of the Library contained in the Combined Work and reverse+engineering for debugging such modifications, if you also do each of+the following: - 16. Limitation of Liability.+ a) Give prominent notice with each copy of the Combined Work that+ the Library is used in it and that the Library and its use are+ covered by this License. - 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.+ b) Accompany the Combined Work with a copy of the GNU GPL and this license+ document. - 17. Interpretation of Sections 15 and 16.+ c) For a Combined Work that displays copyright notices during+ execution, include the copyright notice for the Library among+ these notices, as well as a reference directing the user to the+ copies of the GNU GPL and this license document. - 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.+ d) Do one of the following: - END OF TERMS AND CONDITIONS+ 0) Convey the Minimal Corresponding Source under the terms of this+ License, and the Corresponding Application Code in a form+ suitable for, and under terms that permit, the user to+ recombine or relink the Application with a modified version of+ the Linked Version to produce a modified Combined Work, in the+ manner specified by section 6 of the GNU GPL for conveying+ Corresponding Source. - How to Apply These Terms to Your New Programs+ 1) Use a suitable shared library mechanism for linking with the+ Library. A suitable mechanism is one that (a) uses at run time+ a copy of the Library already present on the user's computer+ system, and (b) will operate properly with a modified version+ of the Library that is interface-compatible with the Linked+ Version. - 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.+ e) Provide Installation Information, but only if you would otherwise+ be required to provide such information under section 6 of the+ GNU GPL, and only to the extent that such information is+ necessary to install and execute a modified version of the+ Combined Work produced by recombining or relinking the+ Application with a modified version of the Linked Version. (If+ you use option 4d0, the Installation Information must accompany+ the Minimal Corresponding Source and Corresponding Application+ Code. If you use option 4d1, you must provide the Installation+ Information in the manner specified by section 6 of the GNU GPL+ for conveying Corresponding Source.) - 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.+ 5. Combined Libraries. - <one line to give the program's name and a brief idea of what it does.>- Copyright (C) <year> <name of author>+ You may place library facilities that are a work based on the+Library side by side in a single library together with other library+facilities that are not Applications and are not covered by this+License, and convey such a combined library under terms of your+choice, if you do both of the following: - 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.+ a) Accompany the combined library with a copy of the same work based+ on the Library, uncombined with any other library facilities,+ conveyed under the terms of this License. - 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.+ b) Give prominent notice with the combined library that part of it+ is a work based on the Library, and explaining where to find the+ accompanying uncombined form of the same work. - You should have received a copy of the GNU Affero General Public License- along with this program. If not, see <https://www.gnu.org/licenses/>.+ 6. Revised Versions of the GNU Lesser General Public License. -Also add information on how to contact you by electronic and paper mail.+ The Free Software Foundation may publish revised and/or new versions+of the GNU Lesser 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. - 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.+ Each version is given a distinguishing version number. If the+Library as you received it specifies that a certain numbered version+of the GNU Lesser General Public License "or any later version"+applies to it, you have the option of following the terms and+conditions either of that published version or of any later version+published by the Free Software Foundation. If the Library as you+received it does not specify a version number of the GNU Lesser+General Public License, you may choose any version of the GNU Lesser+General Public License ever published by the Free Software Foundation. - 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-<https://www.gnu.org/licenses/>.+ If the Library as you received it specifies that a proxy can decide+whether future versions of the GNU Lesser General Public License shall+apply, that proxy's public statement of acceptance of any version is+permanent authorization for you to choose that version for the+Library.
README.md view
@@ -1,12 +1,34 @@-# gemmula [(Hackage)](https://hackage.haskell.org/package/gemmula)+# gemmula - a tiny gemtext parser for Haskell -gemmula (Latin for `little gem`) is a tiny and functional gemtext-(unofficially `text/gemini`) parser from and back into `Text`.+The documentation is available at+[Hackage](https://hackage.haskell.org/package/gemmula/docs/Text-Gemini.html). -Check the ["gemtext" specification](https://geminiprotocol.net/docs/gemtext-specification.gmi)-for more about the `text/gemini` filetype.+## Example -Also check the [Gemini Protocol](https://geminiprotocol.net) capsule for more about Gemini itself.+```hs+>>> let document = Text.Gemini.decode <$> Data.Text.IO.readFile "examples/paradox.gmi"+>>> document -The documentation is available at-[Hackage](https://hackage.haskell.org/package/gemmula/docs/Text-Gemini.html).+[ GemHeading 1 "gemmula"+, GemList [ "hello,"+ , "world!"+ ]+, GemText ""+, GemQuote "made with"+, GemPre [ "<3"+ ]+ (Just "ascii art of a heart")+, GemLink "https://www.haskell.org" (Just "and Haskell!")+]++>>> Text.Gemini.encode <$> document >>= Data.Text.IO.writeFile "examples/paradox.gmi"+```++## See also++- [Project Gemini](https://geminiprotocol.net)+ for more about the Gemini protocol itself.+- [Gemini hypertext format specification](https://geminiprotocol.net/docs/gemtext-specification.gmi)+ for the specification this package is trying to comply with.+- [Awesome Gemini](https://github.com/kr1sp1n/awesome-gemini)+ to discover more projects about Gemini.
Setup.lhs view
@@ -1,7 +1,3 @@ #!/usr/bin/env runhaskell--> module Main where > import Distribution.Simple--> main :: IO () > main = defaultMain
gemmula.cabal view
@@ -1,22 +1,28 @@+cabal-version: 2.2 name: gemmula-version: 1.1.1-synopsis: A tiny gemtext parser-description: gemmula is a tiny and functional gemtext (unofficially @text/gemini@)- parser that aims to parse a gemtext document from and back into Text,- according to the Gemini hypertext format specification at- <https://geminiprotocol.net/docs/gemtext-specification.gmi>.-license: AGPL-3-license-file: LICENSE-author: Sena <jn-sena@proton.me>-maintainer: Sena <jn-sena@proton.me>-tested-with: GHC == 9.6.5 || == 9.8.2+version: 1.2.0 category: Text, Gemini homepage: https://codeberg.org/sena/gemmula bug-reports: https://codeberg.org/sena/gemmula/issues+synopsis: a tiny gemtext parser+description:+ gemmula is a tiny gemtext (unofficially @text/gemini@) parser from and back into+ `Text', attempting to be /mostly/ compliant with the+ [Gemini hypertext format specification](https://geminiprotocol.net/docs/gemtext-specification.gmi)+ while being somewhat practical.+license: LGPL-3.0-or-later+license-file: LICENSE+copyright: (c) Sena 2024+author: Sena <contact@sena.pink>+maintainer: contact@sena.pink build-type: Simple+tested-with: GHC == 9.6.5, GHC == 9.8.2 extra-source-files: README.md, ChangeLog.md-cabal-version: 1.18 +source-repository head+ location: https://codeberg.org/sena/gemmula+ type: git+ library default-language: Haskell2010 hs-source-dirs: src@@ -25,18 +31,13 @@ , text >= 2.0 && < 2.2 ghc-options: -Wall -test-suite gemmulae-probatio+test-suite unit default-language: Haskell2010 type: exitcode-stdio-1.0 hs-source-dirs: test- main-is: Main.hs+ main-is: Test.hs build-depends: base , text , HUnit >= 1.6 && < 2- , raw-strings-qq >= 1.1 && < 2 , gemmula ghc-options: -Wall--source-repository head- location: https://codeberg.org/sena/gemmula- type: git
src/Text/Gemini.hs view
@@ -2,20 +2,17 @@ -- | -- Module : Text.Gemini--- Copyright : (c) Sena, 2024--- License : AGPL-3.0-or-later+-- Copyright : (c) 2024 Sena+-- License : LGPL-3.0-or-later ----- Maintainer : Sena <jn-sena@proton.me>+-- Maintainer : contact@sena.pink -- Stability : stable -- Portability : portable ----- A tiny gemtext (unofficially @text/gemini@) parser------ Parses gemtext documents from and back to 'Text'.+-- Parse gemtext (@text/gemini@) documents from and back into `Text'. -- -- See the Gemini hypertext format specification at -- <https://geminiprotocol.net/docs/gemtext-specification.gmi>.- module Text.Gemini ( -- * Gemtext types GemDocument@@ -28,146 +25,136 @@ -- * Encoding into text , encode , encodeItem++ -- * Utility functions+ , documentTitle ) where import Data.Bool (bool) import Data.Char (isSpace)-import Data.Maybe (fromMaybe)+import Data.Maybe (listToMaybe) import Data.Text (Text) import qualified Data.Text as T ---- | A gemtext document, in the form of an ordered list of 'GemItem's+-- | A gemtext document, in the form of a list of `GemItem's type GemDocument = [GemItem] -- | A gemtext item data GemItem- = -- | A regular gemtext line -- @'GemText' \<Text>@+ = -- | A regular gemtext line -- @`GemText' \<Text>@ GemText !Text- | -- | A gemtext link -- @'GemLink' \<Link> \[Optional Description]@+ | -- | A gemtext link -- @`GemLink' \<Link> \[Optional Description]@ GemLink !Text !(Maybe Text)- | -- | A gemtext heading of 3 levels max -- @'GemHeading' \<Level> \<Text>@+ | -- | A gemtext heading of 3 levels max -- @`GemHeading' \<Level> \<Text>@ GemHeading !Int !Text- | -- | An unordered gemtext list -- @'GemList' \<Lines>@+ | -- | An unordered gemtext list -- @`GemList' \<Lines>@+ --+ -- Gemtext specification does /not/ endorse grouping list items this way.+ -- This approach is purely for practical reasons, such as ease of conversion+ -- to unordered HTML lists. GemList ![Text]- | -- | A gemtext quote -- @'GemQuote' \<Text>@+ | -- | A gemtext quote -- @`GemQuote' \<Text>@ GemQuote !Text- | -- | A preformatted gemtext block -- @'GemPre' \<Lines> [Optional Alt Text]@+ | -- | A preformatted gemtext block -- @`GemPre' \<Lines> [Optional Alt Text]@ GemPre ![Text] !(Maybe Text) deriving (Show, Eq) ---- | Parse a gemtext block as 'GemDocument'.+-- | Parse a gemtext block as a `GemDocument'. ----- The text should be supplied as a 'Text' which uses LF line breaks.+-- The input `Text' must use either CRLF or LF. decode :: Text -> GemDocument-decode = parse [] . T.lines+decode = parse . T.lines . T.replace "\CR" "" where- -- Default line-by-line recursive parser with 'GemDocument' carried.- -- If a list or preformatting is detected, will continue with- -- @parseList@ and @parsePre@ respectively. Otherwise, will use- -- 'decodeLine' on the current line only.- parse :: GemDocument -> [Text] -> GemDocument- parse doc (l : ls)- | l `hasValueOf` "* " = parseList doc [value 1 l] ls- | "```" `T.isPrefixOf` l = parsePre doc [] (optional $ value 3 l) ls- | otherwise = parse (doc <> [decodeLine l]) ls- parse doc [] = doc-- -- List recursive parser. Continues with @parse@ when the line- -- is no longer a list item, and adds the 'GemList' to the 'GemDocument'.- parseList :: GemDocument -> [Text] -> [Text] -> GemDocument- parseList doc glist (l : ls)- | l `hasValueOf` "* " = parseList doc (glist <> [value 1 l]) ls- | otherwise = parse (doc <> [GemList glist]) (l : ls)- parseList doc glist [] = doc <> [GemList glist]-- -- Preformatted recursive parser. Continues with @parse@ when the- -- closing delimiter is reached, and adds the 'GemPre' to the 'GemDocument'.- parsePre :: GemDocument -> [Text] -> Maybe Text -> [Text] -> GemDocument- parsePre doc glines alt (l : ls)- | "```" `T.isPrefixOf` l = parse (doc <> [GemPre glines alt]) ls- | otherwise = parsePre doc (glines <> [l]) alt ls- parsePre doc glines alt [] = doc <> [GemPre glines alt]+ parse :: [Text] -> GemDocument+ parse (l : ls)+ | "* " `T.isPrefixOf` l =+ let (items, rest) = span ("* " `T.isPrefixOf`) ls+ in (GemList . map (value 2) $ [l] <> items) : parse rest+ | "```" `T.isPrefixOf` l =+ let (pre, rest) = break ("```" `T.isPrefixOf`) ls+ in case rest of+ [] -> GemText l : parse ls+ (_ : after) -> GemPre pre (optional . value 3 $ l) : parse after+ | otherwise = decodeLine l : parse ls+ parse [] = [] --- | Parse a /single/ gemtext line as 'GemItem'.+-- | Parse a /single/ gemtext line as `GemItem'. ----- Preformatted text blocks are regarded as 'GemText's as they are strictly multiline.+-- There /should not/ be any line breaks in the input; if present, they are+-- treated as spaces. Preformatted text blocks are regarded as `GemText's as they+-- are strictly multiline. decodeLine :: Text -> GemItem decodeLine line- | line `hasValueOf` "=>" =- let (link, desc) = T.break isSpace $ value 2 line- in GemLink link $ optional $ T.strip desc- | line `hasValueOf` "#" = parseHeading line- | line `hasValueOf` "* " = GemList [value 1 line]- | line `hasValueOf` ">" = GemQuote $ value 1 line- | otherwise = GemText $ T.stripEnd line+ | "=>" `T.isPrefixOf` sane =+ let (link, desc) = T.break isSpace $ value 2 sane+ in if T.null link+ then GemText . T.stripEnd $ sane+ else GemLink link . optional . T.strip $ desc+ | "#" `T.isPrefixOf` sane =+ let level = min (T.length $ fst . T.span (== '#') $ sane) 3+ in GemHeading level . value level $ sane+ | "* " `T.isPrefixOf` sane = GemList [value 2 sane]+ | ">" `T.isPrefixOf` sane = GemQuote . value 1 $ sane+ | otherwise = GemText . T.stripEnd $ sane where- -- Parse a gemtext heading.- -- The max level of a heading is 3.- parseHeading :: Text -> GemItem- parseHeading l- | T.null $ T.strip text = GemText $ T.strip l- | otherwise = GemHeading (min (T.length pre) 3) $ T.strip text- where- (pre, text) = T.span (== '#') l-+ sane = escapeLineBreaks line --- | Encode a parsed 'GemDocument' into a gemtext block.------ The output 'Text' uses LF line breaks.+-- | Encode a parsed `GemDocument' into a gemtext block. ----- Valid prefixes are escaped before encoding. See the 'encodeItem' function below.+-- The output `Text' uses CRLF line breaks and ends with a newline. ----- Empty lists are ignored if given.+-- Empty lists are ignored completely if present. See the `encodeItem' function+-- for additional quirks. encode :: GemDocument -> Text-encode = T.unlines . map encodeItem . filter (not . empty)+encode = T.unlines . map ((<> "\CR") . encodeItem) . filter (not . empty) where- empty :: GemItem -> Bool empty (GemList list) = null list empty _ = False --- | Encode a /single/ parsed 'GemItem' into gemtext.------ /Beware/ that the output text does /not/ end with a newline.------ The output 'Text' might be multiple lines, in which case it uses LF line breaks.+-- | Encode a /single/ parsed `GemItem' into gemtext. ----- Valid prefixes are escaped before encoding.+-- The output `Text' does /not/ end with an additional newline, and might be+-- multiple lines, in which case it uses CRLF line breaks. ----- The spaces in 'GemLink's are replaced with @%20@ to normalize them.+-- Prefixes are escaped as necessary before encoding and the spaces in `GemLink's+-- are replaced with @%20@ to normalize them. Line breaks inside the body of an+-- item are also replaced with a space. encodeItem :: GemItem -> Text-encodeItem (GemText line) = escapePrefixes line-encodeItem (GemLink link desc) = "=> " <> T.replace " " "%20" link <> maybe "" (" " <>) desc-encodeItem (GemHeading level text) = T.replicate (min level 3) "#" <> " " <> text-encodeItem (GemList list) = T.intercalate "\n" $ map ("* " <>) list-encodeItem (GemQuote text) = "> " <> text-encodeItem (GemPre text alt) = T.intercalate "\n" $ ["```" <> fromMaybe "" alt] <> text <> ["```"]-+encodeItem item = case item of+ GemText text ->+ let shouldEscape =+ any (`T.isPrefixOf` text) ["#", "* ", ">"]+ || "```" `T.isPrefixOf` text+ || ("=>" `T.isPrefixOf` text && not (T.null $ value 2 text))+ in T.stripEnd . escapeLineBreaks $ bool text (T.cons ' ' text) shouldEscape+ GemLink link desc -> "=> " <> (T.replace " " "%20" . sanitize $ link) <> append desc+ GemHeading level text -> T.replicate (min level 3) "#" <> append (optional text)+ GemList list -> T.intercalate "\CR\LF" $ map (("* " <>) . sanitize) list+ GemQuote text -> ">" <> append (optional text)+ GemPre text alt -> T.intercalate "\CR\LF" $ ["```" <> append alt] <> text <> ["```"] --- Escape the line prefixes by adding a whitespace at the beginning for 'GemText'.-escapePrefixes :: Text -> Text-escapePrefixes line = bool line (T.cons ' ' line) escape- where- escape = "```" `T.isPrefixOf` line- || any (hasValueOf line) ["=>", "* ", ">"]- || (line `hasValueOf` "#"- && let (_, text) = T.span (== '#') line- in not (T.null $ T.strip text)- )+-- | Get the title of the `GemDocument', which is the very first `GemHeading'+-- in the document, regardless of the level of the heading.+documentTitle :: GemDocument -> Maybe Text+documentTitle doc = listToMaybe [h | GemHeading _ h <- doc] +-- `Nothing' if the text is empty.+optional :: Text -> Maybe Text+optional text = bool (Just text) Nothing $ T.null text --- @True@ if the the line has prefix /and/ a following value.-hasValueOf :: Text -> Text -> Bool-hasValueOf line prefix =- prefix `T.isPrefixOf` line- && not (T.null $ value (T.length prefix) line)+-- Sanitize and add a single space at the beginning if the `Text' exist,+-- otherwise return an empty `Text'.+append :: Maybe Text -> Text+append = maybe "" ((" " <>) . sanitize) --- Get the value of a line.--- Removes the prefix of given length and strips.+-- Strip the prefix of the line and then sanitize it to get the value. value :: Int -> Text -> Text-value prefix = T.strip . T.drop prefix+value prefix = sanitize . T.drop prefix --- @Nothing@ if the text is empty.-optional :: Text -> Maybe Text-optional text = bool (Just text) Nothing $ T.null text+-- Replace the line breaks with spaces and strip the `Text'.+sanitize :: Text -> Text+sanitize = T.strip . escapeLineBreaks++-- Replace the line breaks with spaces.+escapeLineBreaks :: Text -> Text+escapeLineBreaks = T.replace "\LF" " " . T.replace "\CR" ""
− test/Main.hs
@@ -1,135 +0,0 @@-{-# LANGUAGE OverloadedStrings #-}-{-# LANGUAGE QuasiQuotes #-}--import Control.Monad-import Data.Text (Text)-import System.Exit-import Test.HUnit-import Text.RawString.QQ--import Text.Gemini (GemDocument, GemItem (..))-import qualified Text.Gemini as G----- | Query the test functions.-main :: IO ()-main = do- count <-- runTestTT $- TestList- [ gemDecode- , gemEncode- ]- when (failures count > 0) exitFailure----- | Test the decoding of gemtext documents.-gemDecode :: Test-gemDecode =- TestCase- $ assertEqual- "Comparing the expected result of gemtext decoding,"- document- $ G.decode raw---- | Test the encoding of gemtext documents.-gemEncode :: Test-gemEncode =- TestCase- $ assertEqual- "Comparing the expected result of gemtext encoding,"- pretty- $ G.encode document----- | The expected encoded file to compare against-pretty :: Text-pretty =- [r| text!!-another text-=> link.gmi a link-=> gemini://geminiprotocol.net/index.gmi-=>-# heading-## sub-heading-###-### subsubheading but it works-### same as level 3--*text- * also text!-* list item-* another item-*-> quote->-```alt-> preformat with alt-```-```--* preformat without alt-```-> qq-```empty-```-|]---- | The expected decoded document to compare against-document :: GemDocument-document =- [ GemText " text!!"- , GemText "another text"- , GemLink "link.gmi" (Just "a link")- , GemLink "gemini://geminiprotocol.net/index.gmi" Nothing- , GemText "=>"- , GemHeading 1 "heading"- , GemHeading 2 "sub-heading"- , GemText "###"- , GemHeading 3 "subsubheading but it works"- , GemHeading 3 "same as level 3"- , GemText ""- , GemText "*text"- , GemText " * also text!"- , GemList ["list item", "another item"]- , GemText "*"- , GemQuote "quote"- , GemText ">"- , GemPre ["> preformat with alt"] (Just "alt")- , GemPre ["", "* preformat without alt"] Nothing- , GemQuote "qq"- , GemPre [] (Just "empty")- ]---- | The raw file to try to decode-raw :: Text-raw =- [r| text!! -another text-=>link.gmi a link -=> gemini://geminiprotocol.net/index.gmi-=> -# heading -## sub-heading-### -###subsubheading but it works-#### same as level 3- -*text- * also text!-* list item-* another item-*-> quote-> -```alt -> preformat with alt-```-``` --* preformat without alt-```->qq -```empty-```ignored -|]
+ test/Test.hs view
@@ -0,0 +1,139 @@+{-# LANGUAGE OverloadedStrings #-}++module Main (main) where++import Control.Monad+import Data.Text (Text, unlines)+import System.Exit (exitFailure)+import Test.HUnit (Test (..), failures, runTestTT, (~=?))+import Prelude hiding (unlines)++import Text.Gemini (GemDocument, GemItem (..))+import qualified Text.Gemini as G++-- | Query the test cases.+main :: IO ()+main = do+ count <-+ runTestTT . TestList $+ decoding <> encoding <> title+ when (failures count > 0) exitFailure++decoding :: [Test]+decoding =+ [ -- `GemText'+ GemText "" ~=? G.decodeLine ""+ , GemText "text" ~=? G.decodeLine "text"+ , GemText " whitespaces" ~=? G.decodeLine " whitespaces "+ , GemText "new lines" ~=? G.decodeLine "new\CR\LFlines"+ , -- `GemLink'+ GemText "=>" ~=? G.decodeLine "=> "+ , GemLink "link" Nothing ~=? G.decodeLine "=>link"+ , GemLink "link" (Just "description text") ~=? G.decodeLine "=> link description text"+ , GemLink "new" (Just "lines") ~=? G.decodeLine "=> new\CR\LFlines"+ , -- `GemHeading'+ GemHeading 1 "" ~=? G.decodeLine "#"+ , GemHeading 1 "title" ~=? G.decodeLine "#title"+ , GemHeading 2 "spaced" ~=? G.decodeLine "## spaced "+ , GemHeading 3 "# oops" ~=? G.decodeLine "#### oops"+ , -- `GemList'+ GemList [""] ~=? G.decodeLine "* "+ , GemList ["item"] ~=? G.decodeLine "* item "+ , -- `GemQuote'+ GemQuote "" ~=? G.decodeLine ">"+ , GemQuote "quote" ~=? G.decodeLine ">quote"+ , GemQuote "spaced" ~=? G.decodeLine "> spaced "+ , -- `GemDocument'+ document ~=? G.decode raw+ ]++encoding :: [Test]+encoding =+ [ -- `GemText'+ "" ~=? G.encodeItem (GemText "")+ , "=>" ~=? G.encodeItem (GemText "=> ")+ , " whitespaces" ~=? G.encodeItem (GemText " whitespaces")+ , "new lines" ~=? G.encodeItem (GemText "new\CR\LFlines\CR\LF")+ , " => escaped" ~=? G.encodeItem (GemText "=> escaped")+ , -- `GemLink'+ "=> link" ~=? G.encodeItem (GemLink "link" Nothing)+ , "=> with%20spaces" ~=? G.encodeItem (GemLink "with spaces" Nothing)+ , "=> also%20newline like so" ~=? G.encodeItem (GemLink "also\LFnewline " (Just " like\CR\LFso "))+ , "=> link with description" ~=? G.encodeItem (GemLink "link" (Just " with description"))+ , -- `GemHeading'+ "#" ~=? G.encodeItem (GemHeading 1 "")+ , "# title" ~=? G.encodeItem (GemHeading 1 "title")+ , "## subtitle" ~=? G.encodeItem (GemHeading 2 " subtitle ")+ , "### # oops" ~=? G.encodeItem (GemHeading 3 "# oops")+ , -- `GemList'+ "* " ~=? G.encodeItem (GemList [""])+ , "* multiple\CR\LF* items" ~=? G.encodeItem (GemList [" multiple ", "items"])+ , -- `GemQuote'+ ">" ~=? G.encodeItem (GemQuote "")+ , "> quote" ~=? G.encodeItem (GemQuote "quote")+ , "> new line" ~=? G.encodeItem (GemQuote " new\CR\LFline ")+ , -- `GemPre'+ "```\CR\LF pre \CR\LF```" ~=? G.encodeItem (GemPre [" pre "] Nothing)+ , "``` alt text\CR\LF```" ~=? G.encodeItem (GemPre [] (Just "alt\CR\LFtext "))+ , -- `GemDocument'+ pretty ~=? G.encode document+ ]++title :: [Test]+title =+ [ Nothing ~=? G.documentTitle [GemText "titleless"]+ , Just "title" ~=? G.documentTitle [GemHeading 3 "title", GemHeading 1 "not title"]+ , Just "also title" ~=? G.documentTitle [GemText "text", GemHeading 1 "also title"]+ ]++-- | The parsed `GemDocument' to match for `GemDocument' tests+document :: GemDocument+document =+ [ GemHeading 1 "gemmula"+ , GemText " < unit tests!! >"+ , GemPre+ [" ~ i am too lazy to put an ascii art here ~ "]+ (Just "ascii art of a heart")+ , GemText ""+ , GemList+ [ "list item 1"+ , "list item 2"+ ]+ , GemText ""+ , GemQuote "thank you for checking gemmula!"+ , GemLink "gemini://geminiprotocol.net" (Just "check Gemini")+ ]++-- | `document' encoded back into a `Text'+pretty :: Text+pretty =+ unlines . map (<> "\CR") $+ [ "# gemmula"+ , " < unit tests!! >"+ , "``` ascii art of a heart"+ , " ~ i am too lazy to put an ascii art here ~ "+ , "```"+ , ""+ , "* list item 1"+ , "* list item 2"+ , ""+ , "> thank you for checking gemmula!"+ , "=> gemini://geminiprotocol.net check Gemini"+ ]++-- | The raw `Text' that will hopefully be decoded into `document'+raw :: Text+raw =+ unlines+ [ "#gemmula"+ , " < unit tests!! > "+ , "```ascii art of a heart "+ , " ~ i am too lazy to put an ascii art here ~ "+ , "```"+ , " "+ , "* list item 1 "+ , "* list item 2"+ , ""+ , ">thank you for checking gemmula! "+ , "=>gemini://geminiprotocol.net check Gemini"+ ]