Add reconfigure

veewee · Jul 20, 2023 · c451252 · c451252
1 parent ad6651f
commit c451252
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 12 deletions.
diff --git a/src/Xml/Dom/Document.php b/src/Xml/Dom/Document.php
@@ -165,6 +165,16 @@ public function map(callable $mapper)
         return $mapper($this->document);
     }
 
+    /**
+     * @param list<callable(DOMDocument): DOMDocument> $configurators
+     *
+     * @throws RuntimeException
+     */
+    public function reconfigure(callable ... $configurators): self
+    {
+        return self::fromUnsafeDocument($this->document, ...$configurators);
+    }
+
     /**
      * @no-named-arguments
      */
@@ -174,6 +184,9 @@ public function traverse(Visitor ... $visitors): DOMNode
         return $traverser->traverse($this->map(document_element()));
     }
 
+    /**
+     * @return non-empty-string
+     */
     public function toXmlString(): string
     {
         return $this->map(xml_string());

diff --git a/src/Xml/Dom/Mapper/xml_string.php b/src/Xml/Dom/Mapper/xml_string.php
@@ -6,13 +6,14 @@
 
 use Closure;
 use DOMNode;
+use function Psl\Type\non_empty_string;
 use function VeeWee\Xml\Dom\Locator\Node\detect_document;
 use function VeeWee\Xml\Dom\Predicate\is_document;
 use function VeeWee\Xml\ErrorHandling\disallow_issues;
 use function VeeWee\Xml\ErrorHandling\disallow_libxml_false_returns;
 
 /**
- * @return \Closure(DOMNode): string
+ * @return \Closure(DOMNode): non-empty-string
  */
 function xml_string(): Closure
 {
@@ -22,7 +23,7 @@ static function () use ($node): string {
             $node = is_document($node) ? null : $node;
 
             return disallow_libxml_false_returns(
-                $document->saveXML($node),
+                non_empty_string()->assert($document->saveXML($node)),
                 'Unable to output XML as string'
             );
         }

diff --git a/tests/Xml/Dom/DocumentTest.php b/tests/Xml/Dom/DocumentTest.php
@@ -21,7 +21,7 @@ final class DocumentTest extends TestCase
 {
     use FillFileTrait;
 
-    
+
     public function test_it_can_create_a_document_from_dom(): void
     {
         $document = new DOMDocument();
@@ -30,7 +30,7 @@ public function test_it_can_create_a_document_from_dom(): void
         static::assertSame($document, $doc->toUnsafeDocument());
     }
 
-    
+
     public function test_it_can_create_an_empty_document(): void
     {
         $document = new DOMDocument();
@@ -39,7 +39,7 @@ public function test_it_can_create_an_empty_document(): void
         static::assertEquals($document, $doc->toUnsafeDocument());
     }
 
-    
+
     public function test_it_can_create_a_configured_document(): void
     {
         $document = new DOMDocument();
@@ -48,7 +48,7 @@ public function test_it_can_create_a_configured_document(): void
         static::assertEquals($document, $doc->toUnsafeDocument());
     }
 
-    
+
     public function test_it_can_add_various_configurators(): void
     {
         $doc = Document::fromXmlString(
@@ -64,7 +64,7 @@ public function test_it_can_add_various_configurators(): void
         static::assertXmlStringEqualsXmlString($xml, $doc->toXmlString());
     }
 
-    
+
     public function test_it_can_create_a_document_from_xml_nod(): void
     {
         $source = new DOMDocument();
@@ -78,7 +78,7 @@ public function test_it_can_create_a_document_from_xml_nod(): void
         static::assertXmlStringEqualsXmlString($xml, $doc->toXmlString());
     }
 
-    
+
     public function test_it_can_create_a_document_from_xml_file(): void
     {
         [$file, $handle] = $this->fillFile($xml = '<hello />');
@@ -93,7 +93,7 @@ public function test_it_can_create_a_document_from_xml_file(): void
         fclose($handle);
     }
 
-    
+
     public function test_it_can_create_a_document_from_xml_string(): void
     {
         $doc = Document::fromXmlString(
@@ -104,7 +104,7 @@ public function test_it_can_create_a_document_from_xml_string(): void
         static::assertXmlStringEqualsXmlString($xml, $doc->toXmlString());
     }
 
-    
+
     public function test_it_can_map(): void
     {
         $doc = new DOMDocument();
@@ -113,7 +113,7 @@ public function test_it_can_map(): void
 
         static::assertSame($mapped, $doc);
     }
-    
+
     public function test_it_can_traverse(): void
     {
         $doc = Document::fromXmlString('<hello>world</hello>');
@@ -131,4 +131,17 @@ public function onNodeLeave(DOMNode $node): Action
         static::assertXmlStringEqualsXmlString('<hello />', $doc->toXmlString());
         static::assertSame($result, $doc->map(document_element()));
     }
+
+    public function test_it_can_reconfigure_document(): void
+    {
+        $doc1 = Document::fromXmlString('<hello />');
+        $xml1 = $doc1->toXmlString();
+
+        $doc2 = $doc1->reconfigure(identity());
+        $xml2 = $doc2->toXmlString();
+
+        static::assertNotSame($doc1, $doc2);
+        static::assertSame($doc1->toUnsafeDocument(), $doc2->toUnsafeDocument());
+        static::assertXmlStringEqualsXmlString($xml1, $xml2);
+    }
 }
diff --git a/tests/Xml/Dom/Manipulator/Node/RenameTest.php b/tests/Xml/Dom/Manipulator/Node/RenameTest.php
@@ -113,7 +113,7 @@ public function test_it_can_rename_an_element_and_drop_prefix(): void
         $result = rename($node, 'thing');
 
         static::assertSame(
-            Document::fromUnsafeDocument($doc->map(comparable()))->toXmlString(),
+            $doc->reconfigure(comparable())->toXmlString(),
             Document::fromXmlString(
                 '<hello><thing xmlns="http://ok" xmlns:a="http://ok" xmlns:whatever="http://whatever" a:foo="bar"/></hello>',
                 comparable()