refactor(database)!: remove ModelDefinition in favor or ModelInspector (#1372)

Author: brendt

packages/database/src/Builder/FieldDefinition.php

@@ -11,7 +11,6 @@
 
 use function Tempest\get;
 
-// TODO: remove
 final class FieldDefinition implements Stringable
 {
     public function __construct(
@@ -20,42 +19,6 @@ public function __construct(
         public ?string $as = null,
     ) {}
 
-    /** @return ImmutableArray<\Tempest\Database\Builder\FieldDefinition> */
-    public static function all(ClassReflector $class, ?TableDefinition $tableDefinition = null): ImmutableArray
-    {
-        $casterFactory = get(CasterFactory::class);
-        $fieldDefinitions = [];
-        $tableDefinition ??= new ModelDefinition($class->getName())->getTableDefinition();
-
-        foreach ($class->getPublicProperties() as $property) {
-            // Don't include the field if it's a 1:1 or n:1 relation
-            if ($property->getType()->isRelation()) {
-                continue;
-            }
-
-            // Don't include the field if it's a 1:n relation
-            if ($property->getIterableType()?->isRelation()) {
-                continue;
-            }
-
-            $caster = $casterFactory->forProperty($property);
-
-            if ($caster !== null) {
-                $fieldDefinitions[] = new FieldDefinition($tableDefinition, $property->getName());
-
-                continue;
-            }
-
-            if (! $property->getType()->isBuiltIn()) {
-                continue;
-            }
-
-            $fieldDefinitions[] = new FieldDefinition($tableDefinition, $property->getName());
-        }
-
-        return new ImmutableArray($fieldDefinitions);
-    }
-
     public function as(string $as): self
     {
         $this->as = $as;

packages/database/src/Builder/ModelDefinition.php

@@ -3,8 +3,7 @@
 namespace Tempest\Database\Builder\QueryBuilders;
 
 use Closure;
-use Tempest\Database\Builder\ModelDefinition;
-use Tempest\Database\Builder\TableDefinition;
+use Tempest\Database\Builder\ModelInspector;
 use Tempest\Database\Exceptions\HasManyRelationCouldNotBeInsterted;
 use Tempest\Database\Exceptions\HasOneRelationCouldNotBeInserted;
 use Tempest\Database\Id;
@@ -28,13 +27,16 @@ final class InsertQueryBuilder implements BuildsQuery
 
     private array $bindings = [];
 
+    private ModelInspector $model;
+
     public function __construct(
         /** @var class-string|string $model */
-        private readonly string|object $model,
+        string|object $model,
         private readonly array $rows,
         private readonly SerializerFactory $serializerFactory,
     ) {
-        $this->insert = new InsertStatement($this->resolveTableDefinition());
+        $this->model = model($model);
+        $this->insert = new InsertStatement($this->model->getTableDefinition());
     }
 
     public function execute(mixed ...$bindings): Id
@@ -59,16 +61,14 @@ public function toSql(): string
 
     public function build(mixed ...$bindings): Query
     {
-        $definition = model($this->model);
-
         foreach ($this->resolveData() as $data) {
             foreach ($data as $key => $value) {
-                if ($definition->getHasMany($key)) {
-                    throw new HasManyRelationCouldNotBeInsterted($definition->getName(), $key);
+                if ($this->model->getHasMany($key)) {
+                    throw new HasManyRelationCouldNotBeInsterted($this->model->getName(), $key);
                 }
 
-                if ($definition->getHasOne($key)) {
-                    throw new HasOneRelationCouldNotBeInserted($definition->getName(), $key);
+                if ($this->model->getHasOne($key)) {
+                    throw new HasOneRelationCouldNotBeInserted($this->model->getName(), $key);
                 }
 
                 $bindings[] = $value;
@@ -158,15 +158,4 @@ private function resolveData(): array
 
         return $entries;
     }
-
-    private function resolveTableDefinition(): TableDefinition
-    {
-        $modelDefinition = ModelDefinition::tryFrom($this->model);
-
-        if ($modelDefinition === null) {
-            return new TableDefinition($this->model);
-        }
-
-        return $modelDefinition->getTableDefinition();
-    }
 }

packages/database/src/Builder/QueryBuilders/InsertQueryBuilder.php

@@ -7,21 +7,13 @@
 use Stringable;
 use Tempest\Reflection\ClassReflector;
 
-// TODO: remove
 final readonly class TableDefinition implements Stringable
 {
     public function __construct(
         public string $name,
         public ?string $as = null,
     ) {}
 
-    public static function for(ClassReflector $reflector, ?string $as = null): self
-    {
-        return new ModelDefinition($reflector->getName())
-            ->getTableDefinition()
-            ->as($as);
-    }
-
     public function as(?string $as = null): self
     {
         if ($as === null) {

packages/database/src/Builder/TableDefinition.php

@@ -5,7 +5,6 @@
 namespace Tempest\Database\Migrations;
 
 use Tempest\Container\Container;
-use Tempest\Database\Builder\ModelDefinition;
 use Tempest\Database\Config\DatabaseDialect;
 use Tempest\Database\Database;
 use Tempest\Database\DatabaseMigration as MigrationInterface;
@@ -23,6 +22,7 @@
 use Tempest\Database\ShouldMigrate;
 use Throwable;
 
+use function Tempest\Database\model;
 use function Tempest\Database\query;
 use function Tempest\event;
 
@@ -80,7 +80,7 @@ public function down(): void
             }
 
             event(new MigrationFailed(
-                name: new ModelDefinition(Migration::class)->getTableDefinition()->name,
+                name: model(Migration::class)->getTableDefinition()->name,
                 exception: new TableWasNotFound(),
             ));
 

packages/database/src/Migrations/MigrationManager.php

@@ -4,13 +4,13 @@
 
 namespace Tempest\Database\QueryStatements;
 
-use Tempest\Database\Builder\ModelDefinition;
 use Tempest\Database\Builder\TableDefinition;
 use Tempest\Database\Config\DatabaseDialect;
 use Tempest\Database\HasTrailingStatements;
 use Tempest\Database\QueryStatement;
 use Tempest\Support\Str\ImmutableString;
 
+use function Tempest\Database\model;
 use function Tempest\Support\arr;
 use function Tempest\Support\str;
 
@@ -26,7 +26,7 @@ public function __construct(
     /** @param class-string $modelClass */
     public static function forModel(string $modelClass): self
     {
-        return new self(new ModelDefinition($modelClass)->getTableDefinition()->name);
+        return new self(model($modelClass)->getTableDefinition()->name);
     }
 
     public function add(QueryStatement $statement): self

packages/database/src/QueryStatements/AlterTableStatement.php

@@ -5,7 +5,6 @@
 namespace Tempest\Database\QueryStatements;
 
 use BackedEnum;
-use Tempest\Database\Builder\ModelDefinition;
 use Tempest\Database\Builder\TableDefinition;
 use Tempest\Database\Config\DatabaseDialect;
 use Tempest\Database\HasTrailingStatements;
@@ -14,6 +13,7 @@
 use Tempest\Support\Str\ImmutableString;
 use UnitEnum;
 
+use function Tempest\Database\model;
 use function Tempest\Support\arr;
 use function Tempest\Support\str;
 
@@ -29,7 +29,7 @@ public function __construct(
     /** @param class-string $modelClass */
     public static function forModel(string $modelClass): self
     {
-        return new self(new ModelDefinition($modelClass)->getTableDefinition()->name);
+        return new self(model($modelClass)->getTableDefinition()->name);
     }
 
     public function primary(string $name = 'id'): self

packages/database/src/QueryStatements/CreateTableStatement.php

@@ -4,11 +4,12 @@
 
 namespace Tempest\Database\QueryStatements;
 
-use Tempest\Database\Builder\ModelDefinition;
 use Tempest\Database\Config\DatabaseDialect;
 use Tempest\Database\HasLeadingStatements;
 use Tempest\Database\QueryStatement;
 
+use function Tempest\Database\model;
+
 final class DropTableStatement implements QueryStatement, HasLeadingStatements
 {
     use CanExecuteStatement;
@@ -29,7 +30,7 @@ public function dropReference(string $foreign): self
     /** @param class-string $modelClass */
     public static function forModel(string $modelClass): self
     {
-        return new self(new ModelDefinition($modelClass)->getTableDefinition()->name);
+        return new self(model($modelClass)->getTableDefinition()->name);
     }
 
     public function compile(DatabaseDialect $dialect): string

packages/database/src/QueryStatements/DropTableStatement.php

@@ -4,12 +4,13 @@
 
 namespace Tempest\Generation\Tests\Fixtures;
 
-use Tempest\Database\Builder\ModelDefinition;
 use Tempest\Generation\Tests\Fixtures\Database\FakeCreateTableStatement;
 use Tempest\Generation\Tests\Fixtures\Database\FakeMigration;
 use Tempest\Generation\Tests\Fixtures\Database\FakeQueryStatement;
 use Tempest\Generation\Tests\Fixtures\Database\MigrationModel as Model;
 
+use function Tempest\Database\model;
+
 #[TestAttribute]
 final readonly class CreateMigrationsTable implements FakeMigration
 {
@@ -20,7 +21,7 @@ public function getName(): string
 
     public function up(): FakeQueryStatement
     {
-        return new FakeCreateTableStatement(new ModelDefinition(Model::class)->getTableDefinition()->name)
+        return new FakeCreateTableStatement(model(Model::class)->getTableDefinition()->name)
             ->primary()
             ->text('name');
     }

packages/generation/tests/Fixtures/CreateMigrationsTable.php

@@ -15,7 +15,7 @@ final readonly class CreateMigrationsTable implements FakeMigration
 
     public function up(): FakeQueryStatement
     {
-        return new Database\FakeCreateTableStatement(new \Tempest\Database\Builder\ModelDefinition(Database\MigrationModel::class)->getTableDefinition()->name)
+        return new Database\FakeCreateTableStatement(\Tempest\Database\model(Database\MigrationModel::class)->getTableDefinition()->name)
             ->primary()
             ->text('name');
     }