added more content to dynamicHTMLs; fixed some implementions and...

RandomHashTags · RandomHashTags · commit a13a8c38598b · 2024-10-11T00:44:19.000-05:00
- updated dynamic benchmark png
- update README a little
diff --git a/Benchmarks/Benchmarks/Benchmarks/Benchmarks.swift b/Benchmarks/Benchmarks/Benchmarks/Benchmarks.swift
@@ -27,9 +27,9 @@ let benchmarks = {
         "Plot" : PlotTests(),
         "Pointfreeco" : SwiftHTMLPFTests(),
         "SwiftHTMLKit" : SwiftHTMLKitTests(),
-        "Swim" : SwimTests(),
+        "Swim (custom renderer)" : SwimTests(),
         "VaporHTMLKit" : VaporHTMLKitTests(),
-        "Vaux" : VauxTests()
+        "Vaux (custom renderer)" : VauxTests()
     ]
 
     /*for (key, value) in libraries {
diff --git a/Benchmarks/Benchmarks/Elementary/Elementary.swift b/Benchmarks/Benchmarks/Elementary/Elementary.swift
@@ -15,7 +15,7 @@ package struct ElementaryTests : HTMLGenerator {
         StaticView().render()
     }
     package func dynamicHTML(_ context: HTMLContext) -> String {
-        DynamicView(context: context).render()
+        DynamicView(context: context).rawHTML.render()
     }
 }
 
@@ -30,25 +30,31 @@ struct StaticView : HTMLDocument {
     }
 }
 
-struct DynamicView : HTMLDocument {
-    var title:String = "DynamicView"
-
+struct DynamicView { 
     let context:HTMLContext
 
-    var head : some HTML {
-        ""
-    }
-
-    var body : some HTML {
-        h1 { context.heading }
-        div(attributes: [.id(context.desc_id)]) {
-            p { context.string }
-        }
-        h2 { context.user.details_heading }
-        h3 { context.user.qualities_heading }
-        ul(attributes: [.id(context.user.qualities_id)]) {
-            for quality in context.user.qualities {
-                li { quality }
+    // Elementary puts the title element first in the head, which is wrong; it needs to be charset | this is a workaround
+    @HTMLBuilder var rawHTML : some HTML {
+        HTMLRaw("<!DOCTYPE html>")
+        html {
+            head {
+                meta(.custom(name: "charset", value: context.charset))
+                title { "DynamicView" }
+                meta(.content(context.meta_description), .name("description"))
+                meta(.content(context.keywords_string), .name("keywords"))
+            }
+            body {
+                h1 { context.heading }
+                div(attributes: [.id(context.desc_id)]) {
+                    p { context.string }
+                }
+                h2 { context.user.details_heading }
+                h3 { context.user.qualities_heading }
+                ul(attributes: [.id(context.user.qualities_id)]) {
+                    for quality in context.user.qualities {
+                        li { quality }
+                    }
+                }
             }
         }
     }
diff --git a/Benchmarks/Benchmarks/Plot/Plot.swift b/Benchmarks/Benchmarks/Plot/Plot.swift
@@ -24,7 +24,10 @@ package struct PlotTests : HTMLGenerator {
     package func dynamicHTML(_ context: Utilities.HTMLContext) -> String {
         return HTML(
             .head(
-                .element(named: "title", text: "DynamicView")
+                .meta(.attribute(named: "charset", value: context.charset)),
+                .element(named: "title", text: "DynamicView"),
+                .meta(.content(context.meta_description), .name("description")),
+                .meta(.content(context.keywords_string), .name("keywords"))
             ),
             .body(
                 .component(H1(context.heading)),
diff --git a/Benchmarks/Benchmarks/SwiftHTMLBB/SwiftHTMLBB.swift b/Benchmarks/Benchmarks/SwiftHTMLBB/SwiftHTMLBB.swift
@@ -31,7 +31,10 @@ package struct SwiftHTMLBBTests : HTMLGenerator {
         renderer.render(Document(.html) {
             Html {
                 Head {
+                    Meta().charset(context.charset)
                     Title("DynamicView")
+                    Meta().content(context.meta_description).name("description")
+                    Meta().content(context.keywords_string).name("keywords")
                 }
                 Body {
                     H1(context.heading)
diff --git a/Benchmarks/Benchmarks/SwiftHTMLKit/SwiftHTMLKit.swift b/Benchmarks/Benchmarks/SwiftHTMLKit/SwiftHTMLKit.swift
@@ -31,12 +31,13 @@ package struct SwiftHTMLKitTests : HTMLGenerator {
         var qualities:String = ""
         for quality in context.user.qualities {
             qualities += #li(["\(quality)"])
-            //qualities += "<li>" + quality + "</li>"
         }
-        //return "<!DOCTYPE html><html><body><h1>" + context.heading + "</h1><div id=\"" + context.desc_id + "\"><p>" + context.string + "</p></div><h2>" + context.user.details_heading + "</h2><h3>" + context.user.qualities_heading + "</h3><ul id=\"" + context.user.qualities_id + "\">" + qualities + "</ul></body></html>"
         return #html([
             #head([
-                #title(["DynamicView"])
+                #meta(charset: "\(context.charset)"),
+                #title(["DynamicView"]),
+                #meta(content: "\(context.meta_description)", name: "description"),
+                #meta(content: "\(context.keywords_string)", name: "keywords")
             ]),
             #body([
                 #h1(["\(context.heading)"]),
diff --git a/Benchmarks/Benchmarks/SwiftHTMLPF/SwiftHTMLPF.swift b/Benchmarks/Benchmarks/SwiftHTMLPF/SwiftHTMLPF.swift
@@ -29,7 +29,10 @@ package struct SwiftHTMLPFTests : HTMLGenerator {
             .document(
                 .html(
                     .head(
-                        .title("DynamicView")
+                        .meta(attributes: [.charset(.utf8)]),
+                        .title("DynamicView"),
+                        .meta(attributes: [.init("content", context.meta_description), .init("name", "description")]),
+                        .meta(attributes: [.init("content", context.keywords_string), .init("name", "keywords")])
                     ),
                     .body(
                         .h1(.raw(context.heading)),
diff --git a/Benchmarks/Benchmarks/Swim/Swim.swift b/Benchmarks/Benchmarks/Swim/Swim.swift
@@ -16,7 +16,7 @@ extension Node {
             for (key, value) in attributes {
                 attributes_string += " " + key + "=\"" + value + "\""
             }
-            return (name == "html" ? "<!DOCTYPE html>" : "") + "<" + name + attributes_string + ">" + (child?.rendered ?? "") + "</" + name + ">"
+            return (name == "html" ? "<!DOCTYPE html>" : "") + "<" + name + attributes_string + ">" + (child?.rendered ?? "") + (isVoid(name) ? "" : "</" + name + ">")
         case .text(let string): return string
         case .raw(let string): return string
         case .comment(_): return ""
@@ -30,6 +30,12 @@ extension Node {
         case .trim: return ""
         }
     }
+    func isVoid(_ tag: String) -> Bool {
+        switch tag {
+        case "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "source", "track", "wbr": return true
+        default: return false
+        }
+    }
 }
 
 package struct SwimTests : HTMLGenerator {
@@ -54,7 +60,10 @@ package struct SwimTests : HTMLGenerator {
         }
         return html {
             head {
+                meta(charset: context.charset)
                 title { "DynamicView" }
+                meta(customAttributes: ["content":context.meta_description, "name":"description"])
+                meta(customAttributes: ["content":context.keywords_string, "name":"keywords"])
             }
             body {
                 h1 { context.heading }
diff --git a/Benchmarks/Benchmarks/UnitTests/UnitTests.swift b/Benchmarks/Benchmarks/UnitTests/UnitTests.swift
@@ -50,6 +50,7 @@ struct UnitTests {
     @Test func dynamicHTML() {
         let context:HTMLContext = HTMLContext()
         let expected_value:String = libraries["SwiftHTMLKit"]!.dynamicHTML(context)
+        // Plot closes void tags | Swim uses a dictionary for meta values | Vaux is doodoo
         for (key, value) in libraries {
             #expect(value.dynamicHTML(context) == expected_value, Comment(rawValue: key))
         }
diff --git a/Benchmarks/Benchmarks/Utilities/Utilities.swift b/Benchmarks/Benchmarks/Utilities/Utilities.swift
@@ -35,12 +35,26 @@ package actor Cache {
 
 // MARK: HTMLContext
 package struct HTMLContext {
+    package let charset:String, keywords:[String], meta_description:String
     package let heading:String, desc_id:String
     package let string:String, integer:Int, double:Double, float:Float, boolean:Bool
     package let now:Date
     package let user:User
 
+    package var keywords_string : String {
+        var s:String = ""
+        for keyword in keywords {
+            s += "," + keyword
+        }
+        s.removeFirst()
+        return s
+    }
+
     package init() {
+        charset = "utf-8"
+        keywords = ["swift", "html", "benchmark"]
+        meta_description = "This website is to benchmark the performance of different Swift DSL libraries."
+
         heading = "Dynamic HTML Benchmark"
         desc_id = "desc"
         // 1 paragraph of lorem ipsum
diff --git a/Benchmarks/Benchmarks/VaporHTMLKit/VaporHTMLKit.swift b/Benchmarks/Benchmarks/VaporHTMLKit/VaporHTMLKit.swift
@@ -46,7 +46,10 @@ struct DynamicView : View {
         Document(.html5)
         Html {
             Head {
+                Meta().charset(.utf8) // TODO: fix? | not dynamic
                 Title { "DynamicView" }
+                Meta().content(context.meta_description).name(.description)
+                Meta().content(context.keywords_string).name(.keywords)
             }
             Body {
                 Heading1 { context.heading }
diff --git a/Benchmarks/Benchmarks/Vaux/Vaux.swift b/Benchmarks/Benchmarks/Vaux/Vaux.swift
@@ -9,6 +9,7 @@ import Utilities
 import Vaux
 import Foundation
 
+// MARK: Custom rendering
 extension HTML {
     func render(includeTag: Bool) -> (HTMLType, String) {
         if let node:HTMLNode = self as? HTMLNode {
@@ -25,6 +26,12 @@ extension HTML {
             return (.node, String(describing: self))
         }
     }
+    func isVoid(_ tag: String) -> Bool {
+        switch tag {
+        case "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "source", "track", "wbr": return true
+        default: return false
+        }
+    }
 }
 
 enum HTMLType {
@@ -35,7 +42,7 @@ extension AttributedNode {
     var render : String {
         let tag:String = child.getTag()!
         let attribute_string:String = " " + attribute.key + (attribute.value != nil ? "=\"" + attribute.value! + "\"" : "")
-        return "<" + tag + attribute_string + ">" + child.render(includeTag: false).1 + "</" + tag + ">"
+        return "<" + tag + attribute_string + ">" + child.render(includeTag: false).1 + (isVoid(tag) ? "" : "</" + tag + ">")
     }
 }
 
@@ -54,10 +61,11 @@ extension HTMLNode {
                     break
             }
         }
-        return (tag == "html" ? "<!DOCTYPE html>" : "") + (includeTag ? "<" + tag + attributes + ">" : "") + children + (includeTag ? "</" + tag + ">" : "") // Vaux doesn't take void elements into account
+        return (tag == "html" ? "<!DOCTYPE html>" : "") + (includeTag ? "<" + tag + attributes + ">" : "") + children + (!isVoid(tag) && includeTag ? "</" + tag + ">" : "")
     }
 }
 
+// MARK: VauxTests
 package struct VauxTests : HTMLGenerator {
     package init() {}
 
@@ -77,7 +85,10 @@ package struct VauxTests : HTMLGenerator {
     package func dynamicHTML(_ context: HTMLContext) -> String {
         html {
             head {
+                meta().attr("charset", context.charset)
                 title("DynamicView")
+                meta().attr("content", context.meta_description).attr("name", "description")
+                meta().attr("content", context.keywords_string).attr("name", "keywords")
             }
             body {
                 heading(.h1) { context.heading }
diff --git a/Benchmarks/img/throughput_dynamic.png b/Benchmarks/img/throughput_dynamic.png
diff --git a/README.md b/README.md
@@ -148,16 +148,16 @@ Use the `HTMLElementAttribute.event(<type>, "<value>")`.
 
 ## Benchmarks
 - Libraries tested
-  - [BinaryBuilds/swift-html](https://github.com/BinaryBirds/swift-html) v1.7.0 (patched version [here](https://github.com/RandomHashTags/fork-bb-swift-html))
+  - [BinaryBuilds/swift-html](https://github.com/BinaryBirds/swift-html) v1.7.0 (patched version [here](https://github.com/RandomHashTags/fork-bb-swift-html); custom renderer [here](https://github.com/RandomHashTags/swift-htmlkit/blob/main/Benchmarks/Benchmarks/Swim/Swim.swift))
   - [sliemeobn/elementary](https://github.com/sliemeobn/elementary) v0.3.4
   - [JohnSundell/Plot](https://github.com/JohnSundell/Plot) v0.14.0
   - [RandomHashTags/swift-htmlkit](https://github.com/RandomHashTags/swift-htmlkit) v0.5.0 (this library)
   - [pointfreeco/swift-html](https://github.com/pointfreeco/swift-html) v0.4.1
   - [robb/Swim](https://github.com/robb/Swim) v0.4.0 (patched version [here](https://github.com/RandomHashTags/fork-Swim))
   - [vapor-community/HTMLKit](https://github.com/vapor-community/HTMLKit) v2.8.1
-  - [dokun1/Vaux](https://github.com/dokun1/Vaux) v0.2.0 (patched version [here](https://github.com/RandomHashTags/fork-Vaux))
+  - [dokun1/Vaux](https://github.com/dokun1/Vaux) v0.2.0 (patched version [here](https://github.com/RandomHashTags/fork-Vaux); custom renderer [here](https://github.com/RandomHashTags/swift-htmlkit/blob/main/Benchmarks/Benchmarks/Vaux/Vaux.swift))
 
-Using iMac (i9 9900k, 72GB RAM, 2TB) with macOS 15.0 and the Swift 6 compiler.
+Test machine: iMac (i9 9900k, 72GB RAM, 2TB) running macOS 15.0 with the Swift 6 compiler.
 
 Executed command: `swift package -c release --allow-writing-to-package-directory benchmark --metric throughput  --format jmh`
 

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ extension Node {`
`16`	`16`	`for (key, value) in attributes {`
`17`	`17`	`attributes_string += " " + key + "=\"" + value + "\""`
`18`	`18`	`}`
`19`		`- return (name == "html" ? "<!DOCTYPE html>" : "") + "<" + name + attributes_string + ">" + (child?.rendered ?? "") + "</" + name + ">"`
	`19`	`+ return (name == "html" ? "<!DOCTYPE html>" : "") + "<" + name + attributes_string + ">" + (child?.rendered ?? "") + (isVoid(name) ? "" : "</" + name + ">")`
`20`	`20`	`case .text(let string): return string`
`21`	`21`	`case .raw(let string): return string`
`22`	`22`	`case .comment(_): return ""`
`@@ -30,6 +30,12 @@ extension Node {`
`30`	`30`	`case .trim: return ""`
`31`	`31`	`}`
`32`	`32`	`}`
	`33`	`+ func isVoid(_ tag: String) -> Bool {`
	`34`	`+ switch tag {`
	`35`	`+ case "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "source", "track", "wbr": return true`
	`36`	`+ default: return false`
	`37`	`+ }`
	`38`	`+ }`
`33`	`39`	`}`
`34`	`40`
`35`	`41`	`package struct SwimTests : HTMLGenerator {`
`@@ -54,7 +60,10 @@ package struct SwimTests : HTMLGenerator {`
`54`	`60`	`}`
`55`	`61`	`return html {`
`56`	`62`	`head {`
	`63`	`+ meta(charset: context.charset)`
`57`	`64`	`title { "DynamicView" }`
	`65`	`+ meta(customAttributes: ["content":context.meta_description, "name":"description"])`
	`66`	`+ meta(customAttributes: ["content":context.keywords_string, "name":"keywords"])`
`58`	`67`	`}`
`59`	`68`	`body {`
`60`	`69`	`h1 { context.heading }`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,7 @@ struct UnitTests {`
`50`	`50`	`@Test func dynamicHTML() {`
`51`	`51`	`let context:HTMLContext = HTMLContext()`
`52`	`52`	`let expected_value:String = libraries["SwiftHTMLKit"]!.dynamicHTML(context)`
	`53`	`+ // Plot closes void tags \| Swim uses a dictionary for meta values \| Vaux is doodoo`
`53`	`54`	`for (key, value) in libraries {`
`54`	`55`	`#expect(value.dynamicHTML(context) == expected_value, Comment(rawValue: key))`
`55`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ import Utilities`
`9`	`9`	`import Vaux`
`10`	`10`	`import Foundation`
`11`	`11`
	`12`	`+// MARK: Custom rendering`
`12`	`13`	`extension HTML {`
`13`	`14`	`func render(includeTag: Bool) -> (HTMLType, String) {`
`14`	`15`	`if let node:HTMLNode = self as? HTMLNode {`
`@@ -25,6 +26,12 @@ extension HTML {`
`25`	`26`	`return (.node, String(describing: self))`
`26`	`27`	`}`
`27`	`28`	`}`
	`29`	`+ func isVoid(_ tag: String) -> Bool {`
	`30`	`+ switch tag {`
	`31`	`+ case "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "source", "track", "wbr": return true`
	`32`	`+ default: return false`
	`33`	`+ }`
	`34`	`+ }`
`28`	`35`	`}`
`29`	`36`
`30`	`37`	`enum HTMLType {`
`@@ -35,7 +42,7 @@ extension AttributedNode {`
`35`	`42`	`var render : String {`
`36`	`43`	`let tag:String = child.getTag()!`
`37`	`44`	`let attribute_string:String = " " + attribute.key + (attribute.value != nil ? "=\"" + attribute.value! + "\"" : "")`
`38`		`- return "<" + tag + attribute_string + ">" + child.render(includeTag: false).1 + "</" + tag + ">"`
	`45`	`+ return "<" + tag + attribute_string + ">" + child.render(includeTag: false).1 + (isVoid(tag) ? "" : "</" + tag + ">")`
`39`	`46`	`}`
`40`	`47`	`}`
`41`	`48`
`@@ -54,10 +61,11 @@ extension HTMLNode {`
`54`	`61`	`break`
`55`	`62`	`}`
`56`	`63`	`}`
`57`		`- return (tag == "html" ? "<!DOCTYPE html>" : "") + (includeTag ? "<" + tag + attributes + ">" : "") + children + (includeTag ? "</" + tag + ">" : "") // Vaux doesn't take void elements into account`
	`64`	`+ return (tag == "html" ? "<!DOCTYPE html>" : "") + (includeTag ? "<" + tag + attributes + ">" : "") + children + (!isVoid(tag) && includeTag ? "</" + tag + ">" : "")`
`58`	`65`	`}`
`59`	`66`	`}`
`60`	`67`
	`68`	`+// MARK: VauxTests`
`61`	`69`	`package struct VauxTests : HTMLGenerator {`
`62`	`70`	`package init() {}`
`63`	`71`
`@@ -77,7 +85,10 @@ package struct VauxTests : HTMLGenerator {`
`77`	`85`	`package func dynamicHTML(_ context: HTMLContext) -> String {`
`78`	`86`	`html {`
`79`	`87`	`head {`
	`88`	`+ meta().attr("charset", context.charset)`
`80`	`89`	`title("DynamicView")`
	`90`	`+ meta().attr("content", context.meta_description).attr("name", "description")`
	`91`	`+ meta().attr("content", context.keywords_string).attr("name", "keywords")`
`81`	`92`	`}`
`82`	`93`	`body {`
`83`	`94`	`heading(.h1) { context.heading }`