Required if declined rule helper (#43)

* test: Fixed deprecated mismatched param name support

`Providing invalid named argument $rule for method Sourcetoad\RuleHelper\Tests\Unit\DatabaseRuleTest::testDatabaseRules() is deprecated and will not be supported in PHPUnit 11.0.`

* update: Added `required_if_declined` helper

* refactor: Fixed in type

* refactor: Fixed not_in type

Author: erik-perri

UPGRADE.md

@@ -2,6 +2,10 @@
 
 ## v5
 
+### Upgrading from v5.0 to v5.1
+
+- Minimum Laravel version increased from `11.0.3` to `11.4`.
+
 ### Upgrading from v4.3 to v5.0
 
 - Minimum Laravel version increased from `10.46` to `11.0.3`.

composer.json

@@ -6,7 +6,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": "^8.2",
-        "laravel/framework": "^11.0.3"
+        "laravel/framework": "^11.4"
     },
     "require-dev": {
         "ext-json": "*",

src/Rule.php

@@ -996,8 +996,8 @@ public static function requiredIf(mixed $callback): RequiredIf
     }
 
     /**
-     * The field under validation must be present and not empty if the `anotherfield` field is equal to yes, on, 1, "1",
-     * true, or "true".
+     * The field under validation must be present and not empty if the `field` field is equal to yes, on, 1, "1", true,
+     * or "true".
      *
      * @link https://laravel.com/docs/11.x/validation#rule-required-if-accepted
      */
@@ -1026,6 +1026,17 @@ public static function requiredIfAny(RequiredIf ...$rules): RequiredIf
         });
     }
 
+    /**
+     * The field under validation must be present and not empty if the `field` field is equal to "no", "off", 0, "0",
+     * false, or "false".
+     *
+     * @link https://laravel.com/docs/11.x/validation#rule-required-if-declined
+     */
+    public static function requiredIfDeclined(string $field): string
+    {
+        return 'required_if_declined:'.$field;
+    }
+
     /**
      * The field under validation must be present and not empty if the *anotherField* field is equal to any *value*.
      *

src/RuleSet.php

@@ -645,7 +645,7 @@ public function image(): self
      * list of values provided to the *in* rule.
      *
      * @link https://laravel.com/docs/11.x/validation#rule-in
-     * @param Arrayable<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|string $values
+     * @param Arrayable<array-key, mixed>|array<array-key, mixed>|string $values
      */
     public function in(Arrayable|array|string $values): self
     {
@@ -888,7 +888,7 @@ public function multipleOf(int|float $value): self
      * The field under validation must not be included in the given list of values.
      *
      * @link https://laravel.com/docs/11.x/validation#rule-not-in
-     * @param Arrayable<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|string $values
+     * @param Arrayable<array-key, mixed>|array<array-key, mixed>|string $values
      */
     public function notIn(Arrayable|array|string $values): self
     {
@@ -1088,8 +1088,8 @@ public function requiredIf(mixed $callback): self
     }
 
     /**
-     * The field under validation must be present and not empty if the `anotherfield` field is equal to yes, on, 1, "1",
-     * true, or "true".
+     * The field under validation must be present and not empty if the `field` field is equal to yes, on, 1, "1", true,
+     * or "true".
      *
      * @link https://laravel.com/docs/11.x/validation#rule-required-if-accepted
      */
@@ -1114,6 +1114,17 @@ public function requiredIfAny(RequiredIf ...$rules): self
         return $this->rule(Rule::requiredIfAny(...$rules));
     }
 
+    /**
+     * The field under validation must be present and not empty if the `field` field is equal to "no", "off", 0, "0",
+     * false, or "false".
+     *
+     * @link https://laravel.com/docs/11.x/validation#rule-required-if-declined
+     */
+    public function requiredIfDeclined(string $field): self
+    {
+        return $this->rule(Rule::requiredIfDeclined($field));
+    }
+
     /**
      * The field under validation must be present and not empty if the *anotherField* field is equal to any *value*.
      *

tests/Unit/DatabaseRuleTest.php

@@ -54,7 +54,7 @@ public static function databaseSetupProvider(): array
         return [
             'does not exist without column' => [
                 'createData' => fn() => ['email' => $this->faker->email],
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'email' => RuleSet::create()->exists('users'),
                 ],
                 'fails' => true,
@@ -70,14 +70,14 @@ public static function databaseSetupProvider(): array
 
                     return ['email' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'email' => RuleSet::create()->exists('users'),
                 ],
                 'fails' => false,
             ],
             'does not exist with column' => [
                 'createData' => fn() => ['value' => $this->faker->email],
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->exists('users', 'email'),
                 ],
                 'fails' => true,
@@ -93,7 +93,7 @@ public static function databaseSetupProvider(): array
 
                     return ['value' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->exists('users', 'email'),
                 ],
                 'fails' => false,
@@ -109,7 +109,7 @@ public static function databaseSetupProvider(): array
 
                     return ['value' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->exists(
                         'users',
                         'email',
@@ -129,7 +129,7 @@ public static function databaseSetupProvider(): array
 
                     return ['value' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->exists(
                         'users',
                         'email',
@@ -149,14 +149,14 @@ public static function databaseSetupProvider(): array
 
                     return ['email' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'email' => RuleSet::create()->unique('users'),
                 ],
                 'fails' => true,
             ],
             'unique without column' => [
                 'createData' => fn() => ['email' => $this->faker->email],
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'email' => RuleSet::create()->unique('users'),
                 ],
                 'fails' => false,
@@ -172,14 +172,14 @@ public static function databaseSetupProvider(): array
 
                     return ['value' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->unique('users', 'email'),
                 ],
                 'fails' => true,
             ],
             'unique with column' => [
                 'createData' => fn() => ['value' => $this->faker->email],
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->unique('users', 'email'),
                 ],
                 'fails' => false,
@@ -195,7 +195,7 @@ public static function databaseSetupProvider(): array
 
                     return ['value' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->unique(
                         'users',
                         'email',
@@ -215,7 +215,7 @@ public static function databaseSetupProvider(): array
 
                     return ['value' => $email];
                 },
-                'rule' => fn() => [
+                'createRules' => fn() => [
                     'value' => RuleSet::create()->unique(
                         'users',
                         'email',

tests/Unit/RuleTest.php

@@ -2110,6 +2110,26 @@ public static function ruleDataProvider(): array
                 ],
                 'fails' => true,
             ],
+            'requiredIfDeclined valid' => [
+                'data' => [
+                    'field-a' => 'a',
+                    'field-b' => '1',
+                ],
+                'rules' => fn() => [
+                    'field-a' => RuleSet::create()->requiredIfDeclined('field-b'),
+                ],
+                'fails' => false,
+            ],
+            'requiredIfDeclined invalid' => [
+                'data' => [
+                    'field-a' => '',
+                    'field-b' => '0',
+                ],
+                'rules' => fn() => [
+                    'field-a' => RuleSet::create()->requiredIfDeclined('field-b'),
+                ],
+                'fails' => true,
+            ],
             'requiredIfValue valid' => [
                 'data' => [
                     'field-a' => 'a',