Merge pull request #272 from sabre-io/staabm-patch-1

More precise `parseClarkNotation` return type
sabre-io · Apr 18, 2024 · 3e499be · 3e499be
2 parents 43cea9f + 51eb072
commit 3e499be
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 9 deletions.
diff --git a/lib/Service.php b/lib/Service.php
@@ -241,7 +241,6 @@ public function write(string $rootElementName, $value, ?string $contextUri = nul
     public function mapValueObject(string $elementName, string $className): void
     {
         list($namespace) = self::parseClarkNotation($elementName);
-        $namespace = $namespace ?? '';
 
         $this->elementMap[$elementName] = function (Reader $reader) use ($className, $namespace) {
             return \Sabre\Xml\Deserializer\valueObject($reader, $className, $namespace);
@@ -282,7 +281,7 @@ public function writeValueObject(object $object, ?string $contextUri = null): st
      *
      * If the string was invalid, it will throw an InvalidArgumentException.
      *
-     * @return array{string|null, string}
+     * @return array{string, string}
      *
      * @throws \InvalidArgumentException
      */

diff --git a/lib/Writer.php b/lib/Writer.php
@@ -124,7 +124,6 @@ public function startElement($name): bool
         if ('{' === $name[0]) {
             list($namespace, $localName) =
                 Service::parseClarkNotation($name);
-            $namespace = $namespace ?? '';
 
             if (array_key_exists($namespace, $this->namespaceMap)) {
                 $result = $this->startElementNS(
@@ -239,7 +238,6 @@ public function writeAttribute($name, $value): bool
             $localName
         ) = Service::parseClarkNotation($name);
 
-        $namespace = $namespace ?? '';
         if (array_key_exists($namespace, $this->namespaceMap)) {
             // It's an attribute with a namespace we know
             return $this->writeAttribute(

diff --git a/tests/Sabre/Xml/ServiceTest.php b/tests/Sabre/Xml/ServiceTest.php
@@ -352,12 +352,14 @@ public function testWriteVoNotFound(): void
         $service->writeValueObject(new \stdClass());
     }
 
-    public function testParseClarkNotation(): void
+    /**
+     * @param array<string> $expected
+     *
+     * @dataProvider provideParseClarkNotationInput
+     */
+    public function testParseClarkNotation(string $clark, array $expected): void
     {
-        self::assertEquals([
-            'http://sabredav.org/ns',
-            'elem',
-        ], Service::parseClarkNotation('{http://sabredav.org/ns}elem'));
+        self::assertEquals($expected, Service::parseClarkNotation($clark));
     }
 
     public function testParseClarkNotationFail(): void
@@ -366,6 +368,17 @@ public function testParseClarkNotationFail(): void
         Service::parseClarkNotation('http://sabredav.org/ns}elem');
     }
 
+    /**
+     * @return array<int, list{string, array<string>}>
+     */
+    public function provideParseClarkNotationInput(): iterable
+    {
+        return [
+            ['{http://sabredav.org/ns}elem', ['http://sabredav.org/ns', 'elem']],
+            ['{}elem', ['', 'elem']],
+        ];
+    }
+
     /**
      * @return array<int, array<int, string|resource|false>>
      */