Fix error collection for composition properties

Author: wol-soft

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)
 );
 

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;
     }
 

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(),

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),

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'],
                 ]

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%}
 

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)

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) }}

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
      *

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;
-    }
 }