Merge pull request #1569 from gregtyler/support-value-types

Support value types in serialization
schmittjoh · Nov 24, 2024 · 6b86447 · 6b86447
2 parents a093b21 + 9538cce
commit 6b86447
Show file tree

Hide file tree

Showing 8 changed files with 114 additions and 0 deletions.
diff --git a/src/GraphNavigator/DeserializationGraphNavigator.php b/src/GraphNavigator/DeserializationGraphNavigator.php
@@ -128,6 +128,8 @@ public function accept($data, ?array $type = null)
 
             case 'bool':
             case 'boolean':
+            case 'false':
+            case 'true':
                 return $this->visitor->visitBoolean($data, $type);
 
             case 'double':

diff --git a/src/GraphNavigator/SerializationGraphNavigator.php b/src/GraphNavigator/SerializationGraphNavigator.php
@@ -156,6 +156,8 @@ public function accept($data, ?array $type = null)
 
             case 'bool':
             case 'boolean':
+            case 'true':
+            case 'false':
                 return $this->visitor->visitBoolean((bool) $data, $type);
 
             case 'double':

diff --git a/src/Metadata/Driver/TypedPropertiesDriver.php b/src/Metadata/Driver/TypedPropertiesDriver.php
@@ -75,6 +75,8 @@ private function getDefaultWhiteList(): array
             'float',
             'bool',
             'boolean',
+            'true',
+            'false',
             'string',
             'double',
             'iterable',

diff --git a/tests/Fixtures/DataFalse.php b/tests/Fixtures/DataFalse.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures;
+
+class DataFalse
+{
+    public false $data;
+
+    public function __construct(
+        false $data
+    ) {
+        $this->data = $data;
+    }
+}
diff --git a/tests/Fixtures/DataTrue.php b/tests/Fixtures/DataTrue.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures;
+
+class DataTrue
+{
+    public true $data;
+
+    public function __construct(
+        true $data
+    ) {
+        $this->data = $data;
+    }
+}
diff --git a/tests/Fixtures/TypedProperties/UnionTypedProperties.php b/tests/Fixtures/TypedProperties/UnionTypedProperties.php
@@ -10,6 +10,8 @@ class UnionTypedProperties
 
     private int|bool|float|string|null $nullableData;
 
+    private string|false $valueTypedUnion;
+
     public function __construct($data)
     {
         $this->data = $data;

diff --git a/tests/Metadata/Driver/UnionTypedPropertiesDriverTest.php b/tests/Metadata/Driver/UnionTypedPropertiesDriverTest.php
@@ -57,6 +57,31 @@ public function testInferUnionTypesShouldResultInManyTypes()
         );
     }
 
+    public function testInferUnionTypesShouldIncludeValueTypes()
+    {
+        $m = $this->resolve(UnionTypedProperties::class);
+
+        self::assertEquals(
+            [
+                'name' => 'union',
+                'params' =>
+                    [
+                        [
+                            [
+                                'name' => 'string',
+                                'params' => [],
+                            ],
+                            [
+                                'name' => 'false',
+                                'params' => [],
+                            ],
+                        ],
+                    ],
+            ],
+            $m->propertyMetadata['valueTypedUnion']->type,
+        );
+    }
+
     private function resolve(string $classToResolve): ClassMetadata
     {
         $namingStrategy = new IdenticalPropertyNamingStrategy();

diff --git a/tests/Serializer/JsonSerializationTest.php b/tests/Serializer/JsonSerializationTest.php
@@ -15,6 +15,8 @@
 use JMS\Serializer\SerializationContext;
 use JMS\Serializer\Tests\Fixtures\Author;
 use JMS\Serializer\Tests\Fixtures\AuthorList;
+use JMS\Serializer\Tests\Fixtures\DataFalse;
+use JMS\Serializer\Tests\Fixtures\DataTrue;
 use JMS\Serializer\Tests\Fixtures\DiscriminatedAuthor;
 use JMS\Serializer\Tests\Fixtures\DiscriminatedComment;
 use JMS\Serializer\Tests\Fixtures\FirstClassMapCollection;
@@ -27,6 +29,7 @@
 use JMS\Serializer\Visitor\Factory\JsonSerializationVisitorFactory;
 use JMS\Serializer\Visitor\SerializationVisitorInterface;
 use PHPUnit\Framework\Attributes\DataProvider;
+use TypeError;
 
 class JsonSerializationTest extends BaseSerializationTestCase
 {
@@ -151,6 +154,8 @@ protected static function getContent($key)
             $outputs['data_float'] = '{"data":1.236}';
             $outputs['data_bool'] = '{"data":false}';
             $outputs['data_string'] = '{"data":"foo"}';
+            $outputs['data_true'] = '{"data":true}';
+            $outputs['data_false'] = '{"data":false}';
             $outputs['data_author'] = '{"data":{"full_name":"foo"}}';
             $outputs['data_comment'] = '{"data":{"author":{"full_name":"foo"},"text":"bar"}}';
             $outputs['data_discriminated_author'] = '{"data":{"full_name":"foo","objectType":"author"}}';
@@ -480,6 +485,50 @@ public function testSerializingUnionProperties()
         self::assertEquals(static::getContent('data_string'), $serialized);
     }
 
+    public function testTrueDataType()
+    {
+        if (PHP_VERSION_ID < 80200) {
+            $this->markTestSkipped('True type requires PHP 8.2');
+
+            return;
+        }
+
+        self::assertEquals(
+            static::getContent('data_true'),
+            $this->serialize(new DataTrue(true)),
+        );
+
+        self::assertEquals(
+            new DataTrue(true),
+            $this->deserialize(static::getContent('data_true'), DataTrue::class),
+        );
+
+        $this->expectException(TypeError::class);
+        $this->deserialize(static::getContent('data_false'), DataTrue::class);
+    }
+
+    public function testFalseDataType()
+    {
+        if (PHP_VERSION_ID < 80200) {
+            $this->markTestSkipped('False type requires PHP 8.2');
+
+            return;
+        }
+
+        self::assertEquals(
+            static::getContent('data_false'),
+            $this->serialize(new DataFalse(false)),
+        );
+
+        self::assertEquals(
+            new DataFalse(false),
+            $this->deserialize(static::getContent('data_false'), DataFalse::class),
+        );
+
+        $this->expectException(TypeError::class);
+        $this->deserialize(static::getContent('data_true'), DataFalse::class);
+    }
+
     public function testDeserializingComplexDiscriminatedUnionProperties()
     {
         if (PHP_VERSION_ID < 80000) {