👌 IMPROVE: Add imploded errors #5

CHANGELOG.md

@@ -3,11 +3,11 @@ Changelog
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## V1.0.3 - TBD
+## V1.0.3 - 2019-02-21
 
 ### Added
 
-- Nothing.
+- [#5](https://github.com/elie29/validator/issues/5) Add imploded errors.
 
 ### Changed
 

README.md

@@ -118,6 +118,34 @@ class XXXRule extends AbstractRule
         return RuleInterface::VALID;
     }
 }
-
 ```
 
+## Assertion Integration
+
+Instead of using assertion key by key, you can validate the whole context and than use [Assertion](https://github.com/beberlei/assert) or [Assert](https://github.com/webmozart/assert) as follow:
+
+```php
+<?php
+
+use Assert\Assertion;
+use Elie\Validator\Rule\EmailRule;
+use Elie\Validator\Rule\NumericRule;
+use Elie\Validator\Rule\RuleConstInterface;
+use Elie\Validator\Rule\StringRule;
+use Elie\Validator\Validator;
+use Webmozart\Assert\Assert;
+
+$rules =[
+    ['age', NumericRule::class, RuleConstInterface::MAX => 60],
+    ['name', StringRule::class, RuleConstInterface::MIN => 1, RuleConstInterface::REQUIRED => true],
+    ['email', EmailRule::class, RuleConstInterface::REQUIRED => true],
+];
+
+$validator = new Validator($_POST, $rules);
+
+Assert::true($validator->validate(), $validator->getImplodedErrors());
+
+// OR
+
+Assertion::true($validator->validate(), $validator->getImplodedErrors());
+```

src/Validator.php

@@ -75,6 +75,11 @@ public function getErrors(): array
         return $this->errors;
     }
 
+    public function getImplodedErrors(string $separator = '<br/>'): string
+    {
+        return implode($separator, $this->errors);
+    }
+
     public function get(string $key)
     {
         return $this->context[$key] ?? null;

src/ValidatorInterface.php

@@ -77,6 +77,13 @@ public function getRules(): array;
      */
     public function getErrors(): array;
 
+    /**
+     * Return all errors found.
+     *
+     * @return string
+     */
+    public function getImplodedErrors(string $separator = '<br/>'): string;
+
     /**
      * Retrieves the value of a requested key from the {@link context}.
      *

tests/ValidatorTest.php

@@ -4,6 +4,8 @@
 
 namespace Elie\Validator;
 
+use Elie\Validator\Rule\ArrayRule;
+use Elie\Validator\Rule\BooleanRule;
 use Elie\Validator\Rule\NumericRule;
 use Elie\Validator\Rule\StringRule;
 use PHPUnit\Framework\TestCase;
@@ -55,6 +57,25 @@ public function testValidatorStopOnError(): void
         assertThat($validator->shouldStopOnError(), is(true));
     }
 
+    public function testValidatorGetImplodedErrors(): void
+    {
+        $validator = new Validator(['name' => 'Ben'], [
+            ['name', NumericRule::class],
+            ['name', ArrayRule::class],
+            ['name', BooleanRule::class],
+        ]);
+
+        $res = $validator->validate();
+        assertThat($res, is(false));
+
+        // value should not exist on error
+        $validatedContext = $validator->getValidatedContext();
+        assertThat($validatedContext, emptyArray());
+
+        $expected = 'name: Ben is not numeric,name does not have an array value: Ben,name: Ben is not a valid boolean';
+        assertThat($validator->getImplodedErrors(','), is($expected));
+    }
+
     /**
      * @dataProvider getValidatorProvider
      */