Merge pull request #3 from VladimirBerdnik/master

Add ability to use custom declared validation rules

Author: populov

CHANGES.md

@@ -1,5 +1,9 @@
 # Changes History
 
+1.0.5
+-----
+Add ability to use custom declared validation rules 
+
 1.0.4
 -----
 Add 'sometimes' rule modifier 

README.md

@@ -28,6 +28,17 @@ $rules = [
 
 ![Intelisence](docs/intellisence.png)
 
+**Custom validation rules**
+
+You can also use [custom declared validations](https://laravel.com/docs/5.4/validation#custom-validation-rules):
+
+```php
+$rules = [
+    ... => Rule::custom('foo')
+]
+```
+
+
 ## Installation
 
 Install the ```saritasa/laravel-fluent-validation``` package:

src/DatabaseRuleSet.php

@@ -16,7 +16,7 @@ public function __construct(array $rules = [])
     {
         if (!Config::get('validation.allow_db', false)) {
             throw new ConfigurationException("Validation against database is disabled. "
-                ."To to use validation rules, like 'exists', 'unique', etc. set configuration parameter "
+                ."To use validation rules, like 'exists', 'unique', etc. set configuration parameter "
                 ."'validation.allow_db' = true");
         }
 
@@ -46,7 +46,7 @@ public function exists(string $table, string $column = 'NULL', \Closure $callbac
      *
      * @param  string $table
      * @param  string $column
-     * @param \Closure|null $callback callback, that will receive \Illuminate\Validation\Rules\Exists $rule
+     * @param \Closure|null $callback callback, that will receive \Illuminate\Validation\Rules\Unique $rule
      * @return GenericRuleSet
      */
     public function unique(string $table, string $column = 'NULL', \Closure $callback = null): GenericRuleSet

src/Rule.php

@@ -21,6 +21,7 @@
  * @method static GenericRuleSet different(string $anotherFiled) The field under validation must have a different value than field.
  * @method static GenericRuleSet same(string $anotherFiled) The given field must match the field under validation.
  * @method static GenericRuleSet size(int $value) The field under validation must have a size matching the given value. For string data, value corresponds to the number of characters. For numeric data, value corresponds to a given integer value. For an array, size corresponds to the count of the array. For files, size corresponds to the file size in kilobytes.
+ * @method static GenericRuleSet between($minimalValue, $maximalValue) The field under validation must have a size between the given min and max. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.
  * @method static GenericRuleSet min($minValue) The field under validation must have a minimum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.
  * @method static GenericRuleSet max($maxValue) The field under validation must be less than or equal to a maximum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.
  * @method static GenericRuleSet inArray(string $anotherField) The field under validation must exist in $anotherField's values.
@@ -31,6 +32,7 @@
  * @method static GenericRuleSet requiredWithoutAll(string ...$otherFields) The field under validation must be present and not empty only when all of the other specified fields are not present.
  * @method static GenericRuleSet requiredIf(string $anotherField, $value) The field under validation must be present and not empty if the $anotherField field is equal to any value.
  * @method static GenericRuleSet requiredUnless(string $anotherField, $value) The field under validation must be present and not empty unless the $anotherField field is equal to any value.
+ * @method static GenericRuleSet custom(string $customRule) The field under validation must pass custom validation rule.
 
  * @method static StringRuleSet activeUrl() The field under validation must have a valid A or AAAA record according to the dns_get_record PHP function.
  * @method static StringRuleSet alpha() The field under validation must be entirely alphabetic characters.

src/RuleSet.php

@@ -50,6 +50,7 @@ class RuleSet implements IRule
         'between',
         'size',
         'sometimes',
+        'custom',
     ];
 
     /** @var array */

src/SimpleRules.php

@@ -2,6 +2,9 @@
 
 namespace Saritasa\Laravel\Validation;
 
+use Illuminate\Support\Facades\Config;
+use Saritasa\Exceptions\ConfigurationException;
+
 /**
  * Just breakdown of RuleSet, containing too many methods for easy reading
  */
@@ -126,4 +129,23 @@ public function sometimes()
     {
         return $this->appendIfNotExists("sometimes");
     }
+
+    /**
+     * The field under validation must pass custom validation rule.
+     * @param string $customRule
+     * @return GenericRuleSet
+     * @throws ConfigurationException
+     * @see https://laravel.com/docs/5.4/validation#custom-validation-rules
+     * @see \Illuminate\Validation\Factory::extend
+     */
+    public function custom(string $customRule): GenericRuleSet
+    {
+        if (!Config::get('validation.allow_custom', false)) {
+            throw new ConfigurationException("Custom validation rules are disabled. "
+                . "To use custom validation rules, registered via Validator::extend, set configuration parameter "
+                . "'validation.allow_custom' = true");
+        }
+
+        return $this->appendIfNotExists($customRule);
+    }
 }

tests/CustomRulesTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Saritasa\Laravel\Validation\Tests;
+
+use Illuminate\Support\Facades\Config;
+use PHPUnit\Framework\TestCase;
+use Saritasa\Exceptions\ConfigurationException;
+use Saritasa\Laravel\Validation\Rule;
+
+class CustomRulesTest extends TestCase
+{
+    /**
+     * Reset mocked configuration after each test
+     */
+    protected function tearDown()
+    {
+        Config::clearResolvedInstances();
+    }
+
+    /** Mock configuration value to allow custom validation rules
+     * @param bool $allowed
+     */
+    protected function allowCustomValidation(bool $allowed = true)
+    {
+        Config::shouldReceive('get')->with('validation.allow_custom', false)->andReturn($allowed);
+    }
+
+    /**
+     *  Do not allow to use custom validation rules, unless it is set explicitly in configuration
+     */
+    public function testConfigurationRequired()
+    {
+        $this->allowCustomValidation(false);
+        $this->expectException(ConfigurationException::class);
+
+        Rule::custom('foo');
+    }
+
+    /**
+     * Basic form of Rule::custom('foo') works.
+     */
+    public function testCustom()
+    {
+        $this->allowCustomValidation(true);
+
+        $this->assertEquals('foo', Rule::custom('foo'));
+    }
+}