[5.x] Asset validation rules as string in GraphQL, part 2 (#11790)

Author: jasonvarga

src/Contracts/GraphQL/CastableToValidationString.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Statamic\Contracts\GraphQL;
+
+interface CastableToValidationString
+{
+    public function toGqlValidationString(): string;
+}

src/Fieldtypes/Assets/DimensionsRule.php

@@ -3,11 +3,12 @@
 namespace Statamic\Fieldtypes\Assets;
 
 use Illuminate\Contracts\Validation\Rule;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\Asset;
 use Statamic\Statamic;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-class DimensionsRule implements Rule
+class DimensionsRule implements CastableToValidationString, Rule
 {
     protected $parameters;
 
@@ -125,7 +126,7 @@ protected function failsRatioCheck($parameters, $width, $height)
         return abs($numerator / $denominator - $width / $height) > $precision;
     }
 
-    public function __toString()
+    public function toGqlValidationString(): string
     {
         return 'dimensions:'.implode(',', $this->parameters);
     }

src/Fieldtypes/Assets/ImageRule.php

@@ -3,11 +3,12 @@
 namespace Statamic\Fieldtypes\Assets;
 
 use Illuminate\Contracts\Validation\Rule;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\Asset;
 use Statamic\Statamic;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-class ImageRule implements Rule
+class ImageRule implements CastableToValidationString, Rule
 {
     protected $parameters;
 
@@ -50,7 +51,7 @@ public function message()
         return __((Statamic::isCpRoute() ? 'statamic::' : '').'validation.image');
     }
 
-    public function __toString()
+    public function toGqlValidationString(): string
     {
         return 'image:'.implode(',', $this->parameters);
     }

src/Fieldtypes/Assets/MimesRule.php

@@ -3,11 +3,12 @@
 namespace Statamic\Fieldtypes\Assets;
 
 use Illuminate\Contracts\Validation\Rule;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\Asset;
 use Statamic\Statamic;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-class MimesRule implements Rule
+class MimesRule implements CastableToValidationString, Rule
 {
     protected $parameters;
 
@@ -52,7 +53,7 @@ public function message()
         return str_replace(':values', implode(', ', $this->parameters), __((Statamic::isCpRoute() ? 'statamic::' : '').'validation.mimes'));
     }
 
-    public function __toString()
+    public function toGqlValidationString(): string
     {
         return 'mimes:'.implode(',', $this->parameters);
     }

src/Fieldtypes/Assets/MimetypesRule.php

@@ -3,11 +3,12 @@
 namespace Statamic\Fieldtypes\Assets;
 
 use Illuminate\Contracts\Validation\Rule;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\Asset;
 use Statamic\Statamic;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-class MimetypesRule implements Rule
+class MimetypesRule implements CastableToValidationString, Rule
 {
     protected $parameters;
 
@@ -47,7 +48,7 @@ public function message()
         return str_replace(':values', implode(', ', $this->parameters), __((Statamic::isCpRoute() ? 'statamic::' : '').'validation.mimetypes'));
     }
 
-    public function __toString()
+    public function toGqlValidationString(): string
     {
         return 'mimetypes:'.implode(',', $this->parameters);
     }

src/Fieldtypes/Assets/SizeBasedRule.php

@@ -3,10 +3,11 @@
 namespace Statamic\Fieldtypes\Assets;
 
 use Illuminate\Contracts\Validation\Rule;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\Asset;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-abstract class SizeBasedRule implements Rule
+abstract class SizeBasedRule implements CastableToValidationString, Rule
 {
     protected $parameters;
 
@@ -67,7 +68,7 @@ protected function getFileSize($id)
         return false;
     }
 
-    public function __toString()
+    public function toGqlValidationString(): string
     {
         return 'size:'.implode(',', $this->parameters);
     }

src/GraphQL/Types/FormType.php

@@ -3,6 +3,7 @@
 namespace Statamic\GraphQL\Types;
 
 use Statamic\Contracts\Forms\Form;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\GraphQL;
 use Statamic\Fields\Value;
 
@@ -42,11 +43,11 @@ public function fields(): array
                                     return $rule;
                                 }
 
-                                if ($rule instanceof \Stringable) {
-                                    return (string) $rule;
+                                if ($rule instanceof CastableToValidationString) {
+                                    return $rule->toGqlValidationString();
                                 }
 
-                                return $rule;
+                                return get_class($rule).'::class';
                             });
                         })
                         ->all();

tests/Feature/GraphQL/FormTest.php

@@ -6,6 +6,7 @@
 use Facades\Statamic\Fields\BlueprintRepository;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\Test;
+use Statamic\Contracts\GraphQL\CastableToValidationString;
 use Statamic\Facades\Blueprint;
 use Statamic\Facades\Form;
 use Tests\PreventSavingStacheItemsToDisk;
@@ -333,6 +334,8 @@ public function it_returns_string_based_validation_rules_for_mimes_mimetypes_dim
                     'dimensions:1024',
                     'size:1000',
                     'image:jpeg',
+                    'new Tests\Feature\GraphQL\TestValidationRuleWithToString',
+                    'new Tests\Feature\GraphQL\TestValidationRuleWithoutToString',
                 ],
             ],
         ]);
@@ -359,6 +362,8 @@ public function it_returns_string_based_validation_rules_for_mimes_mimetypes_dim
                             'dimensions:1024',
                             'size:1000',
                             'image:jpeg',
+                            'thevalidationrule:foo,bar',
+                            'Tests\\Feature\\GraphQL\\TestValidationRuleWithoutToString::class',
                             'array',
                             'nullable',
                         ],
@@ -367,3 +372,15 @@ public function it_returns_string_based_validation_rules_for_mimes_mimetypes_dim
             ]]);
     }
 }
+
+class TestValidationRuleWithToString implements CastableToValidationString
+{
+    public function toGqlValidationString(): string
+    {
+        return 'thevalidationrule:foo,bar';
+    }
+}
+
+class TestValidationRuleWithoutToString
+{
+}