Merge pull request #41 from sourcetoad/enum-rule-callback

Enum rule modifier callback

Author: erik-perri

UPGRADE.md

@@ -2,6 +2,10 @@
 
 ## v4
 
+### Upgrading from v4.2 to v4.3
+
+- Minimum Laravel version increased from `10.34` to `10.46`.
+
 ### Upgrading from v4.1 to v4.2
 
 - Minimum Laravel version increased from `10.33` to `10.34`.

composer.json

@@ -6,7 +6,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": "^8.1",
-        "laravel/framework": "^10.34"
+        "laravel/framework": "^10.46"
     },
     "require-dev": {
         "ext-json": "*",

src/RuleSet.php

@@ -377,6 +377,8 @@ public function digitsBetween(int $min, int $max): self
      * pass a callback which accepts a {@see \Illuminate\Validation\Rules\Dimensions} instance.
      *
      * @link https://laravel.com/docs/10.x/validation#rule-dimensions
+     * @param array<string, int|float> $constraints
+     * @param ?callable(\Illuminate\Validation\Rules\Dimensions): void $modifier
      */
     public function dimensions(array $constraints, ?callable $modifier = null): self
     {
@@ -444,10 +446,17 @@ public function endsWith(string ...$value): self
      *
      * @link https://laravel.com/docs/10.x/validation#rule-enum
      * @param class-string $type
+     * @param ?callable(\Illuminate\Validation\Rules\Enum): void $modifier
      */
-    public function enum(string $type): self
+    public function enum(string $type, ?callable $modifier = null): self
     {
-        return $this->rule(Rule::enum($type));
+        $rule = Rule::enum($type);
+
+        if ($modifier) {
+            $modifier($rule);
+        }
+
+        return $this->rule($rule);
     }
 
     /**
@@ -526,6 +535,7 @@ public function excludeWithout(string $anotherField): self
      * {@see RuleSet::rule} or pass a callback which accepts an {@see \Illuminate\Validation\Rules\Exists} instance.
      *
      * @link https://laravel.com/docs/10.x/validation#rule-exists
+     * @param ?callable(\Illuminate\Validation\Rules\Exists): void $modifier
      */
     public function exists(string $table, string $column = 'NULL', ?callable $modifier = null): self
     {
@@ -899,6 +909,7 @@ public function numeric(): self
      * use {@see Rule::password} with {@see RuleSet::rule}, or pass a callback which accepts a {@see Password} instance.
      *
      * @link https://laravel.com/docs/10.x/validation#validating-passwords
+     * @param ?callable(\Illuminate\Validation\Rules\Password): void $modifier
      */
     public function password(?int $size = null, ?callable $modifier = null): self
     {
@@ -972,7 +983,7 @@ public function prohibited(): self
      * passed in closure returns true.
      *
      * @link https://laravel.com/docs/10.x/validation#rule-prohibited-if
-     * @param callable|bool $callback
+     * @param bool|callable(): bool $callback
      */
     public function prohibitedIf(mixed $callback): self
     {
@@ -1044,7 +1055,7 @@ public function requiredArrayKeys(string ...$key): self
      * closure returns true.
      *
      * @link https://laravel.com/docs/10.x/validation#rule-required-if
-     * @param callable|bool $callback
+     * @param bool|callable(): bool $callback
      */
     public function requiredIf(mixed $callback): self
     {
@@ -1226,6 +1237,7 @@ public function ulid(): self
      * {@see RuleSet::rule} or pass a callback which accepts a {@see \Illuminate\Validation\Rules\Unique} instance.
      *
      * @link https://laravel.com/docs/10.x/validation#rule-unique
+     * @param ?callable(\Illuminate\Validation\Rules\Unique): void $modifier
      */
     public function unique(string $table, string $column = 'NULL', ?callable $modifier = null): self
     {

tests/Stubs/ExampleStringEnum.php

@@ -6,5 +6,6 @@
 
 enum ExampleStringEnum: string
 {
+    case Another = 'another';
     case Valid = 'valid';
 }

tests/Unit/RuleTest.php

@@ -18,6 +18,7 @@
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
 use Illuminate\Validation\Rules\Dimensions;
+use Illuminate\Validation\Rules\Enum;
 use Illuminate\Validation\Rules\Password;
 use Sourcetoad\RuleHelper\Rule;
 use Sourcetoad\RuleHelper\RuleSet;
@@ -953,6 +954,22 @@ public function ruleDataProvider(): array
                 'rules' => fn() => RuleSet::create()->enum(ExampleIntEnum::class),
                 'fails' => true,
             ],
+            'enum string constrained valid' => [
+                'data' => 'another',
+                'rules' => fn() => RuleSet::create()->enum(
+                    ExampleStringEnum::class,
+                    fn(Enum $rule) => $rule->only(ExampleStringEnum::Another),
+                ),
+                'fails' => false,
+            ],
+            'enum string constrained invalid' => [
+                'data' => 'another',
+                'rules' => fn() => RuleSet::create()->enum(
+                    ExampleStringEnum::class,
+                    fn(Enum $rule) => $rule->except(ExampleStringEnum::Another),
+                ),
+                'fails' => true,
+            ],
             'extensions valid' => [
                 'data' => fn() => $this->mockFile('/code/image.jpg'),
                 'rules' => fn() => RuleSet::create()->extensions('jpg', 'png'),