Allow to hydrate non-initialized readonly properties

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Yii Hydrator Change Log
 
-## 1.2.1 under development
+## 1.3.0 under development
 
-- no changes in this release.
+- Enh #85: Allow to hydrate non-initialized readonly properties (@vjik)
 
 ## 1.2.0 April 03, 2024
 

composer.json

@@ -34,7 +34,7 @@
     "require-dev": {
         "maglnet/composer-require-checker": "^4.7",
         "phpunit/phpunit": "^10.5",
-        "rector/rector": "^1.0.0",
+        "rector/rector": "1.0.*",
         "roave/infection-static-analysis-plugin": "^1.16",
         "spatie/phpunit-watcher": "^1.23",
         "vimeo/psalm": "^5.23",

src/Hydrator.php

@@ -79,7 +79,7 @@ public function hydrate(object $object, array|DataInterface $data = []): void
 
         $this->hydrateInternal(
             $object,
-            ReflectionFilter::filterProperties($reflectionClass),
+            ReflectionFilter::filterProperties($object, $reflectionClass),
             $data
         );
     }
@@ -108,7 +108,7 @@ public function create(string $class, array|DataInterface $data = []): object
 
         $this->hydrateInternal(
             $object,
-            ReflectionFilter::filterProperties($reflectionClass, $excludeProperties),
+            ReflectionFilter::filterProperties($object, $reflectionClass, $excludeProperties),
             $data
         );
 

src/Internal/ReflectionFilter.php

@@ -20,6 +20,7 @@ final class ReflectionFilter
      * @return array<string, ReflectionProperty>
      */
     public static function filterProperties(
+        object $object,
         ReflectionClass $reflectionClass,
         array $propertyNamesToFilter = []
     ): array {
@@ -30,7 +31,7 @@ public static function filterProperties(
                 continue;
             }
 
-            if ($property->isReadOnly()) {
+            if ($property->isReadOnly() && $property->isInitialized($object)) {
                 continue;
             }
             $propertyName = $property->getName();

tests/HydratorTest.php

@@ -32,6 +32,7 @@
 use Yiisoft\Hydrator\Tests\Support\Classes\FromPredefinedArrayClass;
 use Yiisoft\Hydrator\Tests\Support\Classes\InvalidDataResolverClass;
 use Yiisoft\Hydrator\Tests\Support\Classes\NestedModel\UserModel;
+use Yiisoft\Hydrator\Tests\Support\Classes\NonInitializedReadonlyProperties;
 use Yiisoft\Hydrator\Tests\Support\Classes\ObjectPropertyModel\ObjectPropertyModel;
 use Yiisoft\Hydrator\Tests\Support\Classes\ObjectPropertyModel\RedCar;
 use Yiisoft\Hydrator\Tests\Support\Classes\PreparePropertyClass;
@@ -747,4 +748,25 @@ public function testReadonlyObject(): void
         $this->assertSame(3, $object->c);
         $this->assertSame(4, $object->d);
     }
+
+    public function testCreateNonInitializedReadonlyProperties(): void
+    {
+        $hydrator = new Hydrator();
+
+        $object = $hydrator->create(NonInitializedReadonlyProperties::class, ['a' => 1, 'b' => 2]);
+
+        $this->assertSame('1', $object->a);
+        $this->assertSame('2', $object->b);
+    }
+
+    public function testHydrateNonInitializedReadonlyProperties(): void
+    {
+        $hydrator = new Hydrator();
+
+        $object = new NonInitializedReadonlyProperties('3');
+        $hydrator->hydrate($object, ['a' => 1, 'b' => 2]);
+
+        $this->assertSame('1', $object->a);
+        $this->assertSame('3', $object->b);
+    }
 }

tests/Support/Classes/NonInitializedReadonlyProperties.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Hydrator\Tests\Support\Classes;
+
+final class NonInitializedReadonlyProperties
+{
+    public readonly string $a;
+
+    public function __construct(
+        public readonly string $b,
+    ) {
+    }
+}