Refactor the NotEmoji rule

Since we have the ability to use `not` as a prefix, having rules that
validate negative behaviour makes them a bit inflexible, verbose, and
harder to understand.

This commit will refactor the `NotEmoji` and rename it to `Emoji`. It
will no longer check if the string contains emojis, but rather if the
string is an emoji or not. I’m also adding support to more emojis, since
the rule was a bit outdated.

This change will make the validator more strict, but will make it useful
in other scenarios. However, later on, I would like to create a rule
called `has` which, could use a validator like `Emoji` to check if the
input _has_ emojis.

Author: henriquemoody

bin/create-mixin

@@ -8,34 +8,31 @@ require __DIR__ . '/../vendor/autoload.php';
 use Nette\PhpGenerator\InterfaceType;
 use Nette\PhpGenerator\PhpNamespace;
 use Nette\PhpGenerator\Printer;
-use Respect\Validation\Exceptions\ValidationException;
-use Respect\Validation\Mixins\KeyChain;
-use Respect\Validation\Mixins\LengthChain;
-use Respect\Validation\Mixins\MaxChain;
-use Respect\Validation\Mixins\MinChain;
-use Respect\Validation\Mixins\NotChain;
-use Respect\Validation\Mixins\NullOrChain;
-use Respect\Validation\Mixins\PropertyChain;
-use Respect\Validation\Mixins\UndefOrChain;
 use Respect\Validation\Mixins\Chain;
 use Respect\Validation\Mixins\KeyBuilder;
+use Respect\Validation\Mixins\KeyChain;
 use Respect\Validation\Mixins\LengthBuilder;
+use Respect\Validation\Mixins\LengthChain;
 use Respect\Validation\Mixins\MaxBuilder;
+use Respect\Validation\Mixins\MaxChain;
 use Respect\Validation\Mixins\MinBuilder;
+use Respect\Validation\Mixins\MinChain;
 use Respect\Validation\Mixins\NotBuilder;
+use Respect\Validation\Mixins\NotChain;
 use Respect\Validation\Mixins\NullOrBuilder;
+use Respect\Validation\Mixins\NullOrChain;
 use Respect\Validation\Mixins\PropertyBuilder;
+use Respect\Validation\Mixins\PropertyChain;
 use Respect\Validation\Mixins\UndefOrBuilder;
-use Respect\Validation\Rules\Undef;
-use Respect\Validation\Rules\NullOr;
-use Respect\Validation\Rules\UndefOr;
+use Respect\Validation\Mixins\UndefOrChain;
 use Respect\Validation\Rule;
+use Respect\Validation\Validator;
 
 function addMethodToInterface(
     string $originalName,
     InterfaceType $interfaceType,
     ReflectionClass $reflection,
-    ?string $prefix,
+    string|null $prefix,
     array $allowList,
     array $denyList,
 ): void {
@@ -65,6 +62,7 @@ function addMethodToInterface(
     if ($reflrectionConstructor === null) {
         return;
     }
+
     $commend = $reflrectionConstructor->getDocComment();
     if ($commend) {
         $method->addComment(preg_replace('@(/\*\* *| +\* +| +\*/)@', '', $commend));
@@ -83,13 +81,15 @@ function addMethodToInterface(
             }
         } elseif ($type instanceof ReflectionNamedType) {
             $types[] = $type->getName();
-            if (            str_starts_with($type->getName(), 'Sokil')
+            if (
+                str_starts_with($type->getName(), 'Sokil')
                 || str_starts_with($type->getName(), 'Egulias')
                 || $type->getName() === 'finfo'
             ) {
                 continue;
             }
         }
+
         $parameter = $method->addParameter($reflectionParameter->getName());
         $parameter->setType(implode('|', $types));
 
@@ -121,7 +121,7 @@ function overwriteFile(string $content, string $basename): void
 {
     file_put_contents(sprintf('%s/../library/Mixins/%s.php', __DIR__, $basename), implode(PHP_EOL . PHP_EOL, [
         '<?php',
-        file_get_contents(__DIR__.'/../.docheader'),
+        file_get_contents(__DIR__ . '/../.docheader'),
         'declare(strict_types=1);',
         preg_replace('/extends (.+, )+/', 'extends' . PHP_EOL . '\1', $content),
     ]));
@@ -172,7 +172,7 @@ function overwriteFile(string $content, string $basename): void
         ['Length', 'length', $numberRelatedRules, []],
         ['Max', 'max', $numberRelatedRules, []],
         ['Min', 'min', $numberRelatedRules, []],
-        ['Not', 'not', [], ['Not', 'NotEmpty', 'NotEmoji', 'NullOr', 'UndefOr', 'Attributes', 'Templated', 'Named']],
+        ['Not', 'not', [], ['Not', 'NotEmpty', 'NullOr', 'UndefOr', 'Attributes', 'Templated', 'Named']],
         ['NullOr', 'nullOr', [], ['NullOr', 'Blank', 'Undef', 'UndefOr', 'Templated', 'Named']],
         ['Property', 'property', [], $structureRelatedRules],
         ['UndefOr', 'undefOr', [], ['NullOr', 'Blank', 'Undef', 'UndefOr', 'Attributes', 'Templated', 'Named']],
@@ -190,8 +190,10 @@ function overwriteFile(string $content, string $basename): void
         if ($reflection->isAbstract()) {
             continue;
         }
+
         $names[$reflection->getShortName()] = $reflection;
     }
+
     ksort($names);
 
     foreach ($mixins as [$name, $prefix, $allowList, $denyList]) {
@@ -213,7 +215,7 @@ function overwriteFile(string $content, string $basename): void
             $chainedInterface->addExtend(NullOrChain::class);
             $chainedInterface->addExtend(PropertyChain::class);
             $chainedInterface->addExtend(UndefOrChain::class);
-            $chainedInterface->addComment('@mixin \\' . \Respect\Validation\Validator::class);
+            $chainedInterface->addComment('@mixin \\' . Validator::class);
 
             $staticInterface->addExtend(KeyBuilder::class);
             $staticInterface->addExtend(LengthBuilder::class);
@@ -237,5 +239,5 @@ function overwriteFile(string $content, string $basename): void
         overwriteFile($printer->printNamespace($chainedNamespace), $chainedInterface->getName());
     }
 
-    shell_exec(__DIR__.'/../vendor/bin/phpcbf');
+    shell_exec(__DIR__ . '/../vendor/bin/phpcbf ' . __DIR__ . '/../library/Mixins');
 })();

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

@@ -229,13 +229,13 @@
 - [ContainsAny](rules/ContainsAny.md)
 - [Control](rules/Control.md)
 - [Digit](rules/Digit.md)
+- [Emoji](rules/Emoji.md)
 - [EndsWith](rules/EndsWith.md)
 - [Graph](rules/Graph.md)
 - [HexRgbColor](rules/HexRgbColor.md)
 - [In](rules/In.md)
 - [Json](rules/Json.md)
 - [Lowercase](rules/Lowercase.md)
-- [NotEmoji](rules/NotEmoji.md)
 - [Phone](rules/Phone.md)
 - [PhpLabel](rules/PhpLabel.md)
 - [PostalCode](rules/PostalCode.md)
@@ -344,6 +344,7 @@
 - [Domain](rules/Domain.md)
 - [Each](rules/Each.md)
 - [Email](rules/Email.md)
+- [Emoji](rules/Emoji.md)
 - [EndsWith](rules/EndsWith.md)
 - [Equals](rules/Equals.md)
 - [Equivalent](rules/Equivalent.md)
@@ -404,7 +405,6 @@
 - [No](rules/No.md)
 - [NoneOf](rules/NoneOf.md)
 - [Not](rules/Not.md)
-- [NotEmoji](rules/NotEmoji.md)
 - [NotEmpty](rules/NotEmpty.md)
 - [NullOr](rules/NullOr.md)
 - [NullType](rules/NullType.md)

docs/rules/Alnum.md

@@ -70,8 +70,8 @@ See also:
 - [Control](Control.md)
 - [Decimal](Decimal.md)
 - [Digit](Digit.md)
+- [Emoji](Emoji.md)
 - [Lowercase](Lowercase.md)
-- [NotEmoji](NotEmoji.md)
 - [Regex](Regex.md)
 - [Spaced](Spaced.md)
 - [StringType](StringType.md)

docs/rules/Alpha.md

@@ -64,8 +64,8 @@ See also:
 - [Consonant](Consonant.md)
 - [Decimal](Decimal.md)
 - [Digit](Digit.md)
+- [Emoji](Emoji.md)
 - [Lowercase](Lowercase.md)
-- [NotEmoji](NotEmoji.md)
 - [Regex](Regex.md)
 - [Spaced](Spaced.md)
 - [Uppercase](Uppercase.md)

docs/rules/Decimal.md

@@ -55,12 +55,12 @@ See also:
 - [Alpha](Alpha.md)
 - [Consonant](Consonant.md)
 - [CreditCard](CreditCard.md)
+- [Emoji](Emoji.md)
 - [Factor](Factor.md)
 - [Finite](Finite.md)
 - [Infinite](Infinite.md)
 - [IntType](IntType.md)
 - [IntVal](IntVal.md)
-- [NotEmoji](NotEmoji.md)
 - [NumericVal](NumericVal.md)
 - [Regex](Regex.md)
 - [Uuid](Uuid.md)

docs/rules/Digit.md

@@ -56,12 +56,12 @@ See also:
 - [Alpha](Alpha.md)
 - [Consonant](Consonant.md)
 - [CreditCard](CreditCard.md)
+- [Emoji](Emoji.md)
 - [Factor](Factor.md)
 - [Finite](Finite.md)
 - [Infinite](Infinite.md)
 - [IntType](IntType.md)
 - [IntVal](IntVal.md)
-- [NotEmoji](NotEmoji.md)
 - [NumericVal](NumericVal.md)
 - [Regex](Regex.md)
 - [Uuid](Uuid.md)

docs/rules/Emoji.md

@@ -0,0 +1,63 @@
+# Emoji
+
+- `v::emoji()`
+
+Validates if the input is an emoji or a sequence of emojis.
+
+```php
+v::emoji()->isValid('🍕'); // true
+v::emoji()->isValid('🎈'); // true
+v::emoji()->isValid('⚡'); // true
+v::emoji()->isValid('🌊🌊🌊🌊🌊🏄🌊🌊🌊🏖🌴'); // true
+v::emoji()->isValid('🇧🇷'); // true (country flag)
+v::emoji()->isValid('👨‍👩‍👧‍👦'); // true (ZWJ sequence)
+v::emoji()->isValid('👩🏽'); // true (skin tone modifier)
+v::emoji()->isValid('1️⃣'); // true (keycap sequence)
+v::emoji()->isValid('Hello World'); // false
+v::emoji()->isValid('this is a spark ⚡'); // false (mixed content)
+```
+
+This validator supports:
+
+- Basic emojis and pictographs
+- Skin tone modifiers (Fitzpatrick scale)
+- Country flags (regional indicator sequences)
+- Subdivision flags (tag sequences like 🏴󠁧󠁢󠁥󠁮󠁧󠁿)
+- Keycap sequences (0️⃣-9️⃣, #️⃣, \*️⃣)
+- ZWJ (Zero Width Joiner) sequences for families, professions, and combined emojis
+- Emojis up to Unicode 17.0 / Emoji 16.0
+
+## Templates
+
+### `Emoji::TEMPLATE_STANDARD`
+
+| Mode       | Template                         |
+| ---------- | -------------------------------- |
+| `default`  | {{subject}} must be an emoji     |
+| `inverted` | {{subject}} must not be an emoji |
+
+## Template placeholders
+
+| Placeholder | Description                                                      |
+| ----------- | ---------------------------------------------------------------- |
+| `subject`   | The validated input or the custom validator name (if specified). |
+
+## Categorization
+
+- Strings
+
+## Changelog
+
+| Version | Description                                                              |
+| ------: | ------------------------------------------------------------------------ |
+|   3.0.0 | Renamed to `Emoji`, changed the behavior, and add support to more emojis |
+|   2.0.0 | Created as `NotEmoji`                                                    |
+
+---
+
+See also:
+
+- [Alnum](Alnum.md)
+- [Alpha](Alpha.md)
+- [Decimal](Decimal.md)
+- [Digit](Digit.md)

docs/rules/NotEmoji.md

@@ -242,7 +242,7 @@ public static function noneOf(Rule $rule1, Rule $rule2, Rule ...$rules): Chain;
 
     public static function not(Rule $rule): Chain;
 
-    public static function notEmoji(): Chain;
+    public static function emoji(): Chain;
 
     public static function notEmpty(): Chain;
 

library/Mixins/Builder.php

@@ -245,7 +245,7 @@ public function noneOf(Rule $rule1, Rule $rule2, Rule ...$rules): Chain;
 
     public function not(Rule $rule): Chain;
 
-    public function notEmoji(): Chain;
+    public function emoji(): Chain;
 
     public function notEmpty(): Chain;