Fix error collection for composition properties

wol-soft · wol-soft · commit 23d47b1e566d · 2019-09-12T17:13:00.000+02:00
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ As an optional parameter you can set up a *GeneratorConfiguration* object to con
 ```php
 $generator = new Generator(
     (new GeneratorConfiguration())
-        ->setNamespacePrefix('\\MyApp\\Model')
+        ->setNamespacePrefix('\MyApp\Model')
         ->setImmutable(true)
 );
 
diff --git a/src/Exception/ErrorRegistryException.php b/src/Exception/ErrorRegistryException.php
@@ -18,6 +18,9 @@ class ErrorRegistryException extends Exception implements ErrorRegistryException
     public function addError(string $message): ErrorRegistryExceptionInterface
     {
         $this->errors[] = $message;
+
+        $this->message = join("\n", $this->errors);
+
         return $this;
     }
 
diff --git a/src/Model/RenderJob.php b/src/Model/RenderJob.php
@@ -113,7 +113,7 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
             $class = $render->renderTemplate(
                 'Model.phptpl',
                 [
-                    'namespace'              => empty($namespace) ? '' : "namespace $namespace;",
+                    'namespace'              => $namespace,
                     'use'                    => empty($use) ? '' : 'use ' . join(";\nuse ", array_unique($use)) . ';',
                     'class'                  => $this->className,
                     'baseValidators'         => $this->schema->getBaseValidators(),
diff --git a/src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php b/src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php
@@ -73,6 +73,7 @@ protected function generateValidators(PropertyInterface $property, array $proper
                 static::class,
                 [
                     'properties' => $properties,
+                    'generatorConfiguration' => $this->schemaProcessor->getGeneratorConfiguration(),
                     'viewHelper' => new RenderHelper($this->schemaProcessor->getGeneratorConfiguration()),
                     'availableAmount' => $availableAmount,
                     'composedValueValidation' => $this->getComposedValueValidation($availableAmount),
diff --git a/src/PropertyProcessor/ComposedValue/IfProcessor.php b/src/PropertyProcessor/ComposedValue/IfProcessor.php
@@ -70,6 +70,7 @@ protected function generateValidators(PropertyInterface $property, array $proper
                     'ifProperty' => $properties['if'],
                     'thenProperty' => $properties['then'],
                     'elseProperty' => $properties['else'],
+                    'generatorConfiguration' => $this->schemaProcessor->getGeneratorConfiguration(),
                     'viewHelper' => new RenderHelper($this->schemaProcessor->getGeneratorConfiguration()),
                     'onlyForDefinedValues' => $propertyData['onlyForDefinedValues'],
                 ]
diff --git a/src/Templates/Model.phptpl b/src/Templates/Model.phptpl
@@ -2,7 +2,9 @@
 
 declare(strict_types = 1);
 
-{{ namespace }}
+{% if namespace %}
+    namespace {{ namespace }};
+{% endif %}
 
 {{ use }}
 
@@ -12,7 +14,7 @@ declare(strict_types = 1);
  * are re-generated.
  *
  * Class {{ class }}
- * @package {{ namespace }}
+{% if namespace %} * @package {{ namespace }} {% endif %}
  */
 class {{ class }}
 {
@@ -38,7 +40,7 @@ class {{ class }}
      * @param array $modelData
      {% if generatorConfiguration.collectErrors() %}* @param {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }} $errorRegistry{% endif %}
      *
-     * @throws Throwable
+     * @throws {% if generatorConfiguration.collectErrors() %}{{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}{% else %}{{ viewHelper.getSimpleClassName(generatorConfiguration.getExceptionClass()) }}{% endif %}
      */
     public function __construct(
         array $modelData
@@ -48,6 +50,8 @@ class {{ class }}
             if (!$errorRegistry) {
                 $this->isInitialClass = true;
                 $this->errorRegistry = new {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}();
+            } else {
+                $this->errorRegistry = $errorRegistry;
             }
         {% endif%}
 
diff --git a/src/Templates/Validator/ComposedItem.phptpl b/src/Templates/Validator/ComposedItem.phptpl
@@ -5,9 +5,17 @@
     $succeededCompositionElements = {{ availableAmount }};
     $originalModelData = $value;
     $proposedValue = null;
+    {% if generatorConfiguration.collectErrors() %}
+        $originalErrorRegistry = $this->errorRegistry;
+        $this->errorRegistry = new {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}();
+    {% endif %}
 
     {% foreach properties as property %}
         try {
+            {% if generatorConfiguration.collectErrors() %}
+                $currentErrors = count($this->errorRegistry->getErrors());
+            {% endif %}
+
             {% if not postPropose %}
                 $proposedValue = $proposedValue ?? $value;
             {% endif %}
@@ -20,6 +28,14 @@
                 }
             {% endforeach %}
 
+            {% if generatorConfiguration.collectErrors() %}
+                // an error inside the composed validation occurred. Throw an exception to count the validity of the
+                // composition item
+                if ($currentErrors < count($this->errorRegistry->getErrors())) {
+                    throw new \Exception();
+                }
+            {% endif %}
+
             {% if postPropose %}
                 $proposedValue = $proposedValue ?? $value;
             {% endif %}
@@ -43,5 +59,9 @@
         $value = $proposedValue;
     {% endif %}
 
+    {% if generatorConfiguration.collectErrors() %}
+        $this->errorRegistry = $originalErrorRegistry;
+    {% endif %}
+
     return !({{ composedValueValidation }});
 })($value)
diff --git a/src/Templates/Validator/ConditionalComposedItem.phptpl b/src/Templates/Validator/ConditionalComposedItem.phptpl
@@ -4,20 +4,40 @@
 (function (&$value) use (&$modelData) {
     $originalModelData = $value;
     $ifValid  = true;
+    {% if generatorConfiguration.collectErrors() %}
+        $originalErrorRegistry = $this->errorRegistry;
+        $this->errorRegistry = new {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}();
+    {% endif %}
 
     try {
+        {% if generatorConfiguration.collectErrors() %}
+            $currentErrors = count($this->errorRegistry->getErrors());
+        {% endif %}
+
         {{ viewHelper.resolvePropertyDecorator(ifProperty) }}
 
         {% foreach ifProperty.getOrderedValidators() as validator %}
             if ({{ validator.getCheck() }}) {
                 {{ viewHelper.validationError(validator.getExceptionMessage()) }}
             }
         {% endforeach %}
+
+        {% if generatorConfiguration.collectErrors() %}
+            // an error inside the composed validation occurred. Throw an exception to count the validity of the
+            // composition item
+            if ($currentErrors < count($this->errorRegistry->getErrors())) {
+                throw new \Exception();
+            }
+        {% endif %}
     } catch (\Exception $e) {
         $ifValid = false;
     }
     $value = $originalModelData;
 
+    {% if generatorConfiguration.collectErrors() %}
+        $this->errorRegistry = $originalErrorRegistry;
+    {% endif %}
+
     if ($ifValid) {
         {% if thenProperty %}
             {{ viewHelper.resolvePropertyDecorator(thenProperty) }}
diff --git a/tests/AbstractPHPModelGeneratorTest.php b/tests/AbstractPHPModelGeneratorTest.php
@@ -3,9 +3,11 @@
 namespace PHPModelGenerator\Tests;
 
 use FilesystemIterator;
+use PHPModelGenerator\Exception\ErrorRegistryException;
 use PHPModelGenerator\Exception\FileSystemException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
+use PHPModelGenerator\Exception\ValidationException;
 use PHPModelGenerator\ModelGenerator;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPUnit\Framework\TestCase;
@@ -230,6 +232,61 @@ protected function combineDataProvider(array $dataProvider1, array $dataProvider
         return $result;
     }
 
+    protected function expectValidationError(GeneratorConfiguration $configuration, $messages): void
+    {
+        if (!is_array($messages)) {
+            $messages = [$messages];
+        }
+
+        if ($configuration->collectErrors()) {
+            $this->expectExceptionObject($this->getErrorRegistryException($messages));
+        } else {
+            $this->expectException(ValidationException::class);
+            $this->expectExceptionMessage($messages[0]);
+        }
+    }
+
+    protected function expectValidationErrorRegExp(GeneratorConfiguration $configuration, $messages)
+    {
+        if (!is_array($messages)) {
+            $messages = [$messages];
+        }
+
+        if ($configuration->collectErrors()) {
+            $exception = $this->getErrorRegistryException($messages);
+            $this->expectException(get_class($exception));
+            $this->expectExceptionMessageRegExp($exception->getMessage());
+        } else {
+            $this->expectException(ValidationException::class);
+            $this->expectExceptionMessageRegExp($messages[0]);
+        }
+    }
+
+    /**
+     * Set up an ErrorRegistryException containing the given messages
+     *
+     * @param array $messages
+     *
+     * @return ErrorRegistryException
+     */
+    protected function getErrorRegistryException(array $messages): ErrorRegistryException
+    {
+        $errorRegistry = new ErrorRegistryException();
+
+        foreach ($messages as $message) {
+            $errorRegistry->addError($message);
+        }
+
+        return $errorRegistry;
+    }
+
+    public function validationMethodDataProvider(): array {
+        return [
+            'Error Collection' => [new GeneratorConfiguration()],
+            'Direct Exception' => [(new GeneratorConfiguration())->setCollectErrors(false)],
+        ];
+    }
+
     /**
      * Get the annotated type for an object property
      *
diff --git a/tests/Basic/ErrorCollectionTest.php b/tests/Basic/ErrorCollectionTest.php
@@ -4,7 +4,6 @@
 
 namespace PHPModelGenerator\Tests\Basic;
 
-use PHPModelGenerator\Exception\ErrorRegistryException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 use stdClass;
@@ -85,22 +84,4 @@ public function invalidValuesForSinglePropertyDataProvider(): array
             'object' => [new stdClass(), ['invalid type for property']],
         ];
     }
-
-    /**
-     * Set up an ErrorRegistryException containing the given messages
-     *
-     * @param array $messages
-     *
-     * @return ErrorRegistryException
-     */
-    protected function getErrorRegistryException(array $messages): ErrorRegistryException
-    {
-        $errorRegistry = new ErrorRegistryException();
-
-        foreach ($messages as $message) {
-            $errorRegistry->addError($message);
-        }
-
-        return $errorRegistry;
-    }
 }
diff --git a/tests/ComposedValue/ComposedIfTest.php b/tests/ComposedValue/ComposedIfTest.php
@@ -2,7 +2,10 @@
 
 namespace PHPModelGenerator\Tests\ComposedValue;
 
-use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGenerator\Exception\FileSystemException;
+use PHPModelGenerator\Exception\RenderException;
+use PHPModelGenerator\Exception\SchemaException;
+use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
 
 /**
@@ -15,13 +18,18 @@ class ComposedIfTest extends AbstractPHPModelGeneratorTest
     /**
      * @dataProvider validConditionalObjectPropertyDataProvider
      *
+     * @param GeneratorConfiguration $configuration
      * @param string $streetAddress
      * @param string $country
      * @param string $postalCode
      */
-    public function testConditionalObjectProperty(?string $streetAddress, ?string $country, ?string $postalCode): void
-    {
-        $className = $this->generateClassFromFile('ConditionalObjectProperty.json');
+    public function testConditionalObjectProperty(
+        GeneratorConfiguration $configuration,
+        ?string $streetAddress,
+        ?string $country,
+        ?string $postalCode
+    ): void {
+        $className = $this->generateClassFromFile('ConditionalObjectProperty.json', $configuration);
 
         $object = new $className([
             'street_address' => $streetAddress,
@@ -36,29 +44,37 @@ public function testConditionalObjectProperty(?string $streetAddress, ?string $c
 
     public function validConditionalObjectPropertyDataProvider(): array
     {
-        return [
-            'not provided postal code' => ['1600 Pennsylvania Avenue NW', 'USA', null],
-            'USA postal code' => ['1600 Pennsylvania Avenue NW', 'USA', '20500'],
-            'Canada postal code' => ['24 Sussex Drive', 'Canada', 'K1M 1M4'],
-        ];
+        return $this->combineDataProvider(
+            $this->validationMethodDataProvider(),
+            [
+                'not provided postal code' => ['1600 Pennsylvania Avenue NW', 'USA', null],
+                'USA postal code' => ['1600 Pennsylvania Avenue NW', 'USA', '20500'],
+                'Canada postal code' => ['24 Sussex Drive', 'Canada', 'K1M 1M4'],
+            ]
+        );
     }
 
     /**
      * @dataProvider invalidConditionalObjectPropertyDataProvider
      *
+     * @param GeneratorConfiguration $configuration
      * @param string $streetAddress
      * @param string $country
      * @param string $postalCode
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
      */
     public function testInvalidConditionalObjectPropertyThrowsAnException(
+        GeneratorConfiguration $configuration,
         ?string $streetAddress,
         ?string $country,
         ?string $postalCode
     ): void {
-        $this->expectException(ValidationException::class);
-        $this->expectExceptionMessageRegExp('/postal_code doesn\'t match pattern .*/');
+        $this->expectValidationErrorRegExp($configuration, '/postal_code doesn\'t match pattern .*/');
 
-        $className = $this->generateClassFromFile('ConditionalObjectProperty.json');
+        $className = $this->generateClassFromFile('ConditionalObjectProperty.json', $configuration);
 
         new $className([
             'street_address' => $streetAddress,
@@ -69,11 +85,14 @@ public function testInvalidConditionalObjectPropertyThrowsAnException(
 
     public function invalidConditionalObjectPropertyDataProvider(): array
     {
-        return [
-            'empty provided postal code' => ['1600 Pennsylvania Avenue NW', 'USA', ''],
-            'Canadian postal code for USA' => ['1600 Pennsylvania Avenue NW', 'USA', 'K1M 1M4'],
-            'USA postal code for Canada' => ['24 Sussex Drive', 'Canada', '20500'],
-            'Unmatching postal code for both' => ['24 Sussex Drive', 'Canada', 'djqwWDJId8juw9duq9'],
-        ];
+        return $this->combineDataProvider(
+            $this->validationMethodDataProvider(),
+            [
+                'empty provided postal code' => ['1600 Pennsylvania Avenue NW', 'USA', ''],
+                'Canadian postal code for USA' => ['1600 Pennsylvania Avenue NW', 'USA', 'K1M 1M4'],
+                'USA postal code for Canada' => ['24 Sussex Drive', 'Canada', '20500'],
+                'Unmatching postal code for both' => ['24 Sussex Drive', 'Canada', 'djqwWDJId8juw9duq9'],
+            ]
+        );
     }
 }
diff --git a/tests/ComposedValue/ComposedNotTest.php b/tests/ComposedValue/ComposedNotTest.php
diff --git a/tests/Objects/AnyPropertyTest.php b/tests/Objects/AnyPropertyTest.php
diff --git a/tests/Objects/ArrayPropertyTest.php b/tests/Objects/ArrayPropertyTest.php
diff --git a/tests/Objects/StringPropertyTest.php b/tests/Objects/StringPropertyTest.php
diff --git a/tests/Schema/AnyPropertyTest/RequiredAnyProperty.json b/tests/Schema/AnyPropertyTest/RequiredAnyProperty.json

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@ class ErrorRegistryException extends Exception implements ErrorRegistryException`
`18`	`18`	`public function addError(string $message): ErrorRegistryExceptionInterface`
`19`	`19`	`{`
`20`	`20`	`$this->errors[] = $message;`
	`21`	`+`
	`22`	`+ $this->message = join("\n", $this->errors);`
	`23`	`+`
`21`	`24`	`return $this;`
`22`	`25`	`}`
`23`	`26`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):`
`113`	`113`	`$class = $render->renderTemplate(`
`114`	`114`	`'Model.phptpl',`
`115`	`115`	`[`
`116`		`- 'namespace' => empty($namespace) ? '' : "namespace $namespace;",`
	`116`	`+ 'namespace' => $namespace,`
`117`	`117`	`'use' => empty($use) ? '' : 'use ' . join(";\nuse ", array_unique($use)) . ';',`
`118`	`118`	`'class' => $this->className,`
`119`	`119`	`'baseValidators' => $this->schema->getBaseValidators(),`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ protected function generateValidators(PropertyInterface $property, array $proper`
`73`	`73`	`static::class,`
`74`	`74`	`[`
`75`	`75`	`'properties' => $properties,`
	`76`	`+ 'generatorConfiguration' => $this->schemaProcessor->getGeneratorConfiguration(),`
`76`	`77`	`'viewHelper' => new RenderHelper($this->schemaProcessor->getGeneratorConfiguration()),`
`77`	`78`	`'availableAmount' => $availableAmount,`
`78`	`79`	`'composedValueValidation' => $this->getComposedValueValidation($availableAmount),`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ protected function generateValidators(PropertyInterface $property, array $proper`
`70`	`70`	`'ifProperty' => $properties['if'],`
`71`	`71`	`'thenProperty' => $properties['then'],`
`72`	`72`	`'elseProperty' => $properties['else'],`
	`73`	`+ 'generatorConfiguration' => $this->schemaProcessor->getGeneratorConfiguration(),`
`73`	`74`	`'viewHelper' => new RenderHelper($this->schemaProcessor->getGeneratorConfiguration()),`
`74`	`75`	`'onlyForDefinedValues' => $propertyData['onlyForDefinedValues'],`
`75`	`76`	`]`