Add setter hooks to PopulatePostProcessor

Author: wol-soft

src/SchemaProcessor/PostProcessor/PopulatePostProcessor.php

@@ -6,6 +6,7 @@
 
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Model\Schema;
+use PHPModelGenerator\SchemaProcessor\Hook\SchemaHookResolver;
 
 /**
  * Class PopulatePostProcessor
@@ -16,6 +17,14 @@ class PopulatePostProcessor implements PostProcessorInterface
 {
     public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
     {
-        $schema->addMethod('populate', new RenderedMethod($schema, $generatorConfiguration, 'Populate.phptpl'));
+        $schema->addMethod(
+            'populate',
+            new RenderedMethod(
+                $schema,
+                $generatorConfiguration,
+                'Populate.phptpl',
+                ['schemaHookResolver' => new SchemaHookResolver($schema)]
+            )
+        );
     }
 }

src/SchemaProcessor/PostProcessor/Templates/Populate.phptpl

@@ -24,6 +24,8 @@ public function populate(array $modelData): self
 
     {% foreach schema.getProperties() as property %}
         if (array_key_exists('{{ property.getName() }}', $modelData)) {
+            {{ schemaHookResolver.resolveSetterBeforeValidationHook(property) }}
+
             $rollbackValues['{{ property.getAttribute() }}'] = $this->{{ property.getAttribute() }};
             $this->process{{ viewHelper.ucfirst(property.getAttribute()) }}($modelData);
         }
@@ -49,5 +51,13 @@ public function populate(array $modelData): self
 
     $this->rawModelDataInput = array_merge($this->rawModelDataInput, $modelData);
 
+    {% foreach schema.getProperties() as property %}
+        {% if schemaHookResolver.resolveSetterAfterValidationHook(property) %}
+            if (array_key_exists('{{ property.getName() }}', $modelData)) {
+                {{ schemaHookResolver.resolveSetterAfterValidationHook(property) }}
+            }
+        {% endif %}
+    {% endforeach %}
+
     return $this;
 }

tests/PostProcessor/PopulatePostProcessorTest.php

@@ -10,8 +10,13 @@
 use PHPModelGenerator\Exception\Object\MaxPropertiesException;
 use PHPModelGenerator\Exception\String\PatternException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
+use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\ModelGenerator;
+use PHPModelGenerator\SchemaProcessor\Hook\SetterAfterValidationHookInterface;
+use PHPModelGenerator\SchemaProcessor\Hook\SetterBeforeValidationHookInterface;
 use PHPModelGenerator\SchemaProcessor\PostProcessor\PopulatePostProcessor;
+use PHPModelGenerator\SchemaProcessor\PostProcessor\PostProcessorInterface;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 
 class PopulatePostProcessorTest extends AbstractPHPModelGeneratorTest
@@ -20,7 +25,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->modifyModelGenerator = function (ModelGenerator $generator) {
+        $this->modifyModelGenerator = function (ModelGenerator $generator): void {
             $generator->addPostProcessor(new PopulatePostProcessor());
         };
     }
@@ -145,4 +150,104 @@ public function invalidPopulateDataProvider(): array
             ],
         ];
     }
+
+    public function testSetterBeforeValidationHookInsidePopulateIsResolved(): void
+    {
+        $this->modifyModelGenerator = function (ModelGenerator $modelGenerator): void {
+            $modelGenerator->addPostProcessor(new PopulatePostProcessor());
+            $modelGenerator->addPostProcessor(new class () implements PostProcessorInterface {
+                public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
+                {
+                    $schema->addSchemaHook(new class () implements SetterBeforeValidationHookInterface {
+                        public function getCode(PropertyInterface $property): string
+                        {
+                            return $property->getName() === 'age'
+                                ? 'throw new \Exception("SetterBeforeValidationHook");'
+                                : '';
+                        }
+                    });
+                }
+            });
+        };
+
+        $className = $this->generateClassFromFile('BasicSchema.json');
+
+        $object = new $className(['name' => 'Albert', 'age' => 35]);
+        $object->populate(['name' => 'Hannes']);
+
+        $this->expectException(Exception::class);
+        $this->expectExceptionMessage("SetterBeforeValidationHook");
+
+        $object->populate(['age' => 40]);
+    }
+
+    /**
+     * @dataProvider setterAfterValidationHookDataProvider
+     *
+     * @param string|null $expectedException
+     * @param string|null $expectedExceptionMessage
+     * @param array $populateValues
+     */
+    public function testSetterAfterValidationHookInsidePopulateIsResolved(
+        ?string $expectedException,
+        ?string $expectedExceptionMessage,
+        array $populateValues
+    ): void
+    {
+        $this->modifyModelGenerator = function (ModelGenerator $modelGenerator): void {
+            $modelGenerator->addPostProcessor(new PopulatePostProcessor());
+            $modelGenerator->addPostProcessor(new class () implements PostProcessorInterface {
+                public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
+                {
+                    $schema->addSchemaHook(new class () implements SetterAfterValidationHookInterface {
+                        public function getCode(PropertyInterface $property): string
+                        {
+                            return $property->getName() === 'age'
+                                ? 'throw new \Exception("SetterAfterValidationHook");'
+                                : '';
+                        }
+                    });
+                }
+            });
+        };
+
+        $className = $this->generateClassFromFile('BasicSchema.json');
+
+        $object = new $className(['name' => 'Albert', 'age' => 35]);
+
+        if ($expectedException) {
+            $this->expectException($expectedException);
+            $this->expectExceptionMessage($expectedExceptionMessage);
+        } else {
+            $this->expectNotToPerformAssertions();
+        }
+
+        $object->populate($populateValues);
+    }
+
+    public function setterAfterValidationHookDataProvider(): array
+    {
+        return [
+            'update not hooked value valid' => [
+                null,
+                null,
+                ['name' => 'Hannes'],
+            ],
+            'update not hooked value invalid' => [
+                InvalidTypeException::class,
+                'Invalid type for name. Requires string, got boolean',
+                ['name' => false],
+            ],
+            'update hooked value valid' => [
+                Exception::class,
+                'SetterAfterValidationHook',
+                ['age' => 40],
+            ],
+            'update hooked value invalid' => [
+                InvalidTypeException::class,
+                'Invalid type for age. Requires int, got boolean',
+                ['age' => false],
+            ],
+        ];
+    }
 }