feat: automatically generate entity names

Author: calebdw

src/SqlEntity.php

@@ -6,16 +6,20 @@
 
 use Illuminate\Database\Connection;
 use Illuminate\Database\Query\Builder;
+use Illuminate\Support\Str;
 use Stringable;
 
 abstract class SqlEntity implements Stringable
 {
-    /** The entity name. */
-    abstract public function name(): string;
-
     /** The entity definition. */
     abstract public function definition(): Builder|string;
 
+    /** The entity name. */
+    public function name(): string
+    {
+        return Str::snake(class_basename($this));
+    }
+
     /** The entity connection name. */
     public function connectionName(): ?string
     {

tests/Feature/SqlEntityManagerTest.php

@@ -32,13 +32,13 @@
 
 describe('get', function () {
     it('returns the entity by name', function () {
-        $entity = test()->manager->get('users_view');
+        $entity = test()->manager->get('user_view');
 
         expect($entity)->toBeInstanceOf(UserView::class);
     });
 
     it('returns the entity by name and connection', function () {
-        $entity = test()->manager->get('users_view', 'foo');
+        $entity = test()->manager->get('user_view', 'foo');
 
         expect($entity)->toBeInstanceOf(FooConnectionUserView::class);
     });
@@ -58,7 +58,7 @@
 
         test()->manager->create($entity);
     })->with([
-        'name'   => 'users_view',
+        'name'   => 'user_view',
         'class'  => UserView::class,
         'entity' => new UserView(),
     ]);
@@ -85,7 +85,7 @@
 
         test()->manager->drop($entity);
     })->with([
-        'name'   => 'users_view',
+        'name'   => 'user_view',
         'class'  => UserView::class,
         'entity' => new UserView(),
     ]);

tests/Feature/SqlEntityTest.php

@@ -27,11 +27,6 @@ class Foo extends Model
 
 class FooEntity extends SqlEntity
 {
-    public function name(): string
-    {
-        return 'foo_entity';
-    }
-
     public function definition(): Builder|string
     {
         return Foo::query()

tests/Unit/Grammars/GrammarTest.php

@@ -41,11 +41,6 @@ public function compileViewDrop(View $view): string
 
 class UnknownSqlEntity extends SqlEntity
 {
-    public function name(): string
-    {
-        return 'unknown_entity';
-    }
-
     public function definition(): Builder|string
     {
         return '';

tests/Unit/Grammars/PostgresGrammarTest.php

@@ -16,7 +16,7 @@
     $sql = test()->grammar->compileCreate(new UserView());
 
     expect($sql)->toBe(<<<'SQL'
-        CREATE OR REPLACE VIEW users_view AS
+        CREATE OR REPLACE VIEW user_view AS
         SELECT id, name FROM users
         SQL);
 });
@@ -25,6 +25,6 @@
     $sql = test()->grammar->compileDrop(new UserView());
 
     expect($sql)->toBe(<<<'SQL'
-        DROP VIEW IF EXISTS users_view CASCADE
+        DROP VIEW IF EXISTS user_view CASCADE
         SQL);
 });

tests/Unit/Grammars/SQLiteGrammarTest.php

@@ -16,7 +16,7 @@
     $sql = test()->grammar->compileCreate(new UserView());
 
     expect($sql)->toBe(<<<'SQL'
-        CREATE VIEW users_view AS
+        CREATE VIEW user_view AS
         SELECT id, name FROM users
         SQL);
 });
@@ -25,6 +25,6 @@
     $sql = test()->grammar->compileDrop(new UserView());
 
     expect($sql)->toBe(<<<'SQL'
-        DROP VIEW IF EXISTS users_view
+        DROP VIEW IF EXISTS user_view
         SQL);
 });

workbench/database/entities/views/FooConnectionUserView.php

@@ -12,7 +12,7 @@ class FooConnectionUserView extends View
     #[Override]
     public function name(): string
     {
-        return 'users_view';
+        return 'user_view';
     }
 
     #[Override]

workbench/database/entities/views/UserView.php

@@ -14,12 +14,6 @@ class UserView extends View
 
     public bool $shouldDrop = true;
 
-    #[Override]
-    public function name(): string
-    {
-        return 'users_view';
-    }
-
     #[Override]
     public function definition(): string
     {