Add validation rules to ensure attributes are morphable

Author: bentleyo

src/Attributes/PropertyForMorph.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\LaravelData\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+class PropertyForMorph
+{
+}

src/Resolvers/DataValidationRulesResolver.php

@@ -14,6 +14,7 @@
 use Spatie\LaravelData\Support\DataProperty;
 use Spatie\LaravelData\Support\Validation\DataRules;
 use Spatie\LaravelData\Support\Validation\PropertyRules;
+use Spatie\LaravelData\Support\Validation\RequiresPropertyMorphableClassRule;
 use Spatie\LaravelData\Support\Validation\RuleDenormalizer;
 use Spatie\LaravelData\Support\Validation\RuleNormalizer;
 use Spatie\LaravelData\Support\Validation\ValidationContext;
@@ -77,6 +78,10 @@ public function execute(
                 $path,
             );
 
+            if ($dataProperty->isForMorph) {
+                $rules[] = new RequiresPropertyMorphableClassRule($dataClass);
+            }
+
             $dataRules->add($propertyPath, $rules);
         }
 

src/Support/DataProperty.php

@@ -29,6 +29,7 @@ public function __construct(
         public readonly ?string $inputMappedName,
         public readonly ?string $outputMappedName,
         public readonly Collection $attributes,
+        public readonly bool $isForMorph,
     ) {
     }
 }

src/Support/Factories/DataPropertyFactory.php

@@ -9,6 +9,7 @@
 use Spatie\LaravelData\Attributes\Computed;
 use Spatie\LaravelData\Attributes\GetsCast;
 use Spatie\LaravelData\Attributes\Hidden;
+use Spatie\LaravelData\Attributes\PropertyForMorph;
 use Spatie\LaravelData\Attributes\WithCastAndTransformer;
 use Spatie\LaravelData\Attributes\WithoutValidation;
 use Spatie\LaravelData\Attributes\WithTransformer;
@@ -108,6 +109,7 @@ className: $reflectionProperty->class,
             inputMappedName: $inputMappedName,
             outputMappedName: $outputMappedName,
             attributes: $attributes,
+            isForMorph: ! empty($reflectionProperty->getAttributes(PropertyForMorph::class)),
         );
     }
 }

src/Support/Validation/RequiresPropertyMorphableClassRule.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Spatie\LaravelData\Support\Validation;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+use Spatie\LaravelData\Attributes\Validation\ObjectValidationAttribute;
+use Spatie\LaravelData\Support\DataClass;
+
+class RequiresPropertyMorphableClassRule extends ObjectValidationAttribute implements ValidationRule
+{
+    public function __construct(protected DataClass $dataClass)
+    {
+    }
+
+    public function getRule(ValidationPath $path): object|string
+    {
+        return $this;
+    }
+
+    public static function keyword(): string
+    {
+        return 'requires_property_morphable_class';
+    }
+
+    public static function create(string ...$parameters): static
+    {
+        return new static(...$parameters);
+    }
+
+    public function validate(string $attribute, mixed $value, Closure $fail): void
+    {
+        if (! $this->dataClass->propertyMorphable || $this->dataClass->isAbstract) {
+            $fail('The selected :attribute is invalid for morph.');
+        }
+    }
+}

tests/ValidationTest.php

@@ -21,6 +21,7 @@
 use Spatie\LaravelData\Attributes\MapInputName;
 use Spatie\LaravelData\Attributes\MapName;
 use Spatie\LaravelData\Attributes\MergeValidationRules;
+use Spatie\LaravelData\Attributes\PropertyForMorph;
 use Spatie\LaravelData\Attributes\Validation\ArrayType;
 use Spatie\LaravelData\Attributes\Validation\Bail;
 use Spatie\LaravelData\Attributes\Validation\BooleanType;
@@ -2611,7 +2612,7 @@ public static function rules(): array
     abstract class TestValidationAbstractPropertyMorphableData extends Data implements PropertyMorphableData
     {
         public function __construct(
-            #[In('a', 'b')]
+            #[PropertyForMorph]
             public string $variant,
         ) {
         }
@@ -2650,7 +2651,7 @@ public function __construct(public string $b)
             ->assertErrors([
                 'variant' => 'c',
             ], [
-                'variant' => ['The selected variant is invalid.'],
+                'variant' => ['The selected variant is invalid for morph.'],
             ])
             ->assertErrors([
                 'variant' => 'a',
@@ -2700,7 +2701,7 @@ public function __construct(
             ->assertErrors([
                 'nestedCollection' => [['variant' => 'c']],
             ], [
-                'nestedCollection.0.variant' => ['The selected nested collection.0.variant is invalid.'],
+                'nestedCollection.0.variant' => ['The selected nested collection.0.variant is invalid for morph.'],
             ])
             ->assertErrors([
                 'nestedCollection' => [['variant' => 'a'], ['variant' => 'b']],