Merge pull request #89 from nkalvi/extend-dl-with-div-wrapped-groups

Extend dl with div wrapped groups
JohnSundell · Apr 7, 2023 · 4237057 · 4237057
2 parents 969f9bb + 47f5df2
commit 4237057
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 11 deletions.
diff --git a/Sources/Plot/API/HTML.swift b/Sources/Plot/API/HTML.swift
@@ -83,7 +83,7 @@ public extension HTML {
     /// The context within an HTML document's `<head>` element.
     enum HeadContext: HTMLContext, HTMLScriptableContext {}
     /// The context within an HTML document's `<body>` element.
-    class BodyContext: HTMLStylableContext, HTMLScriptableContext, HTMLImageContainerContext {}
+    class BodyContext: HTMLStylableContext, HTMLScriptableContext, HTMLImageContainerContext, HTMLDividableContext {}
     /// The context within an HTML `<a>` element.
     final class AnchorContext: BodyContext, HTMLLinkableContext {}
     /// The context within an HTML `<audio>` element.
@@ -99,7 +99,7 @@ public extension HTML {
     /// The context within an HTML `<datalist>` element.
     enum DataListContext: HTMLOptionListContext {}
     /// The context within an HTML `<dl>` element.
-    enum DescriptionListContext: HTMLStylableContext {}
+    enum DescriptionListContext: HTMLStylableContext, HTMLDividableContext {}
     /// The context within an HTML `<details>` element.
     final class DetailsContext: BodyContext {}
     /// The context within an HTML `<embed>` element.
@@ -153,6 +153,8 @@ public protocol HTMLContext {}
 /// Context shared among all HTML elements that can have their dimensions
 /// (width and height) specified through attributes, such as `<video>`.
 public protocol HTMLDimensionContext: HTMLContext {}
+/// Context shared among all HTML elements can be divided using `<div>` elements.
+public protocol HTMLDividableContext: HTMLContext {}
 /// Context shared among all HTML elements that can contain an `<img>` element.
 public protocol HTMLImageContainerContext: HTMLContext {}
 /// Context shared among all HTML elements that act as some form

diff --git a/Sources/Plot/API/HTMLComponents.swift b/Sources/Plot/API/HTMLComponents.swift
@@ -131,7 +131,7 @@ public enum ElementDefinitions {
     /// Definition for the `<button>` element.
     public enum Button: ElementDefinition { public static var wrapper = Node.button }
     /// Definition for the `<div>` element.
-    public enum Div: ElementDefinition { public static var wrapper = Node.div }
+    public enum Div: ElementDefinition { public static var wrapper = Node<HTML.BodyContext>.div }
     /// Definition for the `<fieldset>` element.
     public enum FieldSet: ElementDefinition { public static var wrapper = Node.fieldset }
     /// Definition for the `<footer>` element.

diff --git a/Sources/Plot/API/HTMLElements.swift b/Sources/Plot/API/HTMLElements.swift
@@ -173,12 +173,6 @@ public extension Node where Context: HTML.BodyContext {
         .element(named: "details", nodes: nodes)
     }
 
-    /// Add a `<div>` HTML element within the current context.
-    /// - parameter nodes: The element's attributes and child elements.
-    static func div(_ nodes: Node<HTML.BodyContext>...) -> Node {
-        .element(named: "div", nodes: nodes)
-    }
-
     /// Add a `<dl>` HTML element within the current context.
     /// - parameter nodes: The element's attributes and child elements.
     static func dl(_ nodes: Node<HTML.DescriptionListContext>...) -> Node {
@@ -523,3 +517,11 @@ public extension Node where Context: HTMLScriptableContext {
         .element(named: "script", nodes: nodes)
     }
 }
+
+public extension Node where Context: HTMLDividableContext {
+    /// Add a `<div>` HTML element within the current context.
+    /// - parameter nodes: The element's attributes and child elements.
+    static func div(_ nodes: Node<Context>...) -> Node {
+        .element(named: "div", nodes: nodes)
+    }
+}
diff --git a/Tests/PlotTests/HTMLComponentTests.swift b/Tests/PlotTests/HTMLComponentTests.swift
@@ -161,8 +161,8 @@ final class HTMLComponentTests: XCTestCase {
     }
 
     func testAddingClassToNode() {
-        let html = Node.div().class("hello").render()
-        XCTAssertEqual(html, #"<div class="hello"></div>"#)
+        let html = Node.div(.p()).class("hello").render()
+        XCTAssertEqual(html, #"<div class="hello"><p></p></div>"#)
     }
 
     func testEnvironmentValuesDoNotApplyToSiblings() {

diff --git a/Tests/PlotTests/HTMLTests.swift b/Tests/PlotTests/HTMLTests.swift
@@ -294,6 +294,29 @@ final class HTMLTests: XCTestCase {
         <body><dl><dt>Term</dt><dd>Description</dd></dl></body>
         """)
     }
+
+    func testDescriptionListWithDiv() {
+        let html = HTML(.body(.dl(
+            .div(
+                .dt("Last modified time"),
+                .dd("2004-12-23T23:33Z")
+            ),
+            .div(
+                .dt("Recommended update interval"),
+                .dd("60s")
+            ),
+            .div(
+                .dt("Authors"),
+                .dt("Editors"),
+                .dd("Robert Rothman"),
+                .dd("Daniel Jackson")
+            )
+        )))
+
+        assertEqualHTMLContent(html, """
+        <body><dl><div><dt>Last modified time</dt><dd>2004-12-23T23:33Z</dd></div><div><dt>Recommended update interval</dt><dd>60s</dd></div><div><dt>Authors</dt><dt>Editors</dt><dd>Robert Rothman</dd><dd>Daniel Jackson</dd></div></dl></body>
+        """)
+    }
 
     func testTextDirectionalityLeftToRight() {
         let html = HTML(.body(