feat: TableName attribute

SoftwarePunt · Jun 24, 2024 · 0e4fc7b · 0e4fc7b
1 parent c176b83
commit 0e4fc7b
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 22 deletions.
diff --git a/.idea/dataSources.local.xml b/.idea/dataSources.local.xml
diff --git a/lib/Attributes/TableName.php b/lib/Attributes/TableName.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace SoftwarePunt\Instarecord\Attributes;
+
+use Attribute;
+
+/**
+ * Specifies a custom name for a model's backing table.
+ */
+#[Attribute(Attribute::TARGET_CLASS)]
+class TableName
+{
+    public function __construct(public string $name)
+    {
+    }
+}
diff --git a/lib/Database/Table.php b/lib/Database/Table.php
@@ -152,6 +152,18 @@ public function getColumnByName(string $columnName): ?Column
         return null;
     }
 
+    public function getTableName(): string
+    {
+        if ($this->reflectionModel->nameOverride) {
+            return $this->reflectionModel->nameOverride;
+        } else {
+            return Column::getDefaultColumnName($this->modelClassNameNoNamespace);
+        }
+    }
+
+    // -----------------------------------------------------------------------------------------------------------------
+    // Static utils
+
     /**
      * @var Table[]
      */
@@ -170,17 +182,12 @@ public static function getTableInfo(string $modelClassName): Table
     }
 
     /**
-     * Gets the "default" table name.
-     *
-     * @param string $className
-     * @return mixed|string
+     * Gets the default table name, derived from the model class name.
      */
-    public static function getDefaultTableName(string $className)
+    public static function getDefaultTableName(string $className): string
     {
         $tableName = TextTransforms::removeNamespaceFromClassName($className);
         $tableName = TextTransforms::pluralize($tableName);
-        $tableName = Column::getDefaultColumnName($tableName);
-
-        return $tableName;
+        return Column::getDefaultColumnName($tableName);
     }
 }
diff --git a/lib/Model.php b/lib/Model.php
@@ -54,7 +54,7 @@ public function __construct(?array $initialValues = [], bool $loadRelationships
      */
     public function getTableName(): string
     {
-        return Table::getDefaultTableName(get_class($this));
+        return $this->getTableInfo()->getTableName();
     }
 
     /**

diff --git a/lib/Reflection/ReflectionModel.php b/lib/Reflection/ReflectionModel.php
@@ -5,6 +5,7 @@
 use ReflectionClass;
 use ReflectionException;
 use ReflectionProperty;
+use SoftwarePunt\Instarecord\Attributes\TableName;
 use SoftwarePunt\Instarecord\Config\ConfigException;
 use SoftwarePunt\Instarecord\Model;
 
@@ -35,6 +36,11 @@ class ReflectionModel
      */
     protected array $defaultValues;
 
+    /**
+     * @var string|null
+     */
+    public readonly ?string $nameOverride;
+
     /**
      * ReflectionModel constructor.
      *
@@ -61,6 +67,14 @@ public function __construct(Model $model)
         foreach ($this->rfClass->getDefaultProperties() as $name => $value) {
             $this->defaultValues[$name] = $value;
         }
+
+        // Get class attributes
+        $attributes = $this->rfClass->getAttributes();
+        foreach ($attributes as $attribute) {
+            if ($attribute->getName() === TableName::class) {
+                $this->nameOverride = $attribute->getArguments()[0];
+            }
+        }
     }
 
     // -----------------------------------------------------------------------------------------------------------------

diff --git a/tests/ModelTest.php b/tests/ModelTest.php
@@ -7,6 +7,7 @@
 use SoftwarePunt\Instarecord\Instarecord;
 use SoftwarePunt\Instarecord\Tests\Samples\TestDummySerializableType;
 use Softwarepunt\Instarecord\Tests\Samples\TestEnum;
+use SoftwarePunt\Instarecord\Tests\Samples\TestUserAuto;
 use SoftwarePunt\Instarecord\Tests\Samples\TestUserWithSerialized;
 use SoftwarePunt\Instarecord\Tests\Samples\TestUser;
 use SoftwarePunt\Instarecord\Tests\Testing\TestDatabaseConfig;
@@ -160,7 +161,13 @@ public function testGetPropertyNameForColumnName()
 
     public function testGetTableName()
     {
-        $sampleUserModel = new TestUser();
+        $sampleUserModel = new TestUser(); // has getTableName() implemented
+        $this->assertEquals('users', $sampleUserModel->getTableName());
+    }
+
+    public function testGetTableNameFromAttribute()
+    {
+        $sampleUserModel = new TestUserAuto(); // has #[TableName] attribute
         $this->assertEquals('users', $sampleUserModel->getTableName());
     }
 

diff --git a/tests/Samples/TestReadOnlyUser.php b/tests/Samples/TestReadOnlyUser.php
@@ -5,9 +5,6 @@
 use SoftwarePunt\Instarecord\Model;
 use SoftwarePunt\Instarecord\Models\IReadOnlyModel;
 
-/**
- * @table users
- */
 class TestReadOnlyUser extends Model implements IReadOnlyModel
 {
     private int $secretNotWritable;

diff --git a/tests/Samples/TestUserAuto.php b/tests/Samples/TestUserAuto.php
@@ -2,11 +2,10 @@
 
 namespace SoftwarePunt\Instarecord\Tests\Samples;
 
+use SoftwarePunt\Instarecord\Attributes\TableName;
 use SoftwarePunt\Instarecord\Model;
 
-/**
- * @table users
- */
+#[TableName("users")]
 class TestUserAuto extends Model
 {
     private int $secretNotWritable;
@@ -20,9 +19,4 @@ class TestUserAuto extends Model
     public \DateTime $modifiedAt;
 
     public \DateTime $createdAt;
-
-    public function getTableName(): string
-    {
-        return "users";
-    }
 }