feat(database): add a findBy method to models (#965)

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

Author: mattdinthehouse

src/Tempest/Auth/src/SessionAuthenticator.php

@@ -41,6 +41,6 @@ public function currentUser(): ?CanAuthenticate
         /** @var \Tempest\Database\Builder\ModelQueryBuilder<\Tempest\Auth\CanAuthenticate> $query */
         $query = $userModelClass->callStatic('query');
 
-        return $query->with('userPermissions.permission')->find($id);
+        return $query->with('userPermissions.permission')->get($id);
     }
 }

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

@@ -59,7 +59,7 @@ public function first(mixed ...$bindings)
     /**
      * @return TModelClass|null
      */
-    public function find(Id $id)
+    public function get(Id $id)
     {
         return $this
             ->whereField('id', $id)

src/Tempest/Database/src/DatabaseModel.php

@@ -23,7 +23,9 @@ public static function create(mixed ...$params): self;
 
     public static function updateOrCreate(array $find, array $update): self;
 
-    public static function find(Id $id, array $relations = []): ?self;
+    public static function get(Id $id, array $relations = []): ?self;
+
+    public static function find(mixed ...$conditions): ModelQueryBuilder;
 
     public function save(): self;
 

src/Tempest/Database/src/IsDatabaseModel.php

@@ -84,16 +84,25 @@ public static function all(array $relations = []): array
             ->all();
     }
 
-    public static function find(Id $id, array $relations = []): ?self
+    public static function get(Id $id, array $relations = []): ?self
     {
         return self::query()
             ->with(...$relations)
-            ->find($id);
+            ->get($id);
+    }
+
+    public static function find(mixed ...$conditions): ModelQueryBuilder
+    {
+        $query = self::query();
+        
+        array_walk($conditions, fn($value, $column) => $query->whereField($column, $value));
+
+        return $query;
     }
 
     public function load(string ...$relations): self
     {
-        $new = self::find($this->getId(), $relations);
+        $new = self::get($this->getId(), $relations);
 
         foreach (new ClassReflector($new)->getPublicProperties() as $property) {
             $property->setValue($this, $property->getValue($new));

src/Tempest/Router/src/RouteModelBindingInitializer.php

@@ -32,7 +32,7 @@ public function initialize(ClassReflector $class, Container $container): object
             }
         }
 
-        $model = $class->callStatic('find', new Id($matchedRoute->params[$parameter->getName()]));
+        $model = $class->callStatic('get', new Id($matchedRoute->params[$parameter->getName()]));
 
         if ($model === null) {
             throw new NotFoundException();

tests/Integration/Database/QueryStatements/AlterTableStatementTest.php

@@ -37,7 +37,7 @@ public function test_it_can_alter_a_table_definition(): void
         $this->assertCount(2, MigrationModel::all());
         $this->assertSame(
             '0000-01-01_create_users_table',
-            MigrationModel::find(new Id(2))->name,
+            MigrationModel::get(new Id(2))->name,
         );
 
         try {
@@ -61,7 +61,7 @@ public function test_it_can_alter_a_table_definition(): void
 
         $this->assertSame(
             '0000-01-02_add_email_to_user_table',
-            MigrationModel::find(new Id(3))->name,
+            MigrationModel::get(new Id(3))->name,
         );
 
         /** @var User $user */

tests/Integration/ORM/IsDatabaseModelTest.php

@@ -58,7 +58,7 @@ public function test_create_and_update_model(): void
         $this->assertSame('baz', $foo->bar);
         $this->assertInstanceOf(Id::class, $foo->id);
 
-        $foo = Foo::find($foo->id);
+        $foo = Foo::get($foo->id);
 
         $this->assertSame('baz', $foo->bar);
         $this->assertInstanceOf(Id::class, $foo->id);
@@ -67,7 +67,7 @@ public function test_create_and_update_model(): void
             bar: 'boo',
         );
 
-        $foo = Foo::find($foo->id);
+        $foo = Foo::get($foo->id);
 
         $this->assertSame('boo', $foo->bar);
     }
@@ -109,7 +109,7 @@ public function test_complex_query(): void
 
         $book = $book->save();
 
-        $book = Book::find($book->id, relations: ['author']);
+        $book = Book::get($book->id, relations: ['author']);
 
         $this->assertEquals(1, $book->id->id);
         $this->assertSame('Book Title', $book->title);
@@ -273,7 +273,7 @@ public function test_has_many_through_relation(): void
         (new ThroughModel(parent: $parent, child: $childA))->save();
         (new ThroughModel(parent: $parent, child: $childB))->save();
 
-        $parent = ParentModel::find($parent->id, ['through.child']);
+        $parent = ParentModel::get($parent->id, ['through.child']);
 
         $this->assertSame('A', $parent->through[1]->child->name);
         $this->assertSame('B', $parent->through[2]->child->name);
@@ -290,7 +290,7 @@ public function test_empty_has_many_relation(): void
 
         $parent = (new ParentModel(name: 'parent'))->save();
 
-        $parent = ParentModel::find($parent->id, ['through.child']);
+        $parent = ParentModel::get($parent->id, ['through.child']);
 
         $this->assertInstanceOf(ParentModel::class, $parent);
         $this->assertEmpty($parent->through);
@@ -313,8 +313,8 @@ public function test_has_one_relation(): void
 
         (new ThroughModel(parent: $parent, child: $childA, child2: $childB))->save();
 
-        $child = ChildModel::find($childA->id, ['through.parent']);
-        $child2 = ChildModel::find($childB->id, ['through2.parent']);
+        $child = ChildModel::get($childA->id, ['through.parent']);
+        $child2 = ChildModel::get($childB->id, ['through2.parent']);
 
         $this->assertSame('parent', $child->through->parent->name);
         $this->assertSame('parent', $child2->through2->parent->name);
@@ -337,8 +337,8 @@ public function test_invalid_has_one_relation(): void
 
         (new ThroughModel(parent: $parent, child: $childA, child2: $childB))->save();
 
-        $child = ChildModel::find($childA->id, ['through.parent']);
-        $child2 = ChildModel::find($childB->id, ['through2.parent']);
+        $child = ChildModel::get($childA->id, ['through.parent']);
+        $child2 = ChildModel::get($childB->id, ['through2.parent']);
 
         $this->assertSame('parent', $child->through->parent->name);
         $this->assertSame('parent', $child2->through2->parent->name);
@@ -462,8 +462,8 @@ public function test_delete(): void
 
         $foo->delete();
 
-        $this->assertNull(Foo::find($foo->getId()));
-        $this->assertNotNull(Foo::find($bar->getId()));
+        $this->assertNull(Foo::get($foo->getId()));
+        $this->assertNotNull(Foo::get($bar->getId()));
     }
 
     public function test_property_with_carbon_type(): void
@@ -499,4 +499,27 @@ enum: CasterEnum::BAR,
         $this->assertSame(['a', 'b', 'c'], $model->array);
         $this->assertSame(CasterEnum::BAR, $model->enum);
     }
+
+    public function test_find(): void
+    {
+        $this->migrate(
+            CreateMigrationsTable::class,
+            CreateATable::class,
+            CreateBTable::class,
+            CreateCTable::class,
+        );
+
+        (new C(name: 'one'))->save();
+        (new C(name: 'two'))->save();
+
+        /** @var C[] */
+        $valid = C::find(name: 'one')->all();
+
+        $this->assertCount(1, $valid);
+        $this->assertSame($valid[0]->name, 'one');
+
+        $invalid = C::find(name: 'three')->all();
+
+        $this->assertCount(0, $invalid);
+    }
 }

tests/Integration/Route/RequestTest.php

@@ -125,7 +125,7 @@ public function test_custom_request_test_with_validation(): void
             )
             ->assertStatus(Status::FOUND);
 
-        $book = Book::find(new Id(1));
+        $book = Book::get(new Id(1));
         $this->assertSame(1, $book->id->id);
         $this->assertSame('a', $book->title);
     }
@@ -148,7 +148,7 @@ public function test_custom_request_test_with_nested_validation(): void
             )
             ->assertStatus(Status::FOUND);
 
-        $book = Book::find(new Id(1), relations: ['author']);
+        $book = Book::get(new Id(1), relations: ['author']);
         $this->assertSame(1, $book->id->id);
         $this->assertSame('a', $book->title);
         $this->assertSame('b', $book->author->name);