Merge pull request #384 from richard-myers/Resolve-Restoring-Promoted-Properties-During-Desrilization

Resolve handling of promoted properties during desrilization

Author: ilvalerione

src/StructuredOutput/Deserializer/Deserializer.php

@@ -57,6 +57,9 @@ protected function deserializeObject(array $data, string $className): object
         // Get all properties including private/protected
         $properties = $reflection->getProperties();
 
+        // Track values set on promoted properties
+        $promotedArgs = [];
+
         foreach ($properties as $property) {
             $propertyName = $property->getName();
 
@@ -72,13 +75,18 @@ protected function deserializeObject(array $data, string $className): object
                 }
 
                 $property->setValue($instance, $value);
+
+                // Track any promoted arguments that are being set
+                if ($property->isPromoted()) {
+                    $promotedArgs[ $propertyName ] = $value;
+                }
             }
         }
 
         // Call constructor if it exists and is public
         $constructor = $reflection->getConstructor();
         if ($constructor && $constructor->isPublic() && $constructor->getNumberOfRequiredParameters() === 0) {
-            $constructor->invoke($instance);
+            $constructor->invokeArgs($instance, $promotedArgs);
         }
 
         return $instance;

tests/DeserializerTest.php

@@ -38,6 +38,43 @@ public function test_person_with_address(): void
         $this->assertEquals('Rome', $obj->address->city);
     }
 
+    public function test_constructor_as_new_instance(): void
+    {
+        // Check we can manually instantiate the class with values
+        $greenObj = new ColorWithDefaults(0, 255, 0);
+
+        $this->assertInstanceOf(ColorWithDefaults::class, $greenObj);
+        $this->assertEquals(0, $greenObj->r);
+        $this->assertEquals(255, $greenObj->g);
+        $this->assertEquals(0, $greenObj->b);
+    }
+
+    public function test_constructor_deserialize_with_default_values(): void
+    {
+        // Create a new instance from json deserialization, where all properties are optional and have default values (will be black)
+        $json = '{}';
+
+        $obj = Deserializer::make()->fromJson($json, ColorWithDefaults::class);
+
+        $this->assertInstanceOf(ColorWithDefaults::class, $obj);
+        $this->assertEquals(0, $obj->r);
+        $this->assertEquals(0, $obj->g);
+        $this->assertEquals(0, $obj->b);
+    }
+
+    public function test_constructor_deserialize_with_provided_values(): void
+    {
+        // Create a new instance, where properties are being provided for a "green" color
+        $json = '{"r": 0, "g": 255, "b": 0}';
+
+        $obj = Deserializer::make()->fromJson($json, ColorWithDefaults::class);
+
+        $this->assertInstanceOf(ColorWithDefaults::class, $obj);
+        $this->assertEquals(0, $obj->r);
+        $this->assertEquals(255, $obj->g);
+        $this->assertEquals(0, $obj->b);
+    }
+
     public function test_deserialize_array(): void
     {
         $json = '{"firstName": "John", "lastName": "Doe", "tags": [{"name": "agent"}]}';

tests/Stubs/StructuredOutput/ColorWithDefaults.php

@@ -0,0 +1,21 @@
+<?php
+
+declare( strict_types=1 );
+
+namespace NeuronAI\Tests\Stubs\StructuredOutput;
+
+use NeuronAI\StructuredOutput\SchemaProperty;
+
+class ColorWithDefaults
+{
+
+    public function __construct(
+        #[SchemaProperty( description: "The RED", required: false )]
+        public int $r = 0,
+        #[SchemaProperty( description: "The GREEN", required: false )]
+        public int $g = 0,
+        #[SchemaProperty( description: "The BLUE", required: false )]
+        public int $b = 0,
+    ) {}
+
+}