gemoire (empty) → 0.1.0
raw patch · 11 files changed
+1561/−0 lines, 11 filesdep +HUnitdep +basedep +directorysetup-changed
Dependencies added: HUnit, base, directory, extra, filepath, gemmula, gemoire, text, time, unordered-containers
Files
- ChangeLog.md +5/−0
- LICENSE +674/−0
- README.md +135/−0
- Setup.lhs +3/−0
- gemoire.cabal +53/−0
- src/Gemoire.hs +21/−0
- src/Gemoire/Gemlog.hs +191/−0
- src/Gemoire/Gemlog/Feed.hs +139/−0
- src/Gemoire/Gemlog/Post.hs +143/−0
- src/Gemoire/Template.hs +124/−0
- test/Main.hs +73/−0
+ ChangeLog.md view
@@ -0,0 +1,5 @@+# Change Log for gemoire++## 0.1.0 (January 25, 2025)++- Initial release!
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU 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 General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <https://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<https://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+ README.md view
@@ -0,0 +1,135 @@+# gemoire - yet another static gemlog generator++gemoire is just a basic flexible gemini blog generator, that can:++- be configured using Haskell code,+- use custom templates written in an authentic syntax,+- set additional and overriding variables for formatting,+- and generate Atom and Gemini feeds.++See the [example](https://codeberg.org/sena/gemoire/src/branch/main/example)+directory in the repository to see how it looks like in "production".++## Getting Started++Intended way for using gemoire is through Cabal scripts. To get started, you should+organize your gemlog sources like so:++```+gemlog+├── content+│ ├── post1.gmi+│ └── post2.gmi+└── gemlog.hs+```++The contents directory can be as deep as you want, all posts will end up in a+flat directory in the end. After setting up your files, you can start configuring+your `gemlog.hs`, here is a simple template for you using the defaults:++```hs+#!/usr/bin/env cabal+{- cabal:+build-depends: base+ , gemoire+-}+{-# LANGUAGE OverloadedStrings #-}++import Gemoire++main :: IO ()+main = do+ let gemlog =+ Gemlog+ { title = "my gemlog"+ , author = "me"+ , sourceDir = "content"+ , baseURL = "gemini://my.website.com/path/to/gemlog"+ , postTemplate = defPost+ , gemfeedTemplates =+ ( defGemfeed+ , defGemfeedEntry+ )+ , atomTemplates =+ ( defAtom+ , defAtomEntry+ )+ , overrides = vempty+ }++ generatePosts gemlog "~/public_gemini/path/to/gemlog"+ generateGemfeed gemlog "~/public_gemini/path/to/gemlog/index.gmi"+ generateAtom gemlog "~/public_gemini/path/to/gemlog/atom.xml"+```++After setting up your configuration, you can just cd into the `gemlog` directory+and run the generator:++```bash+$ cabal run gemlog.hs+```++If Cabal is causing problems, you can just install the library and use `runghc`+instead, like so:++```bash+$ cabal install --lib gemoire+$ runghc gemlog.hs+```++## Customizing++You can then customize your gemlog to your liking. To do that, you might want+to start with changing the templates, like so:++```hs+#!/usr/bin/env cabal+{- cabal:+build-depends: base+ , text+ , gemoire+-}+{-# LANGUAGE OverloadedStrings #-}++-- gemoire uses Data.Text underhood.+import Data.Text (unlines)+import Prelude hiding (unlines)+import Gemoire++-- The line endings will be taken care of by gemoire.+-- ...+ , postTemplate = template . unlines $+ [ "By {$author$}."+ , ""+ , "{$post$}"+ ]+-- ...+```++There are various variables and different useful compounds you can use in the+templates. A detailed list can be found in the documentation of+[`Gemoire.Template`](https://hackage.haskell.org/package/gemoire/docs/Gemoire-Template.html).+Also check the default templates in the source for some inspiration!++Different special variables are available to the formatters for feeds and posts.+You can see a list of those and how you can set overrides per post in the page for+[`Gemoire.Gemlog`](https://hackage.haskell.org/package/gemoire/docs/Gemoire-Gemlog.html).++Additionally, you can set overriding variables globally using the `overrides`+variable, like so:++```hs+-- ...+ , overrides = vlist+ [ ("variable", "new value")+ , ("another", "overridden")+ ]+-- ...+```++## See also++- [Project Gemini](https://geminiprotocol.net)+ for more about the Gemini protocol itself.+- [Awesome Gemini](https://github.com/kr1sp1n/awesome-gemini)+ to discover more projects about Gemini.
+ Setup.lhs view
@@ -0,0 +1,3 @@+#!/usr/bin/env runhaskell+> import Distribution.Simple+> main = defaultMain
+ gemoire.cabal view
@@ -0,0 +1,53 @@+cabal-version: 2.2+name: gemoire+version: 0.1.0+category: Gemini+homepage: https://codeberg.org/sena/gemoire+bug-reports: https://codeberg.org/sena/gemoire/issues+synopsis: yet another static gemlog generator+description:+ gemoire is just another take on a static gemlog generator with feeds trying+ to be flexible just enough, configured and served using Haskell. See the+ README.md for usage examples and Hackage for a detailed documentation.+license: GPL-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.6, GHC == 9.8.4, GHC == 9.10.1+extra-doc-files: README.md, ChangeLog.md++source-repository head+ location: https://codeberg.org/sena/gemoire+ type: git++library+ default-language: Haskell2010+ hs-source-dirs: src+ exposed-modules: Gemoire+ , Gemoire.Gemlog+ , Gemoire.Gemlog.Post+ , Gemoire.Gemlog.Feed+ , Gemoire.Template+ build-depends: base >= 4.16 && < 5+ , directory >= 1.3.7 && < 1.4+ , extra >= 1.7.12 && < 1.9+ , filepath >= 1.4.100.4 && < 1.6+ , gemmula >= 1.2 && < 1.3+ , text >= 2.0 && < 2.2+ , time >= 1.12 && < 1.15+ , unordered-containers >= 0.2.18 && < 0.2.21+ ghc-options: -Wall++test-suite unit+ default-language: Haskell2010+ type: exitcode-stdio-1.0+ hs-source-dirs: test+ main-is: Main.hs+ build-depends: base+ , HUnit >= 1.6 && < 2+ , text+ , unordered-containers+ , gemoire+ ghc-options: -Wall
+ src/Gemoire.hs view
@@ -0,0 +1,21 @@+-- |+-- Module : Gemoire+-- Copyright : (c) 2024 Sena+-- License : GPL-3.0-or-later+--+-- Maintainer : contact@sena.pink+-- Stability : stable+-- Portability : portable+--+-- yet another static gemlog generator+--+-- See each module below for a detailed explanation.+-- See the README.md for a roughly step-by-step guide.+module Gemoire+ ( -- * Module re-exports+ module Gemoire.Gemlog+ , module Gemoire.Template+ ) where++import Gemoire.Gemlog+import Gemoire.Template
+ src/Gemoire/Gemlog.hs view
@@ -0,0 +1,191 @@+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE OverloadedStrings #-}++-- |+-- Module : Gemoire.Gemlog+-- Copyright : (c) 2024 Sena+-- License : GPL-3.0-or-later+--+-- Maintainer : contact@sena.pink+-- Stability : stable+-- Portability : portable+--+-- A tiny static gemlog generator+--+-- To make a gemlog, you need two essential types of materials: posts and+-- templates.+--+-- The template syntax detailed in `Gemoire.Template' is also usable in posts.+-- The posts processed using this module have some special variables available+-- to them while generating. Those are, including others:+--+-- * @title@ - The first heading in the document if it exists+-- * @path@ - The given file path /(non-overrideable)/+-- * @fname@ - The file name without the extension and the directories+-- * @modified@ - File modification date and time (@yyyy-mm-ddThh:mm:ss[.ss]±hh:mm@)+-- * @modified_date@ - File modification date (@yyyy-mm-dd@)+-- * @url@ - The permanent link to post /(non-overrideable)/+-- * @gemlog@ - The title of the gemlog /(non-overrideable)/+-- * @author@ - The author of the gemlog /(non-overrideable)/+--+-- Additionally, variables can also be set (or overridden) in the post like so,+-- assuming a /single variable per line/:+--+-- > {= variable value =}+--+-- For the templates, see `Gemoire.Template'. However, as with posts, feeds also+-- have special variables available. Those are, for the /feed itself/:+--+-- * @title@ - The title of the gemlog+-- * @author@ - The author of the gemlog+-- * @base@ - The base URL of the gemlog+-- * @url@ - The permanent link to the feed+-- * @entries@ - The formatted entries+--+-- For each entry in the feed, every variable the post associated with the entry has+-- is available.+--+-- See the README.md for a roughly step-by-step guide.+module Gemoire.Gemlog+ ( -- * Gemlog generation+ Gemlog (..)+ , generatePosts+ , generateGemfeed+ , generateAtom++ -- * Re-exports+ , defPost+ , defGemfeed+ , defGemfeedEntry+ , defAtom+ , defAtomEntry+ , vempty+ , vlist+ ) where++import Data.Bool (bool)+import Data.HashMap.Strict (findWithDefault, fromList, singleton)+import Data.Text (Text)+import qualified Data.Text as T+import qualified Data.Text.IO as TIO+import System.Directory (createDirectoryIfMissing, doesDirectoryExist)+import System.Directory.Extra (listFilesRecursive)+import System.FilePath (takeExtension, takeFileName, (</>))++import Gemoire.Gemlog.Feed+ ( defAtom+ , defAtomEntry+ , defGemfeed+ , defGemfeedEntry+ , escapeFeed+ , lastModified+ , sortPosts+ )+import Gemoire.Gemlog.Post (defPost, readPost)+import Gemoire.Template (Template, Values, format, vempty, vlist)++-- | A gemlog recipe to generate files for+data Gemlog = Gemlog+ { title :: !Text+ -- ^ The title of the gemlog+ , author :: !Text+ -- ^ The author of the gemlog+ , sourceDir :: !FilePath+ -- ^ The source directory for posts, scanned recursively,+ -- /not/ retaining the directory structure+ , baseURL :: !Text+ -- ^ The base URL of the gemlog+ , postTemplate :: Template+ -- ^ The post template+ , gemfeedTemplates :: (Template, Template)+ -- ^ The gemfeed templates, where the first is the feed itself+ -- and the second is a single entry+ , atomTemplates :: (Template, Template)+ -- ^ The Atom feed templates, where the first is the feed itself+ -- and the second is a single entry+ , overrides :: !Values+ }+ deriving (Show, Eq)++-- | Generates and writes all the posts in the given `Gemlog' to the given directory.+--+-- The output directory is /flat/ and the structure of the source is /never/ retained.+--+-- See the module description for the variables available in the post.+generatePosts :: Gemlog -> FilePath -> IO ()+generatePosts glog@(Gemlog{postTemplate}) outputDir = do+ posts <- parsePosts glog+ createDirectoryIfMissing True outputDir+ mapM_ (\p -> writeFile (outputDir </> fileName p) $ T.unpack . crlf $ format postTemplate p) posts++-- | Generates a gemfeed in the given path.+--+-- See the module description for the variables available in the feed.+--+-- If the given path is a directory, the feed file will be named+-- @index.gmi@ by default.+--+-- The entries are sorted by last modified in the feed. Every variable in the+-- post is available in its respective entry. See `generatePosts' above.+generateGemfeed :: Gemlog -> FilePath -> IO ()+generateGemfeed = generateFeed True++-- | Generates an feed Atom in the given path.+--+-- See the module description for the variables available in the feed.+--+-- If the given path is a directory, the feed file will be named+-- @atom.xml@ by default.+--+-- The entries are sorted by last modified in the feed. Every variable in the post+-- is available in its respective entry. See `generatePosts' above.+--+-- Additionally, every variable is escaped to make the XML valid. Variables ending with+-- @url@ are escaped using percent encodings for URLs instead of ampersand. See `escapeAtom'.+generateAtom :: Gemlog -> FilePath -> IO ()+generateAtom = generateFeed False++-- The first parameter is @True@ for gemfeeds and @False@ for Atom.+-- Adds some additional variables described above.+generateFeed :: Bool -> Gemlog -> FilePath -> IO ()+generateFeed gemfeed glog@(Gemlog{title, author, baseURL, overrides}) path = do+ let (feed, entry) = bool atomTemplates gemfeedTemplates gemfeed glog+ ending = bool "" "\CR" gemfeed <> "\LF"+ fname = bool "atom.xml" "index.gmi" gemfeed+ output <- bool path (path </> fname) <$> doesDirectoryExist path+ posts <- sortPosts <$> parsePosts glog+ TIO.writeFile output+ . bool id crlf gemfeed+ . format feed+ . escapeFeed gemfeed+ . (overrides <>)+ . (lastModified posts <>)+ . fromList+ $ [ ("title", title)+ , ("author", author)+ , ("base", baseURL)+ , ("url", T.dropWhileEnd (== '/') baseURL <> "/" <> T.pack (takeFileName output))+ ,+ ( "entries"+ , T.intercalate ending $+ map (T.stripEnd . bool id crlf gemfeed . format entry . escapeFeed gemfeed) posts+ )+ ]++-- Parse all the posts /recursively/ in a `Gemlog's source directory.+-- Adds the @url@, @gemlog@, and @author@ fields.+parsePosts :: Gemlog -> IO [Values]+parsePosts (Gemlog{title, author, sourceDir, baseURL, overrides}) =+ map (\p -> singleton "url" (T.dropWhileEnd (== '/') baseURL <> "/" <> T.pack (fileName p)) <> p)+ <$> ( mapM (readPost (fromList [("gemlog", title), ("author", author)] <> overrides))+ . filter ((== ".gmi") . takeExtension)+ =<< listFilesRecursive sourceDir+ )++-- Take the file name from the path in a parsed post.+fileName :: Values -> FilePath+fileName p = takeFileName . T.unpack $ findWithDefault "post.gmi" "path" p++-- Make the newlines CRLF in the given text if the boolean is @True@.+crlf :: Text -> Text+crlf = T.unlines . map ((<> "\CR") . T.dropWhileEnd (== '\CR')) . T.lines
+ src/Gemoire/Gemlog/Feed.hs view
@@ -0,0 +1,139 @@+{-# LANGUAGE OverloadedStrings #-}++-- |+-- Module : Gemoire.Gemlog.Feed+-- Copyright : (c) 2024 Sena+-- License : GPL-3.0-or-later+--+-- Maintainer : contact@sena.pink+-- Stability : stable+-- Portability : portable+--+-- Feed related functions and default templates for gemlogs+--+-- The variables that are available to use in a feed template is not defined+-- here, as feeds need the whole gemlog. See `Gemoire.Gemlog' for the variables+-- available in the intended use.+module Gemoire.Gemlog.Feed+ ( -- * Utility functions+ sortPosts+ , lastModified+ , escapeFeed++ -- * Templates+ , defGemfeed+ , defGemfeedEntry+ , defAtom+ , defAtomEntry++ -- * Re-exports+ , vempty+ , vlist+ ) where++import Control.Monad ((<=<))+import Data.Function (applyWhen)+import qualified Data.HashMap.Strict as M+import Data.List (sortBy)+import Data.Maybe (listToMaybe)+import Data.Text (Text)+import qualified Data.Text as T+import Data.Time (UTCTime (utctDay), utc, utcToZonedTime, zonedTimeToUTC)+import Data.Time.Format.ISO8601 (iso8601ParseM, iso8601Show)++import Gemoire.Template (Template, Values, template, vempty, vlist)++defGemfeed :: Template+defGemfeed =+ template . T.unlines . map (<> "\CR") $+ [ "# {$title$}"+ , ""+ , "{$entries$}"+ ]++defGemfeedEntry :: Template+defGemfeedEntry = template "=> {$url$} {$modified_date$} - {&title:fname:Post&}"++defAtom :: Template+defAtom =+ template . T.unlines $+ [ "<?xml version=\"1.0\" encoding=\"utf-8\"?>"+ , "<feed xmlns=\"http://www.w3.org/2005/Atom\">"+ , " <title>{$title$}</title>"+ , " <author>"+ , " <name>{$author$}</name>"+ , " </author>"+ , " <link rel=\"self\" type=\"application/atom+xml\" href=\"{$url$}\" />"+ , " <link rel=\"alternate\" type=\"text/gemini\" href=\"{$base$}\" />"+ , " <generator uri=\"https://hackage.haskell.org/package/gemoire\">gemoire</generator>"+ , " <updated>{$modified$}</updated>"+ , " <id>{$url$}</id>"+ , ""+ , "{$entries$}"+ , ""+ , "</feed>"+ ]++defAtomEntry :: Template+defAtomEntry =+ template . T.intercalate "\LF" $+ [ "<entry>"+ , " <title>{&title:fname:Post&}</title>"+ , " <link rel=\"alternate\" type=\"text/gemini\" href=\"{$url$}\" />"+ , " <updated>{$modified$}</updated>"+ , " <id>{$url$}</id>"+ , " <summary type=\"text\">{&summary:title:No summary given.&}</summary>"+ , " <content type=\"text/gemini\" src=\"{$url$}\"></content>"+ , "</entry>"+ ]++-- | Takes the modified time and date of the latest post in the list,+-- in the form of a map of `Values' with the variables @modified@ and+-- @modified_date@, like in `Gemoire.Gemlog.Post.readPost'.+lastModified :: [Values] -> Values+lastModified posts = case parseModified <=< listToMaybe . sortPosts $ posts of+ Nothing -> vempty+ Just modified ->+ let modifiedStr = T.pack . iso8601Show . utcToZonedTime utc $ modified+ modifiedDate = T.pack . iso8601Show . utctDay $ modified+ in M.fromList [("modified", modifiedStr), ("modified_date", modifiedDate)]++-- | Sorts the posts by the last modified.+sortPosts :: [Values] -> [Values]+sortPosts = sortBy (\a b -> compare (parseModified b) (parseModified a))++-- | Escapes variables in feeds.+-- Only does bare minimum of encoding, enough to make the feed valid.+--+-- * Percent encodes the variable @base@ and those ending with @url@.+-- * Doesn't do anything to the variable @entries@.+-- * Ampersand encodes everything else /only for Atom feeds/.+escapeFeed+ :: Bool+ -- ^ Whether the feed is a gemfeed+ -> Values+ -> Values+escapeFeed gemfeed = M.mapWithKey escape+ where+ escape key value+ | "url" `T.isSuffixOf` key = escapeLink value+ | "base" == key = escapeLink value+ | "entries" == key = value+ | otherwise = applyWhen (not gemfeed) escapeContent value++-- Ampersand encode given text minimally.+escapeContent :: Text -> Text+escapeContent =+ T.replace ">" ">"+ . T.replace "<" "<"+ . T.replace "'" "'"+ . T.replace "\"" """+ . T.replace "&" "&"++-- Percent encode given text minimally.+escapeLink :: Text -> Text+escapeLink = T.replace "'" "%27" . T.replace "\"" "%22"++-- Get the time modified of the given post.+parseModified :: Values -> Maybe UTCTime+parseModified = fmap zonedTimeToUTC . iso8601ParseM <=< fmap T.unpack . M.lookup "modified"
+ src/Gemoire/Gemlog/Post.hs view
@@ -0,0 +1,143 @@+{-# LANGUAGE OverloadedStrings #-}++-- |+-- Module : Gemoire.Gemlog.Post+-- Copyright : (c) 2024 Sena+-- License : GPL-3.0-or-later+--+-- Maintainer : contact@sena.pink+-- Stability : stable+-- Portability : portable+--+-- Minimal gemlog post parser/formatter and default templates+--+-- For posts, the template components are also usable, following the same+-- syntax described in `Gemoire.Template'. Variables available to the post will+-- be applied while parsing like in templates.+--+-- The variables available in a post /may/ change depending on what function parses+-- them. Unless doing heavy customization, see `Gemoire.Gemlog' for the variables+-- available in the intended use. Otherwise, see each function below.+--+-- Additionally, variables can also be set (or overridden) in the post like so,+-- assuming a /single variable per line/:+--+-- > {= variable value =}+module Gemoire.Gemlog.Post+ ( -- * Parsers+ parsePost+ , readPost++ -- * Templates+ , defPost++ -- * Re-exports+ , vempty+ , vlist+ ) where++import Control.Arrow ((***))+import Control.Monad (join)+import Data.Bool (bool)+import qualified Data.HashMap.Strict as M+import Data.Text (Text)+import qualified Data.Text as T+import qualified Data.Text.IO as TIO+import Data.Time (UTCTime (..), utc, utcToZonedTime)+import Data.Time.Format.ISO8601 (iso8601Show)+import System.Directory (getModificationTime)+import System.FilePath (takeBaseName)+import Text.Gemini (GemDocument, GemItem (..))+import qualified Text.Gemini as G++import Gemoire.Template (Template, Values, format, template, vempty, vlist)++defPost :: Template+defPost = template "{$post$}\CR\LF"++-- | Parses a GemText post into a map of `Values' to use in templates.+--+-- The post content will be evaluated and formatted using `template' and+-- `format' before creating the map.+--+-- Some special variables are also generated while parsing. Those are:+--+-- * @title@ - The first heading in the document if it exists+-- * @post@ - The post content (non-overrideable by the post text)+parsePost+ :: Values+ -- ^ Extra variable overrides+ -> Text+ -> Values+parsePost extras text = parse M.empty [] doc+ where+ doc = G.decode text++ parse :: Values -> GemDocument -> [GemItem] -> Values+ parse vars post (i : is) = case i of+ GemText line -> case getVariable line of+ Just pair -> parse (uncurry M.insert pair vars) post is+ Nothing -> parse vars (post <> [GemText line]) is+ line -> parse vars (post <> [line]) is+ parse vars post [] =+ let title = maybe M.empty (M.singleton "title") $ G.documentTitle doc+ recursive = extras <> vars <> title+ content =+ M.singleton "post"+ $ stripFinalNewline+ . (`format` recursive)+ . template+ . G.encode+ $ post+ in extras <> content <> vars <> title++-- | Reads and parses a GemText post file into a map of `Values' to use in templates.+--+-- See `parsePost' for how this function works. Everything there applies here as well.+-- This function adds some additional formatting variables, which are:+--+-- * @path@ - The given file path+-- * @fname@ - The file name without the extension and the directories+-- * @modified@ - File modification date and time (@yyyy-mm-ddThh:mm:ss[.ss]±hh:mm@)+-- * @modified_date@ - File modification date (@yyyy-mm-dd@)+--+-- These variables are /not/ overrideable by the post text.+readPost+ :: Values+ -- ^ Extra variable overrides+ -> FilePath+ -> IO Values+readPost extras path = do+ modified <- stripTime <$> getModificationTime path+ let modifiedStr = T.pack . iso8601Show . utcToZonedTime utc $ modified+ modifiedDate = T.pack . iso8601Show . utctDay $ modified+ in parsePost+ ( extras+ <> M.fromList+ [ ("path", T.pack path)+ , ("fname", T.pack . takeBaseName $ path)+ , ("modified", modifiedStr)+ , ("modified_date", modifiedDate)+ ]+ )+ <$> TIO.readFile path++-- Get the variable value if it exists.+getVariable :: Text -> Maybe (Text, Text)+getVariable line =+ (\v -> bool (Just v) Nothing (T.null $ fst v))+ . join (***) T.strip+ . T.break (== ' ')+ . T.strip+ =<< (T.stripPrefix "{=" line >>= T.stripSuffix "=}")++-- Strip the final newline from text if it exists.+stripFinalNewline :: Text -> Text+stripFinalNewline text+ | "\CR\LF" `T.isSuffixOf` text = T.dropEnd 2 text+ | "\LF" `T.isSuffixOf` text = T.dropEnd 1 text+ | otherwise = text++-- Strip the picosecond precision from time.+stripTime :: UTCTime -> UTCTime+stripTime (UTCTime day time) = UTCTime day $ fromInteger $ floor time
+ src/Gemoire/Template.hs view
@@ -0,0 +1,124 @@+{-# LANGUAGE OverloadedStrings #-}++-- |+-- Module : Gemoire.Template+-- Copyright : (c) 2024 Sena+-- License : GPL-3.0-or-later+--+-- Maintainer : contact@sena.pink+-- Stability : stable+-- Portability : portable+--+-- A minimal template parser to use with generated static gemlogs+--+-- Gemoire uses its own template system, where the templates are plain texts+-- with special inline components. The valid components are:+--+-- * @{$pholder$}@ - A placeholder with the key @pholder@+-- * @{$pholder:default value$}@ - A placeholder with a default value+-- * @{&pholder:fallback&}@ - With a fallback /key/ to use in case @pholder@ has no value+-- * @{&pholder:fallback:default value&}@ - With a fallback /key/ and a default /value/+-- * @{# comment! #}@ - An unrendered comment+-- * @{\ constant \}@ - An unevaluated block, akin to escaping things inside it+--+-- All inline components can be multiline in any way, including placeholder keys.+-- The arguments can also be surrounded by any amount of whitespace, which will+-- get stripped /except/ when specifying a default value.+--+-- The surrounding braces are parsed in order, so the components /can not/ be nested.+module Gemoire.Template+ ( -- * Formatting+ template+ , format++ -- * Types+ , Values+ , Template+ , Component (..)++ -- * Utility+ , vempty+ , vlist+ ) where++import Control.Arrow (second, (&&&), (***))+import Control.Monad (join)+import Data.Bool (bool)+import Data.HashMap.Strict (HashMap, empty, findWithDefault, fromList, (!?))+import Data.Maybe (fromMaybe)+import Data.Text (Text)+import qualified Data.Text as T++-- | A basic template, in the form of a string of either plain text+-- blocks or meaningful components+type Template = [Either Text Component]++-- | A parsed template component with a special meaning+data Component+ = -- | A placeholder with an optional default value+ Placeholder !Text !(Maybe Text)+ | -- | A placeholder with another key to fallback to if the first one+ -- has no value, and an optional default value+ Fallback !Text !Text !(Maybe Text)+ deriving (Eq, Show)++-- | An unordered `HashMap' of formatting keys and values+type Values = HashMap Text Text++-- | Construct a `Template' from the given `Text'.+--+-- See the module description for how the templates are formed.+--+-- The whitespaces in the arguments will be stripped /except/ for default values.+--+-- The surrounding braces are parsed in order, so the components /can not/ be nested.+template :: Text -> Template+template text+ | T.null text = []+ | otherwise =+ let (str, ((pfx, inside), (sfx, rest))) =+ second (shiftDelimiters . join (***) (T.splitAt 1) . T.break (== '}')) $+ T.break (== '{') text+ optstr = bool [Left str] [] $ T.null str+ in case (pfx, sfx) of+ ("{$", "$}") ->+ let (name, def) = second (T.stripPrefix ":") $ T.break (== ':') inside+ in optstr <> [Right $ Placeholder (T.strip name) def] <> template rest+ ("{&", "&}") ->+ let (name, (fback, def)) =+ second (second (T.stripPrefix ":") . T.break (== ':') . T.drop 1) $+ T.break (== ':') inside+ in optstr <> [Right $ Fallback (T.strip name) (T.strip fback) def] <> template rest+ ("{#", _) ->+ let (_, end) = second (T.drop 2) $ T.breakOn "#}" (inside <> sfx <> rest)+ in optstr <> template end+ ("{\\", _) ->+ let (constant, end) = second (T.drop 2) $ T.breakOn "\\}" (inside <> sfx <> rest)+ in optstr <> [Left constant] <> template end+ _ -> [Left (str <> pfx)] <> template (inside <> sfx)+ where+ shiftDelimiters :: ((Text, Text), (Text, Text)) -> ((Text, Text), (Text, Text))+ shiftDelimiters ((pfx, pholder), (sfx, rest)) =+ ( (((pfx <>) . T.take 1) &&& (T.drop 1 . T.dropEnd 1)) pholder+ , (T.takeEnd 1 pholder <> sfx, rest)+ )++-- | Format the `Template' using given `Values' map.+format :: Template -> Values -> Text+format [] _ = ""+format (p : ps) vars =+ ( case p of+ Left text -> text+ Right (Placeholder key def) -> findWithDefault (fromMaybe "" def) key vars+ Right (Fallback key1 key2 def) ->+ findWithDefault (fromMaybe (fromMaybe "" def) (vars !? key2)) key1 vars+ )+ <> format ps vars++-- | An empty `Values' map for convenience+vempty :: Values+vempty = empty++-- | `fromList' for convenience+vlist :: [(Text, Text)] -> Values+vlist = fromList
+ test/Main.hs view
@@ -0,0 +1,73 @@+{-# LANGUAGE OverloadedStrings #-}++module Main (main) where++import Control.Monad (when)+import qualified Data.HashMap.Strict as M+import System.Exit (exitFailure)+import Test.HUnit (Test (..), failures, runTestTT, (~=?))++import Gemoire.Gemlog.Feed (lastModified, sortPosts)+import Gemoire.Gemlog.Post (parsePost)+import Gemoire.Template (Component (..), format, template)++-- | Query the test cases.+main :: IO ()+main = do+ count <-+ runTestTT . TestList $+ feeds <> posts <> templates+ when (failures count > 0) exitFailure++feeds :: [Test]+feeds =+ let post =+ [ M.fromList [("post", "1"), ("modified", "2024-08-17T05:00:00+00:00")]+ , M.fromList [("post", "2"), ("modified", "2024-08-17T09:00:00+00:00")]+ , M.fromList [("post", "3"), ("modified", "2024-11-14T13:47:01+00:00")]+ ]+ in [ [ M.fromList [("post", "3"), ("modified", "2024-11-14T13:47:01+00:00")]+ , M.fromList [("post", "2"), ("modified", "2024-08-17T09:00:00+00:00")]+ , M.fromList [("post", "1"), ("modified", "2024-08-17T05:00:00+00:00")]+ ]+ ~=? sortPosts post+ , M.fromList [("modified", "2024-11-14T13:47:01+00:00"), ("modified_date", "2024-11-14")]+ ~=? lastModified post+ ]++posts :: [Test]+posts =+ [ M.fromList [("post", "post")] ~=? parsePost M.empty "post"+ , M.fromList [("title", "heading"), ("post", "# heading")] ~=? parsePost M.empty "# heading"+ , M.fromList [("data", "extras"), ("post", "with extras")]+ ~=? parsePost (M.singleton "data" "extras") "with {$data$}"+ , M.fromList [("data", "variables"), ("post", "with variables")]+ ~=? parsePost M.empty "{= data variables =}\CR\LFwith {$data$}"+ ]++templates :: [Test]+templates =+ [ [Left "text"] ~=? template "text"+ , [Left "also {$", Left "text"] ~=? template "also {$text"+ , [Right $ Placeholder "placeholder" Nothing] ~=? template "{$ placeholder $}"+ , [Right $ Placeholder "with" $ Just "default value"] ~=? template "{$with:default value$}"+ , [Right $ Placeholder "{$weird" Nothing, Left "$}"] ~=? template "{${$weird$}$}"+ , [Right $ Placeholder "pholder" $ Just "multiline \CR\LF value"]+ ~=? template "{$pholder:multiline \CR\LF value$}"+ , [Right $ Placeholder "multiline\CR\LFunfortunately" Nothing]+ ~=? template "{$multiline\CR\LFunfortunately$}"+ , [Left "mixed ", Right $ Placeholder "pholder" Nothing, Left " text"]+ ~=? template "mixed {$pholder$} text"+ , [Right $ Fallback "variable" "fallback" Nothing] ~=? template "{&variable:fallback&}"+ , [Right $ Fallback "same as a variable" "" Nothing] ~=? template "{& same as a variable&}"+ , [Right $ Fallback "var" "fback" (Just "default")] ~=? template "{&var:fback:default&}"+ , [Left "commented ", Left " text"] ~=? template "commented {# meow #} text"+ , [] ~=? template "{# comment with {$flare$} #}"+ , [] ~=? template "{#multiline \CR\LF comment#}"+ , [Left "{# not a comment #}"] ~=? template "{\\{# not a comment #}\\}"+ , [Left "constant"] ~=? template "{\\constant\\}"+ , "formatted text!" ~=? format (template "formatted {$ key $}") (M.singleton "key" "text!")+ , "default value" ~=? format (template "{$key:default$} value") M.empty+ , "falled back!" ~=? format (template "falled {&unexist:fallback&}!") (M.singleton "fallback" "back")+ , "couldn't fall back." ~=? format (template "couldn't {&a:b:fall&} back.") M.empty+ ]