Allow pattern properties when additional properties is set to false

setAdditionalProperty must not check if the provided property key matches an internal property

Author: wol-soft

docs/source/generator/postProcessor.rst

@@ -243,6 +243,7 @@ What can you do inside your custom post processor?
     * Implement the **GetterHookInterface** to add code to your getter methods
     * Implement the **SetterBeforeValidationHookInterface** to add code to the beginning of your setter methods
     * Implement the **SetterAfterValidationHookInterface** to add code to the end of your setter methods
+    * Implement the **SerializationHookInterface** to add code to the end of your serialization process
 
 .. warning::
 

src/Model/Validator/NoAdditionalPropertiesValidator.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Model\Validator;
+
+use PHPModelGenerator\Exception\Object\AdditionalPropertiesException;
+use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Utils\RenderHelper;
+
+/**
+ * Class NoAdditionalPropertiesValidator
+ *
+ * @package PHPModelGenerator\Model\Validator
+ */
+class NoAdditionalPropertiesValidator extends PropertyTemplateValidator
+{
+    /**
+     * PropertyDependencyValidator constructor.
+     *
+     * @param PropertyInterface $property
+     * @param array $json
+     */
+    public function __construct(PropertyInterface $property, array $json)
+    {
+        parent::__construct(
+            $property,
+            DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'NoAdditionalProperties.phptpl',
+            [
+                'properties' => RenderHelper::varExportArray(array_keys($json['properties'] ?? [])),
+                'pattern' => addcslashes(join('|', array_keys($json['patternProperties'] ?? [])), "'/"),
+            ],
+            AdditionalPropertiesException::class,
+            ['&$additionalProperties']
+        );
+    }
+}

src/PropertyProcessor/Property/BaseProcessor.php

@@ -7,7 +7,6 @@
 use PHPMicroTemplate\Exception\FileSystemException;
 use PHPMicroTemplate\Exception\SyntaxErrorException;
 use PHPMicroTemplate\Exception\UndefinedSymbolException;
-use PHPModelGenerator\Exception\Object\AdditionalPropertiesException;
 use PHPModelGenerator\Exception\Object\MaxPropertiesException;
 use PHPModelGenerator\Exception\Object\MinPropertiesException;
 use PHPModelGenerator\Exception\SchemaException;
@@ -20,6 +19,7 @@
 use PHPModelGenerator\Model\Validator\AbstractComposedPropertyValidator;
 use PHPModelGenerator\Model\Validator\AdditionalPropertiesValidator;
 use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
+use PHPModelGenerator\Model\Validator\NoAdditionalPropertiesValidator;
 use PHPModelGenerator\Model\Validator\PatternPropertiesValidator;
 use PHPModelGenerator\Model\Validator\PropertyNamesValidator;
 use PHPModelGenerator\Model\Validator\PropertyTemplateValidator;
@@ -29,7 +29,6 @@
 use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
 use PHPModelGenerator\PropertyProcessor\PropertyFactory;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
-use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class BaseObjectProcessor
@@ -148,14 +147,9 @@ protected function addAdditionalPropertiesValidator(JsonSchema $propertySchema):
         }
 
         $this->schema->addBaseValidator(
-            new PropertyValidator(
+            new NoAdditionalPropertiesValidator(
                 new Property($this->schema->getClassName(), null, $propertySchema),
-                sprintf(
-                    '$additionalProperties = array_diff(array_keys($modelData), %s)',
-                    RenderHelper::varExportArray(array_keys($json['properties'] ?? []))
-                ),
-                AdditionalPropertiesException::class,
-                ['&$additionalProperties']
+                $json
             )
         );
     }

src/SchemaProcessor/PostProcessor/AdditionalPropertiesAccessorPostProcessor.php

@@ -103,9 +103,17 @@ private function addSetAdditionalPropertyMethod(
         ?PropertyInterface $validationProperty
     ): void {
         $objectProperties = RenderHelper::varExportArray(
-            array_map(function (PropertyInterface $property): string {
-                return $property->getName();
-            }, $schema->getProperties())
+            array_map(
+                function (PropertyInterface $property): string {
+                    return $property->getName();
+                },
+                array_filter(
+                    $schema->getProperties(),
+                    function (PropertyInterface $property): bool {
+                        return !$property->isInternal();
+                    }
+                )
+            )
         );
 
         $schema->addUsedClass(RegularPropertyAsAdditionalPropertyException::class);

src/Templates/Validator/NoAdditionalProperties.phptpl

@@ -0,0 +1,15 @@
+$additionalProperties =  (function () use ($modelData): array {
+    $additionalProperties = array_diff(array_keys($modelData), {{ properties }});
+
+    {% if pattern %}
+        // filter out all pattern properties
+        $additionalProperties = array_filter(
+            $additionalProperties,
+            function (string $property): bool {
+                return preg_match('/{{ pattern }}/', $property) !== 1;
+            }
+        );
+    {% endif %}
+
+    return $additionalProperties;
+})()

tests/PostProcessor/PatternPropertiesAccessorPostProcessorTest.php

@@ -7,6 +7,7 @@
 use DateTime;
 use Exception;
 use PHPModelGenerator\Exception\ErrorRegistryException;
+use PHPModelGenerator\Exception\Object\AdditionalPropertiesException;
 use PHPModelGenerator\Exception\Object\UnknownPatternPropertyException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Exception\ValidationException;
@@ -459,4 +460,27 @@ public function testPatternPropertiesWithFilter(): void
         $this->assertSame('array', $returnType->getName());
         $this->assertFalse($returnType->allowsNull());
     }
+
+    public function testPatternPropertiesCanBeAddedWhenAdditionalPropertiesAreDenied(): void
+    {
+        $this->addPostProcessors(new PatternPropertiesAccessorPostProcessor(), new PopulatePostProcessor());
+
+        $className = $this->generateClassFromFile(
+            'PatternPropertiesWithAdditionalPropertiesDenied.json',
+            (new GeneratorConfiguration())->setSerialization(true)->setImmutable(false)->setCollectErrors(false)
+        );
+
+        $object = new $className(['a0' => 'Hello', 'a1' => 'World']);
+        $this->assertEqualsCanonicalizing(['a0' => 'Hello', 'a1' => 'World'], $object->toArray());
+
+        $object->populate(['a0' => 'Goodbye', 'a2' => 'cya']);
+        $this->assertEqualsCanonicalizing(['a0' => 'Goodbye', 'a1' => 'World', 'a2' => 'cya'], $object->toArray());
+
+        $this->expectException(AdditionalPropertiesException::class);
+        $this->expectExceptionMessageMatches(
+            '/Provided JSON for .* contains not allowed additional properties \[b1\]/'
+        );
+
+        $object->populate(['a0' => 'Hello', 'b1' => 'not allowed']);
+    }
 }

tests/Schema/PatternPropertiesAccessorPostProcessorTest/PatternPropertiesWithAdditionalPropertiesDenied.json

@@ -0,0 +1,9 @@
+{
+  "type": "object",
+  "patternProperties": {
+    "^a": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}