Implement an option to deny additional properties by default (#31)

Author: wol-soft

docs/source/generator/postProcessor.rst

@@ -92,6 +92,10 @@ AdditionalPropertiesAccessorPostProcessor
 
 The **AdditionalPropertiesAccessorPostProcessor** adds methods to your model to work with `additional properties <../complexTypes/object.html#additional-properties>`__ on your objects. By default the post processor only adds methods to objects from a schema which defines constraints for additional properties. If the first constructor parameter *$addForModelsWithoutAdditionalPropertiesDefinition* is set to true the methods will also be added to objects generated from a schema which doesn't define additional properties constraints. If the *additionalProperties* keyword in a schema is set to false the methods will never be added.
 
+.. note::
+
+    If the `deny additional properties setting <../gettingStarted.html#deny-additional-properties>`__ is set to true the setting *$addForModelsWithoutAdditionalPropertiesDefinition* is ignored as all objects which don't define additional properties are restricted to the defined properties
+
 Added methods
 ~~~~~~~~~~~~~
 

docs/source/gettingStarted.rst

@@ -172,6 +172,22 @@ If the implicit null option is enabled the interface of your classes may change.
     (new GeneratorConfiguration())
         ->setImplicitNull(true);
 
+Deny additional properties
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By default each generated object accepts additional properties. For strict property checks which error if undefined properties are provided each object must contain the *additionalProperties* kes set to *false*.
+
+By setting the **denyAdditionalProperties** option each object which doesn't specify a value for *additionalProperties* is restricted to the defined properties.
+
+.. code-block:: php
+
+    setDenyAdditionalProperties(bool $denyAdditionalProperties);
+
+.. code-block:: php
+
+    (new GeneratorConfiguration())
+        ->setDenyAdditionalProperties(true);
+
 Collect errors vs. early return
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

src/Model/GeneratorConfiguration.php

@@ -28,6 +28,8 @@ class GeneratorConfiguration
     /** @var bool */
     protected $allowImplicitNull = false;
     /** @var bool */
+    protected $denyAdditionalProperties = false;
+    /** @var bool */
     protected $prettyPrint = false;
     /** @var bool */
     protected $outputEnabled = true;
@@ -177,6 +179,26 @@ public function setImmutable(bool $immutable): self
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function denyAdditionalProperties(): bool
+    {
+        return $this->denyAdditionalProperties;
+    }
+
+    /**
+     * @param bool $denyAdditionalProperties
+     *
+     * @return $this
+     */
+    public function setDenyAdditionalProperties(bool $denyAdditionalProperties): self
+    {
+        $this->denyAdditionalProperties = $denyAdditionalProperties;
+
+        return $this;
+    }
+
     /**
      * @return bool
      */

src/PropertyProcessor/Property/BaseProcessor.php

@@ -119,6 +119,12 @@ protected function addAdditionalPropertiesValidator(JsonSchema $propertySchema):
     {
         $json = $propertySchema->getJson();
 
+        if (!isset($json['additionalProperties']) &&
+            $this->schemaProcessor->getGeneratorConfiguration()->denyAdditionalProperties()
+        ) {
+            $json['additionalProperties'] = false;
+        }
+
         if (!isset($json['additionalProperties']) || $json['additionalProperties'] === true) {
             return;
         }

src/SchemaProcessor/PostProcessor/AdditionalPropertiesAccessorPostProcessor.php

@@ -55,6 +55,7 @@ public function process(Schema $schema, GeneratorConfiguration $generatorConfigu
 
         if ((!$this->addForModelsWithoutAdditionalPropertiesDefinition && !isset($json['additionalProperties']))
             || (isset($json['additionalProperties']) && $json['additionalProperties'] === false)
+            || (!isset($json['additionalProperties']) && $generatorConfiguration->denyAdditionalProperties())
         ) {
             return;
         }

tests/Basic/AdditionalPropertiesTest.php

@@ -35,7 +35,12 @@ public function testAdditionalPropertiesAreIgnoredByDefault(array $propertyValue
      */
     public function testAdditionalPropertiesAreIgnoredWhenSetToTrue(array $propertyValue): void
     {
-        $className = $this->generateClassFromFileTemplate('AdditionalProperties.json', ['true']);
+        $className = $this->generateClassFromFileTemplate(
+            'AdditionalProperties.json',
+            ['true'],
+            // make sure the deny additional properties setting doesn't affect specified additional properties
+            (new GeneratorConfiguration())->setDenyAdditionalProperties(true)
+        );
 
         $object = new $className($propertyValue);
         $this->assertSame($propertyValue['name'] ?? null, $object->getName());
@@ -91,6 +96,27 @@ public function testAdditionalPropertiesThrowAnExceptionWhenSetToFalse(array $pr
         new $className($propertyValue);
     }
 
+    /**
+     * @dataProvider additionalPropertiesDataProvider
+     *
+     * @param array $propertyValue
+     */
+    public function testAdditionalPropertiesThrowAnExceptionWhenNotDefinedAndDeniedByGeneratorConfiguration(
+        array $propertyValue
+    ): void {
+        $this->expectException(AdditionalPropertiesException::class);
+        $this->expectExceptionMessageMatches(
+            '/Provided JSON for .* contains not allowed additional properties \[additional\]/'
+        );
+
+        $className = $this->generateClassFromFile(
+            'AdditionalPropertiesNotDefined.json',
+            (new GeneratorConfiguration())->setDenyAdditionalProperties(true)->setCollectErrors(false)
+        );
+
+        new $className($propertyValue);
+    }
+
     /**
      * @dataProvider validTypedAdditionalPropertiesDataProvider
      *

tests/PostProcessor/AdditionalPropertiesAccessorPostProcessorTest.php

@@ -57,6 +57,29 @@ public function testAdditionalPropertiesAccessorsAreNotGeneratedForAdditionalPro
         $this->assertFalse(is_callable([$object, 'removeAdditionalProperty']));
     }
 
+    /**
+     * @dataProvider additionalPropertiesAccessorPostProcessorConfigurationDataProvider
+     *
+     * @param bool $addForModelsWithoutAdditionalPropertiesDefinition
+     */
+    public function testAdditionalPropertiesAccessorsAreNotGeneratedWhenAdditionalPropertiesAreDenied(
+        bool $addForModelsWithoutAdditionalPropertiesDefinition
+    ): void {
+        $this->addPostProcessor($addForModelsWithoutAdditionalPropertiesDefinition);
+
+        $className = $this->generateClassFromFile(
+            'AdditionalPropertiesNotDefined.json',
+            (new GeneratorConfiguration())->setDenyAdditionalProperties(true)
+        );
+
+        $object = new $className();
+
+        $this->assertFalse(is_callable([$object, 'getAdditionalProperties']));
+        $this->assertFalse(is_callable([$object, 'getAdditionalProperty']));
+        $this->assertFalse(is_callable([$object, 'setAdditionalProperty']));
+        $this->assertFalse(is_callable([$object, 'removeAdditionalProperty']));
+    }
+
     /**
      * @dataProvider additionalPropertiesAccessorPostProcessorConfigurationDataProvider
      *
@@ -103,7 +126,11 @@ public function testAdditionalPropertiesAccessorsAreGeneratedForAdditionalProper
     ): void {
         $this->addPostProcessor($addForModelsWithoutAdditionalPropertiesDefinition);
 
-        $className = $this->generateClassFromFile('AdditionalProperties.json');
+        $className = $this->generateClassFromFile(
+            'AdditionalProperties.json',
+            // make sure the deny additional properties setting doesn't affect specified additional properties
+            (new GeneratorConfiguration())->setDenyAdditionalProperties(true)
+        );
 
         $object = new $className(['property1' => 'Hello', 'property2' => 'World']);