Invert the behaviour of NotBlank

Since we have the ability to use `not` as a prefix, having rules that
start with not becomes a bit inflexible, verbose, and harder to
understand.

This commit will refactor the `NotBlank` rule by inverting its behaviour
and renaming it to `Blank`. Although this is a breaking change, users
will not feel it because "NotBlank" will still be available by using the
`not` prefix followed by the `Blank` rule.

Author: henriquemoody

bin/create-mixin

@@ -107,10 +107,12 @@ function addMethodToInterface(
 
         $defaultValue = $reflectionParameter->getDefaultValue();
         if (is_object($defaultValue)) {
+            $parameter->setDefaultValue(null);
+            $parameter->setNullable(true);
             continue;
         }
 
-        $parameter->setDefaultValue($reflectionParameter->getDefaultValue());
+        $parameter->setDefaultValue($defaultValue);
         $parameter->setNullable(false);
     }
 }
@@ -170,10 +172,10 @@ function overwriteFile(string $content, string $basename): void
         ['Length', 'length', $numberRelatedRules, []],
         ['Max', 'max', $numberRelatedRules, []],
         ['Min', 'min', $numberRelatedRules, []],
-        ['Not', 'not', [], ['Not', 'NotEmpty', 'NotBlank', 'NotEmoji', 'NotUndef', 'NullOr', 'UndefOr', 'Attributes', 'Templated', 'Named']],
-        ['NullOr', 'nullOr', [], ['NullOr', 'NotUndef', 'UndefOr', 'Templated', 'Named']],
+        ['Not', 'not', [], ['Not', 'NotEmpty', 'NotEmoji', 'NotUndef', 'NullOr', 'UndefOr', 'Attributes', 'Templated', 'Named']],
+        ['NullOr', 'nullOr', [], ['NullOr', 'Blank', 'NotUndef', 'UndefOr', 'Templated', 'Named']],
         ['Property', 'property', [], $structureRelatedRules],
-        ['UndefOr', 'undefOr', [], ['NullOr', 'NotUndef', 'UndefOr', 'Attributes', 'Templated', 'Named']],
+        ['UndefOr', 'undefOr', [], ['NullOr', 'Blank', 'NotUndef', 'UndefOr', 'Attributes', 'Templated', 'Named']],
         ['', null, [], []],
     ];
 

docs/09-list-of-rules-by-category.md

@@ -159,9 +159,9 @@
 
 ## Miscellaneous
 
+- [Blank](rules/Blank.md)
 - [FilterVar](rules/FilterVar.md)
 - [Named](rules/Named.md)
-- [NotBlank](rules/NotBlank.md)
 - [NotEmpty](rules/NotEmpty.md)
 - [NotUndef](rules/NotUndef.md)
 - [Templated](rules/Templated.md)
@@ -315,6 +315,7 @@
 - [Base64](rules/Base64.md)
 - [Between](rules/Between.md)
 - [BetweenExclusive](rules/BetweenExclusive.md)
+- [Blank](rules/Blank.md)
 - [BoolType](rules/BoolType.md)
 - [BoolVal](rules/BoolVal.md)
 - [Bsn](rules/Bsn.md)
@@ -403,7 +404,6 @@
 - [No](rules/No.md)
 - [NoneOf](rules/NoneOf.md)
 - [Not](rules/Not.md)
-- [NotBlank](rules/NotBlank.md)
 - [NotEmoji](rules/NotEmoji.md)
 - [NotEmpty](rules/NotEmpty.md)
 - [NotUndef](rules/NotUndef.md)

docs/rules/Blank.md

@@ -0,0 +1,63 @@
+# Blank
+
+- `Blank()`
+
+Validates if the given input is a blank value (`null`, zeros, empty strings or empty arrays, recursively).
+
+```php
+v::blank()->isValid(null); // true
+v::blank()->isValid(''); // true
+v::blank()->isValid([]); // true
+v::blank()->isValid(' '); // true
+v::blank()->isValid(0); // true
+v::blank()->isValid('0'); // true
+v::blank()->isValid(0); // true
+v::blank()->isValid('0.0'); // true
+v::blank()->isValid(false); // true
+v::blank()->isValid(['']); // true
+v::blank()->isValid([' ']); // true
+v::blank()->isValid([0]); // true
+v::blank()->isValid(['0']); // true
+v::blank()->isValid([false]); // true
+v::blank()->isValid([[''], [0]]); // true
+v::blank()->isValid(new stdClass()); // true
+```
+
+It's similar to [NotEmpty](NotEmpty.md), but way stricter.
+
+## Templates
+
+### `Blank::TEMPLATE_STANDARD`
+
+| Mode       | Template                      |
+| ---------- | ----------------------------- |
+| `default`  | {{subject}} must be blank     |
+| `inverted` | {{subject}} must not be blank |
+
+## Template placeholders
+
+| Placeholder | Description                                                      |
+| ----------- | ---------------------------------------------------------------- |
+| `subject`   | The validated input or the custom validator name (if specified). |
+
+## Categorization
+
+- Miscellaneous
+
+## Changelog
+
+| Version | Description                                 |
+| ------: | ------------------------------------------- |
+|   3.0.0 | Renamed to `Blank` and changed the behavior |
+|   1.0.0 | Created as `NotBlank`                       |
+
+---
+
+See also:
+
+- [NotEmpty](NotEmpty.md)
+- [NotUndef](NotUndef.md)
+- [NoWhitespace](NoWhitespace.md)
+- [NullType](NullType.md)
+- [Number](Number.md)
+- [UndefOr](UndefOr.md)

docs/rules/NoWhitespace.md

@@ -42,8 +42,8 @@ See also:
 
 - [Alnum](Alnum.md)
 - [Alpha](Alpha.md)
+- [Blank](Blank.md)
 - [CreditCard](CreditCard.md)
-- [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
 - [NotUndef](NotUndef.md)
 - [UndefOr](UndefOr.md)

docs/rules/NotBlank.md

@@ -64,10 +64,10 @@ v::stringType()->notEmpty()->isValid("\t \n \r");  //false
 
 See also:
 
+- [Blank](Blank.md)
 - [Each](Each.md)
 - [Max](Max.md)
 - [Min](Min.md)
-- [NotBlank](NotBlank.md)
 - [NotUndef](NotUndef.md)
 - [NoWhitespace](NoWhitespace.md)
 - [NullType](NullType.md)

docs/rules/NotEmpty.md

@@ -59,7 +59,7 @@ v::notUndef()->isValid(new stdClass()); // true
 
 See also:
 
-- [NotBlank](NotBlank.md)
+- [Blank](Blank.md)
 - [NotEmpty](NotEmpty.md)
 - [NoWhitespace](NoWhitespace.md)
 - [NullType](NullType.md)

docs/rules/NotUndef.md

@@ -39,12 +39,12 @@ v::nullType()->isValid(null); // true
 See also:
 
 - [ArrayType](ArrayType.md)
+- [Blank](Blank.md)
 - [BoolType](BoolType.md)
 - [BoolVal](BoolVal.md)
 - [CallableType](CallableType.md)
 - [FloatType](FloatType.md)
 - [IntType](IntType.md)
-- [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
 - [NotUndef](NotUndef.md)
 - [NullOr](NullOr.md)

docs/rules/NullType.md

@@ -42,11 +42,11 @@ v::number()->isValid(acos(8)); // false
 
 See also:
 
+- [Blank](Blank.md)
 - [BoolType](BoolType.md)
 - [CallableType](CallableType.md)
 - [FloatType](FloatType.md)
 - [IntType](IntType.md)
-- [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
 - [NotUndef](NotUndef.md)
 - [NullType](NullType.md)

docs/rules/Number.md

@@ -65,7 +65,7 @@ v::not(v::undefOr(v::alpha()))->assert("alpha");
 
 See also:
 
-- [NotBlank](NotBlank.md)
+- [Blank](Blank.md)
 - [NotEmpty](NotEmpty.md)
 - [NotUndef](NotUndef.md)
 - [NoWhitespace](NoWhitespace.md)