Adding support for __set_state magic method

Author: nyamsprod

src/ByteSequence.php

@@ -6,6 +6,18 @@
 
 final class ByteSequence implements StructuredField
 {
+    private function __construct(private string $value)
+    {
+    }
+
+    /**
+     * @param array{value:string} $properties
+     */
+    public static function __set_state(array $properties): self
+    {
+        return new self($properties['value']);
+    }
+
     /**
      * Returns a new instance from a Base64 encoded string.
      */
@@ -29,10 +41,6 @@ public static function fromDecoded(string $value): self
         return new self($value);
     }
 
-    private function __construct(private string $value)
-    {
-    }
-
     /**
      * Returns the decoded string.
      */

src/ByteSequenceTest.php

@@ -50,4 +50,18 @@ public function it_can_encode_raw_field(): void
         self::assertSame($source, $item->encoded());
         self::assertSame(":$source:", $item->toHttpValue());
     }
+
+    /**
+     * @test
+     */
+    public function it_can_be_regenerated_with_eval(): void
+    {
+        $decoded = 'pretend this is binary content.';
+        $item = ByteSequence::fromDecoded($decoded);
+
+        /** @var ByteSequence $generatedItem */
+        $generatedItem = eval('return '.var_export($item, true).';');
+
+        self::assertEquals($item, $generatedItem);
+    }
 }

src/Dictionary.php

@@ -19,6 +19,14 @@ private function __construct(
     ) {
     }
 
+    /**
+     * @param array{members:array<string, Item|InnerList>} $properties
+     */
+    public static function __set_state(array $properties): self
+    {
+        return new self($properties['members']);
+    }
+
     /**
      * Returns a new instance from an associative iterable construct.
      *

src/DictionaryTest.php

@@ -197,4 +197,18 @@ public function it_can_handle_string_with_comma(): void
         self::assertSame($expected, $instance->toHttpValue());
         self::assertCount(2, $instance);
     }
+
+    /**
+     * @test
+     */
+    public function it_can_be_regenerated_with_eval(): void
+    {
+        $expected = 'a=foobar;test="bar, baz", b=toto';
+        $instance = Dictionary::fromHttpValue($expected);
+
+        /** @var Dictionary $generatedInstance */
+        $generatedInstance = eval('return '.var_export($instance, true).';');
+
+        self::assertEquals($instance, $generatedInstance);
+    }
 }

src/InnerList.php

@@ -21,6 +21,14 @@ public function __construct(private Parameters $parameters, Item ...$members)
         $this->members = $members;
     }
 
+    /**
+     * @param array{members:array<Item>, parameters:Parameters} $properties
+     */
+    public static function __set_state(array $properties): self
+    {
+        return new self($properties['parameters'], ...$properties['members']);
+    }
+
     /**
      * @param iterable<Item|ByteSequence|Token|bool|int|float|string>        $members
      * @param iterable<string,Item|ByteSequence|Token|bool|int|float|string> $parameters

src/InnerListTest.php

@@ -153,4 +153,17 @@ public function it_can_merge_two_or_more_instances_to_yield_different_result():
         self::assertCount(3, $instance3);
         self::assertSame($expected->toHttpValue(), $instance3->toHttpValue());
     }
+
+    /**
+     * @test
+     */
+    public function it_can_be_regenerated_with_eval(): void
+    {
+        $instance = InnerList::fromMembers([false], ['foo' => 'bar']);
+
+        /** @var InnerList $generatedInstance */
+        $generatedInstance = eval('return '.var_export($instance, true).';');
+
+        self::assertEquals($instance, $generatedInstance);
+    }
 }

src/Item.php

@@ -12,6 +12,14 @@ private function __construct(
     ) {
     }
 
+    /**
+     * @param array{value:Token|ByteSequence|int|float|string|bool, parameters:Parameters} $properties
+     */
+    public static function __set_state(array $properties): self
+    {
+        return new self($properties['value'], $properties['parameters']);
+    }
+
     /**
      * Returns a new instance from a value type and an iterable of key-value parameters.
      *
@@ -107,13 +115,11 @@ private static function parseToken(string $string): array
             $regexp .= '$';
         }
 
-        if (1 !== preg_match('/'.$regexp.'/i', $string, $matches)) {
-            throw new SyntaxError("The HTTP textual representation `$string` for a token contains invalid characters.");
-        }
+        preg_match('/'.$regexp.'/i', $string, $found);
 
         return [
-            new Token($matches['token']),
-            substr($string, strlen($matches['token'])),
+            new Token($found['token']),
+            substr($string, strlen($found['token'])),
         ];
     }
 

src/ItemTest.php

@@ -189,4 +189,34 @@ public function test_in_can_be_instantiated_using_bare_items(): void
 
         self::assertEquals($item2, $item1);
     }
+
+    /**
+     * @test
+     */
+    public function it_will_fail_with_wrong_token(): void
+    {
+        $this->expectException(SyntaxError::class);
+
+        Item::fromHttpValue('foo,bar;a=3');
+    }
+
+    /**
+     * @test
+     */
+    public function it_can_be_regenerated_with_eval(): void
+    {
+        $instance = Item::from('/terms', [
+            'string' => '42',
+            'integer' => 42,
+            'float' => 4.2,
+            'boolean' => true,
+            'token' => new Token('forty-two'),
+            'byte-sequence' => ByteSequence::fromDecoded('a42'),
+        ]);
+
+        /** @var Item $generatedInstance */
+        $generatedInstance = eval('return '.var_export($instance, true).';');
+
+        self::assertEquals($instance, $generatedInstance);
+    }
 }

src/OrderedList.php

@@ -21,6 +21,14 @@ public function __construct(Item|InnerList ...$members)
         $this->members = $members;
     }
 
+    /**
+     * @param array{members:array<Item|InnerList>} $properties
+     */
+    public static function __set_state(array $properties): self
+    {
+        return new self(...$properties['members']);
+    }
+
     /**
      * @param iterable<InnerList|Item|ByteSequence|Token|bool|int|float|string> $members
      */

src/OrderedListTest.php

@@ -156,4 +156,17 @@ public function it_can_merge_without_argument_and_not_throw(): void
         $instance->merge();
         self::assertCount(1, $instance);
     }
+
+    /**
+     * @test
+     */
+    public function it_can_be_regenerated_with_eval(): void
+    {
+        $instance = OrderedList::fromMembers([Item::from(false)]);
+
+        /** @var OrderedList $generatedInstance */
+        $generatedInstance = eval('return '.var_export($instance, true).';');
+
+        self::assertEquals($instance, $generatedInstance);
+    }
 }