Tweaks the model ID generation.

- New model instances will be prefixed with "create_" instead of
suffixed with "_new"
- Strip out only the model root namespace when generating the DOM ID

Author: tonysm

config/turbo-laravel.php

@@ -13,4 +13,19 @@
     */
 
     'queue' => true,
+
+    /*
+     |--------------------------------------------------------------------------
+     | Root Model Namespaces
+     |--------------------------------------------------------------------------
+     |
+     | When generating the DOM ID for models, we need to strip out parts of the namespace, so we
+     | can more accurate DOM IDs. If you happen to use a different convention for where you place
+     | your models, please, add the model namespace prefixes here. We'll strip out the first one that
+     | matches a "Str:startsWith()" check, so sort them from more specific to less specific.
+     */
+    'models_namespace' => [
+        'App\\Models\\',
+        'App\\',
+    ],
 ];

src/Models/Broadcasts.php

@@ -77,7 +77,7 @@ public function hotwireBroadcastUsing()
 
     public function hotwireTargetDomId()
     {
-        return $this->hotwireResolveNamesUsing()->resourceId(static::class, $this->getKey());
+        return $this->hotwireResolveNamesUsing()->resourceIdFor($this);
     }
 
     public function hotwireTargetResourcesName()

src/NamesResolver.php

@@ -14,7 +14,7 @@ public static function resourceName(Model $model, bool $plural = true): string
 
     private static function resourceNameFor(string $modelName, bool $plural = true): string
     {
-        return (string)strtolower(implode('_', preg_split('/(?=[A-Z])/', Str::of($modelName)->camel()->plural($plural ? 2 : 1))));
+        return (string)strtolower(implode('_', preg_split('/(?=[A-Z])/', Str::of($modelName)->replace('\\', ' ')->camel()->plural($plural ? 2 : 1))));
     }
 
     private static function resourceNameSingularFor(string $modelName): string
@@ -63,21 +63,32 @@ public function modelPathToChannelName(string $model, $id)
         return "{$path}.{$id}";
     }
 
-    public static function resourceId($modelClass, $modelId, $prefix = ""): string
+    public static function resourceIdFor(Model $model, string $prefix = ""): string
     {
         $prefix = $prefix !== ""
             ? "{$prefix}_"
             : "";
 
-        $resource = static::resourceNameSingularFor(class_basename($modelClass));
+        $resource = static::resourceNameSingularFor(static::getModelWithoutRootNamespaces($model));
+
+        if (!($modelId = $model->getKey())) {
+            return "{$prefix}create_{$resource}";
+        }
 
-        return "{$prefix}{$resource}_{$modelId}";
+        return trim("{$prefix}{$resource}_{$modelId}", '_');
     }
 
-    public static function resourceIdFor(Model $model, string $prefix = ""): string
+    private static function getModelWithoutRootNamespaces(Model $model): string
     {
-        $id = $model->getKey() ?: "new";
+        $className = get_class($model);
+
+        foreach (config('turbo-laravel.models_namespace') as $rootNs) {
+            if (Str::startsWith($className, $rootNs)) {
+                return Str::replaceFirst($rootNs, '', $className);
+            }
+        }
 
-        return static::resourceId(class_basename($model), $id, $prefix);
+        // If none of the previous matchers work, we use the class_basename helper instead.
+        return class_basename($model);
     }
 }

src/TurboStreamModelRenderer.php

@@ -39,7 +39,7 @@ public function renderDeleted(Model $model, string $action): ViewContract
         return View::make('turbo-laravel::model-removed', [
             'target' => method_exists($model, 'hotwireTargetDomId')
                 ? $model->hotwireTargetDomId()
-                : NamesResolver::resourceId($model, $model->getKey()),
+                : NamesResolver::resourceIdFor($model),
             'action' => $action,
         ]);
     }

tests/Views/Models/Account/TestModel.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Tonysm\TurboLaravel\Tests\Views\Models\Account;
+
+class TestModel extends \Tonysm\TurboLaravel\Tests\TestModel
+{
+}

tests/Views/Models/TestModel.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Tonysm\TurboLaravel\Tests\Views\Models;
+
+class TestModel extends \Tonysm\TurboLaravel\Tests\TestModel
+{
+}

tests/Views/ViewHelpersTest.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace Tonysm\TurboLaravel\Tests\Views\Components;
+namespace Tonysm\TurboLaravel\Tests\Views;
 
 use Illuminate\Support\Facades\View;
 use Illuminate\Support\Str;
+use Tonysm\TurboLaravel\Tests\Views\Models;
 use function Tonysm\TurboLaravel\dom_id;
 use Tonysm\TurboLaravel\Tests\TestCase;
-use Tonysm\TurboLaravel\Tests\TestModel;
 use Tonysm\TurboLaravel\TurboFacade;
 
 class ViewHelpersTest extends TestCase
@@ -27,23 +27,43 @@ public function renders_turbo_native_correctly()
     /** @test */
     public function renders_dom_id()
     {
-        $testModel = TestModel::create(['name' => 'lorem']);
+        $testModel = Models\TestModel::create(['name' => 'lorem']);
 
         $renderedDomId = View::file(__DIR__ . '/fixtures/domid.blade.php', ['model' => $testModel])->render();
         $renderedDomIdWithPrefix = View::file(__DIR__ . '/fixtures/domid_with_prefix.blade.php', ['model' => $testModel])->render();
-        $rendersDomIdOfNewModel = View::file(__DIR__ . '/fixtures/domid.blade.php', ['model' => new TestModel()])->render();
+        $rendersDomIdOfNewModel = View::file(__DIR__ . '/fixtures/domid.blade.php', ['model' => new Models\TestModel()])->render();
 
         $this->assertEquals('<div id="test_model_1"></div>', trim($renderedDomId));
         $this->assertEquals('<div id="favorites_test_model_1"></div>', trim($renderedDomIdWithPrefix));
-        $this->assertEquals('<div id="test_model_new"></div>', trim($rendersDomIdOfNewModel));
+        $this->assertEquals('<div id="create_test_model"></div>', trim($rendersDomIdOfNewModel));
     }
 
     /** @test */
     public function can_use_helper_function()
     {
-        $testModel = TestModel::create(['name' => 'lorem']);
+        $testModel = Models\TestModel::create(['name' => 'lorem']);
 
         $this->assertEquals("test_model_1", dom_id($testModel));
         $this->assertEquals("my_context_test_model_1", dom_id($testModel, "my_context"));
     }
+
+    /** @test */
+    public function generates_model_ids_for_models_in_nested_folders()
+    {
+        config()->set('turbo-laravel.models_namespace', [
+            __NAMESPACE__.'\\Models\\',
+        ]);
+
+        $testModel = Models\TestModel::create(['name' => 'lorem']);
+
+        $this->assertEquals("test_model_1", dom_id($testModel));
+        $this->assertEquals("my_context_test_model_1", dom_id($testModel, "my_context"));
+
+        $accountTestModel = Models\Account\TestModel::create(['name' => 'lorem']);
+
+        $this->assertEquals("account_test_model_{$accountTestModel->getKey()}", dom_id($accountTestModel));
+        $this->assertEquals("my_context_account_test_model_{$accountTestModel->getKey()}", dom_id($accountTestModel, "my_context"));
+
+        $this->assertEquals("create_account_test_model", dom_id(new Models\Account\TestModel()));
+    }
 }