Integrated pretty printing serializer

composer.json

@@ -5,7 +5,7 @@
     "require": {
         "php": ">=8.0",
         "ext-dom": "*",
-        "mensbeam/html-parser": "dev-master",
+        "mensbeam/html-parser": "dev-pretty-print",
         "mensbeam/framework": "dev-main",
         "symfony/css-selector": "^5.3"
     },

lib/Document.php

@@ -16,7 +16,6 @@ use MensBeam\HTML\Parser\{
     Charset,
     Data,
     Config as ParserConfig,
-    Serializer
 };
 
 
@@ -427,7 +426,7 @@ class Document extends Node {
         $this->load($data, $charset);
     }
 
-    public function serialize(?Node $node = null): string {
+    public function serialize(?Node $node = null, array $config = []): string {
         $node = $node ?? $this;
         if ($node !== $this) {
             if ($node->ownerDocument !== $this) {
@@ -439,7 +438,29 @@ class Document extends Node {
             $node = $node->innerNode;
         }
 
-        return Serializer::serialize($node);
+        $parserConfig = new ParserConfig();
+        foreach ($config as $key => $value) {
+            switch ($key) {
+                case 'indentStep':
+                    if (!is_int($value)) {
+                        continue 2;
+                    }
+                break;
+                case 'indentWithSpaces':
+                case 'reformatWhitespace':
+                case 'serializeBooleanAttributeValues':
+                case 'serializeForeignVoidEndTags':
+                    if (!is_bool($value)) {
+                        continue 2;
+                    }
+                break;
+                default: continue 2;
+            }
+
+            $parserConfig->$key = $value;
+        }
+
+        return Serializer::serialize($node, $parserConfig);
     }
 
 

lib/Serializer.php

@@ -0,0 +1,106 @@
+<?php
+/**
+ * @license MIT
+ * Copyright 2017 Dustin Wilson, J. King, et al.
+ * See LICENSE and AUTHORS files for details
+ */
+
+declare(strict_types=1);
+namespace MensBeam\HTML\DOM;
+use MensBeam\HTML\DOM\Inner\Reflection,
+    MensBeam\HTML\Parser;
+use MensBeam\HTML\Parser\{
+    Config,
+    Serializer as ParserSerializer
+};
+
+
+class Serializer extends ParserSerializer {
+    protected static function getTemplateContent(\DOMElement $node, ?Config $config = null): \DOMNode {
+        // NOTE: PHP's DOM does not support the content property on template elements
+        // natively. This method exists purely so implementors of userland PHP DOM
+        // solutions may extend this method to get template contents how they need them.
+        return Reflection::getProtectedProperty($node->ownerDocument->getWrapperNode($node)->content, 'innerNode');
+    }
+
+    protected static function isPreformattedContent(\DOMNode $node): bool {
+        // NOTE: This method is used only when pretty printing. Implementors of userland
+        // PHP DOM solutions with template contents will need to extend this method to
+        // be able to moonwalk through document fragment hosts.
+
+        $n = $node;
+        do {
+            if ($n instanceof \DOMElement) {
+                if (($n->namespaceURI ?? Parser::HTML_NAMESPACE) === Parser::HTML_NAMESPACE && in_array($n->tagName, self::PREFORMATTED_ELEMENTS)) {
+                    return true;
+                }
+            } elseif ($n instanceof \DOMDocumentFragment) {
+                $host = Reflection::getProtectedProperty($node->ownerDocument->getWrapperNode($n), 'host');
+                if ($host !== null) {
+                    $n = Reflection::getProtectedProperty($host->get(), 'innerNode');
+                }
+            }
+        } while ($n = $n->parentNode);
+
+        return false;
+    }
+
+    protected static function treatAsBlock(\DOMNode $node): bool {
+        // NOTE: This method is used only when pretty printing. Implementors of userland
+        // PHP DOM solutions with template contents will need to extend this method to
+        // check for any templates and look within their content fragments for "block"
+        // content.
+        if ($node instanceof \DOMDocument || $node instanceof \DOMDocumentFragment) {
+            return true;
+        }
+
+        $xpath = new \DOMXPath($node->ownerDocument);
+        $result = ($xpath->evaluate(self::BLOCK_QUERY, $node) > 0);
+
+        if (!$result) {
+            $templates = $xpath->query('.//template[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"][not(ancestor::iframe[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::listing[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::noembed[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::noframes[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::noscript[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::plaintext[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::pre[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::style[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::script[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::textarea[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::title[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"] or ancestor::xmp[namespace-uri()="" or namespace-uri()="http://www.w3.org/1999/xhtml"])]');
+
+            foreach ($templates as $t) {
+                $content = Reflection::getProtectedProperty($t->ownerDocument->getWrapperNode($t)->content, 'innerNode');
+
+                // This circumvents a PHP XPath bug where it will silently fail to query
+                // nodes within fragments.
+                $clone = $content->cloneNode(true);
+                $span = $content->ownerDocument->createElement('span');
+                $span->appendChild($clone);
+
+                if ($xpath->evaluate(self::BLOCK_QUERY, $span) > 0) {
+                    return true;
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    protected static function treatForeignRootAsBlock(\DOMNode $node): bool {
+        // NOTE: This method is used only when pretty printing. Implementors of userland
+        // PHP DOM solutions with template contents will need to extend this method to
+        // be able to moonwalk through document fragment hosts.
+        $n = $node;
+        while ($n = $n->parentNode) {
+            if ($n instanceof \DOMDocument || ($n instanceof \DOMElement && $n->parentNode === null)) {
+                return true;
+            } elseif ($n instanceof \DOMDocumentFragment) {
+                $host = Reflection::getProtectedProperty($node->ownerDocument->getWrapperNode($n), 'host');
+                if ($host !== null) {
+                    $n = Reflection::getProtectedProperty($host->get(), 'innerNode');
+                } else {
+                    return true;
+                }
+            } elseif (($n->parentNode->namespaceURI ?? Parser::HTML_NAMESPACE) === Parser::HTML_NAMESPACE) {
+                if (self::treatAsBlock($n->parentNode)) {
+                    return true;
+                }
+                break;
+            }
+        }
+
+        return false;
+    }
+}