├── .github └── workflows │ └── test.yml ├── .gitignore ├── CHANGELOG.md ├── LICENCE ├── README.md ├── gleam.toml ├── manifest.toml ├── src ├── htmb.gleam ├── htmb_ffi.erl └── htmb_ffi.mjs └── test └── htmb_test.gleam /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | - main 8 | pull_request: 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | - uses: erlef/setup-beam@v1 16 | with: 17 | otp-version: "25.2" 18 | gleam-version: "0.34.1" 19 | rebar3-version: "3" 20 | - run: gleam format --check src test 21 | - run: gleam deps download 22 | - run: gleam test 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.beam 2 | *.ez 3 | build 4 | erl_crash.dump 5 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## v2.1.0 - 2024-12-07 4 | 5 | - Updated for `gleam_stdlib` v0.45.0. 6 | 7 | ## v2.0.0 - 2024-01-31 8 | 9 | - **[BREAKING]** The package now exclusively targets HTML5 and `render_page` no 10 | longer accepts the `doctype` parameter 11 | ([#2](https://github.com/lpil/htmb/pull/2)) 12 | - [Void elements](https://www.w3.org/TR/2011/WD-html-markup-20110113/syntax.html#void-element) 13 | are now rendered correctly ([#2](https://github.com/lpil/htmb/pull/2)) 14 | 15 | ## v1.1.0 - 2023-11-06 16 | 17 | - Updated for Gleam v0.32.0. 18 | 19 | ## v1.0.1 - 2023-08-12 20 | 21 | - The `escape` function now takes a single argument, while before it erroneously 22 | took two arguments. 23 | 24 | ## v1.0.0 - 2023-08-12 25 | 26 | - Initial release. 27 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2023 onwards, Louis Pilfold . 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | 192 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HyperText Markup Builder 2 | 3 | [![Package Version](https://img.shields.io/hexpm/v/htmb)](https://hex.pm/packages/htmb) 4 | [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/htmb/) 5 | 6 | A tiny HTML builder for Gleam. 7 | 8 | ```gleam 9 | let html = 10 | h("h1", [], [text("Hello, Joe!")]) 11 | |> render 12 | |> string_tree.to_string 13 | assert html == "

Hello, Joe!

" 14 | ``` 15 | 16 | This package doesn't do much. If you'd like more features, check out these 17 | alternatives: 18 | 19 | - [Glemplate](https://hex.pm/packages/glemplate) 20 | - [Lustre](https://hex.pm/packages/lustre) 21 | - [Nakai](https://hex.pm/packages/nakai) 22 | - [React Gleam](https://hex.pm/packages/react_gleam) 23 | 24 | 25 | ## Installation 26 | 27 | ```sh 28 | gleam add htmb 29 | ``` 30 | 31 | The documentation can be found at . 32 | -------------------------------------------------------------------------------- /gleam.toml: -------------------------------------------------------------------------------- 1 | name = "htmb" 2 | version = "2.1.0" 3 | gleam = ">= 0.32.0" 4 | description = "A tiny HTML builder for Gleam" 5 | licences = ["Apache-2.0"] 6 | 7 | repository = { type = "github", user = "lpil", repo = "htmb" } 8 | links = [ 9 | { title = "Sponsor", href = "https://github.com/sponsors/lpil" }, 10 | ] 11 | 12 | [dependencies] 13 | gleam_stdlib = ">= 0.45.0 and < 2.0.0" 14 | 15 | [dev-dependencies] 16 | gleeunit = "~> 1.0" 17 | -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | # This file was generated by Gleam 2 | # You typically do not need to edit this file 3 | 4 | packages = [ 5 | { name = "gleam_stdlib", version = "0.45.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "206FCE1A76974AECFC55AEBCD0217D59EDE4E408C016E2CFCCC8FF51278F186E" }, 6 | { name = "gleeunit", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "F7A7228925D3EE7D0813C922E062BFD6D7E9310F0BEE585D3A42F3307E3CFD13" }, 7 | ] 8 | 9 | [requirements] 10 | gleam_stdlib = { version = ">= 0.45.0 and < 2.0.0" } 11 | gleeunit = { version = "~> 1.0" } 12 | -------------------------------------------------------------------------------- /src/htmb.gleam: -------------------------------------------------------------------------------- 1 | //// # HyperText Markup Builder 2 | //// 3 | //// A tiny HTML builder for Gleam. 4 | //// 5 | //// ```gleam 6 | //// let html = 7 | //// h("h1", [], [text("Hello, Joe!")]) 8 | //// |> render 9 | //// |> string_tree.to_string 10 | //// assert html == "

Hello, Joe!

" 11 | //// ``` 12 | //// 13 | //// This package doesn't do much. If you'd like more features, check out these 14 | //// alternatives: 15 | //// 16 | //// - [Glemplate](https://hex.pm/packages/glemplate) 17 | //// - [Lustre](https://hex.pm/packages/lustre) 18 | //// - [Nakai](https://hex.pm/packages/nakai) 19 | //// - [React Gleam](https://hex.pm/packages/react_gleam) 20 | //// 21 | 22 | import gleam/list 23 | import gleam/string 24 | import gleam/string_tree.{type StringTree} 25 | 26 | pub type Html 27 | 28 | pub fn h( 29 | tag: String, 30 | attributes: List(#(String, String)), 31 | children: List(Html), 32 | ) -> Html { 33 | let opening = 34 | "<" 35 | |> string.append(tag) 36 | |> list.fold(attributes, _, attribute) 37 | |> string.append(">") 38 | |> string_tree.from_string 39 | 40 | // Void elements do not have a closing part and cannot accept children 41 | // See https://www.w3.org/TR/2011/WD-html-markup-20110113/syntax.html#syntax-elements 42 | case tag { 43 | // See https://www.w3.org/TR/2011/WD-html-markup-20110113/syntax.html#void-elements 44 | "area" 45 | | "base" 46 | | "br" 47 | | "col" 48 | | "command" 49 | | "embed" 50 | | "hr" 51 | | "img" 52 | | "input" 53 | | "keygen" 54 | | "link" 55 | | "meta" 56 | | "param" 57 | | "source" 58 | | "track" 59 | | "wbr" -> opening 60 | _ -> 61 | opening 62 | |> list.fold(children, _, child) 63 | |> string_tree.append(" tag <> ">") 64 | } 65 | |> dangerous_unescaped_fragment 66 | } 67 | 68 | pub fn text(content: String) -> Html { 69 | content 70 | |> do_escape("", _) 71 | |> string_tree.from_string 72 | |> dangerous_unescaped_fragment 73 | } 74 | 75 | pub fn escape(content: String) -> String { 76 | do_escape("", content) 77 | } 78 | 79 | fn do_escape(escaped: String, content: String) -> String { 80 | case string.pop_grapheme(content) { 81 | Ok(#("<", xs)) -> do_escape(escaped <> "<", xs) 82 | Ok(#(">", xs)) -> do_escape(escaped <> ">", xs) 83 | Ok(#("&", xs)) -> do_escape(escaped <> "&", xs) 84 | Ok(#(x, xs)) -> do_escape(escaped <> x, xs) 85 | Error(_) -> escaped <> content 86 | } 87 | } 88 | 89 | pub fn render_page(html: Html) -> StringTree { 90 | render(html) 91 | |> string_tree.prepend("") 92 | } 93 | 94 | fn attribute(content: String, attribute: #(String, String)) -> String { 95 | content <> " " <> attribute.0 <> "=\"" <> attribute.1 <> "\"" 96 | } 97 | 98 | fn child(siblings: StringTree, child: Html) -> StringTree { 99 | string_tree.append_tree(siblings, render(child)) 100 | } 101 | 102 | @external(erlang, "htmb_ffi", "identity") 103 | @external(javascript, "./htmb_ffi.mjs", "identity") 104 | pub fn dangerous_unescaped_fragment(s: StringTree) -> Html 105 | 106 | @external(erlang, "htmb_ffi", "identity") 107 | @external(javascript, "./htmb_ffi.mjs", "identity") 108 | pub fn render(element: Html) -> StringTree 109 | -------------------------------------------------------------------------------- /src/htmb_ffi.erl: -------------------------------------------------------------------------------- 1 | -module(htmb_ffi). 2 | -export([identity/1]). 3 | identity(X) -> X. 4 | -------------------------------------------------------------------------------- /src/htmb_ffi.mjs: -------------------------------------------------------------------------------- 1 | export function identity(x) { 2 | return x; 3 | } 4 | -------------------------------------------------------------------------------- /test/htmb_test.gleam: -------------------------------------------------------------------------------- 1 | import gleam/string_tree 2 | import gleeunit 3 | import gleeunit/should 4 | import htmb.{h, text} 5 | 6 | pub fn main() { 7 | gleeunit.main() 8 | } 9 | 10 | pub fn hello_joe_test() { 11 | h("h1", [], [text("Hello Joe!")]) 12 | |> htmb.render 13 | |> string_tree.to_string 14 | |> should.equal("

Hello Joe!

") 15 | } 16 | 17 | pub fn void_test() { 18 | h("img", [#("src", "/tilly.jpg"), #("alt", "A perfect cat")], [ 19 | text("Will not show up!"), 20 | ]) 21 | |> htmb.render 22 | |> string_tree.to_string 23 | |> should.equal("\"A") 24 | } 25 | 26 | pub fn page_test() { 27 | h("html", [#("lang", "en")], [ 28 | h("head", [], [ 29 | h("title", [], [text("htmb test")]), 30 | h("meta", [#("charset", "utf-8")], []), 31 | ]), 32 | h("body", [], [ 33 | h("h1", [], [text("Hello, Joe!")]), 34 | h("script", [], [text("console.log('Hello, Joe!');")]), 35 | ]), 36 | ]) 37 | |> htmb.render_page 38 | |> string_tree.to_string 39 | |> should.equal( 40 | "htmb test

Hello, Joe!

", 41 | ) 42 | } 43 | 44 | pub fn escaping_test() { 45 | h("h1", [], [text("")]) 46 | |> htmb.render 47 | |> string_tree.to_string 48 | |> should.equal("

<script>alert('&');</script>

") 49 | } 50 | --------------------------------------------------------------------------------