[PoC] Custom ActiveQuery collections based on an attribute

src/Attribute/Collection.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\ActiveRecord\Attribute;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+readonly class Collection
+{
+    public function __construct(public string $name)
+    {
+    }
+}

src/Query/ActiveQuery.php

@@ -4,8 +4,13 @@
 
 namespace Cycle\ActiveRecord\Query;
 
+use Cycle\ActiveRecord\Attribute\Collection;
 use Cycle\ActiveRecord\Facade;
+use Cycle\ORM\ORMInterface;
 use Cycle\ORM\Select;
+use ReflectionAttribute;
+use ReflectionClass;
+use ReflectionException;
 
 /**
  * @template-covariant TEntity of object
@@ -14,11 +19,36 @@
  */
 class ActiveQuery extends Select
 {
+    protected ORMInterface $orm;
+
     /**
      * @param class-string<TEntity> $class
      */
-    final public function __construct(string $class)
+    final public function __construct(protected string $class)
     {
-        parent::__construct(Facade::getOrm(), $class);
+        $this->orm = Facade::getOrm();
+
+        parent::__construct($this->orm, $class);
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    public function fetchAll(): iterable
+    {
+        $reflection = new ReflectionClass(static::class);
+        // $reflection = new ReflectionClass($this->class);
+        $attributes = $reflection->getAttributes(Collection::class, ReflectionAttribute::IS_INSTANCEOF);
+
+        dd($attributes);
+
+        if ([] === $attributes) {
+            return parent::fetchAll();
+        }
+
+        $attribute = $attributes[0]->newInstance();
+        $collection = $this->orm->getFactory()->collection($attribute->name);
+
+        return $collection->collect($this->getIterator());
     }
 }

tests/app/Entity/User.php

@@ -8,6 +8,7 @@
 use Cycle\Annotated\Annotation\Column;
 use Cycle\Annotated\Annotation\Entity;
 use Cycle\Annotated\Annotation\Relation\BelongsTo;
+use Cycle\App\Query\UserCollectionQuery;
 use Cycle\App\Query\UserQuery;
 
 #[Entity(table: 'user')]
@@ -30,6 +31,11 @@ public static function query(): UserQuery
         return new UserQuery(static::class);
     }
 
+    public static function queryWithCollection(): UserCollectionQuery
+    {
+        return new UserCollectionQuery(static::class);
+    }
+
     public function __construct(string $name, ?Identity $identity = null)
     {
         $this->name = $name;

tests/app/Query/UserCollectionQuery.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\App\Query;
+
+use Cycle\ActiveRecord\Attribute\Collection;
+use Cycle\ActiveRecord\Query\ActiveQuery;
+use Cycle\ORM\Collection\IlluminateCollectionFactory;
+
+/**
+ * @template-covariant TEntity of object
+ *
+ * @extends ActiveQuery<TEntity>
+ */
+#[Collection(name: IlluminateCollectionFactory::class)]
+class UserCollectionQuery extends ActiveQuery
+{
+    public function active(bool $state = true): UserCollectionQuery
+    {
+        return $this->where(['active' => $state]);
+    }
+}

tests/src/ActiveRecordTest.php

@@ -6,6 +6,7 @@
 
 use Cycle\ActiveRecord\Facade;
 use Cycle\App\Entity\User;
+use Cycle\Database\Database;
 use Cycle\Database\DatabaseManager;
 use Cycle\ORM\Select\Repository;
 use PHPUnit\Framework\Attributes\Test;
@@ -21,8 +22,10 @@ public function tearDown(): void
         parent::tearDown();
 
         $databaseManager = $this->getContainer()->get(DatabaseManager::class);
+        /** @var Database $database */
+        $database = $databaseManager->database('default');
 
-        $this->dropDatabase($databaseManager->database('default'));
+        $this->dropDatabase($database);
         Facade::reset();
     }
 

tests/src/Query/ActiveQueryTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Tests\Query;
+
+use Cycle\ActiveRecord\Facade;
+use Cycle\App\Entity\User;
+use Cycle\Database\Database;
+use Cycle\Database\DatabaseManager
+use Cycle\Tests\DatabaseTestCase;
+use PHPUnit\Framework\Attributes\Test;
+use ReflectionException;
+use Throwable;
+
+final class ActiveQueryTest extends DatabaseTestCase
+{
+    /**
+     * @throws Throwable
+     */
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        $databaseManager = $this->getContainer()->get(DatabaseManager::class);
+        /** @var Database $database */
+        $database = $databaseManager->database('default');
+
+        $this->dropDatabase($database);
+        Facade::reset();
+    }
+
+    /**
+     * @test
+     *
+     * @throws ReflectionException
+     */
+    #[Test]
+    public function it_checks_if_fetch_all_method_returns_array_by_default(): void
+    {
+        $users = User::queryWithCollection()->fetchAll();
+
+        dd($users);
+
+        $this::assertIsArray($users);
+    }
+}