Add JsonValidationError exception and improve JSON schema error message

Author: sandrokeil

src/Exception/JsonValidationError.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EventEngine\JsonSchema\Exception;
+
+
+class JsonValidationError extends InvalidArgumentException
+{
+}

src/Exception/JustinRainbowJsonValidationError.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EventEngine\JsonSchema\Exception;
+
+
+class JustinRainbowJsonValidationError extends JsonValidationError
+{
+    /**
+     * @var array
+     */
+    private $errors;
+
+    public static function withError(string $objectName, ...$errors): JustinRainbowJsonValidationError
+    {
+        $self = new self('Validation of "' . $objectName . '" failed: ');
+        $self->errors = $errors;
+
+        $self->message .= \array_reduce(
+            $errors,
+            static function ($message, array $error) use ($self) {
+                return $message . "\n" . $self->errorMessage($error);
+            }
+        );
+
+        return $self;
+    }
+
+    public function errors(): array
+    {
+        return $this->errors;
+    }
+
+    public function errorMessage(array $error): string
+    {
+        return sprintf("[%s] %s\n", $error['property'], $error['message']);
+    }
+}

src/Exception/OpisJsonValidationError.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EventEngine\JsonSchema\Exception;
+
+
+use Opis\JsonSchema\ValidationError;
+
+class OpisJsonValidationError extends JsonValidationError
+{
+    /**
+     * @var ValidationError[]
+     */
+    private $errors;
+
+    public static function withError(string $objectName, ValidationError ...$validationErrors): OpisJsonValidationError
+    {
+        $self = new self('Validation of "' . $objectName . '" failed: ');
+        $self->errors = $validationErrors;
+
+        foreach ($validationErrors as $error) {
+            $self->message .= $self->errorMessage($error);
+
+            if ($error->subErrorsCount()) {
+                $self->message .= \array_reduce(
+                    $error->subErrors(),
+                    static function ($message, ValidationError $error) use ($self) {
+                        return $message . "\n" . $self->errorMessage($error);
+                    }
+                );
+            }
+        }
+
+        return $self;
+    }
+
+    /**
+     * @return ValidationError[]
+     */
+    public function errors(): array
+    {
+        return $this->errors;
+    }
+
+    public function errorMessage(ValidationError $error): string
+    {
+        $dataPointer = $error->dataPointer();
+
+        if (count($dataPointer) === 0) {
+            return \sprintf('[%s] %s', $error->keyword(), \json_encode($error->keywordArgs(), JSON_PRETTY_PRINT));
+        }
+
+        return \sprintf('field "%s" [%s] %s',
+            implode('.', $dataPointer),
+            $error->keyword(),
+            \json_encode($error->keywordArgs(), JSON_PRETTY_PRINT)
+        );
+    }
+}

src/JustinRainbowJsonSchema.php

@@ -11,7 +11,7 @@
 
 namespace EventEngine\JsonSchema;
 
-use EventEngine\JsonSchema\Exception\InvalidArgumentException;
+use EventEngine\JsonSchema\Exception\JustinRainbowJsonValidationError;
 use JsonSchema\Validator;
 
 final class JustinRainbowJsonSchema extends AbstractJsonSchema
@@ -30,17 +30,8 @@ public function assert(string $objectName, array $data, array $jsonSchema)
         $this->jsonValidator()->validate($enforcedObjectData, $jsonSchema);
 
         if (! $this->jsonValidator()->isValid()) {
-            $errors = $this->jsonValidator()->getErrors();
-
             $this->jsonValidator()->reset();
-
-            foreach ($errors as $i => $error) {
-                $errors[$i] = \sprintf("[%s] %s\n", $error['property'], $error['message']);
-            }
-
-            throw new InvalidArgumentException(
-                "Validation of $objectName failed: " . \implode("\n", $errors)
-            );
+            throw JustinRainbowJsonValidationError::withError($objectName, $this->jsonValidator()->getErrors());
         }
 
         $this->jsonValidator()->reset();

src/OpisJsonSchema.php

@@ -11,7 +11,7 @@
 
 namespace EventEngine\JsonSchema;
 
-use EventEngine\JsonSchema\Exception\InvalidArgumentException;
+use EventEngine\JsonSchema\Exception\OpisJsonValidationError;
 use Opis\JsonSchema\Schema as OpisSchema;
 use Opis\JsonSchema\Validator;
 
@@ -38,21 +38,7 @@ public function assert(string $objectName, array $data, array $jsonSchema)
         $result = $this->jsonValidator()->schemaValidation($enforcedObjectData, OpisSchema::fromJsonString(\json_encode($jsonSchema)));
 
         if (! $result->isValid()) {
-            $errors = [];
-
-            foreach ($result->getErrors() as $error) {
-                $errors[] = \sprintf('[%s] %s', $error->keyword(), \json_encode($error->keywordArgs(), JSON_PRETTY_PRINT));
-
-                if ($error->subErrorsCount()) {
-                    foreach ($error->subErrors() as $subError) {
-                        $errors[] = \sprintf("[%s] %s\n", $subError->keyword(), \json_encode($subError->keywordArgs(), JSON_PRETTY_PRINT));
-                    }
-                }
-            }
-
-            throw new InvalidArgumentException(
-                "Validation of $objectName failed: " . \implode("\n", $errors)
-            );
+            throw OpisJsonValidationError::withError($objectName, ...$result->getErrors());
         }
     }