Rename "NotOptional" to "NotUndef"

Since I've already renamed the "Optional" rule to "UnderOf," it makes sense to rename this rule too. Signed-off-by: Henrique Moody <[email protected]>
Respect · May 6, 2024 · 4fd26e3 · 4fd26e3
1 parent 719f12a
commit 4fd26e3
Show file tree

Hide file tree

Showing 31 changed files with 137 additions and 114 deletions.
diff --git a/bin/create-mixin b/bin/create-mixin
@@ -25,6 +25,7 @@ use Respect\Validation\Mixins\StaticNot;
 use Respect\Validation\Mixins\StaticNullOr;
 use Respect\Validation\Mixins\StaticProperty;
 use Respect\Validation\Mixins\StaticUndefOr;
+use Respect\Validation\Rules\NotUndef;
 use Respect\Validation\Rules\NullOr;
 use Respect\Validation\Rules\UndefOr;
 use Respect\Validation\Validatable;
@@ -175,10 +176,10 @@ function overwriteFile(string $content, string $basename): void
         ['Length', 'length', $numberRelatedRules, []],
         ['Max', 'max', $numberRelatedRules, []],
         ['Min', 'min', $numberRelatedRules, []],
-        ['Not', 'not', [], ['Not', 'NotEmpty', 'NotBlank', 'NotEmoji', 'NotOptional', 'NullOr', 'UndefOr', 'Optional']],
-        ['NullOr', 'nullOr', [], ['Nullable', 'NullOr', 'Optional', 'UndefOr']],
+        ['Not', 'not', [], ['Not', 'NotEmpty', 'NotBlank', 'NotEmoji', 'NotUndef', 'NotOptional', 'NullOr', 'UndefOr', 'Optional']],
+        ['NullOr', 'nullOr', [], ['Nullable', 'NullOr', 'Optional', 'NotOptional', 'NotUndef', 'UndefOr']],
         ['Property', 'property', [], $structureRelatedRules],
-        ['UndefOr', 'undefOr', [], ['Nullable', 'NullOr', 'Optional', 'UndefOr']],
+        ['UndefOr', 'undefOr', [], ['Nullable', 'NullOr', 'NotOptional', 'NotUndef', 'Optional', 'UndefOr']],
         ['Validator', null, [], []],
     ];
 
@@ -200,6 +201,9 @@ function overwriteFile(string $content, string $basename): void
         if ($className === NullOr::class) {
             $names['Nullable'] = $reflection;
         }
+        if ($className === NotUndef::class) {
+            $names['NotOptional'] = $reflection;
+        }
     }
     ksort($names);
 

diff --git a/docs/02-feature-guide.md b/docs/02-feature-guide.md
@@ -102,7 +102,7 @@ v::optional(v::alpha())->validate(null); // true
 
 By _optional_ we consider `null` or an empty string (`''`).
 
-See more on [Optional](rules/Optional.md).
+See more on [Optional](rules/UndefOr.md).
 
 ## Negating rules
 

diff --git a/docs/08-list-of-rules-by-category.md b/docs/08-list-of-rules-by-category.md
@@ -157,7 +157,7 @@
 - [FilterVar](rules/FilterVar.md)
 - [NotBlank](rules/NotBlank.md)
 - [NotEmpty](rules/NotEmpty.md)
-- [NotOptional](rules/NotOptional.md)
+- [NotUndef](rules/NotUndef.md)
 
 ## Nesting
 
@@ -173,9 +173,9 @@
 - [Not](rules/Not.md)
 - [Nullable](rules/Nullable.md)
 - [OneOf](rules/OneOf.md)
-- [Optional](rules/Optional.md)
 - [Property](rules/Property.md)
 - [PropertyOptional](rules/PropertyOptional.md)
+- [UndefOr](rules/UndefOr.md)
 - [When](rules/When.md)
 
 ## Numbers
@@ -394,15 +394,14 @@
 - [NotBlank](rules/NotBlank.md)
 - [NotEmoji](rules/NotEmoji.md)
 - [NotEmpty](rules/NotEmpty.md)
-- [NotOptional](rules/NotOptional.md)
+- [NotUndef](rules/NotUndef.md)
 - [NullType](rules/NullType.md)
 - [Nullable](rules/Nullable.md)
 - [Number](rules/Number.md)
 - [NumericVal](rules/NumericVal.md)
 - [ObjectType](rules/ObjectType.md)
 - [Odd](rules/Odd.md)
 - [OneOf](rules/OneOf.md)
-- [Optional](rules/Optional.md)
 - [PerfectSquare](rules/PerfectSquare.md)
 - [Pesel](rules/Pesel.md)
 - [Phone](rules/Phone.md)
@@ -438,6 +437,7 @@
 - [Tld](rules/Tld.md)
 - [TrueVal](rules/TrueVal.md)
 - [Type](rules/Type.md)
+- [UndefOr](rules/UndefOr.md)
 - [Unique](rules/Unique.md)
 - [Uploaded](rules/Uploaded.md)
 - [Uppercase](rules/Uppercase.md)

diff --git a/docs/rules/NoWhitespace.md b/docs/rules/NoWhitespace.md
@@ -29,5 +29,5 @@ See also:
 - [CreditCard](CreditCard.md)
 - [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
-- [NotOptional](NotOptional.md)
-- [Optional](Optional.md)
+- [NotUndef](NotUndef.md)
+- [UndefOr](UndefOr.md)
diff --git a/docs/rules/NotBlank.md b/docs/rules/NotBlank.md
@@ -41,7 +41,7 @@ See also:
 
 - [NoWhitespace](NoWhitespace.md)
 - [NotEmpty](NotEmpty.md)
-- [NotOptional](NotOptional.md)
+- [NotUndef](NotUndef.md)
 - [NullType](NullType.md)
 - [Number](Number.md)
-- [Optional](Optional.md)
+- [UndefOr](UndefOr.md)
diff --git a/docs/rules/NotEmpty.md b/docs/rules/NotEmpty.md
@@ -53,7 +53,7 @@ See also:
 - [Min](Min.md)
 - [NoWhitespace](NoWhitespace.md)
 - [NotBlank](NotBlank.md)
-- [NotOptional](NotOptional.md)
+- [NotUndef](NotUndef.md)
 - [NullType](NullType.md)
 - [Number](Number.md)
-- [Optional](Optional.md)
+- [UndefOr](UndefOr.md)
diff --git a/docs/rules/NotOptional.md b/docs/rules/NotOptional.md
diff --git a/docs/rules/NotUndef.md b/docs/rules/NotUndef.md
@@ -0,0 +1,51 @@
+# NotUndef
+
+- `NotUndef()`
+
+Validates if the given input is not optional. By _optional_ we consider `null`
+or an empty string (`''`).
+
+```php
+v::notUndef()->validate(''); // false
+v::notUndef()->validate(null); // false
+```
+
+Other values:
+
+```php
+v::notUndef()->validate([]); // true
+v::notUndef()->validate(' '); // true
+v::notUndef()->validate(0); // true
+v::notUndef()->validate('0'); // true
+v::notUndef()->validate(0); // true
+v::notUndef()->validate('0.0'); // true
+v::notUndef()->validate(false); // true
+v::notUndef()->validate(['']); // true
+v::notUndef()->validate([' ']); // true
+v::notUndef()->validate([0]); // true
+v::notUndef()->validate(['0']); // true
+v::notUndef()->validate([false]); // true
+v::notUndef()->validate([[''), [0]]); // true
+v::notUndef()->validate(new stdClass()); // true
+```
+
+## Categorization
+
+- Miscellaneous
+
+## Changelog
+
+|  Version | Description                              |
+|---------:|------------------------------------------|
+|    3.0.0 | Renamed from "NotOptional" to "NotUndef" |
+|    1.0.0 | Created                                  |
+
+***
+See also:
+
+- [NoWhitespace](NoWhitespace.md)
+- [NotBlank](NotBlank.md)
+- [NotEmpty](NotEmpty.md)
+- [NullType](NullType.md)
+- [Number](Number.md)
+- [UndefOr](UndefOr.md)
diff --git a/docs/rules/NullType.md b/docs/rules/NullType.md
@@ -30,12 +30,12 @@ See also:
 - [IntType](IntType.md)
 - [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
-- [NotOptional](NotOptional.md)
+- [NotUndef](NotUndef.md)
 - [Nullable](Nullable.md)
 - [Number](Number.md)
 - [ObjectType](ObjectType.md)
-- [Optional](Optional.md)
 - [ResourceType](ResourceType.md)
 - [StringType](StringType.md)
 - [StringVal](StringVal.md)
 - [Type](Type.md)
+- [UndefOr](UndefOr.md)
diff --git a/docs/rules/Nullable.md b/docs/rules/Nullable.md
@@ -24,4 +24,4 @@ Version | Description
 See also:
 
 - [NullType](NullType.md)
-- [Optional](Optional.md)
+- [UndefOr](UndefOr.md)
diff --git a/docs/rules/Number.md b/docs/rules/Number.md
@@ -32,7 +32,7 @@ See also:
 - [IntType](IntType.md)
 - [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
-- [NotOptional](NotOptional.md)
+- [NotUndef](NotUndef.md)
 - [NullType](NullType.md)
 - [NumericVal](NumericVal.md)
 - [ObjectType](ObjectType.md)

diff --git a/docs/rules/UndefOr.md b/docs/rules/UndefOr.md
@@ -40,6 +40,6 @@ See also:
 - [NoWhitespace](NoWhitespace.md)
 - [NotBlank](NotBlank.md)
 - [NotEmpty](NotEmpty.md)
-- [NotOptional](NotOptional.md)
+- [NotUndef](NotUndef.md)
 - [NullType](NullType.md)
 - [Nullable](Nullable.md)
diff --git a/library/Mixins/ChainedKey.php b/library/Mixins/ChainedKey.php
@@ -255,6 +255,8 @@ public function keyNotEmpty(int|string $key): ChainedValidator;
 
     public function keyNotOptional(int|string $key): ChainedValidator;
 
+    public function keyNotUndef(int|string $key): ChainedValidator;
+
     public function keyNullType(int|string $key): ChainedValidator;
 
     public function keyNumber(int|string $key): ChainedValidator;

diff --git a/library/Mixins/ChainedNullOr.php b/library/Mixins/ChainedNullOr.php
@@ -242,8 +242,6 @@ public function nullOrNotEmoji(): ChainedValidator;
 
     public function nullOrNotEmpty(): ChainedValidator;
 
-    public function nullOrNotOptional(): ChainedValidator;
-
     public function nullOrNullType(): ChainedValidator;
 
     public function nullOrNumber(): ChainedValidator;

diff --git a/library/Mixins/ChainedProperty.php b/library/Mixins/ChainedProperty.php
@@ -267,6 +267,8 @@ public function propertyNotEmpty(string $propertyName): ChainedValidator;
 
     public function propertyNotOptional(string $propertyName): ChainedValidator;
 
+    public function propertyNotUndef(string $propertyName): ChainedValidator;
+
     public function propertyNullType(string $propertyName): ChainedValidator;
 
     public function propertyNumber(string $propertyName): ChainedValidator;

diff --git a/library/Mixins/ChainedUndefOr.php b/library/Mixins/ChainedUndefOr.php
@@ -246,8 +246,6 @@ public function undefOrNotEmoji(): ChainedValidator;
 
     public function undefOrNotEmpty(): ChainedValidator;
 
-    public function undefOrNotOptional(): ChainedValidator;
-
     public function undefOrNullType(): ChainedValidator;
 
     public function undefOrNumber(): ChainedValidator;

diff --git a/library/Mixins/ChainedValidator.php b/library/Mixins/ChainedValidator.php
@@ -253,6 +253,8 @@ public function notEmpty(): ChainedValidator;
 
     public function notOptional(): ChainedValidator;
 
+    public function notUndef(): ChainedValidator;
+
     public function nullOr(Validatable $rule): ChainedValidator;
 
     public function nullType(): ChainedValidator;

diff --git a/library/Mixins/StaticKey.php b/library/Mixins/StaticKey.php
@@ -259,6 +259,8 @@ public static function keyNotEmpty(int|string $key): ChainedValidator;
 
     public static function keyNotOptional(int|string $key): ChainedValidator;
 
+    public static function keyNotUndef(int|string $key): ChainedValidator;
+
     public static function keyNullType(int|string $key): ChainedValidator;
 
     public static function keyNumber(int|string $key): ChainedValidator;

diff --git a/library/Mixins/StaticNullOr.php b/library/Mixins/StaticNullOr.php
@@ -258,8 +258,6 @@ public static function nullOrNotEmoji(): ChainedValidator;
 
     public static function nullOrNotEmpty(): ChainedValidator;
 
-    public static function nullOrNotOptional(): ChainedValidator;
-
     public static function nullOrNullType(): ChainedValidator;
 
     public static function nullOrNumber(): ChainedValidator;

diff --git a/library/Mixins/StaticProperty.php b/library/Mixins/StaticProperty.php
@@ -291,6 +291,8 @@ public static function propertyNotEmpty(string $propertyName): ChainedValidator;
 
     public static function propertyNotOptional(string $propertyName): ChainedValidator;
 
+    public static function propertyNotUndef(string $propertyName): ChainedValidator;
+
     public static function propertyNullType(string $propertyName): ChainedValidator;
 
     public static function propertyNumber(string $propertyName): ChainedValidator;

diff --git a/library/Mixins/StaticUndefOr.php b/library/Mixins/StaticUndefOr.php
@@ -258,8 +258,6 @@ public static function undefOrNotEmoji(): ChainedValidator;
 
     public static function undefOrNotEmpty(): ChainedValidator;
 
-    public static function undefOrNotOptional(): ChainedValidator;
-
     public static function undefOrNullType(): ChainedValidator;
 
     public static function undefOrNumber(): ChainedValidator;

diff --git a/library/Mixins/StaticValidator.php b/library/Mixins/StaticValidator.php
@@ -256,6 +256,8 @@ public static function notEmpty(): ChainedValidator;
 
     public static function notOptional(): ChainedValidator;
 
+    public static function notUndef(): ChainedValidator;
+
     public static function nullOr(Validatable $rule): ChainedValidator;
 
     public static function nullType(): ChainedValidator;

diff --git a/library/Rules/NotOptional.php → library/Rules/NotUndef.php b/library/Rules/NotOptional.php → library/Rules/NotUndef.php
@@ -24,7 +24,7 @@
     '{{name}} must be optional',
     self::TEMPLATE_NAMED,
 )]
-final class NotOptional extends Standard
+final class NotUndef extends Standard
 {
     use CanValidateUndefined;
 

diff --git a/library/Transformers/Aliases.php b/library/Transformers/Aliases.php
@@ -15,6 +15,7 @@
 final class Aliases implements Transformer
 {
     private const ALIASES = [
+        'notOptional' => 'notUndef',
         'nullable' => 'nullOr',
         'optional' => 'undefOr',
     ];

diff --git a/library/Transformers/Prefix.php b/library/Transformers/Prefix.php
@@ -30,7 +30,7 @@ final class Prefix implements Transformer
         'notBlank',
         'notEmoji',
         'notEmpty',
-        'notOptional',
+        'notUndef',
         'nullOr',
         'property',
         'propertyExists',

diff --git a/tests/integration/rules/notOptional.phpt b/tests/integration/rules/notOptional.phpt