Adding InnerList::fromHttpValue named constructor

Author: nyamsprod

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All Notable changes to `bakame/http-strucured-fields` will be documented in this file
 
+## [Next] - TBD
+
+### Added
+
+- `InnerList::fromHttpValue` named constructor to make the public API consistent for all VOs
+
+### Fixed
+
+- None
+
+### Deprecated
+
+- None
+
+### Removed
+
+- None
+
 ## [0.2.0] - 2022-03-20
 
 ### Added

src/InnerList.php

@@ -63,12 +63,17 @@ private static function filterMember(Item|ByteSequence|Token|bool|int|float|stri
         };
     }
 
+    public static function fromHttpValue(string $httpValue): self
+    {
+        return Parser::parseInnerList($httpValue);
+    }
+
     public function toHttpValue(): string
     {
-        return '('
-            .implode(' ', array_map(fn (Item $value): string => $value->toHttpValue(), $this->members))
-            .')'
-            .$this->parameters->toHttpValue();
+        return '('.implode(' ', array_map(
+            fn (Item $value): string => $value->toHttpValue(),
+            $this->members
+        )).')'.$this->parameters->toHttpValue();
     }
 
     public function count(): int

src/InnerListTest.php

@@ -146,4 +146,20 @@ public function it_fails_to_access_unknown_parameter_values(): void
 
         self::assertNull($instance->parameters->value('bar'));
     }
+
+    /**
+     * @test
+     */
+    public function it_successfully_parse_a_http_field(): void
+    {
+        $instance = InnerList::fromHttpValue('("hello)world" 42 42.0;john=doe);foo="bar("');
+
+        self::assertCount(3, $instance);
+        self::assertCount(1, $instance->parameters);
+        self::assertSame('bar(', $instance->parameters->value('foo'));
+        self::assertSame('hello)world', $instance->get(0)->value);
+        self::assertSame(42, $instance->get(1)->value);
+        self::assertSame(42.0, $instance->get(2)->value);
+        self::assertInstanceOf(Token::class, $instance->get(2)->parameters->value('john'));
+    }
 }

src/Parser.php

@@ -20,7 +20,7 @@
  *
  * @see https://www.rfc-editor.org/rfc/rfc8941.html#section-4.2
  *
- * @internal Use OrderedList::fromHttpValue() or Dictionary::fromHttpValue() instead
+ * @internal Use Dictionary::fromHttpValue(), OrderedList::fromHttpValue(), InnerList::fromHttpValue() or Item::fromHttpValue() instead
  */
 final class Parser
 {
@@ -95,6 +95,26 @@ public static function parseDictionary(string $httpValue): array
         return $members;
     }
 
+    /**
+     * Returns a InnerList value object from an HTTP textual representation.
+     *
+     * @see https://www.rfc-editor.org/rfc/rfc8941.html#section-4.2.1.2
+     */
+    public static function parseInnerList(string $httpValue): InnerList
+    {
+        if ('(' !== $httpValue[0]) {
+            throw new SyntaxError("The HTTP textual representation `$httpValue` for a inner list is missing a parenthesis.");
+        }
+
+        [$members, $offset] = self::parseInnerListValue($httpValue);
+        $remainder = ltrim(substr($httpValue, $offset), " \t");
+        if ('' !== $remainder) {
+            throw new SyntaxError("The HTTP textual representation `$httpValue` for a inner list contains invalid data.");
+        }
+
+        return $members;
+    }
+
     /**
      * Returns an Item or an InnerList value object from an HTTP textual representation.
      *
@@ -105,7 +125,7 @@ public static function parseDictionary(string $httpValue): array
     private static function parseItemOrInnerList(string $httpValue): array
     {
         if ('(' === $httpValue[0]) {
-            return self::parseInnerList($httpValue);
+            return self::parseInnerListValue($httpValue);
         }
 
         [$value, $offset] = self::parseBareItem($httpValue);
@@ -118,13 +138,13 @@ private static function parseItemOrInnerList(string $httpValue): array
     }
 
     /**
-     * Returns an InnerList value object from an HTTP textual representation.
+     * Returns an InnerList value object from an HTTP textual representation and the consumed offset.
      *
      * @see https://www.rfc-editor.org/rfc/rfc8941.html#section-4.2.1.2
      *
      * @return array{0:InnerList, 1:int}
      */
-    private static function parseInnerList(string $httpValue): array
+    private static function parseInnerListValue(string $httpValue): array
     {
         $members = [];
         $remainder = substr($httpValue, 1);