Rework remaining exceptions

Enno Woortmann · Enno Woortmann · commit e33ffa016242 · 2020-06-23T16:55:13.000+02:00
diff --git a/docs/source/combinedSchemas/allOf.rst b/docs/source/combinedSchemas/allOf.rst
@@ -39,7 +39,7 @@ Possible exception (if a string is provided):
 .. code-block:: none
 
     Invalid value for example declined by composition constraint.
-      Requires to match 2 composition elements but matched 0 elements.
+      Requires to match all composition elements but matched 0 elements.
       - Composition element #1: Failed
         * Invalid type for example. Requires float, got string
       - Composition element #2: Failed
diff --git a/docs/source/complexTypes/array.rst b/docs/source/complexTypes/array.rst
@@ -56,7 +56,7 @@ With a schema like this all items must contain a string with at least two charac
 
 .. code-block:: none
 
-    Invalid item in array example:
+    Invalid items in array example:
       - invalid item #3
         * Invalid type for item of array example. Requires string, got double
 
diff --git a/docs/source/complexTypes/multiType.rst b/docs/source/complexTypes/multiType.rst
@@ -54,6 +54,6 @@ For example if an array **["Hello", 123, "Goodbye"]** is given the validation wi
 
 .. code-block:: none
 
-    Invalid item in array example:
+    Invalid items in array example:
       - invalid item #1
         * Invalid type for item of array example. Requires string, got integer
diff --git a/docs/source/generic/combinedException.rst b/docs/source/generic/combinedException.rst
@@ -60,30 +60,30 @@ The exception which will be thrown (combined array-exception and combined-schema
 
 .. code-block:: none
 
-    Invalid item in array property:
+    Invalid items in array property:
       - invalid item #0
         * Invalid value for item of array property declined by composition constraint.
-          Requires to match 2 composition elements but matched 1 elements.
+          Requires to match all composition elements but matched 1 elements.
           - Composition element #1: Failed
             * Invalid type for name. Requires string, got boolean
           - Composition element #2: Valid
       - invalid item #1
         * Invalid value for item of array property declined by composition constraint.
-          Requires to match 2 composition elements but matched 0 elements.
+          Requires to match all composition elements but matched 0 elements.
           - Composition element #1: Failed
             * Value for name must not be shorter than 2
           - Composition element #2: Failed
             * Invalid type for age. Requires int, got string
       - invalid item #2
         * Invalid value for item of array property declined by composition constraint.
-          Requires to match 2 composition elements but matched 0 elements.
+          Requires to match all composition elements but matched 0 elements.
           - Composition element #1: Failed
             * Invalid type for item of array property. Requires object, got integer
           - Composition element #2: Failed
             * Invalid type for item of array property. Requires object, got integer
       - invalid item #3
         * Invalid value for item of array property declined by composition constraint.
-          Requires to match 2 composition elements but matched 1 elements.
+          Requires to match all composition elements but matched 1 elements.
           - Composition element #1: Failed
             * Missing required value for name
             * Invalid type for name. Requires string, got NULL
diff --git a/src/Model/Validator/ConditionalPropertyValidator.php b/src/Model/Validator/ConditionalPropertyValidator.php
@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
+use PHPModelGenerator\Exception\ComposedValue\ConditionalException;
 use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\PropertyProcessor\ComposedValue\IfProcessor;
@@ -28,9 +29,10 @@ public function __construct(
         array $validatorVariables
     ) {
         parent::__construct(
-            "Invalid value for {$property->getName()} declined by conditional composition constraint",
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ConditionalComposedItem.phptpl',
-            $validatorVariables
+            $validatorVariables,
+            ConditionalException::class,
+            [$property->getName()]
         );
 
         $this->composedProcessor = IfProcessor::class;
diff --git a/src/Model/Validator/FilterValidator.php b/src/Model/Validator/FilterValidator.php
@@ -4,10 +4,11 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
+use PHPModelGenerator\Exception\Generic\IncompatibleFilterException;
+use PHPModelGenerator\Exception\Generic\InvalidFilterValueException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Model\Property\PropertyInterface;
-use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\PropertyProcessor\Filter\FilterInterface;
 use PHPModelGenerator\PropertyProcessor\Filter\TransformingFilterInterface;
 use PHPModelGenerator\Utils\RenderHelper;
@@ -24,13 +25,14 @@ class FilterValidator extends PropertyTemplateValidator
     /**
      * FilterValidator constructor.
      *
-     * @param GeneratorConfiguration $generatorConfiguration
-     * @param FilterInterface $filter
-     * @param PropertyInterface $property
-     * @param array $filterOptions
+     * @param GeneratorConfiguration           $generatorConfiguration
+     * @param FilterInterface                  $filter
+     * @param PropertyInterface                $property
+     * @param array                            $filterOptions
      * @param TransformingFilterInterface|null $transformingFilter
      *
      * @throws SchemaException
+     * @throws ReflectionException
      */
     public function __construct(
         GeneratorConfiguration $generatorConfiguration,
@@ -44,11 +46,6 @@ public function __construct(
             : $this->validateFilterCompatibilityWithTransformedType($filter, $transformingFilter, $property);
 
         parent::__construct(
-            sprintf(
-                'Filter %s is not compatible with property type " . gettype($value) . " for property %s',
-                $filter->getToken(),
-                $property->getName()
-            ),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'Filter.phptpl',
             [
                 'skipTransformedValuesCheck' => false,
@@ -63,13 +60,15 @@ public function __construct(
                 'filterClass' => $filter->getFilter()[0],
                 'filterMethod' => $filter->getFilter()[1],
                 'filterOptions' => var_export($filterOptions, true),
-                'transferExceptionMessage' => sprintf(
-                    'Invalid value for property %s denied by filter %s: {$e->getMessage()}',
-                    $property->getName(),
-                    $filter->getToken()
+                'filterValueValidator' => new PropertyValidator(
+                    '',
+                    InvalidFilterValueException::class,
+                    [$property->getName(), $filter->getToken(), '&$filterException']
                 ),
                 'viewHelper' => new RenderHelper($generatorConfiguration),
-            ]
+            ],
+            IncompatibleFilterException::class,
+            [$property->getName(), $filter->getToken()]
         );
     }
 
diff --git a/src/Model/Validator/PassThroughTypeCheckValidator.php b/src/Model/Validator/PassThroughTypeCheckValidator.php
@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
+use PHPModelGenerator\Exception\Generic\InvalidTypeException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use ReflectionType;
 
@@ -37,12 +38,8 @@ public function __construct(
                 ReflectionTypeCheckValidator::fromReflectionType($passThroughType, $property)->getCheck(),
                 $typeCheckValidator->getCheck()
             ),
-            sprintf(
-                'Invalid type for %s. Requires [%s, %s], got " . gettype($value) . "',
-                $property->getName(),
-                $passThroughType->getName(),
-                $property->getType()
-            )
+            InvalidTypeException::class,
+            [$property->getName(), [$passThroughType->getName(), $property->getType()]]
         );
     }
 
diff --git a/src/Model/Validator/PropertyDependencyValidator.php b/src/Model/Validator/PropertyDependencyValidator.php
@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
+use PHPModelGenerator\Exception\Dependency\InvalidPropertyDependencyException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
@@ -22,11 +23,6 @@ class PropertyDependencyValidator extends PropertyTemplateValidator
     public function __construct(PropertyInterface $property, array $dependencies)
     {
         parent::__construct(
-            sprintf(
-                'Missing required attributes which are dependants of %s:' .
-                    '\n  - " . join("\n  - ", $missingAttributes) . "',
-                $property->getName()
-            ),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'PropertyDependency.phptpl',
             [
                 'propertyName' => $property->getName(),
@@ -35,7 +31,9 @@ public function __construct(PropertyInterface $property, array $dependencies)
                     '',
                     var_export(array_values($dependencies), true)
                 ),
-            ]
+            ],
+            InvalidPropertyDependencyException::class,
+            [$property->getName(), '&$missingAttributes']
         );
     }
 
diff --git a/src/Model/Validator/PropertyNamesValidator.php b/src/Model/Validator/PropertyNamesValidator.php
@@ -7,6 +7,7 @@
 use PHPMicroTemplate\Exception\FileSystemException;
 use PHPMicroTemplate\Exception\SyntaxErrorException;
 use PHPMicroTemplate\Exception\UndefinedSymbolException;
+use PHPModelGenerator\Exception\Generic\InvalidPropertyNamesException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator;
@@ -48,16 +49,14 @@ public function __construct(
             });
 
         parent::__construct(
-            $this->getRenderer()->renderTemplate(
-                DIRECTORY_SEPARATOR . 'Exception' . DIRECTORY_SEPARATOR . 'InvalidPropertiesException.phptpl',
-                ['error' => 'Provided JSON contains properties with invalid names.', 'property' => 'property']
-            ),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'PropertyNames.phptpl',
             [
                 'nameValidationProperty' => $nameValidationProperty,
                 'generatorConfiguration' => $schemaProcessor->getGeneratorConfiguration(),
                 'viewHelper'             => new RenderHelper($schemaProcessor->getGeneratorConfiguration()),
-            ]
+            ],
+            InvalidPropertyNamesException::class,
+            [$schema->getClassName(), '&$invalidProperties']
         );
     }
 
diff --git a/src/Model/Validator/SchemaDependencyValidator.php b/src/Model/Validator/SchemaDependencyValidator.php
@@ -4,6 +4,8 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
+use PHPModelGenerator\Exception\Dependency\InvalidSchemaDependencyException;
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Schema;
@@ -21,15 +23,15 @@ class SchemaDependencyValidator extends PropertyTemplateValidator
     /**
      * SchemaDependencyValidator constructor.
      *
-     * @param SchemaProcessor $schemaProcessor
+     * @param SchemaProcessor   $schemaProcessor
      * @param PropertyInterface $property
-     * @param Schema $schema
+     * @param Schema            $schema
+     *
+     * @throws SchemaException
      */
     public function __construct(SchemaProcessor $schemaProcessor, PropertyInterface $property, Schema $schema)
     {
         parent::__construct(
-            "Invalid schema which is dependant on {$property->getName()}:\\n  - " .
-                '" . preg_replace("/\n([^\s])/m", "\n  - $1", preg_replace("/\n\s/m", "\n     ", $dependencyException->getMessage())) . "',
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'SchemaDependency.phptpl',
             [
                 'viewHelper' => new RenderHelper($schemaProcessor->getGeneratorConfiguration()),
@@ -42,7 +44,9 @@ public function __construct(SchemaProcessor $schemaProcessor, PropertyInterface
                         $schema->getClassName(),
                         $schemaProcessor->getGeneratorConfiguration()
                     ))
-            ]
+            ],
+            InvalidSchemaDependencyException::class,
+            [$property->getName(), '&$dependencyException']
         );
     }
 
diff --git a/src/PropertyProcessor/Decorator/Property/ObjectInstantiationDecorator.php b/src/PropertyProcessor/Decorator/Property/ObjectInstantiationDecorator.php
@@ -51,12 +51,7 @@ public function decorate(string $input, PropertyInterface $property): string
             [
                 'input' => $input,
                 'className' => $this->className,
-                'exceptionMessage' => sprintf(
-                    'Invalid type for %s. Requires object, got " . gettype($param) . "',
-                    $property->getName()
-                ),
                 'generatorConfiguration' => $this->generatorConfiguration,
-                'viewHelper' => new RenderHelper($this->generatorConfiguration),
             ]
         );
     }
diff --git a/src/PropertyProcessor/Filter/FilterProcessor.php b/src/PropertyProcessor/Filter/FilterProcessor.php
@@ -144,7 +144,8 @@ private function addTransformedValuePassThrough(
                             ReflectionTypeCheckValidator::fromReflectionType($filteredType, $property)->getCheck(),
                             $validator->getCheck()
                         ),
-                        $validator->getExceptionClass()
+                        $validator->getExceptionClass(),
+                        $validator->getExceptionParams()
                     ),
                     3
                 );
diff --git a/src/PropertyProcessor/Property/ArrayProcessor.php b/src/PropertyProcessor/Property/ArrayProcessor.php
@@ -7,6 +7,7 @@
 use PHPMicroTemplate\Exception\FileSystemException;
 use PHPMicroTemplate\Exception\SyntaxErrorException;
 use PHPMicroTemplate\Exception\UndefinedSymbolException;
+use PHPModelGenerator\Exception\Arrays\AdditionalTupleItemsException;
 use PHPModelGenerator\Exception\Arrays\ContainsException;
 use PHPModelGenerator\Exception\Arrays\MaxItemsException;
 use PHPModelGenerator\Exception\Arrays\MinItemsException;
@@ -199,11 +200,8 @@ private function addAdditionalItemsValidator(PropertyInterface $property, array
         $property->addValidator(
             new PropertyValidator(
                 '($amount = count($value)) > ' . $expectedAmount,
-                sprintf(
-                    'Tuple array %s contains not allowed additional items. Expected %s items, got $amount',
-                    $property->getName(),
-                    $expectedAmount
-                )
+                AdditionalTupleItemsException::class,
+                [$property->getName(), $expectedAmount, '&$amount']
             )
         );
     }
diff --git a/src/PropertyProcessor/Property/BaseProcessor.php b/src/PropertyProcessor/Property/BaseProcessor.php
@@ -8,6 +8,8 @@
 use PHPMicroTemplate\Exception\SyntaxErrorException;
 use PHPMicroTemplate\Exception\UndefinedSymbolException;
 use PHPModelGenerator\Exception\Generic\AdditionalPropertiesException;
+use PHPModelGenerator\Exception\Object\MaxPropertiesException;
+use PHPModelGenerator\Exception\Object\MinPropertiesException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
@@ -145,11 +147,8 @@ protected function addMaxPropertiesValidator(string $propertyName, array $proper
         $this->schema->addBaseValidator(
             new PropertyValidator(
                 sprintf('count($modelData) > %d', $propertyData['maxProperties']),
-                sprintf(
-                    'Provided object for %s must not contain more than %s properties',
-                    $propertyName,
-                    $propertyData['maxProperties']
-                )
+                MaxPropertiesException::class,
+                [$propertyName, $propertyData['maxProperties']]
             )
         );
     }
@@ -169,11 +168,8 @@ protected function addMinPropertiesValidator(string $propertyName, array $proper
         $this->schema->addBaseValidator(
             new PropertyValidator(
                 sprintf('count($modelData) < %d', $propertyData['minProperties']),
-                sprintf(
-                    'Provided object for %s must not contain less than %s properties',
-                    $propertyName,
-                    $propertyData['minProperties']
-                )
+                MinPropertiesException::class,
+                [$propertyName, $propertyData['minProperties']]
             )
         );
     }
diff --git a/src/Templates/Validator/ArrayItem.phptpl b/src/Templates/Validator/ArrayItem.phptpl
@@ -26,8 +26,8 @@ is_array($value) && (function (&$items) use (&$invalidItems{{ suffix }}) {
         } catch (\Exception $e) {
             // collect all errors concerning invalid items
             isset($invalidItems{{ suffix }}[$index])
-                ? $invalidItems{{ suffix }}[$index][] = $e->getMessage()
-                : $invalidItems{{ suffix }}[$index] = [$e->getMessage()];
+                ? $invalidItems{{ suffix }}[$index][] = $e
+                : $invalidItems{{ suffix }}[$index] = [$e];
         }
     }
 
diff --git a/src/Templates/Validator/ArrayTuple.phptpl b/src/Templates/Validator/ArrayTuple.phptpl
@@ -33,8 +33,8 @@ is_array($value) && (function (&$items) use (&$invalidTuples) {
         } catch (\Exception $e) {
             // collect all errors concerning invalid tuples
             isset($invalidTuples[$index])
-                ? $invalidTuples[$index][] = $e->getMessage()
-                : $invalidTuples[$index] = [$e->getMessage()];
+                ? $invalidTuples[$index][] = $e
+                : $invalidTuples[$index] = [$e];
         }
     {% endforeach %}
 
diff --git a/src/Templates/Validator/Filter.phptpl b/src/Templates/Validator/Filter.phptpl
@@ -5,8 +5,8 @@
         // make sure exceptions from the filter are caught and added to the error handling
         try {
             $value = call_user_func_array([\{{ filterClass }}::class, "{{ filterMethod }}"], [$value, {{ filterOptions }}]);
-        } catch (\Exception $e) {
-            {{ viewHelper.validationError(transferExceptionMessage) }}
+        } catch (\Exception $filterException) {
+            {{ viewHelper.validationError(filterValueValidator) }}
         }
 
         return false;
diff --git a/src/Templates/Validator/PropertyNames.phptpl b/src/Templates/Validator/PropertyNames.phptpl
@@ -27,8 +27,8 @@
         } catch (\Exception $e) {
             // collect all errors concerning invalid property names
             isset($invalidProperties[$value])
-                ? $invalidProperties[$value][] = $e->getMessage()
-                : $invalidProperties[$value] = [$e->getMessage()];
+                ? $invalidProperties[$value][] = $e
+                : $invalidProperties[$value] = [$e];
         }
     }
 
diff --git a/src/Utils/RenderHelper.php b/src/Utils/RenderHelper.php
diff --git a/tests/Basic/AdditionalPropertiesTest.php b/tests/Basic/AdditionalPropertiesTest.php
diff --git a/tests/Basic/PropertyNamesTest.php b/tests/Basic/PropertyNamesTest.php
diff --git a/tests/Basic/SchemaDependencyTest.php b/tests/Basic/SchemaDependencyTest.php
diff --git a/tests/ComposedValue/ComposedAllOfTest.php b/tests/ComposedValue/ComposedAllOfTest.php
diff --git a/tests/Model/Validator/PropertyTemplateValidatorTest.php b/tests/Model/Validator/PropertyTemplateValidatorTest.php
diff --git a/tests/Objects/ArrayPropertyTest.php b/tests/Objects/ArrayPropertyTest.php
diff --git a/tests/Objects/MultiTypePropertyTest.php b/tests/Objects/MultiTypePropertyTest.php
