Implement spacing rules

Author: MaddyGuthridge

pyhtml/__init__.py

@@ -297,6 +297,7 @@
 from .__tag_base import Tag, create_tag, SelfClosingTag, WhitespaceSensitiveTag
 
 from .__tags import input_, object_
+from .__render_options import Options
 
 __all__ = [
     'Tag',
@@ -307,6 +308,7 @@
     'Comment',
     'input_',
     'object_',
+    'Options',
     'html',
     'base',
     'head',

pyhtml/__tag_base.py

@@ -146,20 +146,34 @@ def _render(self, indent: str, options: FullOptions) -> list[str]:
             opening += f"</{self._get_tag_name()}>"
             return [opening]
         else:
-            out = [opening]
+            indent_increase = options.indent if options.spacing == "\n" else ""
             # Children
-            out.extend(
-                util.render_children(
-                    self.children,
-                    self._escape_children(),
-                    indent + options.indent,
-                    options,
-                )
+            children = util.render_children(
+                self.children,
+                self._escape_children(),
+                indent + indent_increase,
+                options,
             )
-            # Closing tag
-            out.append(f"{indent}</{self._get_tag_name()}>")
-
-            return out
+            closing = f"</{self._get_tag_name()}>"
+            if options.spacing == "\n":
+                return [
+                    opening,
+                    *children,
+                    f"{indent}{closing}",
+                ]
+            else:
+                # Children must have at least one line, since we would have
+                # taken the `if not len(self.children)` branch if there were
+                # no children to render
+                out: list[str] = [
+                    opening + options.spacing + children[0],
+                    *children[1:],
+                ]
+                # Add the closing tag onto the end
+                return [
+                    *out[:-1],
+                    out[-1] + options.spacing + closing,
+                ]
 
     def render(self) -> str:
         """
@@ -179,9 +193,7 @@ class SelfClosingTag(Tag):
     Self-closing tags don't contain child elements
     """
 
-    def __init__(
-        self, *options: Options, **attributes: AttributeType
-    ) -> None:
+    def __init__(self, *options: Options, **attributes: AttributeType) -> None:
         # Self-closing tags don't allow children
         super().__init__(*options, **attributes)
 

pyhtml/__util.py

@@ -125,11 +125,30 @@ def render_children(
 
     Elements are placed in the same string
     """
-    rendered = []
+    rendered: list[str] = []
     for ele in children:
-        rendered.extend(
-            render_inline_element(ele, escape_strings, indent, options)
+        rendered_child = render_inline_element(
+            ele, escape_strings, indent, options
         )
+        if options.spacing == "\n":
+            rendered.extend(rendered_child)
+        else:
+            # Custom spacing
+            if len(rendered) == 0:
+                rendered_child[0] = rendered_child[0].strip()
+                rendered = rendered_child
+            else:
+                *r_head, r_tail = rendered
+                # rendered_child should not have length zero, otherwise
+                # something has gone horribly wrong, and it's ok to crash
+                c_head, *c_tail = rendered_child
+                # Join it all nicely
+                rendered = [
+                    *r_head,
+                    # Remove leading whitespace caused by indentation rules
+                    r_tail + options.spacing + c_head.lstrip(),
+                    *c_tail,
+                ]
     return rendered
 
 

tests/render_options_test.py

@@ -0,0 +1,117 @@
+"""
+# Tests / render options test
+
+Test cases for specifying rendering options
+"""
+
+import pyhtml as p
+
+
+def test_indent():
+    doc = p.body(
+        p.Options(indent="\t"),
+        p.span(),
+        p.div(),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body>",
+            "\t<span></span>",
+            "\t<div></div>",
+            "</body>",
+        ]
+    )
+
+
+def test_mixed_indent():
+    doc = p.body(
+        p.div(
+            p.Options(indent="\t"),
+            p.div(),
+        ),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body>",
+            "  <div>",
+            "  \t<div></div>",
+            "  </div>",
+            "</body>",
+        ]
+    )
+
+
+def test_spacing():
+    doc = p.body(
+        p.Options(spacing=" "),
+        p.div(),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body> <div></div> </body>",
+        ]
+    )
+
+
+def test_mixed_spacing():
+    doc = p.body(
+        p.div(
+            p.Options(spacing=" "),
+            p.div(),
+        ),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body>",
+            "  <div> <div></div> </div>",
+            "</body>",
+        ]
+    )
+
+
+def test_spacing_inner_newline():
+    doc = p.body(
+        p.div(
+            p.Options(spacing=" "),
+            p.div(
+                p.Options(spacing="\n"),
+                p.div(),
+            ),
+        ),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body>",
+            "  <div> <div>",
+            "    <div></div>",
+            "  </div> </div>",
+            "</body>",
+        ]
+    )
+
+
+def test_indent_and_spacing_inner_newline():
+    doc = p.body(
+        p.div(
+            p.Options(spacing=" "),
+            p.div(
+                p.Options(spacing="\n", indent="\t"),
+                p.div(),
+            ),
+        ),
+    )
+
+    assert str(doc) == "\n".join(
+        [
+            "<body>",
+            "  <div> <div>",
+            "  \t<div></div>",
+            "  </div> </div>",
+            "</body>",
+        ]
+    )