* Pattern properties must not occur in the additional properties

wol-soft · wol-soft · commit aa8378494757 · 2021-03-29T18:23:25.000+02:00
* Throw an exception for an invalid string pattern validator
diff --git a/src/Model/Validator/AdditionalPropertiesValidator.php b/src/Model/Validator/AdditionalPropertiesValidator.php
@@ -61,16 +61,17 @@ public function __construct(
             $propertiesStructure->withJson($propertiesStructure->getJson()[static::ADDITIONAL_PROPERTIES_KEY])
         );
 
+        $patternProperties = array_keys($schema->getJsonSchema()->getJson()['patternProperties'] ?? []);
+
         parent::__construct(
             new Property($propertyName ?? $schema->getClassName(), null, $propertiesStructure),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'AdditionalProperties.phptpl',
             [
                 'validationProperty' => $this->validationProperty,
-                'additionalProperties' => preg_replace(
-                    '(\d+\s=>)',
-                    '',
-                    var_export(array_keys($propertiesStructure->getJson()[static::PROPERTIES_KEY] ?? []), true)
+                'additionalProperties' => RenderHelper::varExportArray(
+                    array_keys($propertiesStructure->getJson()[static::PROPERTIES_KEY] ?? [])
                 ),
+                'patternProperties' => $patternProperties ? RenderHelper::varExportArray($patternProperties) : null,
                 'generatorConfiguration' => $schemaProcessor->getGeneratorConfiguration(),
                 'viewHelper' => new RenderHelper($schemaProcessor->getGeneratorConfiguration()),
                 // by default don't collect additional property data
diff --git a/src/Model/Validator/EnumValidator.php b/src/Model/Validator/EnumValidator.php
@@ -6,6 +6,7 @@
 
 use PHPModelGenerator\Exception\Generic\EnumException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class EnumValidator
@@ -25,9 +26,7 @@ public function __construct(PropertyInterface $property, array $allowedValues)
 
         parent::__construct(
             $property,
-            '!in_array($value, ' .
-                preg_replace('(\d+\s=>)', '', var_export($allowedValues, true)) .
-            ', true)',
+            '!in_array($value, ' . RenderHelper::varExportArray($allowedValues) . ', true)',
             EnumException::class,
             [$allowedValues]
         );
diff --git a/src/Model/Validator/PropertyDependencyValidator.php b/src/Model/Validator/PropertyDependencyValidator.php
@@ -6,6 +6,7 @@
 
 use PHPModelGenerator\Exception\Dependency\InvalidPropertyDependencyException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class PropertyDependencyValidator
@@ -26,11 +27,7 @@ public function __construct(PropertyInterface $property, array $dependencies)
             $property,
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'PropertyDependency.phptpl',
             [
-                'dependencies' => preg_replace(
-                    '(\d+\s=>)',
-                    '',
-                    var_export(array_values($dependencies), true)
-                ),
+                'dependencies' => RenderHelper::varExportArray(array_values($dependencies)),
             ],
             InvalidPropertyDependencyException::class,
             ['&$missingAttributes']
diff --git a/src/PropertyProcessor/Property/BaseProcessor.php b/src/PropertyProcessor/Property/BaseProcessor.php
@@ -29,6 +29,7 @@
 use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
 use PHPModelGenerator\PropertyProcessor\PropertyFactory;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
+use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class BaseObjectProcessor
@@ -151,7 +152,7 @@ protected function addAdditionalPropertiesValidator(JsonSchema $propertySchema):
                 new Property($this->schema->getClassName(), null, $propertySchema),
                 sprintf(
                     '$additionalProperties = array_diff(array_keys($modelData), %s)',
-                    preg_replace('(\d+\s=>)', '', var_export(array_keys($json['properties'] ?? []), true))
+                    RenderHelper::varExportArray(array_keys($json['properties'] ?? []))
                 ),
                 AdditionalPropertiesException::class,
                 ['&$additionalProperties']
@@ -173,9 +174,9 @@ protected function addPatternPropertiesValidator(JsonSchema $propertySchema): vo
         }
 
         foreach ($json['patternProperties'] as $pattern => $schema) {
-            if (preg_match("/$pattern/", '') === false) {
+            if (@preg_match("/$pattern/", '') === false) {
                 throw new SchemaException(
-                    "Invalid pattern $pattern for pattern property in file {$propertySchema->getFile()}"
+                    "Invalid pattern '$pattern' for pattern property in file {$propertySchema->getFile()}"
                 );
             }
 
diff --git a/src/PropertyProcessor/Property/StringProcessor.php b/src/PropertyProcessor/Property/StringProcessor.php
@@ -47,6 +47,8 @@ protected function generateValidators(PropertyInterface $property, JsonSchema $p
      *
      * @param PropertyInterface $property
      * @param JsonSchema $propertySchema
+     *
+     * @throws SchemaException
      */
     protected function addPatternValidator(PropertyInterface $property, JsonSchema $propertySchema): void
     {
@@ -56,6 +58,17 @@ protected function addPatternValidator(PropertyInterface $property, JsonSchema $
             return;
         }
 
+        if (@preg_match("/{$json[static::JSON_FIELD_PATTERN]}/", '') === false) {
+            throw new SchemaException(
+                sprintf(
+                    "Invalid pattern '%s' for property '%s' in file %s",
+                    $json[static::JSON_FIELD_PATTERN],
+                    $property->getName(),
+                    $propertySchema->getFile()
+                )
+            );
+        }
+
         $json[static::JSON_FIELD_PATTERN] = addcslashes($json[static::JSON_FIELD_PATTERN], "'");
 
         $property->addValidator(
diff --git a/src/SchemaProcessor/PostProcessor/AdditionalPropertiesAccessorPostProcessor.php b/src/SchemaProcessor/PostProcessor/AdditionalPropertiesAccessorPostProcessor.php
@@ -23,6 +23,7 @@
 use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\ArrayTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintDecorator;
 use PHPModelGenerator\SchemaProcessor\Hook\SchemaHookResolver;
+use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class AdditionalPropertiesAccessorPostProcessor
@@ -179,15 +180,10 @@ private function addSetAdditionalPropertyMethod(
         GeneratorConfiguration $generatorConfiguration,
         ?PropertyInterface $validationProperty
     ): void {
-        $objectProperties = preg_replace(
-            '(\d+\s=>)',
-            '',
-            var_export(
-                array_map(function (PropertyInterface $property): string {
-                    return $property->getName();
-                }, $schema->getProperties()),
-                true
-            )
+        $objectProperties = RenderHelper::varExportArray(
+            array_map(function (PropertyInterface $property): string {
+                return $property->getName();
+            }, $schema->getProperties())
         );
 
         $schema->addUsedClass(RegularPropertyAsAdditionalPropertyException::class);
@@ -295,6 +291,8 @@ private function addUpdateAdditionalProperties(Schema $schema): void
             new class ($schema) extends PropertyTemplateValidator {
                 public function __construct(Schema $schema)
                 {
+                    $patternProperties = array_keys($schema->getJsonSchema()->getJson()['patternProperties'] ?? []);
+
                     parent::__construct(
                         new Property($schema->getClassName(), null, $schema->getJsonSchema()),
                         join(
@@ -309,13 +307,11 @@ public function __construct(Schema $schema)
                             ]
                         ),
                         [
-                            'additionalProperties' => preg_replace(
-                                '(\d+\s=>)',
-                                '',
-                                var_export(
-                                    array_keys($schema->getJsonSchema()->getJson()['properties'] ?? []),
-                                    true
-                                )
+                            'patternProperties' => $patternProperties
+                                ? RenderHelper::varExportArray($patternProperties)
+                                : null,
+                            'additionalProperties' => RenderHelper::varExportArray(
+                                array_keys($schema->getJsonSchema()->getJson()['properties'] ?? [])
                             ),
                         ],
                         Exception::class
diff --git a/src/SchemaProcessor/PostProcessor/PatternPropertiesAccessorPostProcessor.php b/src/SchemaProcessor/PostProcessor/PatternPropertiesAccessorPostProcessor.php
@@ -49,9 +49,9 @@ public function process(Schema $schema, GeneratorConfiguration $generatorConfigu
                 $key = $json['patternProperties'][$validator->getPattern()]['key'] ?? $validator->getPattern();
                 $hash = md5($key);
 
-                if (in_array($hash, $patternHashes)) {
+                if (array_key_exists($hash, $patternHashes)) {
                     throw new SchemaException(
-                        "Duplicate pattern property key '$key' in file {$schema->getJsonSchema()->getFile()}"
+                        "Duplicate pattern property access key '$key' in file {$schema->getJsonSchema()->getFile()}"
                     );
                 }
 
diff --git a/src/SchemaProcessor/PostProcessor/Templates/AdditionalProperties/RemoveAdditionalProperty.phptpl b/src/SchemaProcessor/PostProcessor/Templates/AdditionalProperties/RemoveAdditionalProperty.phptpl
@@ -10,6 +10,15 @@
  */
 public function removeAdditionalProperty(string $property): bool
 {
+    if (isset($this->_patternProperties)) {
+        foreach ($this->_patternProperties as $patternHash => $_) {
+            if (isset($this->_patternProperties[$patternHash][$property])) {
+                unset($this->_patternProperties[$patternHash][$property]);
+                unset($this->_rawModelDataInput[$property]);
+            }
+        }
+    }
+
     if (!array_key_exists($property, $this->additionalProperties)) {
         return false;
     }
@@ -33,11 +42,5 @@ public function removeAdditionalProperty(string $property): bool
     unset($this->_rawModelDataInput[$property]);
     unset($this->additionalProperties[$property]);
 
-    if (isset($this->_patternProperties)) {
-        foreach ($this->_patternProperties as $patternHash => $_) {
-            unset($this->_patternProperties[$patternHash][$property]);
-        }
-    }
-
     return true;
 }
diff --git a/src/SchemaProcessor/PostProcessor/Templates/AdditionalProperties/UpdateAdditionalProperties.phptpl b/src/SchemaProcessor/PostProcessor/Templates/AdditionalProperties/UpdateAdditionalProperties.phptpl
@@ -1,5 +1,13 @@
 (function () use ($value) {
     foreach (array_diff(array_keys($value), {{ additionalProperties }}) as $propertyKey) {
+        {% if patternProperties %}
+            foreach ({{ patternProperties }} as $pattern) {
+                if (preg_match("/$pattern/", $propertyKey)) {
+                    continue 2;
+                }
+            }
+        {% endif %}
+
         $this->additionalProperties[$propertyKey] = $value[$propertyKey];
     }
 
diff --git a/src/Templates/Validator/AdditionalProperties.phptpl b/src/Templates/Validator/AdditionalProperties.phptpl
@@ -7,6 +7,14 @@
     {% endif %}
 
     foreach (array_diff(array_keys($properties), {{ additionalProperties }}) as $propertyKey) {
+        {% if patternProperties %}
+            foreach ({{ patternProperties }} as $pattern) {
+                if (preg_match("/$pattern/", $property)) {
+                    continue 2;
+                }
+            }
+        {% endif %}
+
         try {
             $value = $properties[$propertyKey];
 
diff --git a/src/Utils/RenderHelper.php b/src/Utils/RenderHelper.php
@@ -157,4 +157,9 @@ public function getTypeHintAnnotation(PropertyInterface $property, bool $outputT
 
         return implode('|', array_unique(explode('|', $typeHint)));
     }
+
+    public static function varExportArray(array $values): string
+    {
+        return preg_replace('(\d+\s=>)', '', var_export($values, true));
+    }
 }
diff --git a/tests/Basic/PatternPropertiesTest.php b/tests/Basic/PatternPropertiesTest.php
@@ -4,12 +4,26 @@
 
 namespace PHPModelGenerator\Tests\Basic;
 
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 use stdClass;
 
+/**
+ * Class PatternPropertiesTest
+ *
+ * @package PHPModelGenerator\Tests\Basic
+ */
 class PatternPropertiesTest extends AbstractPHPModelGeneratorTest
 {
+    public function testInvalidPatternThrowsAnException(): void
+    {
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessageMatches("/Invalid pattern 'ab\[c' for pattern property in file .*\.json/");
+
+        $this->generateClassFromFile('InvalidPattern.json');
+    }
+
     /**
      * @dataProvider invalidTypedPatternPropertyDataProvider
      */
diff --git a/tests/Objects/EnumPropertyTest.php b/tests/Objects/EnumPropertyTest.php
@@ -377,7 +377,7 @@ public function testNullProvidedEnumItemInRequiredUntypedEnumThrowsAnException(b
     public function testEmptyEnumThrowsSchemaException(): void
     {
         $this->expectException(SchemaException::class);
-        $this->expectExceptionMessage('Empty enum property property in file');
+        $this->expectExceptionMessageMatches('/Empty enum property property in file .*\.json/');
         $this->generateEnumClass('string', []);
     }
 
diff --git a/tests/Objects/ReferencePropertyTest.php b/tests/Objects/ReferencePropertyTest.php
@@ -33,7 +33,7 @@ class ReferencePropertyTest extends AbstractPHPModelGeneratorTest
     public function testNotResolvedReferenceThrowsAnException(string $reference): void
     {
         $this->expectException(SchemaException::class);
-        $this->expectExceptionMessage("Unresolved Reference $reference in file");
+        $this->expectExceptionMessageMatches("/Unresolved Reference $reference in file .*\.json/");
 
         $this->generateClassFromFileTemplate('NotResolvedReference.json', [$reference]);
     }
diff --git a/tests/Objects/StringPropertyTest.php b/tests/Objects/StringPropertyTest.php
@@ -195,6 +195,14 @@ public function testPatternMatchingStringIsValid(
         $this->assertSame($propertyValue, $object->getProperty());
     }
 
+    public function testInvalidPatternThrowsAnException(): void
+    {
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessageMatches("/Invalid pattern 'ab\[c' for property 'property' in file .*\.json/");
+
+        $this->generateClassFromFileTemplate('StringPropertyPattern.json', ['ab[c']);
+    }
+
     public function validPatternProvider(): array
     {
         return $this->combineDataProvider(
diff --git a/tests/PostProcessor/PatternPropertiesAccessorPostProcessorTest.php b/tests/PostProcessor/PatternPropertiesAccessorPostProcessorTest.php
@@ -7,6 +7,7 @@
 use Exception;
 use PHPModelGenerator\Exception\ErrorRegistryException;
 use PHPModelGenerator\Exception\Object\UnknownPatternPropertyException;
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Exception\ValidationException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\ModelGenerator;
@@ -42,6 +43,15 @@ public function testPatternPropertiesAccessorMethodIsNotGeneratedForObjectsWitho
         $this->assertFalse(is_callable([$object, 'getPatternProperties']));
     }
 
+    public function testDuplicatePatternPropertiesAccessKeyThrowsAnException(): void
+    {
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessageMatches("/Duplicate pattern property access key 'Numerics' in file .*\.json/");
+
+        $this->addPostProcessors(new PatternPropertiesAccessorPostProcessor());
+        $this->generateClassFromFile('DuplicateKey.json');
+    }
+
     public function testAccessingPatternProperties(): void
     {
         $this->addPostProcessors(new PatternPropertiesAccessorPostProcessor());
@@ -102,33 +112,27 @@ public function testModifyingPatternPropertiesViaAdditionalPropertiesAccessor():
 
         $this->assertEqualsCanonicalizing(['alpha' => null, 'a0' => 100], $object->getPatternProperties('Numerics'));
         $this->assertEqualsCanonicalizing(['beta' => null], $object->getPatternProperties('^b'));
-        $this->assertEqualsCanonicalizing(['a0' => 100], $object->getAdditionalProperties());
+        $this->assertSame([], $object->getAdditionalProperties());
 
         $object->setAdditionalProperty('b0', 'Hello');
         $this->assertEqualsCanonicalizing(['alpha' => null, 'a0' => 100], $object->getPatternProperties('Numerics'));
         $this->assertEqualsCanonicalizing(['beta' => null, 'b0' => 'Hello'], $object->getPatternProperties('^b'));
-        $this->assertEqualsCanonicalizing(['a0' => 100, 'b0' => 'Hello'], $object->getAdditionalProperties());
+        $this->assertSame([], $object->getAdditionalProperties());
 
         $object->setAdditionalProperty('c0', false);
         $this->assertEqualsCanonicalizing(['alpha' => null, 'a0' => 100], $object->getPatternProperties('Numerics'));
-        $this->assertEqualsCanonicalizing(['beta' => null, 'b0' => 'Hello'], $object->getPatternProperties('^b'));
-        $this->assertEqualsCanonicalizing(
-            ['a0' => 100, 'b0' => 'Hello', 'c0' => false],
-            $object->getAdditionalProperties()
-        );
+        $this->assertSame(['beta' => null, 'b0' => 'Hello'], $object->getPatternProperties('^b'));
+        $this->assertSame(['c0' => false], $object->getAdditionalProperties());
 
         $object->setAdditionalProperty('a0', 10);
         $this->assertEqualsCanonicalizing(['alpha' => null, 'a0' => 10], $object->getPatternProperties('Numerics'));
         $this->assertEqualsCanonicalizing(['beta' => null, 'b0' => 'Hello'], $object->getPatternProperties('^b'));
-        $this->assertEqualsCanonicalizing(
-            ['a0' => 10, 'b0' => 'Hello', 'c0' => false],
-            $object->getAdditionalProperties()
-        );
+        $this->assertSame(['c0' => false], $object->getAdditionalProperties());
 
         $object->removeAdditionalProperty('a0');
         $this->assertEqualsCanonicalizing(['alpha' => null], $object->getPatternProperties('Numerics'));
         $this->assertEqualsCanonicalizing(['beta' => null, 'b0' => 'Hello'], $object->getPatternProperties('^b'));
-        $this->assertEqualsCanonicalizing(['b0' => 'Hello', 'c0' => false], $object->getAdditionalProperties());
+        $this->assertSame(['c0' => false], $object->getAdditionalProperties());
     }
 
     /**
diff --git a/tests/Schema/PatternPropertiesAccessorPostProcessorTest/DuplicateKey.json b/tests/Schema/PatternPropertiesAccessorPostProcessorTest/DuplicateKey.json
@@ -0,0 +1,13 @@
+{
+  "type": "object",
+  "patternProperties": {
+    "^a": {
+      "type": "integer",
+      "key": "Numerics"
+    },
+    "^b": {
+      "type": "integer",
+      "key": "Numerics"
+    }
+  }
+}
diff --git a/tests/Schema/PatternPropertiesTest/InvalidPattern.json b/tests/Schema/PatternPropertiesTest/InvalidPattern.json
