v0.2.0

- Update README.md
- Remove routes
- Add Livewire full-page components as handler
- Fix bug when triggering manually generateUrl() multiple times
- Fix bug when related model is null
- Fix bug in tests

Author: vlados

README.md

@@ -7,6 +7,15 @@
 
 A package for using and generating unique urls for each Eloquent model in Laravel. This package is inspired by [spatie/laravel-sluggable](https://github.com/spatie/laravel-sluggable) but making the urls unique.
 
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Configuration](#configuration)
+    - [Routes]()
+    - [Prepare your model](#prepare-your-model)
+    - [Disable auto creating urls](#batch-import)
+    - [Livewire](#livewire)
+- [Contributing](#contributing)
+
 ### Goals:
 - When create or update a model to generate a unique url based on urlStrategy() function inside each model
 - If the url exists to create a new url with suffix _1, _2, etc.
@@ -28,35 +37,47 @@ php artisan vendor:publish --tag="laravel-unique-urls-migrations"
 php artisan migrate
 ```
 
-You can publish the config file with:
 
+## Usage
+
+### Configuration
+You can publish the config file with:
 ```bash
 php artisan vendor:publish --tag="laravel-unique-urls-config"
 ```
-
-## Usage
-Add to the model:
+There will create `unique-urls.php` with:
 ```php
-use Vlados\LaravelUniqueUrls\HasUniqueUrlTrait;
+return [
+    // Language versions of the urls
+    // 
+    'languages' => ['bg','en'],
+    'redirect_http_code' => 301,
+];
 ```
-In your method add these methods:
-```php
-public function urlStrategy(): string
-{
-    return Str::slug($this->getAttribute('name'));
-}
 
-public function getUrlHandler(): array
+### Prepare your model
+In your Model add these methods:
+```php
+class MyModel extends Model
 {
-    return [
-        // The controller used to handle the request
-        'controller' => CategoryController::class,
-        // The method
-        'method' => 'view',
-        // additional arguments sent to this method
-        'arguments' => [],
-    ];
-}
+    use Vlados\LaravelUniqueUrls\HasUniqueUrlTrait;
+
+    public function urlStrategy(): string
+    {
+        return Str::slug($this->getAttribute('name'));
+    }
+    
+    public function urlHandler(): array
+    {
+        return [
+            // The controller used to handle the request
+            'controller' => CategoryController::class,
+            // The method
+            'method' => 'view',
+            // additional arguments sent to this method
+            'arguments' => [],
+        ];
+    }
 ```
 
 The method for handling the request:
@@ -67,6 +88,12 @@ public function view(Request $request, $arguments = [])
 }
 ```
 
+And last, add this line at the end of your `routes/web.php`
+```php
+Route::get('{urlObj}', [\Vlados\LaravelUniqueUrls\LaravelUniqueUrls::class, 'handleRequest'])->where('urlObj', '.*');
+```
+### Batch import
+If for example you have category tree and you need to import all the data before creating the urls, you can disable the automatic generation of the url on model creation 
 To disable automatically generating the urls on create or update overwrite the method `isAutoGenerateUrls` in the model:
 ```php
 public function isAutoGenerateUrls(): bool
@@ -79,6 +106,41 @@ and call `generateUrl()` later like this:
 YourModel::all()->each(function (YourModel $model) {
     $model->generateUrl();
 });
+```
+### Livewire
+To use [Livewire full-page component](https://laravel-livewire.com/docs/2.x/rendering-components#page-components) to handle the request, first set in `urlHandler()` function in your model:
+```php
+public function urlHandler(): array
+{
+    return [
+        // The Livewire controller
+        'controller' => CategoryController::class,
+        // The method should be empty
+        'method' => '',
+        // additional arguments sent to the mount() function
+        'arguments' => [],
+    ];
+}
+```
+Example livewire component:
+```php
+class LivewireComponentExample extends Component
+{
+    private Url $urlModel;
+    private array $url_arguments;
+
+    public function mount(Url $urlObj, $arguments = [])
+    {
+        $this->urlModel = $urlObj;
+        $this->url_arguments = $arguments;
+    }
+
+    public function render()
+    {
+        return view('livewire.view-category');
+    }
+}
+
 ```
 
 ## Testing

config/unique-urls.php

@@ -1,6 +1,4 @@
 <?php
-
-// config for Vlados/LaravelUniqueUrls
 return [
     'languages' => ['bg','en'],
     'redirect_http_code' => 301,

routes/web.php

@@ -11,7 +11,7 @@
  */
 trait HasUniqueUrlTrait
 {
-    abstract public function getUrlHandler();
+    abstract public function urlHandler();
 
     private bool $autoGenerateUrls = true;
 
@@ -38,16 +38,29 @@ protected static function bootHasUniqueUrlTrait(): void
     public function generateUrl(): void
     {
         $unique_url = Url::makeSlug($this->urlStrategy(), $this);
-        $urls = [];
+        $createRecords = [];
+
+        $existing_languages = is_null($this->url) ? collect() : $this->url()->get()->keyBy('language');
         foreach (config('unique-urls.languages') as $lang) {
             $prefix = (config('app.fallback_locale') == $lang) ? '' : $lang . '/';
-            $new_url = $this->getUrlHandler();
+            $new_url = $this->urlHandler();
+
+            if (in_array($lang, $existing_languages->keys()->toArray())) {
+                // the url is existing for this model
+                if ($existing_languages[$lang]->slug !== $prefix.$unique_url) {
+                    // update the existing record if the url slug is different
+                    $existing_languages[$lang]["slug"] = $prefix.$unique_url;
+                    $existing_languages[$lang]->save();
+                }
+
+                continue;
+            }
             $new_url['language'] = $lang;
             $new_url['slug'] = $prefix . $unique_url;
-            $urls[] = $new_url;
+            $createRecords[] = $new_url;
         }
-        if (count($urls)) {
-            $this->url()->createMany($urls);
+        if (count($createRecords)) {
+            $this->url()->createMany($createRecords);
         }
     }
 
@@ -79,9 +92,7 @@ public function url(): \Illuminate\Database\Eloquent\Relations\MorphOne
      */
     public function getUrl($absolute = true): string
     {
-        throw_if(is_null($this->url), 'The model has no generated url');
-
-        $url = $this->url()->where('language', app()->getLocale())->first()->slug;
+        $url = $this->url()->where('language', app()->getLocale())->first()->slug ?? '';
 
         return $absolute ? url($url) : $url;
     }

src/HasUniqueUrlInterface.php

@@ -15,7 +15,12 @@ public function handleRequest(Url $urlObj, Request $request)
 
         $slugController = new $urlObj->controller();
         $arguments = $urlObj->getAttribute('arguments');
-        $arguments['related'] = $urlObj->getRelation('related');
+        if (method_exists($slugController, '__invoke') && $urlObj->getAttribute('method') === '') {
+            // if it is livewire
+            $request->route()->setParameter('arguments', $arguments);
+            return \App::call([$slugController, '__invoke']);
+        }
+        $arguments['related'] = $urlObj->related;
         if (isset($urlObj->method, $arguments) && method_exists($urlObj->controller, $urlObj->method)) {
             $called = $slugController->{$urlObj->method}($request, $arguments);
         } elseif (isset($urlObj->method) && ! isset($arguments) && method_exists($urlObj->controller, $urlObj->method)) {
@@ -28,7 +33,6 @@ public function handleRequest(Url $urlObj, Request $request)
         if (isset($called) && false !== $called) {
             return $called;
         }
-
         abort('404');
     }
 

src/HasUniqueUrlTrait.php

@@ -12,7 +12,6 @@ public function configurePackage(Package $package): void
         $package
             ->name('laravel-unique-urls')
             ->hasConfigFile()
-            ->hasRoute('web')
             ->hasMigration('create_unique_urls_table');
     }
 }

src/LaravelUniqueUrls.php

@@ -22,7 +22,6 @@
  * @property Carbon|null $created_at
  * @property Carbon|null $updated_at
  */
-
 class Url extends Model
 {
     use HasFactory;
@@ -36,7 +35,7 @@ class Url extends Model
     protected static function booted()
     {
         static::updated(callback: function (Url $url) {
-            if (! $url->isDirty('slug')) {
+            if (!$url->isDirty('slug')) {
                 return;
             }
             Url::create([
@@ -70,7 +69,7 @@ public function related(): MorphTo
      */
     public static function makeSlug(string $slug, Model $model): string
     {
-        if (! $slug) {
+        if (!$slug) {
             throw new Exception('Slug cannot be empty');
         }
         $where = $model->only(['id', 'type']);
@@ -97,12 +96,17 @@ private static function makeUniqueSlug($slug, $where)
 
     private static function otherRecordExistsWithSlug(string $path, $whereModel): bool
     {
-        $query = self::whereNot(function ($query) use ($whereModel) {
-            $query->where('related_id', $whereModel['id'])
-                ->where('related_type', $whereModel['type']);
+        $query = self::where(function ($query) use ($whereModel) {
+            $query->whereNot(function ($query) use ($whereModel) {
+                $query->where('related_id', $whereModel['id'])
+                    ->where('related_type', $whereModel['type']);
+            })
+                ->orWhere(function ($query) use ($whereModel): void {
+                    $query->whereNull('related_id')
+                        ->whereNull('related_type');
+                });
         })
-            ->where('slug', $path)
-            ->withoutGlobalScopes();
+            ->where('slug', $path);
 
         return $query->exists();
     }

src/LaravelUniqueUrlsServiceProvider.php

@@ -7,6 +7,10 @@
 
 //uses(RefreshDatabase::class);
 
+beforeEach(function() {
+    app()->setLocale('en');
+});
+
 test('Check if it creates correct url', closure: function () {
     $model = TestModel::create(['name' => 'this is a test']);
     expect($model->getUrl())->toEqual(url('test-this-is-a-test'));

src/Models/Url.php

@@ -24,7 +24,7 @@ public function urlStrategy(): string
         return 'test-' . Str::slug($this->getAttribute('name'));
     }
 
-    public function getUrlHandler(): array
+    public function urlHandler(): array
     {
         return [
             'controller' => TestUrlHandler::class,