Merge pull request #17 from sourcetoad/pre-1.0

Docs update and `required_array_keys` helper

Author: erik-perri

README.md

@@ -5,7 +5,6 @@ Adds helpers to make building Laravel rule arrays easier by providing helper met
 ## Installation
 
 ```shell
-$ composer config repositories.sourcetoad/rule-helper-for-laravel.git vcs https://github.com/sourcetoad/rule-helper-for-laravel.git
 $ composer require sourcetoad/rule-helper-for-laravel
 ```
 

composer.json

@@ -7,7 +7,7 @@
     "require": {
         "php": "^7.4|^8.0",
         "egulias/email-validator": "^2.1.21",
-        "laravel/framework": "^8.77"
+        "laravel/framework": "^8.82"
     },
     "require-dev": {
         "ext-json": "*",

src/Rule.php

@@ -663,6 +663,14 @@ public static function required(): string
         return 'required';
     }
 
+    /**
+     * The field under validation must be an array and must contain at least the specified keys.
+     */
+    public static function requiredArrayKeys(string ...$key): string
+    {
+        return sprintf('required_array_keys:%s', implode(',', $key));
+    }
+
     /**
      * The field must be present if all the criteria are true.
      */

src/RuleSet.php

@@ -768,6 +768,14 @@ public function required(): self
         return $this->rule(Rule::required());
     }
 
+    /**
+     * The field under validation must be an array and must contain at least the specified keys.
+     */
+    public function requiredArrayKeys(string ...$key): self
+    {
+        return $this->rule(Rule::requiredArrayKeys(...$key));
+    }
+
     /**
      * The field under validation must be present in the input data if a true boolean is passed in or the passed in
      * closure returns true.

tests/Unit/RuleTest.php

@@ -1264,6 +1264,16 @@ public function ruleDataProvider(): array
                 'rules' => fn() => RuleSet::create()->required(),
                 'fails' => true,
             ],
+            'requiredArrayKeys valid' => [
+                'data' => ['field' => ['a' => '1', 'b' => '2', 'c' => '3']],
+                'rules' => fn() => ['field' => RuleSet::create()->requiredArrayKeys('a', 'b', 'c')],
+                'fails' => false,
+            ],
+            'requiredArrayKeys invalid' => [
+                'data' => ['field' => ['a' => '1', 'c' => '3']],
+                'rules' => fn() => ['field' => RuleSet::create()->requiredArrayKeys('a', 'b', 'c')],
+                'fails' => true,
+            ],
             'requiredIf bool valid' => [
                 'data' => [
                     'field-a' => 'a',