Add the ability to optionally merge automatically inferred rules with manual rules

docs/validation/introduction.md

@@ -132,6 +132,28 @@ class SongData extends Data
 }
 ```
 
+The above example will override the automatically inferred rules. If you want the manual rules to be merged with the automatically inferred rules, you can use the `MergeRules` attribute:
+
+```php
+#[MergeRules]
+class SongData extends Data
+{
+ public function __construct(
+ public string $title,
+ public string $artist,
+ ) {
+ }
+
+ public static function rules(): array
+ {
+ return [
+ 'title' => ['max:255'],
+ 'artist' => ['max:255'],
+ ];
+ }
+}
+```
+
 You can read more about manual rules in its [dedicated chapter](/docs/laravel-data/v4/validation/manual-rules).
 
 ### Using the container

src/Attributes/MergeRules.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Spatie\LaravelData\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+class MergeRules
+{
+ //
+}

src/Resolvers/DataValidationRulesResolver.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Illuminate\Validation\Rule;
+use Spatie\LaravelData\Attributes\MergeRules;
 use Spatie\LaravelData\Attributes\Validation\ArrayType;
 use Spatie\LaravelData\Attributes\Validation\Present;
 use Spatie\LaravelData\Support\DataClass;
@@ -67,7 +68,7 @@ public function execute(
  $dataRules->add($propertyPath, $rules);
  }
 
- $this->resolveOverwrittenRules(
+ $this->resolveRules(
  $dataClass,
  $fullPayload,
  $path,
@@ -223,7 +224,7 @@ protected function resolveToplevelRules(
  }
 
 
- protected function resolveOverwrittenRules(
+ protected function resolveRules(
  DataClass $class,
  array $fullPayload,
  ValidationPath $path,
@@ -240,9 +241,19 @@ protected function resolveOverwrittenRules(
  $path
  );
 
- $overwrittenRules = app()->call([$class->name, 'rules'], ['context' => $validationContext]);
+ $manualRules = app()->call([$class->name, 'rules'], ['context' => $validationContext]);
 
- foreach ($overwrittenRules as $key => $rules) {
+ if ($this->shouldMergeRules($class)) {
+ $manualRules = collect($manualRules)->map(
+ fn (string|array $rules) => is_array($rules) ? $rules : explode('|', $rules)
+ )->all();
+
+ $dataRules->rules = array_merge_recursive($dataRules->rules, $manualRules);
+
+ return;
+ }
+
+ foreach ($manualRules as $key => $rules) {
  if (in_array($key, $withoutValidationProperties)) {
  continue;
  }
@@ -278,4 +289,9 @@ protected function inferRulesForDataProperty(
  $path
  );
  }
+
+ protected function shouldMergeRules(DataClass $class): bool
+ {
+ return $class->attributes->contains(fn (object $attribute) => $attribute::class === MergeRules::class);
+ }
 }

tests/Attributes/Validation/MergeRulesetTest.php

@@ -0,0 +1,50 @@
+<?php
+
+use Illuminate\Validation\ValidationException;
+use Spatie\LaravelData\Data;
+use Spatie\LaravelData\Tests\Fakes\DataWithMergedRuleset;
+use Spatie\LaravelData\Tests\Fakes\DataWithMergedStringRuleset;
+
+it('it will merge validation rules', function () {
+ try {
+ DataWithMergedRuleset::validate(['first_name' => str_repeat('a', 1)]);
+ } catch (ValidationException $exception) {
+ expect($exception->errors())->toMatchArray([
+ 'first_name' => ['The first name field must be at least 2 characters.']
+ ]);
+ }
+
+ try {
+ DataWithMergedRuleset::validate(['first_name' => str_repeat('a', 11)]);
+ } catch (ValidationException $exception) {
+ expect($exception->errors())->toMatchArray([
+ 'first_name' => ['The first name field must not be greater than 10 characters.']
+ ]);
+ }
+});
+
+it('it will merge validation rules using string rules', function () {
+ try {
+ Data::validate(['first_name' => str_repeat('a', 1)]);
+ } catch (ValidationException $exception) {
+ expect($exception->errors())->toMatchArray([
+ 'first_name' => ['The first name field must be at least 2 characters.']
+ ]);
+ }
+
+ try {
+ DataWithMergedStringRuleset::validate(['first_name' => str_repeat('a', 11)]);
+ } catch (ValidationException $exception) {
+ expect($exception->errors())->toMatchArray([
+ 'first_name' => ['The first name field must not be greater than 10 characters.']
+ ]);
+ }
+
+ try {
+ DataWithMergedStringRuleset::validate(['first_name' => 'a123']);
+ } catch (ValidationException $exception) {
+ expect($exception->errors())->toMatchArray([
+ 'first_name' => ['The first name field must only contain letters.']
+ ]);
+ }
+});

tests/Fakes/DataWithMergedRuleset.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Spatie\LaravelData\Tests\Fakes;
+
+use Spatie\LaravelData\Attributes\MergeRules;
+use Spatie\LaravelData\Attributes\Validation\Max;
+use Spatie\LaravelData\Data;
+
+#[MergeRules]
+class DataWithMergedRuleset extends Data
+{
+ public function __construct(
+ #[Max(10)]
+ public string $first_name,
+ ) {
+ }
+
+ public static function rules(): array
+ {
+ return [
+ 'first_name' => ['min:2']
+ ];
+ }
+}

tests/Fakes/DataWithMergedStringRuleset.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Spatie\LaravelData\Tests\Fakes;
+
+use Spatie\LaravelData\Attributes\MergeRules;
+use Spatie\LaravelData\Attributes\Validation\Max;
+use Spatie\LaravelData\Data;
+
+#[MergeRules]
+class DataWithMergedStringRuleset extends Data
+{
+ public function __construct(
+ #[Max(10)]
+ public string $first_name,
+ ) {
+ }
+
+ public static function rules(): array
+ {
+ return [
+ 'first_name' => 'min:2|alpha'
+ ];
+ }
+}