Add findBySlugOr() method with callback functionality

README.md

@@ -419,6 +419,18 @@ $model = Article::findBySlug('my-article');
 
 `findBySlug` also accepts a second parameter `$columns` just like the default Eloquent `find` method.
 
+### Find models by slug or
+For convenience, you can use the alias `findBySlugOr` to retrieve a model. The query will compare against the field passed to `saveSlugsTo` when defining the `SlugOptions`. If the model does not exist, the callable will be executed and the result will be returned.
+
+```php
+$model = Article::findBySlugOr('my-article', ['*'], function () {
+    return Article::create(['name' => 'my-article']);
+});
+
+// or
+$model = Article::findBySlugOr('my-article', ['*'],fn () => throw new \Exception('Article not found'));
+```
+
 
 ## Changelog
 

src/Exceptions/InvalidOption.php

@@ -20,4 +20,9 @@ public static function invalidMaximumLength(): static
     {
         return new static('Maximum length should be greater than zero');
     }
+
+    public static function missingCallback(): static
+    {
+        return new static('Could not determine which callback should be used');
+    }
 }

src/HasSlug.php

@@ -201,4 +201,19 @@ public static function findBySlug(string $slug, array $columns = ['*'])
 
         return static::where($field, $slug)->first($columns);
     }
+
+    public static function findBySlugOr(string $slug, array $columns = ['*'], ?callable $callback = null)
+    {
+        if (!is_callable($callback) && $callback !== null) {
+            throw InvalidOption::missingCallback();
+        }
+
+        $result = static::findBySlug($slug, $columns);
+
+        if (!$result && is_callable($callback)) {
+            return $callback($slug);
+        }
+
+        return $result;
+    }
 }

tests/HasSlugTest.php

@@ -349,3 +349,22 @@ public function getSlugOptions(): SlugOptions
 
     expect($savedModel->id)->toEqual($model->id);
 });
+
+it('can use a callable using findBySlugOr alias', function () {
+    $model = new class () extends TestModel {
+        public function getSlugOptions(): SlugOptions
+        {
+            return parent::getSlugOptions()
+                ->saveSlugsTo('url');
+        }
+    };
+
+    $model->name = 'my custom url';
+    $model->save();
+
+    $savedModel = $model::findBySlugOr('my-custom-url1', ['*'], function () {
+        return 'not found';
+    });
+
+    expect($savedModel)->toEqual('not found');
+});