Add anyOf and in_array_keys (#56)

* docs: updated link to point at 12.x

* update: added in array keys rule

* update: added any of rule

* refactor: add missing return type

* refactor: switch to shared defined rule type

* refactor: leave unwrapping to laravel

Author: erik-perri

UPGRADE.md

@@ -2,6 +2,10 @@
 
 ## v6
 
+### Upgrading from v6.0 to v6.1
+
+- Minimum Laravel version increased from `12.0` to `12.16`.
+
 ### Upgrading from v5.6 to v6.0
 
 - Minimum Laravel version increased from `11.43` to `12.0`.

composer.json

@@ -6,7 +6,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": "^8.2||^8.3||^8.4",
-        "laravel/framework": "^12.0"
+        "laravel/framework": "^12.16"
     },
     "require-dev": {
         "ext-json": "*",

src/Rule.php

@@ -12,8 +12,10 @@
 use Illuminate\Contracts\Validation\Rule as RuleContract;
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Fluent;
 use Illuminate\Validation\ConditionalRules;
 use Illuminate\Validation\Rule as LaravelRule;
+use Illuminate\Validation\Rules\AnyOf;
 use Illuminate\Validation\Rules\ArrayRule;
 use Illuminate\Validation\Rules\Can;
 use Illuminate\Validation\Rules\Date;
@@ -33,6 +35,11 @@
 use Stringable;
 use UnitEnum;
 
+/**
+ * @phpstan-type RuleType RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string
+ * @phpstan-type FieldRules RuleSet|array<int, RuleType>|RuleType
+ * @phpstan-type RuleSetDefinition RuleSet|array<string, FieldRules>
+ */
 class Rule
 {
     /**
@@ -147,6 +154,18 @@ public static function alphaNum(?bool $limitToAscii = null): string
         return 'alpha_num';
     }
 
+    /**
+     * The `anyOf` validation rule allows you to specify that the field under validation must satisfy any of the given
+     * validation rulesets.
+     *
+     * @link https://laravel.com/docs/12.x/validation#rule-anyof
+     * @param array<array-key, RuleSetDefinition> $ruleSets
+     */
+    public static function anyOf(array $ruleSets): AnyOf
+    {
+        return LaravelRule::anyOf($ruleSets);
+    }
+
     /**
      * The field under validation must be a PHP *array*.
      *
@@ -662,6 +681,16 @@ public static function inArray(string $anotherField): string
         return 'in_array:'.$anotherField;
     }
 
+    /**
+     * The field under validation must be an array having at least one of the given *values* as a key within the array.
+     *
+     * @link https://laravel.com/docs/12.x/validation#rule-in-array-keys
+     */
+    public static function inArrayKeys(string ...$value): string
+    {
+        return 'in_array_keys:'.implode(',', $value);
+    }
+
     /**
      * The field under validation must be an integer.
      *
@@ -1403,9 +1432,9 @@ public static function uuid(): string
     /**
      * Create a new conditional rule set.
      *
-     * @param bool|callable(\Illuminate\Support\Fluent<array-key, mixed>): bool $condition
-     * @param array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|string|RuleSet $rules
-     * @param array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|string|RuleSet $defaultRules
+     * @param bool|callable(Fluent<array-key, mixed>): bool $condition
+     * @param array<array-key, RuleType>|string|RuleSet $rules
+     * @param array<array-key, RuleType>|string|RuleSet $defaultRules
      */
     public static function when(
         mixed $condition,

src/RuleHelperServiceProvider.php

@@ -8,7 +8,7 @@
 
 class RuleHelperServiceProvider extends ServiceProvider
 {
-    public function register()
+    public function register(): void
     {
         $this->app->singleton(Contracts\DefinedRuleSets::class, DefinedRuleSets::class);
     }

src/RuleSet.php

@@ -9,32 +9,29 @@
 use Brick\Math\BigNumber;
 use DateTimeInterface;
 use Illuminate\Contracts\Support\Arrayable;
-use Illuminate\Contracts\Validation\InvokableRule;
-use Illuminate\Contracts\Validation\Rule as RuleContract;
-use Illuminate\Contracts\Validation\ValidationRule;
-use Illuminate\Validation\ConditionalRules;
 use Illuminate\Validation\Rules\Password;
 use Illuminate\Validation\Rules\RequiredIf;
 use IteratorAggregate;
-use Stringable;
 use UnitEnum;
 
 /**
- * @implements Arrayable<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>
- * @implements IteratorAggregate<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>
+ * @phpstan-import-type RuleType from Rule
+ * @phpstan-import-type RuleSetDefinition from Rule
+ * @implements Arrayable<array-key, RuleType>
+ * @implements IteratorAggregate<array-key, RuleType>
  */
 class RuleSet implements Arrayable, IteratorAggregate
 {
     /**
-     * @param array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string> $rules
+     * @param array<array-key, RuleType> $rules
      */
     final public function __construct(protected array $rules = [])
     {
         //
     }
 
     /**
-     * @return ArrayIterator<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>
+     * @return ArrayIterator<array-key, RuleType>
      */
     public function getIterator(): ArrayIterator
     {
@@ -44,7 +41,7 @@ public function getIterator(): ArrayIterator
     /**
      * Get the rule set as an array.
      *
-     * @return array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>
+     * @return array<array-key, RuleType>
      */
     public function toArray(): array
     {
@@ -54,7 +51,7 @@ public function toArray(): array
     /**
      * Create a new rule set.
      *
-     * @param array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string> $rules
+     * @param array<array-key, RuleType> $rules
      */
     public static function create(array $rules = []): self
     {
@@ -80,7 +77,7 @@ public static function useDefined(string|BackedEnum|UnitEnum $name): RuleSet
     /**
      * Append one or more rules to the end of the rule set.
      *
-     * @param RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string $rule
+     * @param RuleType $rule
      */
     public function concat(...$rule): self
     {
@@ -98,7 +95,7 @@ public function concatDefined(string $name): self
     /**
      * Append a rule to the end of the rule set.
      *
-     * @param RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string $rule
+     * @param RuleType $rule
      */
     public function rule(mixed $rule): self
     {
@@ -205,6 +202,18 @@ public function alphaNum(?bool $limitToAscii = null): self
         return $this->rule(Rule::alphaNum($limitToAscii));
     }
 
+    /**
+     * The `anyOf` validation rule allows you to specify that the field under validation must satisfy any of the given
+     * validation rulesets.
+     *
+     * @link https://laravel.com/docs/12.x/validation#rule-anyof
+     * @param array<array-key, RuleSetDefinition> $ruleSets
+     */
+    public function anyOf(array $ruleSets): self
+    {
+        return $this->rule(Rule::anyOf($ruleSets));
+    }
+
     /**
      * The field under validation must be a PHP *array*.
      *
@@ -759,6 +768,16 @@ public function inArray(string $anotherField): self
         return $this->rule(Rule::inArray($anotherField));
     }
 
+    /**
+     * The field under validation must be an array having at least one of the given *values* as a key within the array.
+     *
+     * @link https://laravel.com/docs/12.x/validation#rule-in-array-keys
+     */
+    public function inArrayKeys(string ...$value): self
+    {
+        return $this->rule(Rule::inArrayKeys(...$value));
+    }
+
     /**
      * The field under validation must be an integer.
      *
@@ -1505,8 +1524,8 @@ public function uuid(): self
      * Create a new conditional rule set.
      *
      * @param bool|callable(\Illuminate\Support\Fluent<array-key, mixed>): bool $condition
-     * @param array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|string|RuleSet $rules
-     * @param array<array-key, RuleContract|InvokableRule|ValidationRule|ConditionalRules|Stringable|string>|string|RuleSet $defaultRules
+     * @param array<array-key, RuleType>|string|RuleSet $rules
+     * @param array<array-key, RuleType>|string|RuleSet $defaultRules
      */
     public function when(mixed $condition, array|string|RuleSet $rules, array|string|RuleSet $defaultRules = []): self
     {