* Error collection

* Extend readme

Author: wol-soft

README.md

@@ -53,10 +53,13 @@ The *GeneratorConfiguration* object offers the following methods to configure th
 
 Method | Configuration | Example | Default
 --- | --- | --- | ---
-``` setNamespacePrefix(string $prefix) ``` | Configures a namespace prefix for all generated classes. The namespaces will be extended with the directory structure of the source directory. | ``` setNamespacePrefix('\\MyApp\\Model') ``` | Empty string so no namespace prefix will be used
-``` setImmutable(bool $immutable) ``` | If set to true the generated model classes will be delivered without setter methods for the object properties. | ``` setImmutable(true) ``` | false
+``` setNamespacePrefix(string $prefix) ``` | Configures a namespace prefix for all generated classes. The namespaces will be extended with the directory structure of the source directory. | ``` setNamespacePrefix('\MyApp\Model') ``` | Empty string so no namespace prefix will be used
+``` setImmutable(bool $immutable) ``` | If set to true the generated model classes will be delivered without setter methods for the object properties. | ``` setImmutable(false) ``` | true
+``` setCollectErrors(bool $collectErrors) ``` | By default the complete input is validated and in case of failing validations all error messages will be thrown in a single exception. If set to false the first failing validation will throw an exception. | ``` setCollectErrors(true) ``` | false
 ``` setPrettyPrint(bool $prettyPrint) ``` | If set to false, the generated model classes won't follow coding gudelines (but the generation is faster). If enabled the package [Symplify/EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard) will be used to clean up the generated code. | ``` setPrettyPrint(false) ``` | true
 ``` setOutputEnabled(bool $prettyPrint) ``` | Enable or disable output of the generation process to STDOUT | ``` setOutputEnabled(false) ``` | true
+``` setErrorRegistryClass(string $exceptionClass) ``` | Define a custom exception implementing the ErrorRegistryExceptionInterface to decouple the generated code from the library (if you want to declare the library as a dev-dependency). The exception will be thrown if a validation fails error collection is **enabled** | ``` setErrorRegistryClass(CustomException::class) ``` | PHPModelGenerator\Exception\ErrorRegistryException::class
+``` setExceptionClass(bool $prettyPrint) ``` | Define a custom exception to decouple the generated code from the library (if you want to declare the library as a dev-dependency). The exception will be thrown if a validation fails error collection is **disabled** | ``` setExceptionClass(CustomException::class) ``` | PHPModelGenerator\Exception\InvalidArgumentException::class
 
 ## How the heck does this work? ##
 

src/PropertyProcessor/PropertyCollectionProcessor.php

@@ -22,7 +22,6 @@ class PropertyCollectionProcessor
     public function __construct(array $requiredAttributes = [])
     {
         $this->requiredAttributes = $requiredAttributes;
-        return $this;
     }
 
     /**

src/Templates/Model.phptpl

@@ -47,7 +47,7 @@ class {{ class }}
     ) {
         {% if generatorConfiguration.collectErrors() %}
             if (!$errorRegistry) {
-                $this->isInitialClass = false;
+                $this->isInitialClass = true;
                 $this->errorRegistry = new {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}();
             }
         {% endif%}

src/Utils/RenderHelper.php

@@ -101,7 +101,7 @@ public function validationError(string $message): string
         $message = $this->escapeSingleQuotes($message);
 
         if ($this->generatorConfiguration->collectErrors()) {
-
+            return "\$this->errorRegistry->addError('$message');";
         }
 
         $exceptionClass = $this->getSimpleClassName($this->generatorConfiguration->getExceptionClass());

tests/Basic/ErrorCollectionTest.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Tests\Basic;
+
+use PHPModelGenerator\Exception\ErrorRegistryException;
+use PHPModelGenerator\Model\GeneratorConfiguration;
+use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
+use stdClass;
+
+/**
+ * Class ErrorCollectionTest
+ *
+ * @package PHPModelGenerator\Tests\Basic
+ */
+class ErrorCollectionTest extends AbstractPHPModelGeneratorTest
+{
+    /**
+     * @dataProvider validValuesForSinglePropertyDataProvider
+     *
+     * @param string $value
+     */
+    public function testValidValuesForMultipleChecksForSingleProperty(string $value): void
+    {
+        $className = $this->generateClassFromFile(
+            'MultipleChecksForSingleProperty.json',
+            (new GeneratorConfiguration())->setCollectErrors(true)
+        );
+
+        $object = new $className(['property' => $value]);
+        $this->assertSame($value, $object->getProperty());
+    }
+
+    public function validValuesForSinglePropertyDataProvider(): array
+    {
+        return [
+            'numeric string' => ['10'],
+            'letter string' => ['Ab'],
+            'special chars' => ['+.'],
+        ];
+    }
+    /**
+     * @dataProvider invalidValuesForSinglePropertyDataProvider
+     *
+     * @param string $value
+     */
+    public function testInvalidValuesForMultipleChecksForSinglePropertyThrowsAnException(
+        $value,
+        array $messages
+    ): void {
+        $this->expectExceptionObject($this->getErrorRegistryException($messages));
+
+        $className = $this->generateClassFromFile(
+            'MultipleChecksForSingleProperty.json',
+            (new GeneratorConfiguration())->setCollectErrors(true)
+        );
+
+        new $className(['property' => $value]);
+    }
+
+    public function invalidValuesForSinglePropertyDataProvider(): array
+    {
+        return [
+            'pattern invalid' => [
+                '  ',
+                ['property doesn\'t match pattern ^[^\s]+$']
+            ],
+            'length invalid' => [
+                'a',
+                ['property must not be shorter than 2']
+            ],
+            'pattern and length invalid' => [
+                ' ',
+                [
+                    'property doesn\'t match pattern ^[^\s]+$',
+                    'property must not be shorter than 2'
+                ]
+            ],
+            'null' => [null, ['invalid type for property']],
+            'int' => [1, ['invalid type for property']],
+            'float' => [0.92, ['invalid type for property']],
+            'bool' => [true, ['invalid type for property']],
+            'array' => [[], ['invalid type for property']],
+            '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;
+    }
+}

tests/Schema/ErrorCollectionTest/MultipleChecksForSingleProperty.json

@@ -0,0 +1,13 @@
+{
+  "type": "object",
+  "properties": {
+    "property": {
+      "type": "string",
+      "minLength": 2,
+      "pattern": "^[^\\s]+$"
+    }
+  },
+  "required": [
+    "property"
+  ]
+}