[6.x] Refactor validation to use laravel-ruleset-validation

composer.json

@@ -39,6 +39,7 @@
     "composer/semver": "^3.3.2",
     "craftcms/laravel-aliases": "^2.0",
     "craftcms/laravel-dependency-aware-cache": "^1.1",
+    "craftcms/laravel-ruleset-validation": "^1.0.1",
     "craftcms/plugin-installer": "~1.6.0",
     "craftcms/server-check": "~5.1.0",
     "craftcms/yii2-adapter": "self.version",

database/Factories/Concerns/HasFieldFactory.php

@@ -108,7 +108,7 @@ public function createElementWithFields(array $attributes = [], bool $save = tru
         $factory->refreshFieldCaches();
 
         $element = $factory->queryElement($model->id);
-        $element->setScenario($factory->elementScenario ?? Element::SCENARIO_DEFAULT);
+        $element->ruleset->useScenario($factory->elementScenario ?? Element::SCENARIO_DEFAULT);
         $element->title = $element->title ?: 'Test entry';
 
         foreach ($factory->fieldConfigs as $config) {

src/Address/Elements/Address.php

@@ -24,14 +24,17 @@
 use CraftCms\Cms\Shared\Concerns\HasNames;
 use CraftCms\Cms\Twig\Attributes\AllowedInSandbox;
 use CraftCms\Cms\User\Elements\User;
-use CraftCms\Cms\Validation\Attributes\Ruleset;
+use CraftCms\RulesetValidation\Attributes\Ruleset;
 use Deprecated;
 use Override;
 use yii\base\InvalidConfigException;
 use yii\helpers\Html;
 
 use function CraftCms\Cms\t;
 
+/**
+ * @property AddressRules $ruleset
+ */
 #[Ruleset(AddressRules::class)]
 class Address extends Element implements AddressInterface, NestedElementInterface
 {
@@ -471,7 +474,7 @@ public function shouldValidateTitle(): bool
     }
 
     #[Override]
-    public function beforeValidate(): bool
+    public function prepareForValidation(): void
     {
         $usedFields = array_unique([
             ...app(Addresses::class)->getUsedFields($this->countryCode),
@@ -490,7 +493,7 @@ public function beforeValidate(): bool
             $this->$field = null;
         }
 
-        return parent::beforeValidate();
+        parent::prepareForValidation();
     }
 
     #[Override]

src/Address/Validation/AddressRules.php

@@ -7,7 +7,6 @@
 use CraftCms\Cms\Address\Addresses;
 use CraftCms\Cms\Address\Elements\Address;
 use CraftCms\Cms\Cms;
-use CraftCms\Cms\Element\Element;
 use CraftCms\Cms\Element\Validation\ElementRules;
 use CraftCms\Cms\FieldLayout\LayoutElements\addresses\LatLongField;
 use CraftCms\Cms\FieldLayout\LayoutElements\addresses\OrganizationField;
@@ -22,7 +21,7 @@
 /**
  * @extends ElementRules<Address>
  *
- * @property Address $component
+ * @property Address $subject
  */
 class AddressRules extends ElementRules
 {
@@ -56,27 +55,27 @@ class AddressRules extends ElementRules
     ];
 
     #[Override]
-    public function prepareForValidation(?array $attributeNames = null): void
+    public function prepareForValidation(): void
     {
-        parent::prepareForValidation($attributeNames);
+        parent::prepareForValidation();
 
-        $attributesToTrim = is_null($attributeNames)
+        $attributesToTrim = is_null($this->validationAttributes)
             ? self::TRIMMABLE_ATTRIBUTES
-            : array_intersect(self::TRIMMABLE_ATTRIBUTES, $attributeNames);
+            : array_intersect(self::TRIMMABLE_ATTRIBUTES, $this->validationAttributes);
 
         foreach ($attributesToTrim as $attribute) {
-            $value = $this->component->{$attribute};
+            $value = $this->subject->{$attribute};
 
             if (is_string($value)) {
-                $this->component->{$attribute} = trim($value);
+                $this->subject->{$attribute} = trim($value);
             }
         }
     }
 
     #[Override]
-    protected function defineRules(): array
+    public function rules(): array
     {
-        $rules = parent::defineRules();
+        $rules = parent::rules();
 
         $rules = $this->addAddressAttributeRules($rules);
         $rules = $this->addCountryCodeValidation($rules);
@@ -135,32 +134,32 @@ private function addAddressFormatRequirements(array $rules): array
 
     private function isRequiredByAddressFormat(string $attribute): bool
     {
-        if (! $this->component->inScenarios(Element::SCENARIO_LIVE)) {
+        if (! $this->inScenarios(self::SCENARIO_LIVE)) {
             return false;
         }
 
         $formatter = app(Addresses::class)
             ->getAddressFormatRepository()
-            ->get($this->component->countryCode);
+            ->get($this->subject->countryCode);
 
         return in_array($attribute, $formatter->getRequiredFields());
     }
 
     private function addFieldLayoutRequirements(array $rules): array
     {
-        $fieldLayout = $this->component->getFieldLayout();
+        $fieldLayout = $this->subject->getFieldLayout();
 
         foreach (self::REQUIRABLE_NATIVE_FIELDS as $fieldClass) {
             /** @var BaseNativeField|null $field */
-            $field = $fieldLayout->getFirstVisibleElementByType($fieldClass, $this->component);
+            $field = $fieldLayout->getFirstVisibleElementByType($fieldClass, $this->subject);
 
             if (! $field?->required) {
                 continue;
             }
 
             foreach ($this->resolveFieldAttributes($field) as $attribute) {
                 $rules[$attribute] ??= [];
-                $rules[$attribute][] = Rule::requiredIf($this->component->inScenarios(Element::SCENARIO_LIVE));
+                $rules[$attribute][] = Rule::requiredIf($this->inScenarios(self::SCENARIO_LIVE));
             }
         }
 
@@ -185,7 +184,7 @@ private function resolveFieldAttributes(BaseNativeField $field): array
 
     private function addCoordinateValidation(array $rules): array
     {
-        $coordinateScenarios = $this->component->inScenarios(Element::SCENARIO_LIVE, Element::SCENARIO_DEFAULT);
+        $coordinateScenarios = $this->inScenarios(self::SCENARIO_LIVE, self::SCENARIO_DEFAULT);
 
         $rules['latitude'][] = Rule::when($coordinateScenarios, [
             'numeric',

src/Asset/AssetIndexer.php

@@ -16,6 +16,7 @@
 use CraftCms\Cms\Asset\Exceptions\MissingVolumeFolderException;
 use CraftCms\Cms\Asset\Exceptions\VolumeException;
 use CraftCms\Cms\Asset\Models\AssetIndexingSession as AssetIndexingSessionModel;
+use CraftCms\Cms\Asset\Validation\AssetRules;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Database\Table;
 use CraftCms\Cms\Element\Elements;
@@ -630,7 +631,7 @@ public function indexFileByEntry(
         $asset->size = $indexEntry->size;
         $timeModified = $indexEntry->timestamp;
 
-        $asset->setScenario(Asset::SCENARIO_INDEX);
+        $asset->ruleset->useScenario(AssetRules::SCENARIO_INDEX);
 
         try {
             if ($isLocalFs) {

src/Asset/Assets.php

@@ -18,6 +18,7 @@
 use CraftCms\Cms\Asset\PreviewHandlers\Pdf;
 use CraftCms\Cms\Asset\PreviewHandlers\Text;
 use CraftCms\Cms\Asset\PreviewHandlers\Video;
+use CraftCms\Cms\Asset\Validation\AssetRules;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Database\Table;
 use CraftCms\Cms\Element\Elements;
@@ -94,7 +95,7 @@ public function replaceAssetFile(Asset $asset, string $pathOnServer, string $fil
         $asset->setMimeType(File::getMimeType($pathOnServer, checkExtension: false) ?? $mimeType);
         $asset->uploaderId = Auth::user()?->id;
         $asset->avoidFilenameConflicts = true;
-        $asset->setScenario(Asset::SCENARIO_REPLACE);
+        $asset->ruleset->useScenario(AssetRules::SCENARIO_REPLACE);
         $this->elements->saveElement($asset);
 
         event(new AfterReplaceAsset(
@@ -118,9 +119,9 @@ public function moveAsset(Asset $asset, VolumeFolder $folder, string $filename =
 
         if ($filenameChanging) {
             $asset->newFilename = $filename;
-            $asset->setScenario(Asset::SCENARIO_FILEOPS);
+            $asset->ruleset->useScenario(AssetRules::SCENARIO_FILEOPS);
         } else {
-            $asset->setScenario(Asset::SCENARIO_MOVE);
+            $asset->ruleset->useScenario(AssetRules::SCENARIO_MOVE);
         }
 
         return $this->elements->saveElement($asset);

src/Asset/Data/Volume.php

@@ -19,7 +19,7 @@
 use CraftCms\Cms\Support\Env;
 use CraftCms\Cms\Support\Facades\Filesystems;
 use CraftCms\Cms\Support\Url;
-use CraftCms\Cms\Validation\Attributes\Ruleset;
+use CraftCms\RulesetValidation\Attributes\Ruleset;
 use Illuminate\Filesystem\FilesystemAdapter;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Log;
@@ -123,19 +123,7 @@ public function __construct(array|object $config = [])
     }
 
     #[Override]
-    public function attributes(): array
-    {
-        return array_values(array_unique(array_merge(parent::attributes(), [
-            'fieldLayout',
-            'fsHandle',
-            'subpath',
-            'transformFsHandle',
-            'transformSubpath',
-        ])));
-    }
-
-    #[Override]
-    public function getAttributes(): array
+    public function validationData(): array
     {
         if (is_string($this->name)) {
             $this->name = trim($this->name);
@@ -151,7 +139,7 @@ public function getAttributes(): array
             $fieldLayout = null;
         }
 
-        return array_merge(parent::getAttributes(), [
+        return array_merge(parent::validationData(), [
             'fieldLayout' => $fieldLayout,
             'fsHandle' => $this->getFsHandle(false),
             'subpath' => $this->getSubpath(ensureTrailing: false, parse: false),

src/Asset/Data/VolumeFolder.php

@@ -68,20 +68,7 @@ public function getRules(): array
     }
 
     #[Override]
-    public function attributes(): array
-    {
-        return [
-            'id',
-            'parentId',
-            'volumeId',
-            'name',
-            'path',
-            'uid',
-        ];
-    }
-
-    #[Override]
-    public function getAttributes(): array
+    public function validationData(): array
     {
         return [
             'id' => $this->id,