Merge pull request #43: Add ::tableName() method and autowire ::transact()

Add `::tableName()` method and autowire `::transact()`

Author: roxblnfk

composer.json

@@ -38,7 +38,8 @@
         "php": ">=8.1",
         "cycle/database": "^2.11",
         "cycle/orm": "^2.7",
-        "psr/container": "^2.0"
+        "psr/container": "^2.0",
+        "yiisoft/injector": "^1.2"
     },
     "require-dev": {
         "buggregator/trap": "^1.5",

composer.lock

@@ -4,9 +4,9 @@
     <MixedArgument>
       <code><![CDATA[$primaryKey]]></code>
     </MixedArgument>
-    <PossiblyUnusedReturnValue>
-      <code><![CDATA[TResult]]></code>
-    </PossiblyUnusedReturnValue>
+    <MixedReturnStatement>
+      <code><![CDATA[static::getOrm()->getSchema()->define(static::class, SchemaInterface::TABLE)]]></code>
+    </MixedReturnStatement>
   </file>
   <file src="src/Facade.php">
     <MixedReturnStatement>
@@ -19,8 +19,8 @@
     </InvalidThrow>
   </file>
   <file src="src/Repository/ActiveRepository.php">
-    <MixedArgument>
+    <ArgumentTypeCoercion>
       <code><![CDATA[$id]]></code>
-    </MixedArgument>
+    </ArgumentTypeCoercion>
   </file>
 </files>

psalm-baseline.xml

@@ -12,13 +12,24 @@
 use Cycle\ORM\Exception\RunnerException;
 use Cycle\ORM\ORMInterface;
 use Cycle\ORM\RepositoryInterface;
+use Cycle\ORM\SchemaInterface;
 
 /**
  * A base class for entities that are managed by the ORM.
  * Adds a set of ActiveRecord methods to the extending entity class.
  */
 abstract class ActiveRecord
 {
+    /**
+     * Get the table name associated with the entity.
+     *
+     * @return non-empty-string
+     */
+    final public static function tableName(): string
+    {
+        return static::getOrm()->getSchema()->define(static::class, SchemaInterface::TABLE);
+    }
+
     /**
      * Create a new entity instance with the given data.
      * It is preferable to use this method instead of the constructor because
@@ -142,8 +153,14 @@ final public static function groupActions(
      *       will be used.
      *
      * @template TResult
-     * @param callable(DatabaseInterface, EntityManagerInterface): TResult $callback Note that the provided
-     *        Entity Manager doesn't collect operations and executes them right away in the opened transaction.
+     * @param callable(): TResult $callback A function that may accept parameters of the following types in any order:
+     *   - {@see DatabaseInterface}
+     *   - {@see EntityManagerInterface}
+     *   - {@see ORMInterface}
+     *   - {@see SchemaInterface}
+     * @psalm-param callable(...): TResult $callback
+     * @note that the provided Entity Manager doesn't collect operations and executes them right away in the opened transaction.
+     *
      * @return TResult
      *
      * @throws TransactionException

src/ActiveRecord.php

@@ -12,6 +12,7 @@
 use Cycle\ORM\Service\SourceProviderInterface;
 use Cycle\ORM\Transaction\Runner;
 use Cycle\ORM\Transaction\UnitOfWork;
+use Yiisoft\Injector\Injector;
 
 /**
  * @internal
@@ -65,8 +66,9 @@ public static function groupOrmActions(
 
     /**
      * @template TResult
-     * @param callable(DatabaseInterface, EntityManagerInterface): TResult $callback
+     * @param callable(): TResult $callback
      * @param class-string|null $entity If null, the default database will be used.
+     * @psalm-param callable(...): TResult $callback
      * @return TResult
      *
      * @throws TransactionException
@@ -86,12 +88,13 @@ public static function transact(
         return $dbal->transaction(static function (DatabaseInterface $db) use ($callback): mixed {
             $previous = self::$em;
             try {
+                $orm = Facade::getOrm();
                 self::$em = $em = new EntityManager(
-                    static fn(): UnitOfWork => new UnitOfWork(Facade::getOrm(), Runner::outerTransaction(strict: true)),
+                    static fn(): UnitOfWork => new UnitOfWork($orm, Runner::outerTransaction(strict: true)),
                     autoExecute: true,
                 );
 
-                return $callback($db, $em);
+                return (new Injector())->invoke($callback, [$db, $em, $orm, $orm->getHeap(), $orm->getSchema()]);
             } finally {
                 self::$em = $previous;
             }

src/Internal/TransactionFacade.php

@@ -51,6 +51,8 @@ public function __construct(string $role)
      *
      * @note Limit of 1 will be added to the query.
      *
+     * @param string|int|non-empty-list<string|int>|non-empty-array<non-empty-string, string|int>|object $id
+     *
      * @return TEntity|null
      */
     public function findByPK(mixed $id): ?object

src/Repository/ActiveRepository.php

@@ -12,6 +12,9 @@
 use Cycle\Database\DatabaseInterface;
 use Cycle\ORM\EntityManagerInterface;
 use Cycle\ORM\Exception\RunnerException;
+use Cycle\ORM\Heap\HeapInterface;
+use Cycle\ORM\ORMInterface;
+use Cycle\ORM\SchemaInterface;
 use Cycle\ORM\Select\Repository;
 use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 use PHPUnit\Framework\Attributes\Test;
@@ -283,9 +286,30 @@ public function it_runs_transaction_with_orm_actions(): void
         self::assertSame($savedUserFour->name, $user4->name);
     }
 
+    #[Test]
+    public function transact_method_resolves_parameters(): void
+    {
+        $ars = User::transact(static fn(
+            SchemaInterface $schema,
+            EntityManagerInterface $em,
+            ORMInterface $orm,
+            HeapInterface $heap,
+            DatabaseInterface $dbal,
+        ): array => \func_get_args());
+
+        self::assertIsArray($ars);
+    }
+
     #[Test]
     public function query_method_returns_ActiveQuery(): void
     {
         self::assertInstanceOf(ActiveQuery::class, Identity::query());
     }
+
+    #[Test]
+    public function get_table_name(): void
+    {
+        self::assertSame('user', User::tableName());
+        self::assertSame('user_identity', Identity::tableName());
+    }
 }