- bugfix: invalid key values are transformed to <item key="">...</item> nodes

Author: kodeart

Serializer/XmlSerializer.php

@@ -18,9 +18,8 @@
 use InvalidArgumentException;
 use Koded\Stdlib\Serializer;
 use Throwable;
-use function array_keys;
+use function array_is_list;
 use function count;
-use function ctype_digit;
 use function current;
 use function error_log;
 use function filter_var;
@@ -31,10 +30,10 @@
 use function is_iterable;
 use function is_numeric;
 use function is_object;
-use function join;
 use function Koded\Stdlib\{json_serialize, json_unserialize};
 use function key;
 use function preg_match;
+use function str_contains;
 use function str_starts_with;
 use function substr;
 use function trim;
@@ -130,14 +129,26 @@ private function buildXml(
                 // node value
                 $parent->nodeValue = $data;
             } elseif (false === $isKeyNumeric && is_array($data)) {
-                if (ctype_digit(join('', array_keys($data)))) {
+                /*
+                 * If the data is an associative array (with numeric keys)
+                 * the structure is transformed to "item" nodes:
+                 *      <item key="0">$key0</item>
+                 *      <item key="1">$key1</item>
+                 * by appending it to the parent node (if any)
+                 */
+                if (array_is_list($data)) {
                     foreach ($data as $d) {
                         $this->appendNode($document, $parent, $d, $key);
                     }
                 } else {
                     $this->appendNode($document, $parent, $data, $key);
                 }
-            } elseif ($isKeyNumeric) {
+            } elseif ($isKeyNumeric || false === $this->hasValidName($key)) {
+                /* If the key is not a valid XML tag name,
+                 * transform the key to "item" node:
+                 *      <item key="$key">$value</item>
+                 * by appending it to the parent node (if any)
+                 */
                 $this->appendNode($document, $parent, $data, 'item', $key);
             } else {
                 $this->appendNode($document, $parent, $data, $key);
@@ -307,4 +318,11 @@ private function getValueByType(mixed $value): mixed
         }
         return $value[$this->val];
     }
+
+    private function hasValidName(int|string $key): bool
+    {
+        return $key &&
+            !str_contains($key, ' ') &&
+            preg_match('~^[\pL_][\pL0-9._:-]*$~ui', $key);
+    }
 }

tests/Serializer/XmlSerializationWithInvalidKeyNamesTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Tests\Koded\Stdlib\Serializer;
+
+use Koded\Stdlib\Serializer\XmlSerializer;
+use PHPUnit\Framework\TestCase;
+
+class XmlSerializationWithInvalidKeyNamesTest extends TestCase
+{
+    private XmlSerializer $serializer;
+
+    private string $xml = <<<XML
+<?xml version="1.0"?>
+<response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <explain>
+        <item key="/geo/ip\\.(json|xml)">Returns the client IP geo information</item>
+        <item key="/geo/(IP_ADDRESS).(json|xml)">Returns the IP address geo information</item>
+        <item key="/geo/">The &lt;index&gt; route</item>
+    </explain>
+ </response>
+XML;
+
+    private array $data = [
+        'explain' => [
+            '/geo/ip\.(json|xml)' => 'Returns the client IP geo information',
+            '/geo/(IP_ADDRESS).(json|xml)' => 'Returns the IP address geo information',
+            '/geo/' => 'The <index> route',
+        ]
+    ];
+
+    public function test_bug_for_serialization()
+    {
+        $this->assertXmlStringEqualsXmlString(
+            $this->xml,
+            $this->serializer->serialize($this->data)
+        );
+    }
+
+    public function test_bug_for_deserialization()
+    {
+        $this->assertTrue(
+            $this->data === $this->serializer->unserialize($this->xml)
+        );
+    }
+
+    protected function setUp(): void
+    {
+        $this->serializer = new XmlSerializer('response');
+    }
+}