Adds validation rule

Author: nunomaduro

src/Illuminate/Database/Eloquent/Attributes/Sluggable.php

@@ -22,6 +22,8 @@ public function __construct(
         public bool $unique = true,
         public int $maxAttempts = 100,
         public ?int $maxLength = null,
+        public ?string $errorKey = null,
+        public ?string $errorMessage = null,
     ) {
     }
 }

src/Illuminate/Database/Eloquent/CouldNotGenerateSlugException.php

@@ -2,9 +2,29 @@
 
 namespace Illuminate\Database\Eloquent;
 
+use Illuminate\Validation\ValidationException;
 use RuntimeException;
 
 class CouldNotGenerateSlugException extends RuntimeException
 {
-    //
+    /**
+     * Create a new exception instance.
+     */
+    public function __construct(
+        string $message,
+        protected string $errorKey,
+        protected string $errorMessage,
+    ) {
+        parent::__construct($message);
+    }
+
+    /**
+     * Get the exception's context for the handler.
+     */
+    public function getInnerException(): ValidationException
+    {
+        return ValidationException::withMessages([
+            $this->errorKey => $this->errorMessage,
+        ]);
+    }
 }

src/Illuminate/Database/Eloquent/EmptySlugException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Illuminate\Database\Eloquent;
+
+use Illuminate\Contracts\Debug\ShouldntReport;
+
+class EmptySlugException extends CouldNotGenerateSlugException implements ShouldntReport
+{
+    //
+}

src/Illuminate/Database/Eloquent/SlugGenerator.php

@@ -56,16 +56,45 @@ public function generate(): string
         $slug = $this->slugify($this->resolveSourceValue());
 
         if ($slug === '') {
-            $columns = implode(', ', Arr::wrap($this->options()->from));
-
-            throw new CouldNotGenerateSlugException(
-                'Could not generate a slug for ['.get_class($this->model)."] using column(s) [{$columns}]."
-            );
+            $this->throwEmptySlugException();
         }
 
         return $this->ensureUnique($slug);
     }
 
+    /**
+     * Throw an exception when the slug source produces an empty slug.
+     *
+     * @throws EmptySlugException
+     */
+    protected function throwEmptySlugException(): void
+    {
+        $options = $this->options();
+        $from = Arr::wrap($options->from);
+        $errorKey = $options->errorKey ?? $from[0];
+        $columns = implode(', ', $from);
+
+        throw new EmptySlugException(
+            "Could not generate a slug for [".get_class($this->model)."] using column(s) [{$columns}].",
+            $errorKey,
+            $this->resolveErrorMessage($errorKey, $options),
+        );
+    }
+
+    /**
+     * Resolve the user-facing error message for a failed slug generation.
+     */
+    protected function resolveErrorMessage(string $errorKey, Sluggable $options): string
+    {
+        $from = Arr::wrap($options->from);
+        $attribute = count($from) === 1 ? $from[0] : implode(' and ', [implode(', ', array_slice($from, 0, -1)), end($from)]);
+        $replacements = ['attribute' => $attribute, 'column' => $options->column];
+
+        return $options->errorMessage
+            ? __($options->errorMessage, $replacements)
+            : __('validation.sluggable', $replacements);
+    }
+
     /**
      * Determine if the slug source columns have changed.
      */
@@ -153,8 +182,12 @@ protected function ensureUnique(string $slug): string
             $count++;
 
             if ($count > $options->maxAttempts) {
+                $errorKey = $options->errorKey ?? $options->column;
+
                 throw new CouldNotGenerateSlugException(
-                    'Could not generate a unique slug for ['.get_class($this->model)."] with base [{$originalSlug}] after {$options->maxAttempts} attempts."
+                    'Could not generate a unique slug for ['.get_class($this->model)."] with base [{$originalSlug}] after {$options->maxAttempts} attempts.",
+                    $errorKey,
+                    $this->resolveErrorMessage($errorKey, $options),
                 );
             }
 

src/Illuminate/Translation/lang/en/validation.php

@@ -157,6 +157,7 @@
         'numeric' => 'The :attribute field must be :size.',
         'string' => 'The :attribute field must be :size characters.',
     ],
+    'sluggable' => 'The :attribute must be able to generate a valid :column.',
     'starts_with' => 'The :attribute field must start with one of the following: :values.',
     'string' => 'The :attribute field must be a string.',
     'timezone' => 'The :attribute field must be a valid timezone.',

tests/Database/DatabaseEloquentSluggableTest.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Database\Capsule\Manager as DB;
 use Illuminate\Database\Eloquent\Attributes\Sluggable;
-use Illuminate\Database\Eloquent\CouldNotGenerateSlugException;
+
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Events\Dispatcher;
@@ -305,16 +305,6 @@ public function test_it_includes_soft_deleted_records_in_uniqueness_check()
 
     // maxAttempts
 
-    public function test_it_throws_after_maximum_attempts_exceeded()
-    {
-        $this->expectException(CouldNotGenerateSlugException::class);
-        $this->expectExceptionMessage('Could not generate a unique slug for [Illuminate\Tests\Database\SluggableMaxAttemptsPost] with base [hello] after 2 attempts.');
-
-        SluggableMaxAttemptsPost::create(['name' => 'Hello']);
-        SluggableMaxAttemptsPost::create(['name' => 'Hello']);
-        SluggableMaxAttemptsPost::create(['name' => 'Hello']);
-    }
-
     // maxLength
 
     public function test_it_respects_maximum_length()
@@ -528,31 +518,6 @@ public function test_slug_generation(string $input, string $expected)
         $this->assertSame($expected, $post->slug);
     }
 
-    // edge cases
-
-    public function test_it_throws_when_source_produces_empty_slug()
-    {
-        $this->expectException(CouldNotGenerateSlugException::class);
-        $this->expectExceptionMessage('Could not generate a slug for [Illuminate\Tests\Database\SluggablePost] using column(s) [name].');
-
-        SluggablePost::create(['name' => '!!!']);
-    }
-
-    public function test_it_throws_when_emoji_only_source_produces_empty_slug()
-    {
-        $this->expectException(CouldNotGenerateSlugException::class);
-        $this->expectExceptionMessage('Could not generate a slug for [Illuminate\Tests\Database\SluggablePost] using column(s) [name].');
-
-        SluggablePost::create(['name' => '🚀🎯🔥']);
-    }
-
-    public function test_it_throws_when_source_column_is_null()
-    {
-        $this->expectException(CouldNotGenerateSlugException::class);
-        $this->expectExceptionMessage('Could not generate a slug for [Illuminate\Tests\Database\SluggablePost] using column(s) [name].');
-
-        SluggablePost::create([]);
-    }
 }
 
 #[Sluggable]
@@ -660,3 +625,11 @@ class SluggableCustomColumnsPost extends Model
 
     protected $guarded = [];
 }
+
+#[Sluggable(errorKey: 'custom_field', errorMessage: 'Please enter a valid name.')]
+class SluggableCustomErrorPost extends Model
+{
+    protected $table = 'sluggable_posts';
+
+    protected $guarded = [];
+}