From 91e72ac49ee92195dabe48c655431659405e296c Mon Sep 17 00:00:00 2001 From: "sashakoshka@tebibyte.media" Date: Thu, 5 Dec 2024 13:15:22 -0500 Subject: [PATCH] Initial commit --- LICENSE | 674 +++++++++++++++++++++++++++++++++++++++ README.md | 8 + cmd/step/main.go | 72 +++++ cmd/stepd/handler.go | 130 ++++++++ cmd/stepd/main.go | 98 ++++++ document.go | 64 ++++ environment.go | 136 ++++++++ error.go | 14 + frontmatter.go | 46 +++ frontmatter_test.go | 52 +++ go.mod | 23 ++ go.sum | 49 +++ plugin.go | 17 + providers/all.go | 13 + providers/math/math.go | 40 +++ providers/os/os.go | 64 ++++ providers/sprig/sprig.go | 17 + 17 files changed, 1517 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 cmd/step/main.go create mode 100644 cmd/stepd/handler.go create mode 100644 cmd/stepd/main.go create mode 100644 document.go create mode 100644 environment.go create mode 100644 error.go create mode 100644 frontmatter.go create mode 100644 frontmatter_test.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 plugin.go create mode 100644 providers/all.go create mode 100644 providers/math/math.go create mode 100644 providers/os/os.go create mode 100644 providers/sprig/sprig.go diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3101a5d --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# STEP + +*Scriptable Template Processor* + +STEP extends Go's HTML templates into a powerful backend scripting language. It +includes support for plugins to further enhance its functionality. It is +designed to run behind an HTTP reverse proxy, such as +[Caddy](https://caddyserver.com/). diff --git a/cmd/step/main.go b/cmd/step/main.go new file mode 100644 index 0000000..ac18df4 --- /dev/null +++ b/cmd/step/main.go @@ -0,0 +1,72 @@ +// Command step evaluates STEP files and prints the result to standard out. +package main + +import "os" +import "io" +import "fmt" +import "context" +import "git.tebibyte.media/sashakoshka/step" +import "git.tebibyte.media/sashakoshka/go-cli" +import "git.tebibyte.media/sashakoshka/step/providers" + +func main () { + // TODO: add some kind of way to play an http request to a STEP file, + // and have it be executed as if the request actually happened. + // TODO: initialize plugins on startup and tear them down on finish + + // parse command line arguments + flagMetadata := cli.NewFlag ( + 'm', "metadata", + "Print document metadata as front matter") + cmd := cli.New ( + "Evaluate STEP files and print the result", + flagMetadata, + cli.NewHelp()) + cmd.Syntax = "[OPTIONS]... FILE" + cmd.ParseOrExit(os.Args) + if len(cmd.Args) > 1 { + cmd.Usage() + os.Exit(2) + } + + // set up the environment + environment := step.Environment { } + environment.FuncProviders = providers.All() + err := environment.Init(context.Background()) + handleErr(cmd, err) + + // load and execute the document + var document *step.Document + if len(cmd.Args) > 0 { + document, err = environment.Parse(cmd.Args[0]) + } else { + document, err = environment.ParseReader(".", os.Stdin) + } + handleErr(cmd, err) + if flagMetadata.Value == "true" { + writeMetadata(os.Stdout, document) + } + err = document.Execute(os.Stdout, step.ExecutionData { }) + handleErr(cmd, err) +} + +func handleErr (cmd *cli.Cli, err error) { + if err != nil { + cmd.Errorln(err) + os.Exit(1) + } +} + +func writeMetadata (output io.Writer, document *step.Document) { + fmt.Fprintln(output, "---") + if document.Author != "" { + fmt.Fprintf(output, "Author: %s\n", document.Author) + } + if document.Title != "" { + fmt.Fprintf(output, "Title: %s\n", document.Title) + } + if document.Extends != "" { + fmt.Fprintf(output, "Extends: %s\n", document.Extends) + } + fmt.Fprintln(output, "---") +} diff --git a/cmd/stepd/handler.go b/cmd/stepd/handler.go new file mode 100644 index 0000000..e0d2637 --- /dev/null +++ b/cmd/stepd/handler.go @@ -0,0 +1,130 @@ +package main + +import "log" +import "fmt" +import "path" +import "io/fs" +import "strings" +import "net/http" +import "html/template" +import "path/filepath" +import "git.tebibyte.media/sashakoshka/step" +import "git.tebibyte.media/sashakoshka/goutil/container" + +type handler struct { + environment *step.Environment + directories bool + stepExt ucontainer.Set[string] + index []string +} + +func (this *handler) ServeHTTP (res http.ResponseWriter, req *http.Request) { + remoteAddr := req.RemoteAddr + if addr := req.Header.Get("CF-Connecting-IP"); addr != "" { + remoteAddr = fmt.Sprintf("%s --CF-> %s", addr, req.RemoteAddr) + } else if addr := req.Header.Get("X-Forwarded-For"); addr != "" { + remoteAddr = fmt.Sprintf("%s --??-> %s", addr, req.RemoteAddr) + } + log.Println("(i)", req.Method, req.URL, "from", remoteAddr) + // TODO log all this stuff + filesystem := this.environment.GetFS() + + // normalize path + pat := req.URL.Path + if !strings.HasPrefix(pat, "/") { + pat = "/" + pat + req.URL.Path = pat + } + pat = path.Clean(req.URL.Path) + + info, err := statFile(filesystem, pathToName(pat)) + if err != nil { + // TODO need more detailed error, should allow specifying error + // documents + this.serveError(res, req, http.StatusNotFound, req.URL) + return + } + if info.IsDir() { + // try to find an index + for _, base := range this.index { + currentPath := path.Join(pat, base) + info, err := statFile(filesystem, pathToName(currentPath)) + if err != nil { continue } + if info.IsDir() { continue } + this.serveFile(res, req, filesystem, currentPath) + return + } + + // TODO: serve a directory + // have a custom directory listing document that takes in a list + // of the files in the directory and the path to the directory + // as data + + if !this.directories { + this.serveError(res, req, http.StatusForbidden, req.URL) + return + } + } + + this.serveFile(res, req, filesystem, pat) +} + +func (this *handler) serveFile (res http.ResponseWriter, req *http.Request, filesystem fs.FS, pat string) { + name := pathToName(pat) + if !this.stepExt.Has(filepath.Ext(name)) { + // just a normal file + http.ServeFileFS(res, req, this.environment.GetFS(), name) + return + } + + // parse and execute + document, err := this.environment.Parse(name) + if err != nil { + this.serveError(res, req, http.StatusInternalServerError, err) + return + } + err = document.Execute(res, step.ExecutionData { + Data: req, + }) + if err != nil { + if tmplErr, ok := err.(*template.Error); ok { + log.Printf ( + "ERR document %s:%s: %s\n", + name, tmplErr.Line, tmplErr.Description) + } else { + log.Printf("ERR document %s: %v\n", name, err) + } + } +} + +func (this *handler) serveError (res http.ResponseWriter, req *http.Request, status int, message any) { + res.Header().Add("Content-Type", "text/plain") + res.WriteHeader(status) + // TODO: allow customization with templates + if message == nil { + fmt.Fprintf(res, "%d %s\n", status, http.StatusText(status)) + } else { + fmt.Fprintf(res, "%d %s: %v\n", status, http.StatusText(status), message) + } + log.Printf("ERR %d %s: %v\n", status, http.StatusText(status), message) +} + +func statFile (filesystem fs.FS, name string) (fs.FileInfo, error) { + if filesystem, ok := filesystem.(fs.StatFS); ok { + return filesystem.Stat(name) + } + file, err := filesystem.Open(name) + if err != nil { return nil, err } + defer file.Close() + return file.Stat() +} + +func pathToName (pat string) string { + if strings.HasPrefix(pat, "/") { + pat = strings.TrimPrefix(pat, "/") + } + if pat == "" { + return "." + } + return pat +} diff --git a/cmd/stepd/main.go b/cmd/stepd/main.go new file mode 100644 index 0000000..b83d8c3 --- /dev/null +++ b/cmd/stepd/main.go @@ -0,0 +1,98 @@ +// Command stepd provides an HTTP server that automatically executes STEP files. +package main + +import "os" +import "log" +import "time" +import "errors" +import "context" +import "net/http" +import "git.tebibyte.media/sashakoshka/step" +import "git.tebibyte.media/sashakoshka/go-cli" +import "git.tebibyte.media/sashakoshka/step/providers" +import "git.tebibyte.media/sashakoshka/goutil/container" +import "git.tebibyte.media/sashakoshka/go-service/daemon" +import "git.tebibyte.media/sashakoshka/go-service/routines" + +func main () { + // parse command line arguments + flagAddress := cli.NewInputFlag ( + 'a', "address", + "The address to host the server on", + ":8080", cli.ValString) + flagDirectories := cli.NewFlag ( + 'd', "directories", + "Serve the contents of directories") + cmd := cli.New ( + "Run an HTTP server that automaticaly executes STEP files", + flagAddress, + flagDirectories, + cli.NewHelp()) + cmd.ParseOrExit(os.Args) + if len(cmd.Args) > 0 { + cmd.Usage() + os.Exit(1) + } + + log.Println(`==========| STEP |===========`) + log.Println(`Scriptable Template Processor`) + log.Println(`... initializing`) + + // set up the environment + environment := step.Environment { } + environment.FuncProviders = providers.All() + err := environment.Init(context.Background()) + if err != nil { log.Fatal(err) } + + // set up the HTTP handler + handler := handler { + environment: &environment, + directories: flagDirectories.Value == "true", + stepExt: ucontainer.NewSet(".step"), + index: []string { "index.step", "index.html", "index" }, + } + + // set up the HTTP server + httpServer := http.Server { + Addr: flagAddress.Value, + Handler: &handler, + } + + // set up the routine manager + httpServerRoutine := httpServerRoutine(httpServer) + manager := routines.Manager { + Routines: []routines.Routine { + &httpServerRoutine, + }, + } + + log.Println(`.// initialized.`) + + ctx, done := context.WithCancel(context.Background()) + daemon.OnSigint(done) + + log.Printf("(i) listening on %s\n", httpServer.Addr) + if err := manager.Run(ctx); err != nil && !errors.Is(err, context.Canceled) { + log.Fatalln(err) + } +} + +type httpServerRoutine http.Server + +func (this *httpServerRoutine) Run (ctx context.Context) error { + ctx, done := context.WithCancel(ctx) + defer done() + server := http.Server(*this) + go func () { + <- ctx.Done() + shutdownCtx, _ := context.WithTimeout ( + context.Background(), + 16 * time.Second) + server.Shutdown(shutdownCtx) + } () + err := server.ListenAndServe() + if ctx.Err() != nil { + return ctx.Err() + } + return err +} diff --git a/document.go b/document.go new file mode 100644 index 0000000..5f7e458 --- /dev/null +++ b/document.go @@ -0,0 +1,64 @@ +package step + +import "io" +import "time" +import "strings" +import "html/template" + +// Document represents a STEP file. +type Document struct { + Author string + Title string + Extends string + + // WORM: + environment *Environment + frontMatter FrontMatter + name string + parseTime time.Time + template *template.Template +} + +// Execute executes this document and writes the result to the output. This +// method is safe for concurrent use by multiple goroutines. +func (this *Document) Execute (output io.Writer, data ExecutionData) error { + if this.Extends == "" { + // no parent + return this.template.Execute(output, data) + } + + // execute into string builder + outputBuilder := strings.Builder { } + err := this.template.Execute(&outputBuilder, data) + if err != nil { return err } + + // execute parent with this document's result + parent, err := this.environment.Parse(this.Extends) + if err != nil { return err } + return parent.Execute(output, ExecutionData { + Data: data.Data, + Child: &ExecutionResult { + Author: this.Author, + Title: this.Title, + Extends: this.Extends, + FrontMatter: this.frontMatter, + Body: template.HTML(outputBuilder.String()), + }, + }) +} + +// ExecutionData is data made available to documents as they are being exeucted. +type ExecutionData struct { + Data any // Custom data + Child *ExecutionResult // The child document's result, if applicable +} + +// ExecutionResult is the result of executing a document. +type ExecutionResult struct { + Author string + Title string + Extends string + + FrontMatter FrontMatter + Body template.HTML +} diff --git a/environment.go b/environment.go new file mode 100644 index 0000000..720be7f --- /dev/null +++ b/environment.go @@ -0,0 +1,136 @@ +package step + +import "os" +import "io" +import "time" +import "io/fs" +import "context" +import "path/filepath" +import "html/template" +import "git.tebibyte.media/sashakoshka/goutil/sync" + +// TODO change Parse to Load, ParseReader to Parse + +// Environment is an execution environment for STEP documents. It can parse +// documents into itself and resolve dependencies among them. +type Environment struct { + // FS, if specified, is the filesystem that this environment will load + // documents from. Its methods must be safe for concurrent execution. + FS fs.FS + // FuncProviders is a slice of FuncMap providers whoose functions will + // be available to any documents this environment processes. + FuncProviders []FuncProvider + + documents usync.Locker[map[string] *Document] + funcMap template.FuncMap +} + +// Init must be called before utilizng the environment. +func (this *Environment) Init (ctx context.Context) error { + this.documents = usync.NewLocker(make(map[string] *Document)) + this.funcMap = make(template.FuncMap) + for _, provider := range this.FuncProviders { + funcMap := provider.FuncMap() + if funcMap == nil { continue } + for name, function := range funcMap { + this.funcMap[name] = function + } + } + return ctx.Err() +} + +// Parse parses the named document and returns it. The name is treated as a file +// path relative to the current working directory. Documents are cached into the +// environment once parsed, and are returned on subsequent calls that have the +// same name. +func (this *Environment) Parse (name string) (*Document, error) { + name = filepath.Clean(name) + input, err := this.GetFS().Open(name) + if err != nil { + // if the file couldn't be opened, delete from cache in case the + // file was deleted + this.Unload(name) + return nil, err + } + defer input.Close() + info, err := input.Stat() + if err != nil { return nil, err } + return this.parse(name, info.ModTime(), input) +} + +// ParseReader is like Parse, but parses a reader and just takes your word for +// it that it corresponds to the file of the given name. It always re-parses. +func (this *Environment) ParseReader (name string, input io.Reader) (*Document, error) { + name = filepath.Clean(name) + return this.parse(name, time.Now(), input) +} + +// Unload removes a named document. It will be reloaded if necessary. +func (this *Environment) Unload (name string) { + documents, done := this.documents.Borrow() + defer done() + delete(documents, name) +} + +func (this *Environment) parse (name string, modTime time.Time, input io.Reader) (*Document, error) { + documents, done := this.documents.Borrow() + defer done() + + // check cache + if document, ok := documents[name]; ok { + if modTime.Before(document.parseTime) { + return document, nil + } + } + + // read entire file and split into front matter and body + buffer, err := io.ReadAll(input) + if err != nil { return nil, err } + frontMatter, body, err := SplitFrontMatter(string(buffer)) + if err != nil { return nil, err } + + // assemble the document struct + document := &Document { + environment: this, + name: name, + parseTime: time.Now(), + frontMatter: frontMatter, + template: template.New(name), + } + if author, ok := frontMatter["author"]; ok { + document.Author = author + } + if title, ok := frontMatter["title"]; ok { + document.Title = title + } + if extends, ok := frontMatter["extends"]; ok { + document.Extends = extends + } + + // parse template from the body + document.template.Funcs(this.funcMap) + _, err = document.template.Parse(body) + if err != nil { return nil, err } + + // add template functions which need a document pointer for context + for _, provider := range this.FuncProviders { + provider, ok := provider.(FuncProviderFor) + if !ok { continue } + funcMap := provider.FuncMapFor(document) + if funcMap == nil { continue } + for name, function := range funcMap { + this.funcMap[name] = function + } + } + + documents[name] = document + return document, nil +} + +// GetFS returns the effective filesystem that the environment uses. +func (this *Environment) GetFS () fs.FS { + if this.FS == nil { + return os.DirFS(".") + } + return this.FS +} diff --git a/error.go b/error.go new file mode 100644 index 0000000..80e039a --- /dev/null +++ b/error.go @@ -0,0 +1,14 @@ +package step + +// Error enumerates errors common to this package. +type Error string; const ( + ErrCircularInheritance Error = "Circular inheritance" + ErrFrontMatterMalformed Error = "Front matter is malformed" + ErrFrontMatterNeverClosed Error = "Front matter is never closed" + ErrFrontMatterDuplicateKey Error = "Duplicate key in front matter" +) + +// Error fulfills the error interface. +func (err Error) Error () string { + return string(err) +} diff --git a/frontmatter.go b/frontmatter.go new file mode 100644 index 0000000..a18c15a --- /dev/null +++ b/frontmatter.go @@ -0,0 +1,46 @@ +package step + +import "strings" + +const frontMatterRule = "---" + +// FrontMatter represents optional metadata that can occur at the very start of +// a document. +type FrontMatter = map[string] string + +// SplitFrontMatter parses the front matter (if it exists), returning a map +// representing it along with the rest of the input as a string. If there is no +// front matter, an empty map will be returned. +func SplitFrontMatter (input string) (FrontMatter, string, error) { + if !strings.HasPrefix(input, frontMatterRule + "\n") { + // no front matter at all + return FrontMatter { }, input, nil + } + input = strings.TrimPrefix(input, frontMatterRule) + index := strings.Index(input, "\n" + frontMatterRule + "\n") + if index < 0 { + return nil, "", ErrFrontMatterNeverClosed + } + frontMatterRaw := input[:index] + body := input[index + len(frontMatterRule) + 2:] + frontMatter := make(FrontMatter) + for _, line := range strings.Split(frontMatterRaw, "\n") { + line = strings.TrimSpace(line) + if line == "" { continue } + key, value, ok := strings.Cut(line, ":") + if !ok { + return nil, "", ErrFrontMatterMalformed + } + key = strings.ToLower(strings.TrimSpace(key)) + value = strings.TrimSpace(value) + if key == "" { + return nil, "", ErrFrontMatterMalformed + } + if _, exists := frontMatter[key]; exists { + return nil, "", ErrFrontMatterDuplicateKey + } + frontMatter[key] = value + } + + return frontMatter, body, nil +} diff --git a/frontmatter_test.go b/frontmatter_test.go new file mode 100644 index 0000000..621f949 --- /dev/null +++ b/frontmatter_test.go @@ -0,0 +1,52 @@ +package step + +import "testing" + +const quickBrownFox = "The quick brown fox jumped over the lazy dog." + +func TestSplitFrontMatter (test *testing.T) { + correctBody := +`this is some sample text +--- +theres another hr that shouldnt +break anything +break: anything +` + frontMatter, body, err := SplitFrontMatter( +`--- +FOO: baR + fOoo: Bar +Shouldn't break anything: --- + +this : that +Sentence: ` + quickBrownFox + ` +--- +` + correctBody) + if err != nil { + test.Fatal(err) + } + + test.Log("BODY:") + test.Log(body) + if body != correctBody { + test.Fatal("body is not correct") + } + + test.Log("FRONT MATTER:") + test.Log(frontMatter) + value0, ok := frontMatter["foo"] + if !ok { test.Fatal("missing key") } + value1, ok := frontMatter["fooo"] + if !ok { test.Fatal("missing key") } + value2, ok := frontMatter["shouldn't break anything"] + if !ok { test.Fatal("missing key") } + value3, ok := frontMatter["this"] + if !ok { test.Fatal("missing key") } + value4, ok := frontMatter["sentence"] + if !ok { test.Fatal("missing key") } + if value0 != "baR" { test.Fatal("value is not correct") } + if value1 != "Bar" { test.Fatal("value is not correct") } + if value2 != "---" { test.Fatal("value is not correct") } + if value3 != "that" { test.Fatal("value is not correct") } + if value4 != quickBrownFox { test.Fatal("value is not correct") } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..5e72c7c --- /dev/null +++ b/go.mod @@ -0,0 +1,23 @@ +module git.tebibyte.media/sashakoshka/step + +go 1.23.3 + +require ( + git.tebibyte.media/sashakoshka/go-cli v0.1.1 + git.tebibyte.media/sashakoshka/go-service v0.1.1 + git.tebibyte.media/sashakoshka/goutil v0.6.0 + github.com/Masterminds/sprig/v3 v3.3.0 +) + +require ( + dario.cat/mergo v1.0.1 // indirect + github.com/Masterminds/goutils v1.1.1 // indirect + github.com/Masterminds/semver/v3 v3.3.0 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/huandu/xstrings v1.5.0 // indirect + github.com/mitchellh/copystructure v1.2.0 // indirect + github.com/mitchellh/reflectwalk v1.0.2 // indirect + github.com/shopspring/decimal v1.4.0 // indirect + github.com/spf13/cast v1.7.0 // indirect + golang.org/x/crypto v0.26.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..96b956d --- /dev/null +++ b/go.sum @@ -0,0 +1,49 @@ +dario.cat/mergo v1.0.1 h1:Ra4+bf83h2ztPIQYNP99R6m+Y7KfnARDfID+a+vLl4s= +dario.cat/mergo v1.0.1/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk= +git.tebibyte.media/sashakoshka/go-cli v0.1.1 h1:g68h/OElSFw82f61oefT6a2n1JqIADdHlTkkw16Uwy0= +git.tebibyte.media/sashakoshka/go-cli v0.1.1/go.mod h1:JFA3wSdRkXxa4iQJWHfe3DokiG7Dh2XUJBzPmuVlbuY= +git.tebibyte.media/sashakoshka/go-service v0.1.1 h1:WhDK532iB3hrVILih2+rJmRtCctXIoj2uEWMm8tU4+E= +git.tebibyte.media/sashakoshka/go-service v0.1.1/go.mod h1:qPtzuqB1psUWZrmy3XTU1dZHHhVNHHP2pSBkpzlTazk= +git.tebibyte.media/sashakoshka/goutil v0.6.0 h1:mJ479aPl8wvL7pdzcTj/y3BvwEXUSp8ygTQoQG1uLKg= +git.tebibyte.media/sashakoshka/goutil v0.6.0/go.mod h1:UF5frNyvtAuaP6JwkbvLqp3DltmDIm9G+ZXU8lP3oVQ= +github.com/Masterminds/goutils v1.1.1 h1:5nUrii3FMTL5diU80unEVvNevw1nH4+ZV4DSLVJLSYI= +github.com/Masterminds/goutils v1.1.1/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU= +github.com/Masterminds/semver/v3 v3.3.0 h1:B8LGeaivUe71a5qox1ICM/JLl0NqZSW5CHyL+hmvYS0= +github.com/Masterminds/semver/v3 v3.3.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM= +github.com/Masterminds/sprig/v3 v3.3.0 h1:mQh0Yrg1XPo6vjYXgtf5OtijNAKJRNcTdOOGZe3tPhs= +github.com/Masterminds/sprig/v3 v3.3.0/go.mod h1:Zy1iXRYNqNLUolqCpL4uhk6SHUMAOSCzdgBfDb35Lz0= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8= +github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/huandu/xstrings v1.5.0 h1:2ag3IFq9ZDANvthTwTiqSSZLjDc+BedvHPAp5tJy2TI= +github.com/huandu/xstrings v1.5.0/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw= +github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s= +github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ= +github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8= +github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs= +github.com/shopspring/decimal v1.4.0 h1:bxl37RwXBklmTi0C79JfXCEBD1cqqHt0bbgBAGFp81k= +github.com/shopspring/decimal v1.4.0/go.mod h1:gawqmDU56v4yIKSwfBSFip1HdCCXN8/+DMd9qYNcwME= +github.com/spf13/cast v1.7.0 h1:ntdiHjuueXFgm5nzDRdOS4yfT43P5Fnud6DH50rz/7w= +github.com/spf13/cast v1.7.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= +github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= +golang.org/x/crypto v0.26.0 h1:RrRspgV4mU+YwB4FYnuBoKsUapNIL5cohGAmSH3azsw= +golang.org/x/crypto v0.26.0/go.mod h1:GY7jblb9wI+FOo5y8/S2oY4zWP07AkOJ4+jxCqdqn54= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugin.go b/plugin.go new file mode 100644 index 0000000..a3ed815 --- /dev/null +++ b/plugin.go @@ -0,0 +1,17 @@ +package step + +import "html/template" + +// FuncProvider provides a template.FuncMap. +type FuncProvider interface { + // FuncMap provides a template.FuncMap. It may return nil, in which case + // its result is simply not considered. + FuncMap () template.FuncMap +} + +// FuncProviderFor is an object that provides +type FuncProviderFor interface { + // FuncMap provides a template.FuncMap, given a particular document. It + // may return nil, in which case its result is simply not considered. + FuncMapFor (*Document) template.FuncMap +} diff --git a/providers/all.go b/providers/all.go new file mode 100644 index 0000000..3f9a0f5 --- /dev/null +++ b/providers/all.go @@ -0,0 +1,13 @@ +package providers + +import "git.tebibyte.media/sashakoshka/step" +import fpos "git.tebibyte.media/sashakoshka/step/providers/os" +import fpsprig "git.tebibyte.media/sashakoshka/step/providers/sprig" + +// All returns a slice of all providers defined in sub-packages. +func All () []step.FuncProvider { + return []step.FuncProvider { + new(fpsprig.Provider), + new(fpos.Provider), + } +} diff --git a/providers/math/math.go b/providers/math/math.go new file mode 100644 index 0000000..cc1997d --- /dev/null +++ b/providers/math/math.go @@ -0,0 +1,40 @@ +package math + +import "math" +import "html/template" +import "git.tebibyte.media/sashakoshka/step" + +var _ step.FuncProvider = new(Provider) + +// Provider provides math functions. +type Provider struct { + +} + +// FuncMap fulfills the step.FuncProvider interface. +func (this *Provider) FuncMap () template.FuncMap { + return template.FuncMap { + "add": funcAdd, + "sub": funcSub, + "mul": funcMul, + "div": funcDiv, + "pow": math.Pow, + "sqrt": math.Sqrt, + } +} + +func funcAdd (a, b float64) float64 { + return a + b +} + +func funcSub (a, b float64) float64 { + return a - b +} + +func funcMul (a, b float64) float64 { + return a * b +} + +func funcDiv (a, b float64) float64 { + return a / b +} diff --git a/providers/os/os.go b/providers/os/os.go new file mode 100644 index 0000000..ff0c41d --- /dev/null +++ b/providers/os/os.go @@ -0,0 +1,64 @@ +package os + +import "os" +import "io" +import "html/template" +import "git.tebibyte.media/sashakoshka/step" + +var _ step.FuncProvider = new(Provider) + +// Provider provides OS functions. +type Provider struct { + +} + +// FuncMap fulfills the step.FuncProvider interface. +func (this *Provider) FuncMap () template.FuncMap { + return template.FuncMap { + "fileExists": funcFileExists, + "readFile": funcReadFile, + "readDir": funcReadDir, + "writeFile": funcWriteFile, + "renameFile": funcRenameFile, + "removeFile": funcRemoveFile, + } +} + +func funcFileExists (name string) (bool) { + _, err := os.Stat(name) + return err == nil +} + +func funcReadFile (name string) (string, error) { + file, err := os.Open(name) + if err != nil { return "", err } + defer file.Close() + buffer, err := io.ReadAll(file) + if err != nil { return "", err } + return string(buffer), nil +} + +func funcReadDir (name string) ([]string, error) { + entries, err := os.ReadDir(name) + if err != nil { return nil, err } + names := make([]string, len(entries)) + for index, entry := range entries { + names[index] = entry.Name() + } + return names, nil +} + +func funcWriteFile (name, content string) error { + file, err := os.Create(name) + if err != nil { return err } + _, err = io.WriteString(file, content) + return err +} + +func funcRenameFile (name, newName string) error { + return os.Rename(name, newName) +} + +func funcRemoveFile (name string) error { + return os.Remove(name) +} diff --git a/providers/sprig/sprig.go b/providers/sprig/sprig.go new file mode 100644 index 0000000..13c51dd --- /dev/null +++ b/providers/sprig/sprig.go @@ -0,0 +1,17 @@ +package sprig + +import "html/template" +import "github.com/Masterminds/sprig/v3" +import "git.tebibyte.media/sashakoshka/step" + +var _ step.FuncProvider = new(Provider) + +// Provider provides all Sprig functions. +type Provider struct { + +} + +// FuncMap fulfills the step.FuncProvider interface. +func (this *Provider) FuncMap () template.FuncMap { + return sprig.FuncMap() +}