feat(database): add a Virtual attribute to exclude model properties from query builder (#966)

Co-authored-by: Brent Roose <[email protected]>

Author: mattdinthehouse

src/Tempest/Database/src/Builder/ModelQueryBuilder.php

@@ -5,10 +5,12 @@
 namespace Tempest\Database\Builder;
 
 use Closure;
-use Tempest\Database\DatabaseModel;
 use Tempest\Database\Id;
-use Tempest\Database\Query;
 use function Tempest\map;
+use Tempest\Database\Query;
+use function Tempest\reflect;
+use Tempest\Database\Virtual;
+use Tempest\Database\DatabaseModel;
 
 /**
  * @template TModelClass of DatabaseModel
@@ -165,6 +167,8 @@ private function build(array $bindings): Query
 
         $fields = $modelDefinition->getFieldNames();
 
+        $fields = array_filter($fields, fn(FieldName $field) => !(reflect($this->modelClass, $field->fieldName)->hasAttribute(Virtual::class)));
+
         foreach ($relations as $relation) {
             $fields = [...$fields, ...$relation->getFieldNames()];
         }

src/Tempest/Database/src/Virtual.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final readonly class Virtual
+{
+}

tests/Fixtures/Models/AWithVirtual.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Fixtures\Models;
+
+use Tempest\Database\Virtual;
+use Tempest\Database\DatabaseModel;
+use Tempest\Database\IsDatabaseModel;
+use Tempest\Database\Builder\TableName;
+
+final class AWithVirtual implements DatabaseModel
+{
+    use IsDatabaseModel;
+
+    #[Virtual]
+    public int $fake {
+        get => $this->id->id * -1;
+    }
+
+    public function __construct(
+        public B $b,
+    ) {
+    }
+
+    public static function table(): TableName
+    {
+        return new TableName('a');
+    }
+}

tests/Integration/ORM/IsDatabaseModelTest.php

@@ -6,37 +6,38 @@
 
 use Carbon\Carbon;
 use DateTimeImmutable;
-use Tempest\Database\Exceptions\MissingRelation;
-use Tempest\Database\Exceptions\MissingValue;
 use Tempest\Database\Id;
-use Tempest\Database\Migrations\CreateMigrationsTable;
-use Tests\Tempest\Fixtures\Migrations\CreateAuthorTable;
-use Tests\Tempest\Fixtures\Migrations\CreateBookTable;
+use function Tempest\map;
 use Tests\Tempest\Fixtures\Models\A;
-use Tests\Tempest\Fixtures\Models\AWithEager;
-use Tests\Tempest\Fixtures\Models\AWithLazy;
-use Tests\Tempest\Fixtures\Models\AWithValue;
 use Tests\Tempest\Fixtures\Models\B;
 use Tests\Tempest\Fixtures\Models\C;
-use Tests\Tempest\Fixtures\Modules\Books\Models\Author;
-use Tests\Tempest\Fixtures\Modules\Books\Models\AuthorType;
+use Tests\Tempest\Fixtures\Models\AWithLazy;
+use Tempest\Database\Exceptions\MissingValue;
+use Tests\Tempest\Fixtures\Models\AWithEager;
+use Tests\Tempest\Fixtures\Models\AWithValue;
+use Tests\Tempest\Fixtures\Models\AWithVirtual;
+use Tempest\Database\Exceptions\MissingRelation;
+use Tests\Tempest\Integration\ORM\Models\CasterEnum;
+use Tests\Tempest\Integration\ORM\Models\ChildModel;
 use Tests\Tempest\Fixtures\Modules\Books\Models\Book;
-use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+use Tests\Tempest\Integration\ORM\Models\CarbonModel;
+use Tests\Tempest\Integration\ORM\Models\CasterModel;
+use Tests\Tempest\Integration\ORM\Models\ParentModel;
+use Tempest\Database\Migrations\CreateMigrationsTable;
+use Tests\Tempest\Fixtures\Migrations\CreateBookTable;
+use Tests\Tempest\Integration\ORM\Models\ThroughModel;
+use Tests\Tempest\Fixtures\Modules\Books\Models\Author;
+use Tests\Tempest\Fixtures\Migrations\CreateAuthorTable;
 use Tests\Tempest\Integration\ORM\Migrations\CreateATable;
 use Tests\Tempest\Integration\ORM\Migrations\CreateBTable;
+use Tests\Tempest\Integration\ORM\Migrations\CreateCTable;
+use Tests\Tempest\Fixtures\Modules\Books\Models\AuthorType;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 use Tests\Tempest\Integration\ORM\Migrations\CreateCarbonModelTable;
 use Tests\Tempest\Integration\ORM\Migrations\CreateCasterModelTable;
-use Tests\Tempest\Integration\ORM\Migrations\CreateCTable;
 use Tests\Tempest\Integration\ORM\Migrations\CreateHasManyChildTable;
 use Tests\Tempest\Integration\ORM\Migrations\CreateHasManyParentTable;
 use Tests\Tempest\Integration\ORM\Migrations\CreateHasManyThroughTable;
-use Tests\Tempest\Integration\ORM\Models\CarbonModel;
-use Tests\Tempest\Integration\ORM\Models\CasterEnum;
-use Tests\Tempest\Integration\ORM\Models\CasterModel;
-use Tests\Tempest\Integration\ORM\Models\ChildModel;
-use Tests\Tempest\Integration\ORM\Models\ParentModel;
-use Tests\Tempest\Integration\ORM\Models\ThroughModel;
-use function Tempest\map;
 
 /**
  * @internal
@@ -399,6 +400,26 @@ public function test_no_result(): void
         $this->assertNull(A::query()->first());
     }
 
+    public function test_virtual_property(): void
+    {
+        $this->migrate(
+            CreateMigrationsTable::class,
+            CreateATable::class,
+            CreateBTable::class,
+            CreateCTable::class,
+        );
+
+        (new A(
+            b: new B(
+                c: new C(name: 'test'),
+            ),
+        ))->save();
+
+        $a = AWithVirtual::query()->first();
+
+        $this->assertSame($a->id->id * -1, $a->fake);
+    }
+
     public function test_update_or_create(): void
     {
         $this->migrate(