From 69c2550f448e1cd3b3d3f5dfcfb33940dfe8e1ce Mon Sep 17 00:00:00 2001 From: Max Richter Date: Tue, 19 Aug 2025 19:06:08 +0200 Subject: [PATCH] feat: added keyword codec (partially works) --- LICENSE.md | 636 ++++++++++++++++++ README.md | 23 + parser/decoders/decoder.go | 2 + parser/decoders/hashtags.go | 19 + parser/decoders/yaml.go | 10 +- parser/matcher/matcher.go | 2 +- parser/matcher/matcher_test.go | 63 +- registry/templates/Article.marka | 6 +- registry/templates/Recipe.marka | 2 + registry/templates/Review.marka | 42 ++ renderer/codec/codec.go | 34 - renderer/encoders/encoders.go | 69 ++ renderer/{codec => encoders}/list.go | 2 +- renderer/{codec => encoders}/yaml.go | 2 +- renderer/renderer.go | 33 +- template/blocks.go | 6 + template/codecs.go | 13 +- testdata/data/complex_front_matter/input.md | 20 + .../data/complex_front_matter/output.json | 26 + .../data/recipe_no_description/output.json | 1 + testdata/data/recipe_salad/input.md | 1 + testdata/data/recipe_salad/output.json | 5 + testdata/data/typo_section_header/input.md | 14 + testdata/data/typo_section_header/output.json | 13 + 24 files changed, 964 insertions(+), 80 deletions(-) create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 parser/decoders/hashtags.go create mode 100644 registry/templates/Review.marka delete mode 100644 renderer/codec/codec.go create mode 100644 renderer/encoders/encoders.go rename renderer/{codec => encoders}/list.go (98%) rename renderer/{codec => encoders}/yaml.go (98%) create mode 100644 testdata/data/complex_front_matter/input.md create mode 100644 testdata/data/complex_front_matter/output.json create mode 100644 testdata/data/typo_section_header/input.md create mode 100644 testdata/data/typo_section_header/output.json diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..85c7c69 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,636 @@ +# GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +Copyright (C) 2007 [Free Software Foundation, Inc.](http://fsf.org/) + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and +other kinds of works. + +The licenses for most software and other practical works are designed to take +away your freedom to share and change the works. By contrast, the GNU General +Public License is intended to guarantee your freedom to share and change all +versions of a program--to make sure it remains free software for all its users. +We, the Free Software Foundation, use the GNU General Public License for most +of our software; it applies also to any other work released this way by its +authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for them if you wish), that you +receive source code or can get it if you want it, that you can change the +software or use pieces of it in new free programs, and that you know you can do +these things. + +To protect your rights, we need to prevent others from denying you these rights +or asking you to surrender the rights. Therefore, you have certain +responsibilities if you distribute copies of the software, or if you modify it: +responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must pass on to the recipients the same freedoms that you received. +You must make sure that they, too, receive or can get the source code. And you +must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: + + 1. assert copyright on the software, and + 2. offer you this License giving you legal permission to copy, distribute + and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that +there is no warranty for this free software. For both users' and authors' sake, +the GPL requires that modified versions be marked as changed, so that their +problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. This +is fundamentally incompatible with the aim of protecting users' freedom to +change the software. The systematic pattern of such abuse occurs in the area of +products for individuals to use, which is precisely where it is most +unacceptable. Therefore, we have designed this version of the GPL to prohibit +the practice for those products. If such problems arise substantially in other +domains, we stand ready to extend this provision to those domains in future +versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on +general-purpose computers, but in those that do, we wish to avoid the special +danger that patents applied to a free program could make it effectively +proprietary. To prevent this, the GPL assures that patents cannot be used to +render the program non-free. + +The precise terms and conditions for copying, distribution and modification +follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +*This License* refers to version 3 of the GNU General Public License. + +*Copyright* also means copyright-like laws that apply to other kinds of works, +such as semiconductor masks. + +*The Program* refers to any copyrightable work licensed under this License. +Each licensee is addressed as *you*. *Licensees* and *recipients* may be +individuals or organizations. + +To *modify* a work means to copy from or adapt all or part of the work in a +fashion requiring copyright permission, other than the making of an exact copy. +The resulting work is called a *modified version* of the earlier work or a work +*based on* the earlier work. + +A *covered work* means either the unmodified Program or a work based on the +Program. + +To *propagate* a work means to do anything with it that, without permission, +would make you directly or secondarily liable for infringement under applicable +copyright law, except executing it on a computer or modifying a private copy. +Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To *convey* a work means any kind of propagation that enables other parties to +make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays *Appropriate Legal Notices* to the +extent that it includes a convenient and prominently visible feature that + + 1. displays an appropriate copyright notice, and + 2. tells the user that there is no warranty for the work (except to the + extent that warranties are provided), that licensees may convey the work + under this License, and how to view a copy of this License. + +If the interface presents a list of user commands or options, such as a menu, a +prominent item in the list meets this criterion. + +### 1. Source Code. + +The *source code* for a work means the preferred form of the work for making +modifications to it. *Object code* means any non-source form of a work. + +A *Standard Interface* means an interface that either is an official standard +defined by a recognized standards body, or, in the case of interfaces specified +for a particular programming language, one that is widely used among developers +working in that language. + +The *System Libraries* of an executable work include anything, other than the +work as a whole, that (a) is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and (b) serves only +to enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code +form. A *Major Component*, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on +which the executable work runs, or a compiler used to produce the work, or an +object code interpreter used to run it. + +The *Corresponding Source* for a work in object code form means all the source +code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. +However, it does not include the work's System Libraries, or general-purpose +tools or generally available free programs which are used unmodified in +performing those activities but which are not part of the work. For example, +Corresponding Source includes interface definition files associated with source +files for the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, such as +by intimate data communication or control flow between those subprograms and +other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright on +the Program, and are irrevocable provided the stated conditions are met. This +License explicitly affirms your unlimited permission to run the unmodified +Program. The output from running a covered work is covered by this License only +if the output, given its content, constitutes a covered work. This License +acknowledges your rights of fair use or other equivalent, as provided by +copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey +covered works to others for the sole purpose of having them make modifications +exclusively for you, or provide you with facilities for running those works, +provided that you comply with the terms of this License in conveying all +material for which you do not control copyright. Those thus making or running +the covered works for you must do so exclusively on your behalf, under your +direction and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes it +unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure +under any applicable law fulfilling obligations under article 11 of the WIPO +copyright treaty adopted on 20 December 1996, or similar laws prohibiting or +restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention is +effected by exercising rights under this License with respect to the covered +work, and you disclaim any intention to limit operation or modification of the +work as a means of enforcing, against the work's users, your or third parties' +legal rights to forbid circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive it, +in any medium, provided that you conspicuously and appropriately publish on +each copy an appropriate copyright notice; keep intact all notices stating that +this License and any non-permissive terms added in accord with section 7 apply +to the code; keep intact all notices of the absence of any warranty; and give +all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may +offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce it +from the Program, in the form of source code under the terms of section 4, +provided that you also meet all of these conditions: + + - a) The work must carry prominent notices stating that you modified it, and + giving a relevant date. + - b) The work must carry prominent notices stating that it is released under + this License and any conditions added under section 7. This requirement + modifies the requirement in section 4 to *keep intact all notices*. + - c) You must license the entire work, as a whole, under this License to + anyone who comes into possession of a copy. This License will therefore + apply, along with any applicable section 7 additional terms, to the whole + of the work, and all its parts, regardless of how they are packaged. This + License gives no permission to license the work in any other way, but it + does not invalidate such permission if you have separately received it. + - d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your work need + not make them do so. + +A compilation of a covered work with other separate and independent works, +which are not by their nature extensions of the covered work, and which are not +combined with it such as to form a larger program, in or on a volume of a +storage or distribution medium, is called an *aggregate* if the compilation and +its resulting copyright are not used to limit the access or legal rights of the +compilation's users beyond what the individual works permit. Inclusion of a +covered work in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections 4 +and 5, provided that you also convey the machine-readable Corresponding Source +under the terms of this License, in one of these ways: + + - a) Convey the object code in, or embodied in, a physical product (including + a physical distribution medium), accompanied by the Corresponding Source + fixed on a durable physical medium customarily used for software + interchange. + - b) Convey the object code in, or embodied in, a physical product (including + a physical distribution medium), accompanied by a written offer, valid for + at least three years and valid for as long as you offer spare parts or + customer support for that product model, to give anyone who possesses the + object code either + 1. a copy of the Corresponding Source for all the software in the product + that is covered by this License, on a durable physical medium + customarily used for software interchange, for a price no more than your + reasonable cost of physically performing this conveying of source, or + 2. access to copy the Corresponding Source from a network server at no + charge. + - c) Convey individual copies of the object code with a copy of the written + offer to provide the Corresponding Source. This alternative is allowed only + occasionally and noncommercially, and only if you received the object code + with such an offer, in accord with subsection 6b. + - d) Convey the object code by offering access from a designated place + (gratis or for a charge), and offer equivalent access to the Corresponding + Source in the same way through the same place at no further charge. You + need not require recipients to copy the Corresponding Source along with the + object code. If the place to copy the object code is a network server, the + Corresponding Source may be on a different server operated by you or a + third party) that supports equivalent copying facilities, provided you + maintain clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the Corresponding + Source, you remain obligated to ensure that it is available for as long as + needed to satisfy these requirements. + - e) Convey the object code using peer-to-peer transmission, provided you + inform other peers where the object code and Corresponding Source of the + work are being offered to the general public at no charge under subsection + 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A *User Product* is either + + 1. a *consumer product*, which means any tangible personal property which is + normally used for personal, family, or household purposes, or + 2. anything designed or sold for incorporation into a dwelling. + +In determining whether a product is a consumer product, doubtful cases shall be +resolved in favor of coverage. For a particular product received by a +particular user, *normally used* refers to a typical or common use of that +class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, +the product. A product is a consumer product regardless of whether the product +has substantial commercial, industrial or non-consumer uses, unless such uses +represent the only significant mode of use of the product. + +*Installation Information* for a User Product means any methods, procedures, +authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified +version of its Corresponding Source. The information must suffice to ensure +that the continued functioning of the modified object code is in no case +prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as part of a +transaction in which the right of possession and use of the User Product is +transferred to the recipient in perpetuity or for a fixed term (regardless of +how the transaction is characterized), the Corresponding Source conveyed under +this section must be accompanied by the Installation Information. But this +requirement does not apply if neither you nor any third party retains the +ability to install modified object code on the User Product (for example, the +work has been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates for a +work that has been modified or installed by the recipient, or for the User +Product in which it has been modified or installed. Access to a network may be +denied when the modification itself materially and adversely affects the +operation of the network or violates the rules and protocols for communication +across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord +with this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require +no special password or key for unpacking, reading or copying. + +### 7. Additional Terms. + +*Additional permissions* are terms that supplement the terms of this License by +making exceptions from one or more of its conditions. Additional permissions +that are applicable to the entire Program shall be treated as though they were +included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may +be used separately under those permissions, but the entire Program remains +governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when +you modify the work.) You may place additional permissions on material, added +by you to a covered work, for which you have or can give appropriate copyright +permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + + - a) Disclaiming warranty or limiting liability differently from the terms of + sections 15 and 16 of this License; or + - b) Requiring preservation of specified reasonable legal notices or author + attributions in that material or in the Appropriate Legal Notices displayed + by works containing it; or + - c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in reasonable + ways as different from the original version; or + - d) Limiting the use for publicity purposes of names of licensors or authors + of the material; or + - e) Declining to grant rights under trademark law for use of some trade + names, trademarks, or service marks; or + - f) Requiring indemnification of licensors and authors of that material by + anyone who conveys the material (or modified versions of it) with + contractual assumptions of liability to the recipient, for any liability + that these contractual assumptions directly impose on those licensors and + authors. + +All other non-permissive additional terms are considered *further restrictions* +within the meaning of section 10. If the Program as you received it, or any +part of it, contains a notice stating that it is governed by this License along +with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or +conveying under this License, you may add to a covered work material governed +by the terms of that license document, provided that the further restriction +does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, +in the relevant source files, a statement of the additional terms that apply to +those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements +apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly provided +under this License. Any attempt otherwise to propagate or modify it is void, +and will automatically terminate your rights under this License (including any +patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated + + - a) provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and + - b) permanently, if the copyright holder fails to notify you of the + violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated +permanently if the copyright holder notifies you of the violation by some +reasonable means, this is the first time you have received notice of violation +of this License (for any work) from that copyright holder, and you cure the +violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. If +your rights have been terminated and not permanently reinstated, you do not +qualify to receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy +of the Program. Ancillary propagation of a covered work occurring solely as a +consequence of using peer-to-peer transmission to receive a copy likewise does +not require acceptance. However, nothing other than this License grants you +permission to propagate or modify any covered work. These actions infringe +copyright if you do not accept this License. Therefore, by modifying or +propagating a covered work, you indicate your acceptance of this License to do +so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives a +license from the original licensors, to run, modify and propagate that work, +subject to this License. You are not responsible for enforcing compliance by +third parties with this License. + +An *entity transaction* is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered work +results from an entity transaction, each party to that transaction who receives +a copy of the work also receives whatever licenses to the work the party's +predecessor in interest had or could give under the previous paragraph, plus a +right to possession of the Corresponding Source of the work from the +predecessor in interest, if the predecessor has it or can get it with +reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights +granted or affirmed under this License. For example, you may not impose a +license fee, royalty, or other charge for exercise of rights granted under this +License, and you may not initiate litigation (including a cross-claim or +counterclaim in a lawsuit) alleging that any patent claim is infringed by +making, using, selling, offering for sale, or importing the Program or any +portion of it. + +### 11. Patents. + +A *contributor* is a copyright holder who authorizes use under this License of +the Program or a work on which the Program is based. The work thus licensed is +called the contributor's *contributor version*. + +A contributor's *essential patent claims* are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, +that would be infringed by some manner, permitted by this License, of making, +using, or selling its contributor version, but do not include claims that would +be infringed only as a consequence of further modification of the contributor +version. For purposes of this definition, *control* includes the right to grant +patent sublicenses in a manner consistent with the requirements of this +License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent +license under the contributor's essential patent claims, to make, use, sell, +offer for sale, import and otherwise run, modify and propagate the contents of +its contributor version. + +In the following three paragraphs, a *patent license* is any express agreement +or commitment, however denominated, not to enforce a patent (such as an express +permission to practice a patent or covenant not to sue for patent +infringement). To *grant* such a patent license to a party means to make such +an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of +charge and under the terms of this License, through a publicly available +network server or other readily accessible means, then you must either + + 1. cause the Corresponding Source to be so available, or + 2. arrange to deprive yourself of the benefit of the patent license for this + particular work, or + 3. arrange, in a manner consistent with the requirements of this License, to + extend the patent license to downstream recipients. + +*Knowingly relying* means you have actual knowledge that, but for the patent +license, your conveying the covered work in a country, or your recipient's use +of the covered work in a country, would infringe one or more identifiable +patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a +patent license to some of the parties receiving the covered work authorizing +them to use, propagate, modify or convey a specific copy of the covered work, +then the patent license you grant is automatically extended to all recipients +of the covered work and works based on it. + +A patent license is *discriminatory* if it does not include within the scope of +its coverage, prohibits the exercise of, or is conditioned on the non-exercise +of one or more of the rights that are specifically granted under this License. +You may not convey a covered work if you are a party to an arrangement with a +third party that is in the business of distributing software, under which you +make payment to the third party based on the extent of your activity of +conveying the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory patent +license + + - a) in connection with copies of the covered work conveyed by you (or copies + made from those copies), or + - b) primarily for and in connection with specific products or compilations + that contain the covered work, unless you entered into that arrangement, or + that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to +you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not excuse +you from the conditions of this License. If you cannot convey a covered work so +as to satisfy simultaneously your obligations under this License and any other +pertinent obligations, then as a consequence you may not convey it at all. For +example, if you agree to terms that obligate you to collect a royalty for +further conveying from those to whom you convey the Program, the only way you +could satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have permission to +link or combine any covered work with a work licensed under version 3 of the +GNU Affero General Public License into a single combined work, and to convey +the resulting work. The terms of this License will continue to apply to the +part which is the covered work, but the special requirements of the GNU Affero +General Public License, section 13, concerning interaction through a network +will apply to the combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program specifies +that a certain numbered version of the GNU General Public License *or any later +version* applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by +the Free Software Foundation. If the Program does not specify a version number +of the GNU General Public License, you may choose any version ever published by +the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the +GNU General Public License can be used, that proxy's public statement of +acceptance of a version permanently authorizes you to choose that version for +the Program. + +Later license versions may give you additional or different permissions. +However, no additional obligations are imposed on any author or copyright +holder as a result of your choosing to follow a later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE +LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER +PARTIES PROVIDE THE PROGRAM *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE +THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE +PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY +HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot +be given local legal effect according to their terms, reviewing courts shall +apply local law that most closely approximates an absolute waiver of all civil +liability in connection with the Program, unless a warranty or assumption of +liability accompanies a copy of the Program in return for a fee. + +## END OF TERMS AND CONDITIONS ### + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively state the exclusion +of warranty; and each file should have at least the *copyright* line and a +pointer to where the full notice is found. + + + 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 +[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/). + +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider +it more useful to permit linking proprietary applications with the library. If +this is what you want to do, use the GNU Lesser General Public License instead +of this License. But first, please read +[http://www.gnu.org/philosophy/why-not-lgpl.html](http://www.gnu.org/philosophy/why-not-lgpl.html). diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b722be --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Marka + +Bidirectional mapping between Markdown and JSON (Schema.org-style) via small, declarative templates. Marka enables you to parse Markdown to JSON and render JSON back to Markdown using the same template. + +## Features + +* **Bidirectional Mapping:** Convert Markdown to JSON and JSON to Markdown using a single template. +* **Declarative Templates:** Define your mappings with concise, easy-to-understand templates. +* **JSON Schema Validation:** Validate parsed JSON against Schema.org entities using JSON Schema. + +## Docker Image (CRUD API) + +A Docker image is available to transform a specified directory into a CRUD API. This allows you to expose your Markdown-to-JSON mappings as a web service. + +To run the Docker image: +```bash +docker run -p 8080:8080 -v /path/to/your/data:/app/data marka-crud-api +``` +*(Replace `/path/to/your/data` with the absolute path to the directory you want to expose.)* + +## License + +This project is licensed under the [GNU General Public License v3.0](LICENSE.md). diff --git a/parser/decoders/decoder.go b/parser/decoders/decoder.go index f52bdb8..73a4b6b 100644 --- a/parser/decoders/decoder.go +++ b/parser/decoders/decoder.go @@ -17,6 +17,8 @@ func ParseBlock(input string, block template.Block) (any, error) { return Yaml(input, block) case template.CodecList: return List(input, block) + case template.CodecHashtags: + return Keywords(input, block) } return nil, fmt.Errorf("unknown codec: %s", block.Codec) } diff --git a/parser/decoders/hashtags.go b/parser/decoders/hashtags.go new file mode 100644 index 0000000..d9e7f94 --- /dev/null +++ b/parser/decoders/hashtags.go @@ -0,0 +1,19 @@ +package decoders + +import ( + "strings" + + "git.max-richter.dev/max/marka/template" +) + +func Keywords(input string, block template.Block) (value any, error error) { + var tags []any + split := strings.SplitSeq(input, "#") + for tag := range split { + tag = strings.TrimSpace(tag) + if tag != "" { + tags = append(tags, tag) + } + } + return tags, nil +} diff --git a/parser/decoders/yaml.go b/parser/decoders/yaml.go index 2bcc16b..9a544e5 100644 --- a/parser/decoders/yaml.go +++ b/parser/decoders/yaml.go @@ -18,16 +18,24 @@ func Yaml(input string, block template.Block) (value any, error error) { var out any for _, f := range block.Fields { - if f.Hidden { + + if f.Path == "@schema" { continue } + if f.CodecType == template.CodecConst { if f.Value != nil { out = utils.SetPathValue(f.Path, f.Value, out) } } else { + if value, ok := res[f.Path]; ok { + out = utils.SetPathValue(f.Path, value, out) + continue + } + if value, ok := renderUtils.GetValueFromPath(res, f.Path); ok { out = utils.SetPathValue(f.Path, value, out) + continue } } } diff --git a/parser/matcher/matcher.go b/parser/matcher/matcher.go index ac1ac16..55e506d 100644 --- a/parser/matcher/matcher.go +++ b/parser/matcher/matcher.go @@ -32,7 +32,7 @@ func MatchBlocksFuzzy(markdown string, templateBlocks []template.Block, maxDist lastIndex := 0 for i, b := range templateBlocks { if b.Type == template.MatchingBlock { - start, end := FuzzyFind(markdown, lastIndex, b.GetContent(), 0.3) + start, end := FuzzyFind(markdown, lastIndex, b.GetContent(), 0.2) if end != -1 { if i > 0 { previousBlock := templateBlocks[i-1] diff --git a/parser/matcher/matcher_test.go b/parser/matcher/matcher_test.go index 2de36d0..cae1b6c 100644 --- a/parser/matcher/matcher_test.go +++ b/parser/matcher/matcher_test.go @@ -49,23 +49,22 @@ func TestFuzzyBlockMatch(t *testing.T) { t.FailNow() } - for _, b := range blocks { - fmt.Printf("block: %#v\n", b) - } - matches := matcher.MatchBlocksFuzzy(string(recipeMd), blocks, 0.3) expected := []struct { value string }{ { - value: "author.name: Max Richter", + value: "@type: Recipe\nauthor.name: Max Richter", }, { value: "Baguette", }, { - value: "My favourite baguette recipe", + value: "\nMy favourite baguette recipe", + }, + { + value: "", }, { value: "- Flour\n- Water\n- Salt", @@ -83,5 +82,57 @@ func TestFuzzyBlockMatch(t *testing.T) { if expected[i].value != m.GetContent() { t.Errorf("Match %d did not match expected: %q", i, m.GetContent()) } + fmt.Printf("match: %s->%q\n", m.Block.Path, m.GetContent()) + } +} + +func TestFuzzyBlockMatchSalad(t *testing.T) { + recipeMd := testdata.Read(t, "recipe_salad/input.md") + schemaMd, err := registry.GetTemplate("Recipe") + if err != nil { + t.Errorf("Failed to load template: %s", err.Error()) + t.FailNow() + } + blocks, err := template.CompileTemplate(schemaMd) + if err != nil { + t.Errorf("Failed to compile template: %s", err.Error()) + t.FailNow() + } + + matches := matcher.MatchBlocksFuzzy(string(recipeMd), blocks, 0.3) + + expected := []struct { + value string + }{ + { + value: "@type: Recipe\nauthor.name: Alex Chef\ncookTime: PT0M\nimage: https://example.com/salad.jpg\nprepTime: PT10M\nrecipeYield: 2 servings", + }, + { + value: "Simple Salad", + }, + { + value: "#healthy #salad", + }, + { + value: "A quick green salad.", + }, + { + value: "- 100 g lettuce\n- 5 cherry tomatoes\n- 1 tbsp olive oil\n- Pinch of salt", + }, + { + value: "1. Wash and dry the lettuce.\n2. Halve the cherry tomatoes.\n3. Toss with olive oil and salt.\n", + }, + } + + for i, m := range matches { + + if i > len(expected)-1 { + t.Errorf("No expected result for match: %d -> %q", i, m.GetContent()) + t.FailNow() + } + if expected[i].value != m.GetContent() { + t.Errorf("Match %d did not match expected: %q", i, m.GetContent()) + } + fmt.Printf("match: %s->%q\n", m.Block.Path, m.GetContent()) } } diff --git a/registry/templates/Article.marka b/registry/templates/Article.marka index 3719104..f6175f3 100644 --- a/registry/templates/Article.marka +++ b/registry/templates/Article.marka @@ -21,9 +21,11 @@ value: Person hidden: true - path: datePublished + - path: articleSection } --- -# { .headline } +# { headline } +{ keywords | hashtags } -{ .articleBody } +{ articleBody } diff --git a/registry/templates/Recipe.marka b/registry/templates/Recipe.marka index c625a77..94e83ce 100644 --- a/registry/templates/Recipe.marka +++ b/registry/templates/Recipe.marka @@ -20,6 +20,7 @@ hidden: true value: Person - path: author.name + - path: author.email - path: datePublished - path: prepTime - path: cookTime @@ -28,6 +29,7 @@ --- # { name | text } +{ keywords | hashtags } { description | text } diff --git a/registry/templates/Review.marka b/registry/templates/Review.marka new file mode 100644 index 0000000..cf49de2 --- /dev/null +++ b/registry/templates/Review.marka @@ -0,0 +1,42 @@ +--- +{ + path: . + codec: yaml + fields: + - path: "@context" + codec: const + value: https://schema.org + hidden: true + - path: "@schema" + codec: const + value: Review + hidden: true + - path: "@type" + codec: const + value: Review + - path: tmdbId + - path: image + - path: author.name + - path: author.@type + codec: const + value: Person + hidden: true + - path: datePublished + - path: itemReviewed.name + - path: reviewRating.ratingValue + - path: reviewRating.bestRating + codec: const + value: 5 + hidden: true + - path: reviewRating.worstRating + codec: const + value: 1 + hidden: true + - path: reviewBody +} +--- + +# { itemReviewed.name } +{ keywords | hashtags } + +{ reviewBody } diff --git a/renderer/codec/codec.go b/renderer/codec/codec.go deleted file mode 100644 index 00e65a0..0000000 --- a/renderer/codec/codec.go +++ /dev/null @@ -1,34 +0,0 @@ -// Package codec contains functions for rendering template.Block to a string. -package codec - -import ( - "fmt" - - "git.max-richter.dev/max/marka/renderer/utils" - "git.max-richter.dev/max/marka/template" -) - -// RenderBlock renders a single template block using the provided data. -func RenderBlock(block template.Block, data map[string]any) (string, error) { - if block.Type == template.MatchingBlock { - return block.GetContent(), nil - } - - value, found := utils.GetValueFromPath(data, block.Path) - if !found { - return "", nil // If not found and not required, return empty string - } - - switch block.Codec { - case template.CodecText: - return fmt.Sprintf("%v", value), nil - case template.CodecYaml: - return RenderYaml(data, block) - case template.CodecList: - return RenderList(value, block) - case template.CodecConst: - return fmt.Sprintf("%v", block.Value), nil - default: - return "", fmt.Errorf("unknown codec: %s for path '%s'", block.Codec, block.Path) - } -} diff --git a/renderer/encoders/encoders.go b/renderer/encoders/encoders.go new file mode 100644 index 0000000..6086d0e --- /dev/null +++ b/renderer/encoders/encoders.go @@ -0,0 +1,69 @@ +// Package encoders contains functions for rendering template.Block to a string. +package encoders + +import ( + "bytes" + "fmt" + "strings" + + "git.max-richter.dev/max/marka/renderer/utils" + "git.max-richter.dev/max/marka/template" +) + +const emptyBlock = "\uE000" + +func fixRenderedBlock(input string) string { + input = strings.ReplaceAll(input, "'@type':", "@type:") + input = strings.ReplaceAll(input, "'@context':", "@context:") + if len(input) == 0 { + return emptyBlock + } + return input +} + +// RenderBlock renders a single template block using the provided data. +func RenderBlock(block template.Block, data map[string]any) (string, error) { + if block.Type == template.MatchingBlock { + return block.GetContent(), nil + } + + value, found := utils.GetValueFromPath(data, block.Path) + if !found { + return "", nil // If not found and not required, return empty string + } + + switch block.Codec { + case template.CodecText: + return fmt.Sprintf("%v", value), nil + case template.CodecYaml: + return RenderYaml(data, block) + case template.CodecList: + return RenderList(value, block) + case template.CodecConst: + return fmt.Sprintf("%v", block.Value), nil + default: + return "", fmt.Errorf("unknown codec: %s for path '%s'", block.Codec, block.Path) + } +} + +func Render(data map[string]any, blocks []template.Block) (string, error) { + var buffer bytes.Buffer + for _, block := range blocks { + renderedContent, err := RenderBlock(block, data) + if err != nil { + return "", fmt.Errorf("failed to render block for path '%s': %w", block.Path, err) + } + renderedContent = fixRenderedBlock(renderedContent) + buffer.WriteString(renderedContent) + } + + outputString := buffer.String() + outputString = strings.ReplaceAll(outputString, "\n\n"+emptyBlock+"\n\n", "\n\n") + outputString = strings.ReplaceAll(outputString, "\n"+emptyBlock+"\n", "\n") + outputString = strings.ReplaceAll(outputString, emptyBlock, "") + if !strings.HasSuffix(outputString, "\n") { + outputString += "\n" + } + + return outputString, nil +} diff --git a/renderer/codec/list.go b/renderer/encoders/list.go similarity index 98% rename from renderer/codec/list.go rename to renderer/encoders/list.go index 9241634..8d11fc4 100644 --- a/renderer/codec/list.go +++ b/renderer/encoders/list.go @@ -1,4 +1,4 @@ -package codec +package encoders import ( "bytes" diff --git a/renderer/codec/yaml.go b/renderer/encoders/yaml.go similarity index 98% rename from renderer/codec/yaml.go rename to renderer/encoders/yaml.go index 73cc622..a5eed49 100644 --- a/renderer/codec/yaml.go +++ b/renderer/encoders/yaml.go @@ -1,4 +1,4 @@ -package codec +package encoders import ( "fmt" diff --git a/renderer/renderer.go b/renderer/renderer.go index a9d7214..3ce8d89 100644 --- a/renderer/renderer.go +++ b/renderer/renderer.go @@ -2,28 +2,15 @@ package renderer import ( - "bytes" "encoding/json" "fmt" - "strings" "git.max-richter.dev/max/marka/registry" - "git.max-richter.dev/max/marka/renderer/codec" + "git.max-richter.dev/max/marka/renderer/encoders" "git.max-richter.dev/max/marka/template" "git.max-richter.dev/max/marka/validator" ) -const emptyBlock = "\uE000" - -func fixRenderedBlock(input string) string { - input = strings.ReplaceAll(input, "'@type':", "@type:") - input = strings.ReplaceAll(input, "'@context':", "@context:") - if len(input) == 0 { - return emptyBlock - } - return input -} - func RenderFile(rawJSON []byte) ([]byte, error) { // 1) parse json var data map[string]any @@ -57,21 +44,9 @@ func RenderFile(rawJSON []byte) ([]byte, error) { } // 6) render the template with the blocks - var buffer bytes.Buffer - for _, block := range compiledTemplate { - renderedContent, err := codec.RenderBlock(block, data) - if err != nil { - return nil, fmt.Errorf("failed to render block for path '%s': %w", block.Path, err) - } - renderedContent = fixRenderedBlock(renderedContent) - buffer.WriteString(renderedContent) - } - - outputString := buffer.String() - outputString = strings.ReplaceAll(outputString, "\n\n"+emptyBlock+"\n\n", "\n\n") - outputString = strings.ReplaceAll(outputString, emptyBlock, "") - if !strings.HasSuffix(outputString, "\n") { - outputString += "\n" + outputString, err := encoders.Render(data, compiledTemplate) + if err != nil { + return nil, fmt.Errorf("failed to render template: %w", err) } return []byte(outputString), nil diff --git a/template/blocks.go b/template/blocks.go index 24f2b2e..37a5c87 100644 --- a/template/blocks.go +++ b/template/blocks.go @@ -72,6 +72,12 @@ func parseShortTemplate(input string) (Block, error) { switch strings.TrimSpace(option) { case "number": block.Codec = CodecNumber + case "text": + block.Codec = CodecText + case "hashtags": + block.Codec = CodecHashtags + default: + return block, fmt.Errorf("unknown codec option: %s", option) } } } diff --git a/template/codecs.go b/template/codecs.go index 96d8703..e4dcfac 100644 --- a/template/codecs.go +++ b/template/codecs.go @@ -6,11 +6,12 @@ import "fmt" type CodecType string const ( - CodecText CodecType = "text" - CodecNumber CodecType = "number" - CodecYaml CodecType = "yaml" - CodecList CodecType = "list" - CodecConst CodecType = "const" + CodecText CodecType = "text" + CodecNumber CodecType = "number" + CodecYaml CodecType = "yaml" + CodecList CodecType = "list" + CodecConst CodecType = "const" + CodecHashtags CodecType = "hashtags" ) func parseCodecType(input string) (CodecType, error) { @@ -25,6 +26,8 @@ func parseCodecType(input string) (CodecType, error) { return CodecText, nil case "const": return CodecConst, nil + case "hashtags": + return CodecHashtags, nil } return CodecText, fmt.Errorf("unknown codec: '%s'", input) } diff --git a/testdata/data/complex_front_matter/input.md b/testdata/data/complex_front_matter/input.md new file mode 100644 index 0000000..ad9d3f2 --- /dev/null +++ b/testdata/data/complex_front_matter/input.md @@ -0,0 +1,20 @@ +--- +@type: Book +name: The Great Book +author: + @type: Person + name: Jane Doe + email: jane.doe@example.com +tags: + - fiction + - adventure +chapters: + - name: Chapter 1 + pages: 20 + - name: Chapter 2 + pages: 30 +--- + +# The Great Book + +This is the content of the great book. \ No newline at end of file diff --git a/testdata/data/complex_front_matter/output.json b/testdata/data/complex_front_matter/output.json new file mode 100644 index 0000000..93f098d --- /dev/null +++ b/testdata/data/complex_front_matter/output.json @@ -0,0 +1,26 @@ +{ + "@context": "https://schema.org", + "@type": "Book", + "name": "The Great Book", + "author": { + "@type": "Person", + "name": "Jane Doe", + "email": "jane.doe@example.com" + }, + "tags": [ + "fiction", + "adventure" + ], + "chapters": [ + { + "name": "Chapter 1", + "pages": 20 + }, + { + "name": "Chapter 2", + "pages": 30 + } + ], + "headline": "The Great Book", + "articleBody": "This is the content of the great book." +} \ No newline at end of file diff --git a/testdata/data/recipe_no_description/output.json b/testdata/data/recipe_no_description/output.json index d67cc65..3b2ae3f 100644 --- a/testdata/data/recipe_no_description/output.json +++ b/testdata/data/recipe_no_description/output.json @@ -1,5 +1,6 @@ { "@context": "https://schema.org", + "@schema": "Recipe", "@type": "Recipe", "name": "Simple Salad", "image": "https://example.com/salad.jpg", diff --git a/testdata/data/recipe_salad/input.md b/testdata/data/recipe_salad/input.md index 3699b22..7d39d7a 100644 --- a/testdata/data/recipe_salad/input.md +++ b/testdata/data/recipe_salad/input.md @@ -8,6 +8,7 @@ recipeYield: 2 servings --- # Simple Salad +#healthy #salad A quick green salad. diff --git a/testdata/data/recipe_salad/output.json b/testdata/data/recipe_salad/output.json index 6ff5606..6e5163d 100644 --- a/testdata/data/recipe_salad/output.json +++ b/testdata/data/recipe_salad/output.json @@ -1,5 +1,6 @@ { "@context": "https://schema.org", + "@schema": "Recipe", "@type": "Recipe", "name": "Simple Salad", "image": "https://example.com/salad.jpg", @@ -7,6 +8,10 @@ "@type": "Person", "name": "Alex Chef" }, + "keywords": [ + "healthy", + "salad" + ], "description": "A quick green salad.", "prepTime": "PT10M", "cookTime": "PT0M", diff --git a/testdata/data/typo_section_header/input.md b/testdata/data/typo_section_header/input.md new file mode 100644 index 0000000..a38af47 --- /dev/null +++ b/testdata/data/typo_section_header/input.md @@ -0,0 +1,14 @@ +--- +@type: Recipe +name: Typo Recipe +--- + +# Typo Recipe + +## Ingredints +- Item 1 +- Item 2 + +## Stps +1. Step 1 +2. Step 2 \ No newline at end of file diff --git a/testdata/data/typo_section_header/output.json b/testdata/data/typo_section_header/output.json new file mode 100644 index 0000000..a8fdd75 --- /dev/null +++ b/testdata/data/typo_section_header/output.json @@ -0,0 +1,13 @@ +{ + "@context": "https://schema.org", + "@type": "Recipe", + "name": "Typo Recipe", + "recipeIngredient": [ + "Item 1", + "Item 2" + ], + "recipeInstructions": [ + "Step 1", + "Step 2" + ] +} \ No newline at end of file