fix support for Enum validation rule

Author: danilopolani

README.md

@@ -102,7 +102,7 @@ Of course you can provide your own custom validation Rules:
 ```php
 it('throws validation error', function () {
     $this->postJson('/')
-        ->assertJsonValidationErrorRule('foo', new MyCustomRule());
+        ->assertJsonValidationErrorRule('foo', new Uppercase());
 });
 ```
 

src/JsonValidation.php

@@ -3,14 +3,15 @@
 namespace DaniloPolani\JsonValidation;
 
 use DaniloPolani\JsonValidation\Contracts\HasRuleMessage;
+use Illuminate\Validation\Rules\Enum as EnumRule;
 use Illuminate\Support\Facades\App;
 
 class JsonValidation
 {
     /**
      * Get the error messages for an attribute and a validation rule.
      */
-    public static function getRuleErrorMessage(string $attribute, string|HasRuleMessage $rule): array
+    public static function getRuleErrorMessage(string $attribute, string|HasRuleMessage|EnumRule $rule): array
     {
         return (new Validator(App::make('translator'), [], []))
             ->getErrorMessage(...func_get_args());

src/JsonValidationServiceProvider.php

@@ -3,6 +3,7 @@
 namespace DaniloPolani\JsonValidation;
 
 use DaniloPolani\JsonValidation\Contracts\HasRuleMessage;
+use Illuminate\Validation\Rules\Enum as EnumRule;
 use Illuminate\Support\Facades\App;
 use Illuminate\Testing\Assert as PHPUnit;
 use Illuminate\Testing\TestResponse;
@@ -22,13 +23,9 @@ public function packageBooted(): void
             'assertJsonValidationErrorRule',
             /**
              * Assert that the response has the given JSON validation errors.
-             *
-             * @param  string|array  $attribute
-             * @param  string|\Illuminate\Contracts\Validation\Rule|null  $rule
-             * @param  string  $responseKey
              * @return self
              */
-            function (string|array $attribute, string|HasRuleMessage|null $rule = null, string $responseKey = 'errors') {
+            function (string|array $attribute, string|HasRuleMessage|EnumRule|null $rule = null, string $responseKey = 'errors') {
                 $validationRules = $attribute;
 
                 if (is_string($attribute)) {

src/Validator.php

@@ -3,6 +3,7 @@
 namespace DaniloPolani\JsonValidation;
 
 use DaniloPolani\JsonValidation\Contracts\HasRuleMessage;
+use Illuminate\Validation\Rules\Enum as EnumRule;
 use Illuminate\Support\Str;
 use Illuminate\Validation\ValidationRuleParser;
 
@@ -23,7 +24,7 @@ class Validator extends \Illuminate\Validation\Validator
     /**
      * Get the error messages for an attribute and a validation rule.
      */
-    public function getErrorMessage(string $attribute, string|HasRuleMessage $rule): array
+    public function getErrorMessage(string $attribute, string|HasRuleMessage|EnumRule $rule): array
     {
         if ($rule instanceof HasRuleMessage) {
             $messages = $rule->message();
@@ -42,6 +43,12 @@ public function getErrorMessage(string $attribute, string|HasRuleMessage $rule):
             return $result;
         }
 
+        if ($rule instanceof EnumRule) {
+            return [
+                str_replace(':attribute', $attribute, $this->getMessage($attribute, 'enum')),
+            ];
+        }
+
         [$rule, $parameters] = ValidationRuleParser::parse($rule);
         $result = [];
 

tests/TestResponseTest.php

@@ -1,9 +1,11 @@
 <?php
 
 use DaniloPolani\JsonValidation\Contracts\HasRuleMessage;
+use DaniloPolani\JsonValidation\Tests\TestEnumRole;
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Http\Response;
 use Illuminate\Testing\TestResponse;
+use Illuminate\Validation\Rules\Enum;
 use PHPUnit\Framework\ExpectationFailedException;
 
 it('accepts a string as field name', function () {
@@ -33,7 +35,8 @@
 });
 
 it('accepts a custom rule', function () {
-    $rule = new class () implements ValidationRule, HasRuleMessage {
+    $rule = new class() implements ValidationRule, HasRuleMessage
+    {
         public function validate(string $attribute, mixed $value, \Closure $fail): void
         {
             return;
@@ -57,6 +60,19 @@ public function message(): string
     $testResponse->assertJsonValidationErrorRule('key', $rule);
 });
 
+it('accepts "Enum" rule', function () {
+    $data = [
+        'response' => 'error',
+        'errors' => ['key' => 'The selected key is invalid.'],
+    ];
+
+    $testResponse = TestResponse::fromBaseResponse(
+        (new Response())->setContent(json_encode($data))
+    );
+
+    $testResponse->assertJsonValidationErrorRule('key', new Enum(TestEnumRole::class));
+});
+
 it('throws error when field is a string and rule is not provided', function () {
     $response = TestResponse::fromBaseResponse(new Response());
     $response->assertJsonValidationErrorRule('foo');

tests/ValidationRuleMessageTest.php

@@ -2,13 +2,16 @@
 
 use DaniloPolani\JsonValidation\Contracts\HasRuleMessage;
 use DaniloPolani\JsonValidation\JsonValidation;
+use DaniloPolani\JsonValidation\Tests\TestEnumRole;
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\App;
 use Illuminate\Translation\ArrayLoader;
 use Illuminate\Translation\Translator;
+use Illuminate\Validation\Rules\Enum;
+
+$rules = require './vendor/laravel/framework/src/Illuminate/Translation/lang/en/validation.php';
 
-$rules = require './tests/validation.php';
 $rulesToLoad = Collection::make($rules)->mapWithKeys(fn (mixed $value, string $key) => [
     'validation.' . $key => $value,
 ])->toArray();
@@ -35,7 +38,8 @@
 });
 
 it('extracts the error message from a custom rule', function () {
-    $rule = new class () implements ValidationRule, HasRuleMessage {
+    $rule = new class() implements ValidationRule, HasRuleMessage
+    {
         public function validate(string $attribute, mixed $value, \Closure $fail): void
         {
             return;
@@ -244,3 +248,19 @@ public function message(): string
     'numeric',
     'string',
 ]);
+
+it('handles "Enum" rule', function () use ($rules, $rulesToLoad) {
+    $trans = new Translator(new ArrayLoader(), 'en');
+    $trans->addLines($rulesToLoad, 'en');
+
+    /** @var \DaniloPolani\JsonValidation\Tests\TestCase $this */
+    App::getFacadeApplication()->instance('translator', $trans);
+
+    $expected = str_replace(
+        ':attribute',
+        'role',
+        $rules['enum'],
+    );
+
+    expect(JsonValidation::getRuleErrorMessage('role', new Enum(TestEnumRole::class)))->toBe([$expected]);
+});