[5.x] Update our custom string based rules to class based rules

resources/js/components/field-validation/Rules.js

@@ -313,7 +313,15 @@ export default [
  // },
  {
  label: 'Unique Entry Value',
- value: 'unique_entry_value:{collection},{id},{site}',
+ value: 'new \\Statamic\\Rules\\UniqueEntryValue({collection}, {id}, {site})',
+ },
+ {
+ label: 'Unique Term Value',
+ value: 'new \\Statamic\\Rules\\UniqueTermValue({taxonomy}, {id}, {site})',
+ },
+ {
+ label: 'Unique User Value',
+ value: 'new \\Statamic\\Rules\\UniqueUserValue({id})',
  },
  {
  label: 'URL',

src/Actions/DuplicateForm.php

@@ -5,6 +5,7 @@
 use Statamic\Contracts\Forms\Form;
 use Statamic\Facades\Form as Forms;
 use Statamic\Rules\Handle;
+use Statamic\Rules\UniqueFormHandle;
 use Statamic\Statamic;
 
 class DuplicateForm extends Action
@@ -31,7 +32,7 @@ protected function fieldItems()
  'type' => 'slug',
  'instructions' => __('statamic::messages.form_configure_handle_instructions'),
  'separator' => '_',
- 'validate' => ['required', new Handle, 'unique_form_handle'],
+ 'validate' => ['required', new Handle, new UniqueFormHandle],
  ],
  ];
  }

src/Fields/ClassRuleParser.php

@@ -34,6 +34,12 @@ public function parse(string $rule): array
  return [$key => (string) Str::of($arg)->trim('"')->replace('\\"', '"')];
  } elseif (Str::startsWith($arg, "'") && Str::endsWith($arg, "'")) {
  return [$key => (string) Str::of($arg)->trim("'")->replace("\\'", "'")];
+ } elseif ($arg === 'null') {
+ return [$key => null];
+ } elseif ($arg === 'true') {
+ return [$key => true];
+ } elseif ($arg === 'false') {
+ return [$key => false];
  }
 
  return [$key => $arg];

src/Fields/Validator.php

@@ -125,19 +125,43 @@ public function attributes()
  private function parse($rule)
  {
  if (is_string($rule) && Str::startsWith($rule, 'new ')) {
- [$class, $arguments] = (new ClassRuleParser)->parse($rule);
-
- return new $class(...$arguments);
+ return $this->parseClassBasedRule($rule);
  }
 
- if (! is_string($rule) ||
- ! Str::contains($rule, '{') ||
- Str::startsWith($rule, 'regex:') ||
- Str::startsWith($rule, 'not_regex:')
- ) {
- return $rule;
+ if (is_string($rule) && Str::contains($rule, '{') && ! Str::startsWith($rule, ['regex:', 'not_regex:'])) {
+ return $this->parseStringBasedRule($rule);
  }
 
+ return $rule;
+ }
+
+ private function parseClassBasedRule($rule)
+ {
+ $rule = preg_replace_callback('/{\s*([a-zA-Z0-9_\-]+)\s*}/', function ($match) {
+ $value = Arr::get($this->replacements, $match[1]);
+
+ if ($value === null) {
+ return 'null';
+ }
+
+ if ($value === true) {
+ return 'true';
+ }
+
+ if ($value === false) {
+ return 'false';
+ }
+
+ return is_string($value) ? "'{$value}'" : $value;
+ }, $rule);
+
+ [$class, $arguments] = (new ClassRuleParser)->parse($rule);
+
+ return new $class(...$arguments);
+ }
+
+ private function parseStringBasedRule($rule)
+ {
  $rule = str_replace('{this}.', $this->context['prefix'] ?? '', $rule);
 
  return preg_replace_callback('/{\s*([a-zA-Z0-9_\-]+)\s*}/', function ($match) {

src/Fieldtypes/Code.php

@@ -6,6 +6,7 @@
 use Statamic\Fields\ArrayableString;
 use Statamic\Fields\Fieldtype;
 use Statamic\GraphQL\Types\CodeType;
+use Statamic\Rules\CodeFieldtypeRulers;
 
 class Code extends Fieldtype
 {
@@ -110,7 +111,7 @@ protected function configFieldItems(): array
  'key_header' => __('Columns'),
  'value_header' => __('Line Style (dashed or solid)'),
  'add_button' => __('Add Ruler'),
- 'validate' => 'code_fieldtype_rulers',
+ 'validate' => [new CodeFieldtypeRulers],
  ],
  ],
  ],

src/Fieldtypes/Date.php

@@ -4,16 +4,16 @@
 
 use Carbon\Exceptions\InvalidFormatException;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Validator;
 use InvalidArgumentException;
-use Statamic\Exceptions\ValidationException;
 use Statamic\Facades\GraphQL;
 use Statamic\Fields\Fieldtype;
 use Statamic\GraphQL\Fields\DateField;
 use Statamic\GraphQL\Types\DateRangeType;
 use Statamic\Query\Scopes\Filters\Fields\Date as DateFilter;
+use Statamic\Rules\DateFieldtype as ValidationRule;
 use Statamic\Statamic;
 use Statamic\Support\DateFormat;
-use Statamic\Validation\DateFieldtype as ValidationRule;
 
 class Date extends Fieldtype
 {
@@ -366,11 +366,10 @@ public function secondsEnabled()
 
  public function preProcessValidatable($value)
  {
- if ($error = (new ValidationRule($this))($value)) {
- throw ValidationException::withMessages([
- $this->field->handle() => $error,
- ]);
- }
+ Validator::make(
+ [$this->field->handle() => $value],
+ [$this->field->handle() => [new ValidationRule($this)]],
+ )->validate();
 
  if ($value === null) {
  return null;

src/Fieldtypes/Time.php

@@ -3,7 +3,7 @@
 namespace Statamic\Fieldtypes;
 
 use Statamic\Fields\Fieldtype;
-use Statamic\Validation\TimeFieldtype as ValidationRule;
+use Statamic\Rules\TimeFieldtype as ValidationRule;
 
 class Time extends Fieldtype
 {

src/Http/Controllers/CP/Assets/AssetsController.php

@@ -11,7 +11,7 @@
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
 use Statamic\Http\Resources\CP\Assets\Asset as AssetResource;
-use Statamic\Validation\AllowedFile;
+use Statamic\Rules\AllowedFile;
 
 class AssetsController extends CpController
 {

src/Http/Controllers/CP/Fieldtypes/FilesFieldtypeController.php

@@ -5,7 +5,7 @@
 use Illuminate\Http\Request;
 use Statamic\Assets\FileUploader as Uploader;
 use Statamic\Http\Controllers\CP\CpController;
-use Statamic\Validation\AllowedFile;
+use Statamic\Rules\AllowedFile;
 
 class FilesFieldtypeController extends CpController
 {

src/Http/Controllers/CP/Taxonomies/TermsController.php

@@ -15,6 +15,7 @@
 use Statamic\Http\Resources\CP\Taxonomies\Terms;
 use Statamic\Query\Scopes\Filters\Concerns\QueriesFilters;
 use Statamic\Rules\Slug;
+use Statamic\Rules\UniqueTermValue;
 
 class TermsController extends CpController
 {
@@ -170,7 +171,7 @@ public function update(Request $request, $taxonomy, $term, $site)
  'slug' => [
  'required',
  new Slug,
- 'unique_term_value:'.$taxonomy->handle().','.$term->id().','.$site->handle(),
+ new UniqueTermValue(taxonomy: $taxonomy->handle(), except: $term->id(), site: $site->handle()),
  ],
  ]);
 
@@ -270,7 +271,7 @@ public function store(Request $request, $taxonomy, $site)
 
  $fields->validate([
  'title' => 'required',
- 'slug' => 'required|unique_term_value:'.$taxonomy->handle().',null,'.$site->handle(),
+ 'slug' => ['required', new UniqueTermValue(taxonomy: $taxonomy->handle(), site: $site->handle())],
  ]);
 
  $values = $fields->process()->values()->except(['slug', 'blueprint']);

src/Http/Controllers/CP/Users/UsersController.php

@@ -16,6 +16,7 @@
 use Statamic\Http\Resources\CP\Users\Users;
 use Statamic\Notifications\ActivateAccount;
 use Statamic\Query\Scopes\Filters\Concerns\QueriesFilters;
+use Statamic\Rules\UniqueUserValue;
 use Statamic\Search\Result;
 use Symfony\Component\Mailer\Exception\TransportException;
 
@@ -165,7 +166,7 @@ public function store(Request $request)
 
  $fields = $blueprint->fields()->except(['roles', 'groups'])->addValues($request->all());
 
- $fields->validate(['email' => 'required|email|unique_user_value']);
+ $fields->validate(['email' => ['required', 'email', new UniqueUserValue]]);
 
  if ($request->input('_validate_only')) {
  return [];
@@ -277,7 +278,7 @@ public function update(Request $request, $user)
 
  $fields
  ->validator()
- ->withRules(['email' => 'required|unique_user_value:{id}'])
+ ->withRules(['email' => ['required', 'email', new UniqueUserValue(except: $user->id())]])
  ->withReplacements(['id' => $user->id()])
  ->validate();
 

src/Http/Controllers/UserController.php

@@ -14,6 +14,7 @@
 use Statamic\Exceptions\SilentFormFailureException;
 use Statamic\Exceptions\UnauthorizedHttpException;
 use Statamic\Facades\User;
+use Statamic\Rules\UniqueUserValue;
 
 class UserController extends Controller
 {
@@ -63,7 +64,7 @@ public function register(Request $request)
  $fields = $fields->addValues($values);
 
  $fieldRules = $fields->validator()->withRules([
- 'email' => ['required', 'email', 'unique_user_value'],
+ 'email' => ['required', 'email', new UniqueUserValue],
  'password' => ['required', 'confirmed', Password::default()],
  ])->rules();
 
@@ -124,11 +125,9 @@ public function profile(Request $request)
  try {
  $fields
  ->validator()
- ->withRules([
- 'email' => ['required', 'email', 'unique_user_value:{id}'],
- ])->withReplacements([
- 'id' => $user->id(),
- ])->validate();
+ ->withRules(['email' => ['required', 'email', new UniqueUserValue(except: $user->id())]])
+ ->withReplacements(['id' => $user->id()])
+ ->validate();
  } catch (ValidationException $e) {
  return $this->userProfileFailure($e->validator->errors());
  }

src/Http/Requests/FrontendFormRequest.php

@@ -8,8 +8,8 @@
 use Illuminate\Support\Traits\Localizable;
 use Illuminate\Validation\ValidationException;
 use Statamic\Facades\Site;
+use Statamic\Rules\AllowedFile;
 use Statamic\Support\Arr;
-use Statamic\Validation\AllowedFile;
 
 class FrontendFormRequest extends FormRequest
 {

src/Providers/ExtensionServiceProvider.php

@@ -230,6 +230,7 @@ class ExtensionServiceProvider extends ServiceProvider
  Updates\AddDefaultPreferencesToGitConfig::class,
  Updates\AddConfigureFormFieldsPermission::class,
  Updates\AddSitePermissions::class,
+ Updates\UseClassBasedStatamicUniqueRules::class,
  ];
 
  public function register()

src/Providers/StatamicServiceProvider.php

@@ -29,7 +29,6 @@ class StatamicServiceProvider extends AggregateServiceProvider
  \Statamic\StaticCaching\ServiceProvider::class,
  \Statamic\Revisions\ServiceProvider::class,
  CpServiceProvider::class,
- ValidationServiceProvider::class,
  RouteServiceProvider::class,
  BroadcastServiceProvider::class,
  \Statamic\API\ServiceProvider::class,

src/Validation/AllowedFile.php → src/Rules/AllowedFile.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Statamic\Validation;
+namespace Statamic\Rules;
 
-use Illuminate\Contracts\Validation\InvokableRule;
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Http\UploadedFile;
 
-class AllowedFile implements InvokableRule
+class AllowedFile implements ValidationRule
 {
- private array $extensions = [
+ private const EXTENSIONS = [
  '7z',
  'aiff',
  'asc',
@@ -108,16 +109,16 @@ class AllowedFile implements InvokableRule
  'zip',
  ];
 
- public function __invoke($attribute, $value, $fail): void
+ public function validate(string $attribute, mixed $value, Closure $fail): void
  {
- if (! $this->isAllowed($value)) {
- $fail(__('validation.uploaded'));
+ if (! $this->isAllowedExtension($value)) {
+ $fail('statamic::validation.uploaded')->translate();
  }
  }
 
- private function isAllowed(UploadedFile $file): bool
+ private function isAllowedExtension(UploadedFile $file): bool
  {
- $extensions = array_merge($this->extensions, config('statamic.assets.additional_uploadable_extensions', []));
+ $extensions = array_merge(static::EXTENSIONS, config('statamic.assets.additional_uploadable_extensions', []));
 
  return in_array(trim(strtolower($file->getClientOriginalExtension())), $extensions);
  }

src/Rules/CodeFieldtypeRulers.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Statamic\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class CodeFieldtypeRulers implements ValidationRule
+{
+ public function validate(string $attribute, mixed $value, Closure $fail): void
+ {
+ foreach ($value as $key => $val) {
+ if (! is_int($key) || ! in_array($val, ['dashed', 'solid'])) {
+ $fail('statamic::validation.code_fieldtype_rulers')->translate();
+ }
+ }
+ }
+}