diff --git a/.ghcid b/.ghcid new file mode 100644 index 0000000..b79997e --- /dev/null +++ b/.ghcid @@ -0,0 +1 @@ +--warnings -T "Ema.Example.runSimpleSitePure" diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..92bce4c --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,21 @@ +name: "Build" +on: + pull_request: + push: +jobs: + build: + runs-on: ubuntu-latest + env: + MAINLINE: refs/heads/master + steps: + - uses: actions/checkout@v2 + - uses: cachix/install-nix-action@v13 + with: + install_url: https://nixos-nix-install-tests.cachix.org/serve/lb41az54kzk6j12p81br4bczary7m145/install + install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve' + extra_nix_config: | + experimental-features = nix-command flakes + # This downloads deps from Nix cache, builds neuron, as well as run tests + - name: Build 🔧 + run: | + nix build -j4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f62f6bd --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +dist +dist-* +cabal-dev +*.o +*.hi +*.hie +*.chi +*.chs.h +*.dyn_o +*.dyn_hi +.hpc +.hsenv +.cabal-sandbox/ +cabal.sandbox.config +*.prof +*.aux +*.hp +*.eventlog +.stack-work/ +cabal.project.local +cabal.project.local~ +.HTF/ +.ghc.environment.* +result +result-* \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..ac6233d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,9 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "haskell.haskell", + "arrterian.nix-env-selector", + "bbenoist.nix" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..c0430f9 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "editor.formatOnType": true, + "editor.formatOnSave": true, + "nixEnvSelector.nixFile": "${workspaceRoot}/shell.nix" +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..528443f --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,21 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "Ema Example Server", + "type": "shell", + "command": "bin/run", + "args": [], + "problemMatcher": [], + "group": { + "kind": "build", + "isDefault": true + }, + "runOptions": { + "runOn": "folderOpen" + } + } + ] +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e81c8a8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for ema + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index b786fab..1a04cc5 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,25 @@ **WIP** ema is the next-generation static site generator and live server that hot-reload's on code *or* data change. + +## Hacking + +Open in VSCode, and run the build task. + +## TODO + +- [x] MVP +- [ ] Implement hot reload, and ditch browser-sync + - [x] server to client refresh + - [ ] client to server reconnect (on ghcid reload, or accidental client disconnect) + - [ ] or, investigate https://hackage.haskell.org/package/ghci-websockets +- [ ] Example: filesystem watcher + +public, +- [ ] refactor and simplify +- [ ] examples + +doc notes, +- use async:race to avoid ghcid ghosts +- at most one ws client supported right now +- tailwind + blaze-html layout (BlazeWind?) for no-frills getting started diff --git a/bin/format b/bin/format new file mode 100755 index 0000000..f61a3f1 --- /dev/null +++ b/bin/format @@ -0,0 +1,6 @@ +#!/usr/bin/env nix-shell +#! nix-shell ../shell.nix -i bash +set -xe +find src -name \*.hs | xargs ormolu -m inplace +nixpkgs-fmt *.nix +cabal-fmt -i *.cabal \ No newline at end of file diff --git a/bin/run b/bin/run new file mode 100755 index 0000000..eda21fb --- /dev/null +++ b/bin/run @@ -0,0 +1,3 @@ +#!/usr/bin/env bash +set -xe +exec nix-shell --run ghcid diff --git a/ema.cabal b/ema.cabal new file mode 100644 index 0000000..5492f6a --- /dev/null +++ b/ema.cabal @@ -0,0 +1,83 @@ +cabal-version: 2.4 +name: ema +version: 0.1.0.0 +license: AGPL-3.0-only +copyright: 2020 Sridhar Ratnakumar +maintainer: srid@srid.ca +author: Sridhar Ratnakumar +category: Web + +-- A short (one-line) description of the package. +-- synopsis: + +-- A longer description of the package. +-- description: + +-- A URL where users can report bugs. +-- bug-reports: + +extra-source-files: + CHANGELOG.md + README.md + LICENSE + +library + -- Modules included in this executable, other than Main. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + build-depends: + , aeson + , async + , base ^>=4.14.1.0 + , blaze-html + , blaze-markup + , containers + , data-default + , directory + , filepath + , http-types + , mtl + , neat-interpolation + , optparse-applicative + , parser-combinators + , relude + , stm + , text + , time + , wai + , wai-app-static + , wai-websockets + , warp + , websockets + + -- record-hasfield is included due to https://github.com/commercialhaskell/stackage/issues/4449 + mixins: + base hiding (Prelude), + relude (Relude as Prelude, Relude.Container.One), + relude + + ghc-options: + -Wall -Wincomplete-record-updates -Wincomplete-uni-patterns + + default-extensions: + FlexibleContexts + FlexibleInstances + KindSignatures + LambdaCase + MultiParamTypeClasses + MultiWayIf + OverloadedStrings + ScopedTypeVariables + TupleSections + ViewPatterns + + other-modules: + Ema.App + Ema.Example + Ema.Layout + Ema.Route + + hs-source-dirs: src + default-language: Haskell2010 diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..9cd4215 --- /dev/null +++ b/flake.lock @@ -0,0 +1,60 @@ +{ + "nodes": { + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1606424373, + "narHash": "sha256-oq8d4//CJOrVj+EcOaSXvMebvuTkmBJuT5tzlfewUnQ=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "99f1c2157fba4bfe6211a321fd0ee43199025dbf", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-utils": { + "locked": { + "lastModified": 1618217525, + "narHash": "sha256-WGrhVczjXTiswQaoxQ+0PTfbLNeOQM6M36zvLn78AYg=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "c6169a2772643c4a93a0b5ac1c61e296cba68544", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1618447066, + "narHash": "sha256-2f9ydxgdW2igSIe1vmV8buTEpAVQPVhV+OxvlFRTA+Y=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "dcdf30a78a523296b5f9d44fb67afac485b64737", + "type": "github" + }, + "original": { + "owner": "nixos", + "repo": "nixpkgs", + "rev": "dcdf30a78a523296b5f9d44fb67afac485b64737", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-compat": "flake-compat", + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..788f345 --- /dev/null +++ b/flake.nix @@ -0,0 +1,42 @@ +{ + description = "Ema project"; + inputs = { + nixpkgs.url = "github:nixos/nixpkgs/dcdf30a78a523296b5f9d44fb67afac485b64737"; + flake-utils.url = "github:numtide/flake-utils"; + flake-compat = { + url = "github:edolstra/flake-compat"; + flake = false; + }; + }; + outputs = inputs@{ self, nixpkgs, flake-utils, ... }: + flake-utils.lib.eachSystem [ "x86_64-linux" "x86_64-darwin" ] (system: + let + overlays = [ ]; + pkgs = import nixpkgs { inherit system overlays; }; + emaProject = returnShellEnv: + pkgs.haskellPackages.developPackage { + inherit returnShellEnv; + name = "ema"; + root = ./.; + withHoogle = false; + modifier = drv: + pkgs.haskell.lib.addBuildTools drv (with pkgs.haskellPackages; + [ + cabal-install + cabal-fmt + pkgs.nixpkgs-fmt + ghcid + ormolu + haskell-language-server + ]); + }; + in + { + # Built by `nix build .` + defaultPackage = emaProject false; + + # This is used by `nix develop .` to open a shell for use with + # `cabal`, `hlint` and `haskell-language-server` + devShell = emaProject true; + }); +} diff --git a/hie.yaml b/hie.yaml new file mode 100644 index 0000000..08ab24f --- /dev/null +++ b/hie.yaml @@ -0,0 +1,4 @@ +cradle: + cabal: + - path: "./src" + component: "library:ema" diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..9eb132a --- /dev/null +++ b/shell.nix @@ -0,0 +1,13 @@ +(import + ( + let + lock = builtins.fromJSON (builtins.readFile ./flake.lock); + in + fetchTarball { + url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz"; + sha256 = lock.nodes.flake-compat.locked.narHash; + } + ) + { + src = ./.; + }).shellNix diff --git a/src/Ema/App.hs b/src/Ema/App.hs new file mode 100644 index 0000000..48bd86d --- /dev/null +++ b/src/Ema/App.hs @@ -0,0 +1,165 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UndecidableInstances #-} + +module Ema.App where + +import Control.Concurrent.Async (race_) +import Control.Concurrent.STM.TVar (swapTVar) +import Control.Exception (try) +import qualified Data.Text as T +import Ema.Route (IsRoute (..)) +import GHC.IO.Handle (BufferMode (LineBuffering), hSetBuffering) +import NeatInterpolation (text) +import qualified Network.HTTP.Types as H +import qualified Network.Wai as Wai +import qualified Network.Wai.Handler.Warp as Warp +import qualified Network.Wai.Handler.WebSockets as WaiWs +import Network.WebSockets (ConnectionException) +import qualified Network.WebSockets as WS + +-- A mutable variable with change notification +-- +-- one subscriber only (because of TMVar) +-- +-- TODO: Rename to @TVarO@ and put in a module +-- TODO: refactor? https://hackage.haskell.org/package/websockets-0.7.2.0/docs/Network-WebSockets-Util-PubSub.html +data Changing a = Changing + { changingTVar :: TVar a, + changingEvent :: TMVar () + } + +data Ema s r = Ema + { emaModel :: Changing s, + emaRenderRoute :: s -> r -> LByteString + } + +-- | Run Ema live server +-- +-- Continually observe the world, with a concomitant incremental update of the +-- model so as to hot-reload the browser view. +runEma :: + forall model route. + (Show route, IsRoute route) => + Ema model route -> + IO () +runEma ema = do + -- TODO: Use a logging library, in place of managing buffering and using putStrLn + hSetBuffering stdout LineBuffering + hSetBuffering stderr LineBuffering + putStrLn "Launching Ema" + let settings = Warp.setPort 8000 Warp.defaultSettings + currentWsConn :: TVar (Maybe (route, WS.Connection)) <- newTVarIO Nothing + -- bracket helps clean up after ghcid reboot + race_ (notifyWsClient currentWsConn) $ + Warp.runSettings settings $ WaiWs.websocketsOr WS.defaultConnectionOptions (wsApp currentWsConn) httpApp + where + notifyWsClient currentWsConn = do + let log s = putTextLn $ " :: " <> s + ch = changingEvent $ emaModel ema + forever $ do + -- FIXME: 100% cpu usage if currentWsConn is nothing? + -- Just spawn this thread on demand, when conn comes in. + readTVarIO currentWsConn >>= \case + Nothing -> pure () + Just (r, conn) -> do + atomically $ takeTMVar ch + log $ "Sending new HTML for: " <> show r + s <- routeBS r + try (WS.sendTextData conn s) >>= \case + Right () -> pure () + Left (err :: ConnectionException) -> + log $ "notify:: " <> show err + + wsApp currentWsConn pendingConn = do + let log s = putTextLn $ " :: " <> s + log "ws connected" + conn :: WS.Connection <- WS.acceptRequest pendingConn + WS.withPingThread conn 30 (pure ()) $ do + watchingRoute :: Text <- WS.receiveData conn + let pathInfo = filter (/= "") $ T.splitOn "/" $ T.drop 1 watchingRoute + r :: route = fromMaybe (error "invalid route from ws") $ fromSlug $ fromString . toString <$> pathInfo + log $ "Browser loaded: " <> show pathInfo <> " => " <> show r + -- NOTE: only one active client is supported for hot-reload; not + -- bothering with client management for now, because that will require + -- broadcast TChan. + void $ atomically $ swapTVar currentWsConn $ Just (r, conn) + let loop = do + try (WS.receiveDataMessage conn) >>= \case + Right (_ :: WS.DataMessage) -> loop + Left (err :: ConnectionException) -> do + log $ "wsApp:: " <> show err + void $ atomically $ swapTVar currentWsConn Nothing + loop + -- WS.sendTextData conn ("reload" :: Text) + -- WS.sendClose conn ("close" :: Text) + httpApp req f = do + print $ Wai.pathInfo req + let mr = fromSlug $ fromString . toString <$> Wai.pathInfo req + (status, v) <- case mr of + Nothing -> + pure (H.status404, "No route") + Just r -> do + (H.status200,) <$> routeBS r + f $ Wai.responseLBS status [(H.hContentType, "text/html")] v + routeBS :: route -> IO LByteString + routeBS r = do + s <- readTVarIO $ changingTVar $ emaModel ema + pure $ emaRenderRoute ema s r <> wsClientShim + -- TODO: Auto reconnect when server reloads + wsClientShim = + encodeUtf8 + [text| + + |] + +-- | Pure version of @runEma@ that is independent of the world outside the program. +-- +-- Due to purity, there is no model that varies over time. The render function +-- can use any value from the closure. +runEmaPure :: + forall r. + (IsRoute r, Show r) => + -- | How to render a route + (r -> LByteString) -> + IO () +runEmaPure render = do + model <- Changing <$> newTVarIO () <*> newEmptyTMVarIO + let ema = Ema model (const render) + runEma ema diff --git a/src/Ema/Example.hs b/src/Ema/Example.hs new file mode 100644 index 0000000..0cc1dbe --- /dev/null +++ b/src/Ema/Example.hs @@ -0,0 +1,131 @@ +{-# LANGUAGE TypeApplications #-} + +module Ema.Example where + +import Control.Concurrent (threadDelay) +import Control.Concurrent.Async (race_) +import Control.Concurrent.STM.TVar (swapTVar) +import Data.List ((!!)) +import qualified Data.Text as T +import Data.Time + ( UTCTime, + defaultTimeLocale, + formatTime, + getCurrentTime, + ) +import Ema.App (Changing (Changing), Ema (Ema), runEma, runEmaPure) +import qualified Ema.Layout as Layout +import Ema.Route (IsRoute (..), Slug (unSlug)) +import Text.Blaze.Html5 ((!)) +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html5.Attributes as A + +-- First, the simplest example using @runEmaPure@ +-- ---------------------------------------------- + +runHelloWorld :: IO () +runHelloWorld = do + let name :: Text = "Srid" + runEmaPure $ \() -> + encodeUtf8 $ "Hello, " <> name + +-- Next, an example involving routes & impure data (current time) using @runEma@ +-- ----------------------------------------------------------------------------- + +data PeopleRoute + = PR_Index + | PR_Person Text + deriving (Show) + +instance IsRoute PeopleRoute where + toSlug = \case + PR_Index -> mempty + PR_Person name -> one $ fromString . toString $ T.replace " " "_" name + fromSlug = \case + [] -> Just PR_Index + [person] -> Just $ PR_Person (T.replace "_" " " $ unSlug person) + _ -> Nothing + +timeC :: IO (Changing UTCTime, IO ()) +timeC = do + var <- newTVarIO =<< getCurrentTime + ch <- newEmptyTMVarIO + let run = void $ + forever $ do + now <- getCurrentTime + atomically $ do + void $ swapTVar var now + void $ tryPutTMVar ch () + threadDelay $ 1 * 1000000 + pure (Changing var ch, run) + +runSimpleSitePure :: IO () +runSimpleSitePure = do + (model, runTimeC) <- timeC + race_ runTimeC $ + runEma $ + Ema model $ \now r -> + Layout.tailwindSite (H.title "Simple Site") $ + H.div ! A.class_ "container mx-auto" $ do + H.header ! A.class_ "text-4xl font-bold border-b-1" $ "Simple Site!" + case r of + PR_Index -> do + H.p ! A.style "color: red;" $ "Checkout some profiles:" + forM_ ["Srid Ratna", "ema", "Great India"] $ \person -> + H.li $ + routeElem (PR_Person person) $ + H.toMarkup person + PR_Person name -> do + H.header ! A.class_ "text-2xl" $ H.toMarkup $ "Profile of " <> name + H.div $ routeElem PR_Index "Go to Home" + H.footer ! A.class_ "border-t-1 p-2 text-center" $ do + "The current time is: " + H.pre ! A.class_ "text-4xl" $ do + let epoch = fromMaybe 0 . readMaybe @Int $ formatTime defaultTimeLocale "%s" now + colors = ["green", "purple", "red", "blue"] + color = colors !! mod epoch (length colors) + cls = "text-" <> color <> "-500" + H.span ! A.class_ cls $ H.toMarkup $ formatTime defaultTimeLocale "%Y/%m/%d %H:%M:%S" now + where + routeElem r w = + H.a ! A.class_ "text-xl text-purple-500 hover:underline" ! routeHref r $ w + routeHref r = + A.href (fromString . toString $ routeUrl r) + +-- Finally, an advanced example demonstrating how to build something like neuron +-- ----------------------------------------------------------------------------- + +{- +type Zk = Map FilePath () + +runNeuron :: FilePath -> IO () +runNeuron fp = do + s <- neuronModel fp + runEma $ + Ema s $ \_zk () -> do + "TODO" + +neuronModel :: FilePath -> IO (Changing Zk) +neuronModel notebookDir = do + ch <- watchDir notebookDir + buildWorldIncrementally mempty ch $ \zk diff -> + foldl' go zk (Map.toList diff) + where + watchDir :: FilePath -> IO (TBQueue (Map FilePath (Maybe ByteString))) + watchDir = undefined + + buildWorldIncrementally :: + state -> + TBQueue worldChange -> + (state -> worldChange -> state) -> + IO (Changing state) + buildWorldIncrementally _state0 _change _f = + undefined + go zk (k, mv) = case mv of + Nothing -> + -- Deleted! + Map.delete k zk + Just newVal -> + Map.insert k (parseMarkdown newVal) zk + parseMarkdown = const () +-} diff --git a/src/Ema/Layout.hs b/src/Ema/Layout.hs new file mode 100644 index 0000000..455bdd4 --- /dev/null +++ b/src/Ema/Layout.hs @@ -0,0 +1,91 @@ +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE TypeApplications #-} + +module Ema.Layout where + +import NeatInterpolation (text) +import qualified Text.Blaze.Html.Renderer.Utf8 as RU +import Text.Blaze.Html5 ((!)) +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html5.Attributes as A + +-- | A simple and off-the-shelf layout using Tailwind CSS +-- TODO: Allow customizing twindShim preflight classes (see below), including google fonts. +tailwindSite :: H.Html -> H.Html -> LByteString +tailwindSite appHead appBody = RU.renderHtml $ do + H.docType + H.html ! A.lang "en" $ do + H.head $ do + H.meta ! A.charset "UTF-8" + H.meta ! A.name "viewport" ! A.content "width=device-width, initial-scale=1" + appHead + googleFonts + -- Using shim doesn't work very well with hot-reload. + -- TODO: Conditionally use shim, when statically generating the site + -- twindShim' + twindCdn + H.body $ do + appBody + +twindCdn :: H.Html +twindCdn = + H.unsafeByteString . encodeUtf8 $ + [text| + + |] + +twindShim :: H.Html +twindShim = + H.unsafeByteString . encodeUtf8 $ + [text| + + |] + +twindShim' :: H.Html +twindShim' = do + H.script + ! A.type_ "text/javascript" + ! A.src "https://cdn.jsdelivr.net/combine/npm/twind/twind.umd.min.js,npm/twind/observe/observe.umd.min.js" + $ "" + H.script + ! A.type_ "text/javascript" + $ (fromString . toString) twindShimJS' + +twindShimJS' :: Text +twindShimJS' = + [text| + twind.setup({ + theme: { + extend: { + fontFamily: (theme) => ({ + sans: ["DM Sans", theme("fontFamily.sans")], + serif: ["Roboto", theme("fontFamily.serif")] + }) + } + }, + preflight: { + body: { + "@apply": "text-gray-700" + }, + "a:any-link": { + "@apply": "no-underline hover:font-bold" + }, + p: { + "@apply": "mb-2" + }, + "header.pageHeader": { + "@apply": "mb-4 border-l-4 pl-2 hover:(shadow-sm bg-pink-50)" + } + }, + }) + twindObserve.observe(document.documentElement) + |] + +googleFonts :: H.Markup +googleFonts = + -- Using unsafe string only for convenience when copy-pasting from Google Fonts. + H.unsafeByteString . encodeUtf8 $ + [text| + + + |] diff --git a/src/Ema/Route.hs b/src/Ema/Route.hs new file mode 100644 index 0000000..fc287ca --- /dev/null +++ b/src/Ema/Route.hs @@ -0,0 +1,84 @@ +{-# LANGUAGE InstanceSigs #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE TypeFamilies #-} + +module Ema.Route where + +import Data.Default (Default, def) +import qualified Data.Text as T +import System.FilePath (joinPath) + +-- ---- [Slug] ---- + +newtype Slug = Slug {unSlug :: Text} + deriving (Eq) + +instance IsString Slug where + fromString :: HasCallStack => String -> Slug + fromString (toText -> s) = + if "/" `T.isInfixOf` s + then error ("Slug cannot contain a slash: " <> s) + else Slug s + +-- ---- [Route] ---- + +class IsRoute r where + -- | Determine the route for the given URL slug + fromSlug :: [Slug] -> Maybe r + + -- | The URL slug to use for a given route. + toSlug :: r -> [Slug] + + -- | Relative URL to use in "href" + routeUrl :: r -> Text + routeUrl = + routeUrlWithStrategy def + + -- | Relative file path to .html file correspondong to this route. + routeFile :: r -> FilePath + routeFile = + routeFileWithStrategy def + +instance IsRoute () where + fromSlug = \case + [] -> Just () + _ -> Nothing + toSlug () = [] + +-- ---- [UrlStrategy] ---- + +data UrlStrategy + = UrlStrategy_FolderOnly + | -- | Pretty URLs without ugly .html ext or slash-suffix + UrlStrategy_HtmlOnlySansExt + deriving (Eq, Show, Ord) + +instance Default UrlStrategy where + def = UrlStrategy_HtmlOnlySansExt + +routeUrlWithStrategy :: IsRoute r => UrlStrategy -> r -> Text +routeUrlWithStrategy strat r = + case strat of + UrlStrategy_FolderOnly -> + "/" <> T.replace "index.html" "" (toText $ routeFile r) + UrlStrategy_HtmlOnlySansExt -> + -- FIXME: This should replace only at the end, not middle + let fp = toText (routeFile r) + in if + | "index.html" == fp -> + "/" + | "/index.html" `T.isSuffixOf` fp -> + "/" <> T.take (T.length fp - T.length "/index.html") fp + | ".html" `T.isSuffixOf` fp -> + "/" <> T.take (T.length fp - T.length ".html") fp + | otherwise -> + "/" <> fp + +routeFileWithStrategy :: IsRoute r => UrlStrategy -> r -> FilePath +routeFileWithStrategy strat (toSlug -> slugs) = + case strat of + UrlStrategy_FolderOnly -> + joinPath $ fmap (toString . unSlug) slugs <> ["index.html"] + UrlStrategy_HtmlOnlySansExt -> + let (term :| (reverse -> parts)) = fromMaybe ("index" :| []) $ nonEmpty (reverse $ fmap unSlug slugs) + in joinPath $ fmap toString parts <> [toString term <> ".html"]