Differences between legacy and new API

veewee · Sep 16, 2024 · dec15b1 · dec15b1
1 parent 0377972
commit dec15b1
Show file tree

Hide file tree

Showing 54 changed files with 1,821 additions and 265 deletions.
diff --git a/src/Xml/Dom/Assert/assert_cdata.php b/src/Xml/Dom/Assert/assert_cdata.php
@@ -4,15 +4,15 @@
 
 namespace VeeWee\Xml\Dom\Assert;
 
-use \DOM\CdataSection;
+use \DOM\CDATASection;
 use Psl\Type\Exception\AssertException;
 use function Psl\Type\instance_of;
 
 /**
- * @psalm-assert \DOM\CdataSection $node
+ * @psalm-assert \DOM\CDATASection $node
  * @throws AssertException
  */
-function assert_cdata(mixed $node): \DOM\CdataSection
+function assert_cdata(mixed $node): \DOM\CDATASection
 {
-    return instance_of(\DOM\CdataSection::class)->assert($node);
+    return instance_of(\DOM\CDATASection::class)->assert($node);
 }
diff --git a/src/Xml/Dom/Builder/cdata.php b/src/Xml/Dom/Builder/cdata.php
@@ -5,20 +5,20 @@
 namespace VeeWee\Xml\Dom\Builder;
 
 use Closure;
-use \DOM\CdataSection;
+use \DOM\CDATASection;
 use \DOM\Node;
 use function VeeWee\Xml\Dom\Assert\assert_cdata;
 use function VeeWee\Xml\Dom\Locator\Node\detect_document;
 use function VeeWee\Xml\Internal\configure;
 
 /**
- * @param list<callable(\DOM\CdataSection): \DOM\CdataSection> $configurators
+ * @param list<callable(\DOM\CDATASection): \DOM\CDATASection> $configurators
  *
- * @return Closure(\DOM\Node): \DOM\CdataSection
+ * @return Closure(\DOM\Node): \DOM\CDATASection
  */
 function cdata(string $data, ...$configurators): Closure
 {
-    return static function (\DOM\Node $node) use ($data, $configurators): \DOM\CdataSection {
+    return static function (\DOM\Node $node) use ($data, $configurators): \DOM\CDATASection {
         $document = detect_document($node);
 
         return assert_cdata(

diff --git a/src/Xml/Dom/Builder/escaped_value.php b/src/Xml/Dom/Builder/escaped_value.php
@@ -5,16 +5,13 @@
 namespace VeeWee\Xml\Dom\Builder;
 
 use Closure;
-use \DOM\Element;
 
 /**
  * @return Closure(\DOM\Element): \DOM\Element
  */
 function escaped_value(string $value): Closure
 {
     return static function (\DOM\Element $node) use ($value): \DOM\Element {
-        $node->nodeValue = htmlspecialchars($value, ENT_XML1|ENT_QUOTES);
-
-        return $node;
+        return value(htmlspecialchars($value, ENT_XML1|ENT_QUOTES))($node);
     };
 }
diff --git a/src/Xml/Dom/Builder/value.php b/src/Xml/Dom/Builder/value.php
@@ -6,14 +6,17 @@
 
 use Closure;
 use \DOM\Element;
+use function VeeWee\Xml\Dom\Locator\Node\detect_document;
 
 /**
  * @return Closure(\DOM\Element): \DOM\Element
  */
 function value(string $value): Closure
 {
     return static function (\DOM\Element $node) use ($value): \DOM\Element {
-        $node->nodeValue = $value;
+        $document = detect_document($node);
+        $text = $document->createTextNode($value);
+        $node->appendChild($text);
 
         return $node;
     };

diff --git a/src/Xml/Dom/Collection/NodeList.php b/src/Xml/Dom/Collection/NodeList.php
@@ -59,6 +59,15 @@ public static function empty(): self
         return new self();
     }
 
+    /**
+     * @param \DOM\HTMLCollection $list
+     * @return NodeList<\DOM\Element>
+     */
+    public static function fromDOMHTMLCollection(\DOM\HTMLCollection $list): self
+    {
+        return new self(...values($list->getIterator()));
+    }
+
     /**
      * @template X of \DOM\Node
      * @param DOMNodeList<X> $list

diff --git a/src/Xml/Dom/Configurator/canonicalize.php b/src/Xml/Dom/Configurator/canonicalize.php
@@ -8,16 +8,20 @@
 use \DOM\XMLDocument as DOMDocument;
 use VeeWee\Xml\Dom\Document;
 use function Psl\Type\non_empty_string;
+use function VeeWee\Xml\Dom\Loader\xml_string_loader;
 
 /**
  * @return Closure(DOMDocument): DOMDocument
  */
 function canonicalize(): Closure
 {
     return static fn (DOMDocument $document): DOMDocument
-        => Document::fromXmlString(
-            non_empty_string()->assert($document->C14N()), // TODO : LIBXML_NSCLEAN + LIBXML_NOCDATA
-            // pretty_print() : TODO
+        => Document::fromLoader(
+            xml_string_loader(
+                non_empty_string()->assert($document->C14N()),
+                LIBXML_NSCLEAN + LIBXML_NOCDATA
+            ),
+            pretty_print(),
             normalize()
         )->toUnsafeDocument();
 }
diff --git a/src/Xml/Dom/Configurator/loader.php b/src/Xml/Dom/Configurator/loader.php
diff --git a/src/Xml/Dom/Configurator/normalize.php b/src/Xml/Dom/Configurator/normalize.php
@@ -13,8 +13,7 @@
 function normalize(): Closure
 {
     return static function (\DOM\XMLDocument $document): \DOM\XMLDocument {
-        // TODO : does not exist anmyore
-        // $document->normalizeDocument();
+        $document->normalize();
 
         return $document;
     };

diff --git a/src/Xml/Dom/Configurator/pretty_print.php b/src/Xml/Dom/Configurator/pretty_print.php
@@ -13,7 +13,8 @@
 function pretty_print(): Closure
 {
     return static function (\DOM\XMLDocument $document): \DOM\XMLDocument {
-        $document->preserveWhiteSpace = false;
+        // TODO :  not fully implemented yet in the new API
+        //$document->preserveWhiteSpace = false;
         $document->formatOutput = true;
 
         return $document;

diff --git a/src/Xml/Dom/Configurator/trim_spaces.php b/src/Xml/Dom/Configurator/trim_spaces.php
@@ -13,7 +13,8 @@
 function trim_spaces(): Closure
 {
     return static function (\DOM\XMLDocument $document): \DOM\XMLDocument {
-        $document->preserveWhiteSpace = false;
+        // TODO :  not fully implemented yet in the new API
+        //$document->preserveWhiteSpace = false;
         $document->formatOutput = false;
 
         return $document;

diff --git a/src/Xml/Dom/Configurator/utf8.php b/src/Xml/Dom/Configurator/utf8.php
@@ -13,7 +13,7 @@
 function utf8(): Closure
 {
     return static function (\DOM\XMLDocument $document): \DOM\XMLDocument {
-        $document->encoding = 'UTF-8';
+        $document->charset = 'UTF-8';
 
         return $document;
     };

diff --git a/src/Xml/Dom/Document.php b/src/Xml/Dom/Document.php
@@ -14,10 +14,7 @@
 use VeeWee\Xml\ErrorHandling\Issue\IssueCollection;
 use VeeWee\Xml\Exception\RuntimeException;
 use function Psl\Vec\map;
-use function VeeWee\Xml\Dom\Configurator\loader;
-use function VeeWee\Xml\Dom\Loader\xml_file_loader;
-use function VeeWee\Xml\Dom\Loader\xml_node_loader;
-use function VeeWee\Xml\Dom\Loader\xml_string_loader;
+use function VeeWee\Xml\Dom\Loader;
 use function VeeWee\Xml\Dom\Locator\document_element;
 use function VeeWee\Xml\Dom\Mapper\xml_string;
 use function VeeWee\Xml\Internal\configure;
@@ -47,18 +44,28 @@ public static function configure(callable ... $configurators): self
     }
 
     /**
+     * @param callable(): XMLDocument $loader
      * @param list<callable(XMLDocument): XMLDocument> $configurators
      *
      * @throws RuntimeException
      */
-    public static function fromXmlFile(string $file, callable ...$configurators): self
+    public static function fromLoader(callable $loader, callable ...$configurators): self
     {
         return new self(
-            configure(...$configurators)(XMLDocument::createFromFile($file))
-            // TODO : What with loader(xml_file_loader($file))
+            configure(...$configurators)($loader())
         );
     }
 
+    /**
+     * @param list<callable(XMLDocument): XMLDocument> $configurators
+     *
+     * @throws RuntimeException
+     */
+    public static function fromXmlFile(string $file, callable ...$configurators): self
+    {
+        return self::fromLoader(Loader\xml_file_loader($file), ...$configurators);
+    }
+
     /**
      * @param non-empty-string $xml
      * @param list<callable(XMLDocument): XMLDocument> $configurators
@@ -67,10 +74,7 @@ public static function fromXmlFile(string $file, callable ...$configurators): se
      */
     public static function fromXmlString(string $xml, callable ...$configurators): self
     {
-        return new self(
-            configure(...$configurators)(XMLDocument::createFromString($xml))
-           // TODO : What with loader(xml_string_loader($file))
-        );
+        return self::fromLoader(Loader\xml_string_loader($xml), ...$configurators);
     }
 
     /**
@@ -80,10 +84,7 @@ public static function fromXmlString(string $xml, callable ...$configurators): s
      */
     public static function fromXmlNode(\DOM\Node $node, callable ...$configurators): self
     {
-        return self::configure(
-            loader(xml_node_loader($node)),
-            ...$configurators
-        );
+        return self::fromLoader(Loader\xml_node_loader($node), ...$configurators);
     }
 
     /**
@@ -93,9 +94,7 @@ public static function fromXmlNode(\DOM\Node $node, callable ...$configurators):
      */
     public static function fromUnsafeDocument(XMLDocument $document, callable ...$configurators): self
     {
-        return new self(
-            configure(...$configurators)($document)
-        );
+        return self::fromLoader(static fn () => $document, ...$configurators);
     }
 
     public function toUnsafeDocument(): XMLDocument

diff --git a/src/Xml/Dom/Loader/Loader.php b/src/Xml/Dom/Loader/Loader.php
@@ -8,5 +8,5 @@
 
 interface Loader
 {
-    public function __invoke(\DOM\XMLDocument $document): void;
+    public function __invoke(): XMLDocument;
 }
diff --git a/src/Xml/Dom/Loader/load.php b/src/Xml/Dom/Loader/load.php
diff --git a/src/Xml/Dom/Loader/xml_file_loader.php b/src/Xml/Dom/Loader/xml_file_loader.php
@@ -5,21 +5,19 @@
 namespace VeeWee\Xml\Dom\Loader;
 
 use Closure;
-use \DOM\XMLDocument;
+use DOM\XMLDocument;
 use Webmozart\Assert\Assert;
+use function VeeWee\Xml\ErrorHandling\disallow_issues;
 
 /**
  * @param int $options - bitmask of LIBXML_* constants https://www.php.net/manual/en/libxml.constants.php
- * @return Closure(\DOM\XMLDocument): void
+ * @return Closure(): XMLDocument
  */
 function xml_file_loader(string $file, int $options = 0): Closure
 {
-    return static function (\DOM\XMLDocument $document) use ($file, $options): void {
-        load(
-            static function () use ($document, $file, $options): bool {
-                Assert::fileExists($file);
-                return $document->load($file, $options);
-            }
-        );
-    };
+    return static fn () => disallow_issues(static function () use ($file, $options): XMLDocument {
+        Assert::fileExists($file);
+
+        return XMLDocument::createFromFile($file, $options);
+    });
 }
diff --git a/src/Xml/Dom/Loader/xml_node_loader.php b/src/Xml/Dom/Loader/xml_node_loader.php
@@ -6,16 +6,20 @@
 
 use Closure;
 use \DOM\XMLDocument;
-
 use \DOM\Node;
 use function VeeWee\Xml\Dom\Manipulator\Node\append_external_node;
+use function VeeWee\Xml\ErrorHandling\disallow_issues;
 
 /**
- * @return Closure(\DOM\XMLDocument): void
+ * @return Closure(): XMLDocument
  */
 function xml_node_loader(\DOM\Node $importedNode): Closure
 {
-    return static function (\DOM\XMLDocument $document) use ($importedNode): void {
-        load(static fn (): bool => (bool) append_external_node($document, $importedNode));
-    };
+    return static fn () => disallow_issues(static function () use ($importedNode): XMLDocument {
+        $document = XMLDocument::createEmpty();
+
+        append_external_node($document, $importedNode);
+
+        return $document;
+    });
 }
diff --git a/src/Xml/Dom/Loader/xml_string_loader.php b/src/Xml/Dom/Loader/xml_string_loader.php
@@ -6,15 +6,16 @@
 
 use Closure;
 use \DOM\XMLDocument;
+use function VeeWee\Xml\ErrorHandling\disallow_issues;
 
 /**
  * @param non-empty-string $xml
  * @param int $options - bitmask of LIBXML_* constants https://www.php.net/manual/en/libxml.constants.php
- * @return Closure(\DOM\XMLDocument): void
+ * @return Closure(): XMLDocument
  */
 function xml_string_loader(string $xml, int $options = 0): Closure
 {
-    return static function (\DOM\XMLDocument $document) use ($xml, $options): void {
-        load(static fn (): bool => $document->loadXML($xml, $options));
-    };
+    return static fn () => disallow_issues(static function () use ($xml, $options): XMLDocument {
+        return XMLDocument::createFromString($xml, $options);
+    });
 }
diff --git a/src/Xml/Dom/Locator/Element/locate_by_namespaced_tag_name.php b/src/Xml/Dom/Locator/Element/locate_by_namespaced_tag_name.php
@@ -12,5 +12,5 @@
  */
 function locate_by_namespaced_tag_name(\DOM\Element $node, string $namespace, string $localTagName): NodeList
 {
-    return NodeList::fromDOMNodeList($node->getElementsByTagNameNS($namespace, $localTagName));
+    return NodeList::fromDOMHTMLCollection($node->getElementsByTagNameNS($namespace, $localTagName));
 }
diff --git a/src/Xml/Dom/Locator/Element/locate_by_tag_name.php b/src/Xml/Dom/Locator/Element/locate_by_tag_name.php
@@ -12,5 +12,5 @@
  */
 function locate_by_tag_name(\DOM\Element $node, string $tag): NodeList
 {
-    return NodeList::fromDOMNodeList($node->getElementsByTagName($tag));
+    return NodeList::fromDOMHTMLCollection($node->getElementsByTagName($tag));
 }
diff --git a/src/Xml/Dom/Locator/Node/detect_document.php b/src/Xml/Dom/Locator/Node/detect_document.php
@@ -16,8 +16,5 @@
  */
 function detect_document(\DOM\Node $node): \DOM\XMLDocument
 {
-    $document = is_document($node) ? $node : $node->ownerDocument;
-    Assert::notNull($document, 'Expected to find an ownerDocument on provided \DOM\Node.');
-
-    return $document;
+    return is_document($node) ? $node : $node->ownerDocument;
 }