Replace collector concept with validator factories

Author: odan

README.md

@@ -263,7 +263,7 @@ composer require cakephp/validation
 
 use Cake\Validation\Validator;
 use Selective\Validation\Exception\ValidationException;
-use Selective\Validation\Collector\CakeValidationErrorCollector;
+use Selective\Validation\Factory\CakeValidatorFactory;
 
 // Note: This is just an example. Don't use the $request object within the domain layer.
 $formData = (array)$request->getParsedBody();
@@ -278,8 +278,7 @@ $validator
     ->requirePresence('comment')
     ->notEmpty('comment', 'You need to give a comment.');
 
-$validationResult = (new CakeValidationErrorCollector)
-    ->addErrors($validator->validate($formData));
+$validationResult = CakeValidatorFactory::createValidationResult($validator->validate($formData));
 
 // Optional: Do more complex validation and append it to the validation result
 if (!$this->existsEmailInDatabase($formData['email'])) {
@@ -291,41 +290,6 @@ if ($validationResult->isFailed()) {
 }
 ```
 
-Instead of instantiating the `Validator` and `CakeValidationErrorCollector` yourself, you could use a factory like this
-
-```php
-<?php
-
-namespace App\Validation;
-
-use Cake\Validation\Validator;
-use Selective\Validation\Collector\CakeValidationErrorCollector;
-use Selective\Validation\Collector\ValidationErrorCollectorInterface;
-
-final class ValidationFactory
-{
-    /**
-     * Create validator.
-     *
-     * @return Validator The validator
-     */
-    public function createValidator(): Validator
-    {
-        return new Validator();
-    }
-
-    /**
-     * Create a error collector.
-     *
-     * @return ValidationErrorCollectorInterface The error collector
-     */
-    public function createErrorCollector(): ValidationErrorCollectorInterface
-    {
-        return new CakeValidationErrorCollector();
-    }
-}
-```
-
 **Usage**
 
 ```php

src/Collector/ValidationErrorCollectorInterface.php

@@ -1,47 +1,57 @@
 <?php
 
-namespace Selective\Validation\Collector;
+namespace Selective\Validation\Factory;
 
 use Selective\Validation\ValidationResult;
 
 /**
  * CakePHP validation error collector.
  */
-final class CakeValidationErrorCollector implements ValidationErrorCollectorInterface
+final class CakeValidatorFactory
 {
     /**
      * Create validation result from array with errors.
      *
      * @param array<mixed> $errors The validation errors
-     * @param ValidationResult $result The result
-     * @param string $path The path
+     * @param ValidationResult|null $result The result
      *
      * @return ValidationResult The result
      */
-    public function addErrors(
-        $errors,
-        ValidationResult $result = null,
-        string $path = ''
-    ): ValidationResult {
+    public static function createValidationResult(array $errors, ValidationResult $result = null): ValidationResult
+    {
         if ($result === null) {
             $result = new ValidationResult();
         }
 
+        static::addErrors($result, $errors);
+
+        return $result;
+    }
+
+    /**
+     * Add errors.
+     *
+     * @param ValidationResult $result The result
+     * @param array $errors The errors
+     * @param string $path The path
+     *
+     * @return void
+     */
+    private static function addErrors(ValidationResult $result, array $errors, string $path = ''): void
+    {
         foreach ($errors as $field => $error) {
             $oldPath = $path;
             $path .= ($path === '' ? '' : '.') . $field;
 
             foreach ($error as $field2 => $errorMessage) {
                 if (is_array($errorMessage)) {
-                    $result = $this->addErrors([$field2 => $errorMessage], $result, $path);
+                    static::addErrors($result, [$field2 => $errorMessage], $path);
                 } else {
                     $result->addError($path, $errorMessage);
                 }
             }
 
             $path = $oldPath;
         }
-
-        return $result;
     }
 }

…llector/CakeValidationErrorCollector.php src/Factory/CakeValidatorFactory.phpsrc/Collector/CakeValidationErrorCollector.php renamed to src/Factory/CakeValidatorFactory.php src/Collector/CakeValidationErrorCollector.php renamed to src/Factory/CakeValidatorFactory.php

@@ -1,16 +1,16 @@
 <?php
 
-namespace Selective\Validation\Test\Collector;
+namespace Selective\Validation\Test\Factory;
 
 use PHPUnit\Framework\TestCase;
-use Selective\Validation\Collector\CakeValidationErrorCollector;
+use Selective\Validation\Factory\CakeValidatorFactory;
 use Selective\Validation\Transformer\ErrorDetailsResultTransformer;
 use Selective\Validation\ValidationResult;
 
 /**
  * Tests.
  */
-class CakeValidationErrorCollectorTest extends TestCase
+class CakeValidationFactoryTest extends TestCase
 {
     /**
      * Convert validation details to array.
@@ -31,9 +31,7 @@ private function getValidationResultAsArray(ValidationResult $validationResult):
      */
     public function testCreateResultFromErrorsSimple()
     {
-        $errorCollector = new CakeValidationErrorCollector();
-
-        $errors = [
+        $result = CakeValidatorFactory::createValidationResult([
             'first_name' => [
                 '_empty' => 'This field cannot be left empty',
             ],
@@ -58,9 +56,7 @@ public function testCreateResultFromErrorsSimple()
             'street' => [
                 '_empty' => 'This field cannot be left empty',
             ],
-        ];
-
-        $result = $errorCollector->addErrors($errors);
+        ]);
 
         $errors = $this->getValidationResultAsArray($result);
         $expected = [
@@ -108,9 +104,7 @@ public function testCreateResultFromErrorsSimple()
      */
     public function testCreateResultFromErrorsNestedArray()
     {
-        $errorCollector = new CakeValidationErrorCollector();
-
-        $errors = [
+        $result = CakeValidatorFactory::createValidationResult([
             'bills' => [
                 0 => [
                     'billing_number' => [
@@ -137,9 +131,7 @@ public function testCreateResultFromErrorsNestedArray()
                     ],
                 ],
             ],
-        ];
-
-        $result = $errorCollector->addErrors($errors);
+        ]);
 
         $errors = $this->getValidationResultAsArray($result);
         $expected = [