feat: convert SqlEntity to interface

Author: calebdw

src/SqlEntity.php renamed to src/Concerns/DefaultSqlEntityBehaviour.php

@@ -2,60 +2,59 @@
 
 declare(strict_types=1);
 
-namespace CalebDW\SqlEntities;
+namespace CalebDW\SqlEntities\Concerns;
 
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use Illuminate\Database\Connection;
-use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Str;
-use Stringable;
+use Override;
 
-abstract class SqlEntity implements Stringable
+/** @phpstan-require-implements SqlEntity */
+trait DefaultSqlEntityBehaviour
 {
-    /** The entity definition. */
-    abstract public function definition(): Builder|string;
+    /** The connection name. */
+    protected ?string $connection = null;
 
     /** The entity name. */
+    protected ?string $name = null;
+
+    #[Override]
     public function name(): string
     {
-        return Str::snake(class_basename($this));
+        return $this->name ?? Str::snake(class_basename($this));
     }
 
-    /** The entity connection name. */
+    #[Override]
     public function connectionName(): ?string
     {
-        return null;
+        return $this->connection;
     }
 
-    /**
-     * Hook before creating the entity.
-     *
-     * @return bool true to create the entity, false to skip.
-     */
+    #[Override]
     public function creating(Connection $connection): bool
     {
         return true;
     }
 
-    /** Hook after creating the entity. */
+    #[Override]
     public function created(Connection $connection): void
     {
+        return;
     }
 
-    /**
-     * Hook before dropping the entity.
-     *
-     * @return bool true to drop the entity, false to skip.
-     */
+    #[Override]
     public function dropping(Connection $connection): bool
     {
         return true;
     }
 
-    /** Hook after dropping the entity. */
+    #[Override]
     public function dropped(Connection $connection): void
     {
+        return;
     }
 
+    #[Override]
     public function toString(): string
     {
         $definition = $this->definition();
@@ -67,6 +66,7 @@ public function toString(): string
         return $definition->toRawSql();
     }
 
+    #[Override]
     public function __toString(): string
     {
         return $this->toString();

src/Contracts/SqlEntity.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CalebDW\SqlEntities\Contracts;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\Query\Builder;
+use Stringable;
+
+interface SqlEntity extends Stringable
+{
+    /** The entity definition. */
+    public function definition(): Builder|string;
+
+    /** The entity name. */
+    public function name(): string;
+
+    /** The entity connection name. */
+    public function connectionName(): ?string;
+
+    /**
+     * Hook before creating the entity.
+     *
+     * @return bool true to create the entity, false to skip.
+     */
+    public function creating(Connection $connection): bool;
+
+    /** Hook after creating the entity. */
+    public function created(Connection $connection): void;
+
+    /**
+     * Hook before dropping the entity.
+     *
+     * @return bool true to drop the entity, false to skip.
+     */
+    public function dropping(Connection $connection): bool;
+
+    /** Hook after dropping the entity. */
+    public function dropped(Connection $connection): void;
+
+    /** Returns a string representation of the entity. */
+    public function toString(): string;
+}

src/Facades/SqlEntity.php

@@ -4,15 +4,15 @@
 
 namespace CalebDW\SqlEntities\Facades;
 
-use CalebDW\SqlEntities\SqlEntity as SqlEntityBase;
+use CalebDW\SqlEntities\Contracts\SqlEntity as SqlEntityContract;
 use CalebDW\SqlEntities\SqlEntityManager;
 use Illuminate\Support\Facades\Facade;
 use Override;
 
 /**
- * @method static SqlEntityBase get(string $name)
- * @method static void create(SqlEntityBase|class-string<SqlEntityBase>|string $entity)
- * @method static void drop(SqlEntityBase|class-string<SqlEntityBase>|string $entity)
+ * @method static SqlEntityContract get(string $name)
+ * @method static void create(SqlEntityContract|class-string<SqlEntityContract>|string $entity)
+ * @method static void drop(SqlEntityContract|class-string<SqlEntityContract>|string $entity)
  * @method static void createAll(?string $type = null, ?string $connection = null)
  * @method static void dropAll(?string $type = null, ?string $connection = null)
  *

src/Grammars/Grammar.php

@@ -4,7 +4,7 @@
 
 namespace CalebDW\SqlEntities\Grammars;
 
-use CalebDW\SqlEntities\SqlEntity;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\View;
 use Illuminate\Database\Connection;
 use InvalidArgumentException;

src/ServiceProvider.php

@@ -4,7 +4,7 @@
 
 namespace CalebDW\SqlEntities;
 
-use CalebDW\SqlEntities\SqlEntity;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\Support\Composer;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Contracts\Support\DeferrableProvider;
@@ -33,7 +33,7 @@ public function register(): void
     }
 
     /** @return Collection<int, SqlEntity> */
-    private function getEntities(Application $app): Collection
+    protected function getEntities(Application $app): Collection
     {
         $composer = new Composer($app->make('files'), $app->basePath());
 

src/SqlEntityManager.php

@@ -4,7 +4,7 @@
 
 namespace CalebDW\SqlEntities;
 
-use CalebDW\SqlEntities\SqlEntity;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\Grammars\Grammar;
 use CalebDW\SqlEntities\Grammars\PostgresGrammar;
 use CalebDW\SqlEntities\Grammars\SQLiteGrammar;

src/View.php

@@ -4,6 +4,10 @@
 
 namespace CalebDW\SqlEntities;
 
-abstract class View extends SqlEntity
+use CalebDW\SqlEntities\Concerns\DefaultSqlEntityBehaviour;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
+
+abstract class View implements SqlEntity
 {
+    use Concerns\DefaultSqlEntityBehaviour;
 }

tests/Feature/SqlEntityManagerTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use CalebDW\SqlEntities\SqlEntity;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\SqlEntityManager;
 use CalebDW\SqlEntities\View;
 use Illuminate\Database\Connection;

tests/Feature/SqlEntityTest.php

@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-use CalebDW\SqlEntities\SqlEntity;
+use CalebDW\SqlEntities\Concerns\DefaultSqlEntityBehaviour;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Query\Builder;
 
@@ -25,8 +26,10 @@ class Foo extends Model
     protected $table = 'foo';
 }
 
-class FooEntity extends SqlEntity
+class FooEntity implements SqlEntity
 {
+    use DefaultSqlEntityBehaviour;
+
     public function definition(): Builder|string
     {
         return Foo::query()

tests/Unit/Grammars/GrammarTest.php

@@ -2,7 +2,8 @@
 
 declare(strict_types=1);
 
-use CalebDW\SqlEntities\SqlEntity;
+use CalebDW\SqlEntities\Concerns\DefaultSqlEntityBehaviour;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\View;
 use CalebDW\SqlEntities\Grammars\Grammar;
 use Illuminate\Database\Connection;
@@ -39,8 +40,10 @@ public function compileViewDrop(View $view): string
     }
 }
 
-class UnknownSqlEntity extends SqlEntity
+class UnknownSqlEntity implements SqlEntity
 {
+    use DefaultSqlEntityBehaviour;
+
     public function definition(): Builder|string
     {
         return '';