Merge pull request #16 from cycle/refactoring-facade

chore: refactor Facade, simplify exceptions range
cycle · May 4, 2024 · d8ef258 · d8ef258
2 parents c20aedb + 438f1c8
commit d8ef258
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 90 deletions.
diff --git a/infection.json.dist b/infection.json.dist
@@ -7,7 +7,7 @@
         }
     },
     "minCoveredMsi": 70,
-    "minMsi": 70,
+    "minMsi": 55,
     "phpUnit": {
         "configDir": "./"
     },

diff --git a/src/ActiveRecord.php b/src/ActiveRecord.php
@@ -10,8 +10,6 @@
 use Cycle\ORM\RepositoryInterface;
 use Cycle\ORM\Select;
 use Cycle\ORM\Transaction\StateInterface;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
 use Throwable;
 
 /**
@@ -21,9 +19,6 @@ abstract class ActiveRecord
 {
     /**
      * Finds a single record based on the given primary key.
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     final public static function find(mixed $primaryKey): ?static
     {
@@ -35,9 +30,6 @@ final public static function find(mixed $primaryKey): ?static
 
     /**
      * Finds a single record based on the given scope.
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     final public static function findOne(array $scope = []): ?static
     {
@@ -49,9 +41,6 @@ final public static function findOne(array $scope = []): ?static
 
     /**
      * Finds all records based on the given scope.
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     final public static function findAll(array $scope = []): iterable
     {
@@ -61,9 +50,6 @@ final public static function findAll(array $scope = []): iterable
     /**
      * Returns a Select query builder for the extending entity class.
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
-     *
      * @return Select<TEntity>
      */
     final public static function query(): Select
@@ -74,19 +60,11 @@ final public static function query(): Select
         return $select;
     }
 
-    /**
-     * @throws NotFoundExceptionInterface
-     * @throws ContainerExceptionInterface
-     */
     private static function getRepository(): RepositoryInterface
     {
         return self::getOrm()->getRepository(static::class);
     }
 
-    /**
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
-     */
     private static function getOrm(): ORMInterface
     {
         return Facade::getOrm();
@@ -95,8 +73,6 @@ private static function getOrm(): ORMInterface
     /**
      * Persists the current entity.
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
      */
     final public function save(bool $cascade = true): StateInterface
@@ -111,8 +87,6 @@ final public function save(bool $cascade = true): StateInterface
     /**
      * Persists the current entity and throws an exception if an error occurs.
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
      */
     final public function saveOrFail(bool $cascade = true): StateInterface
@@ -124,18 +98,12 @@ final public function saveOrFail(bool $cascade = true): StateInterface
         return $entityManager->run();
     }
 
-    /**
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
-     */
     final public function persist(bool $cascade = true): EntityManagerInterface
     {
         return Facade::getEntityManager()->persist($this, $cascade);
     }
 
     /**
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
      */
     final public function delete(bool $cascade = true): StateInterface
@@ -148,9 +116,7 @@ final public function delete(bool $cascade = true): StateInterface
     }
 
     /**
-     * @throws ContainerExceptionInterface
      * @throws Throwable
-     * @throws NotFoundExceptionInterface
      */
     final public function deleteOrFail(bool $cascade = true): StateInterface
     {
@@ -163,9 +129,6 @@ final public function deleteOrFail(bool $cascade = true): StateInterface
 
     /**
      * Prepares the current entity for deletion.
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     final public function remove(bool $cascade = true): EntityManagerInterface
     {

diff --git a/src/Facade.php b/src/Facade.php
@@ -8,10 +8,15 @@
 use Cycle\ORM\EntityManager;
 use Cycle\ORM\EntityManagerInterface;
 use Cycle\ORM\ORMInterface;
-use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
+use Throwable;
 
+use function sprintf;
+
+/**
+ * @internal
+ */
 class Facade
 {
     private static ?ORMInterface $orm = null;
@@ -29,27 +34,13 @@ public static function setOrm(ORMInterface $orm): void
     }
 
     /**
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
+     * @throws ConfigurationException
      */
     public static function getOrm(): ORMInterface
     {
-        if (null === self::$container) {
-            throw new ConfigurationException('Container has not been set. Please set the container first using setContainer() method.');
-        }
-
-        self::$orm ??= self::$container->get(ORMInterface::class);
-        if (null === self::$orm) {
-            throw new ConfigurationException('The ORM Carrier is not configured.');
-        }
-
-        return self::$orm;
+        return self::$orm ??= self::getFromContainer(ORMInterface::class);
     }
 
-    /**
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
-     */
     public static function getEntityManager(): EntityManagerInterface
     {
         return self::$entityManager ??= new EntityManager(self::getOrm());
@@ -61,4 +52,33 @@ public static function reset(): void
         self::$entityManager = null;
         self::$container = null;
     }
+
+    /**
+     * @template T of object
+     *
+     * @param class-string<T> $class
+     *
+     * @throws ConfigurationException
+     *
+     * @return T
+     */
+    private static function getFromContainer(string $class): object
+    {
+        // Check if container is set
+        null === self::$container and throw new ConfigurationException(
+            sprintf(
+                'Container has not been set. Please set the container first using %s method.',
+                self::class . '::setContainer()',
+            ),
+        );
+
+        // Pull service from container
+        try {
+            return self::$container->get($class);
+        } catch (NotFoundExceptionInterface $e) {
+            throw new ConfigurationException('Container has no ORMInterface service.', previous: $e);
+        } catch (Throwable $e) {
+            throw new ConfigurationException('Failed to get ORMInterface from container.', previous: $e);
+        }
+    }
 }
diff --git a/tests/src/ActiveRecordTest.php b/tests/src/ActiveRecordTest.php
@@ -8,8 +8,6 @@
 use Cycle\App\Entity\User;
 use Cycle\Database\DatabaseManager;
 use PHPUnit\Framework\Attributes\Test;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
 use Throwable;
 
 final class ActiveRecordTest extends DatabaseTestCase
@@ -29,9 +27,6 @@ public function tearDown(): void
 
     /**
      * @test
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     #[Test]
     public function it_finds_one_entity(): void
@@ -47,9 +42,6 @@ public function it_finds_one_entity(): void
 
     /**
      * @test
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     #[Test]
     public function it_finds_all_entities(): void
@@ -60,9 +52,6 @@ public function it_finds_all_entities(): void
 
     /**
      * @test
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     #[Test]
     public function it_finds_entity_by_primary_key(): void
@@ -78,9 +67,6 @@ public function it_finds_entity_by_primary_key(): void
 
     /**
      * @test
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     #[Test]
     public function it_uses_query_to_select_entity(): void
@@ -94,8 +80,6 @@ public function it_uses_query_to_select_entity(): void
     /**
      * @test
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
      */
     #[Test]
@@ -114,8 +98,6 @@ public function it_saves_entity(): void
     /**
      * @test
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
      */
     #[Test]
@@ -135,9 +117,7 @@ public function it_triggers_exception_when_tries_to_save_entity_using_save_or_fa
     /**
      * @test
      *
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
-     * @throws ContainerExceptionInterface
      */
     #[Test]
     public function it_persists_multiple_entities(): void
@@ -163,9 +143,7 @@ public function it_persists_multiple_entities(): void
     /**
      * @test
      *
-     * @throws NotFoundExceptionInterface
      * @throws Throwable
-     * @throws ContainerExceptionInterface
      */
     #[Test]
     public function it_deletes_entity(): void
@@ -180,8 +158,6 @@ public function it_deletes_entity(): void
     /**
      * @test
      *
-     * @throws NotFoundExceptionInterface
-     * @throws ContainerExceptionInterface
      * @throws Throwable
      */
     #[Test]

diff --git a/tests/src/FacadeTest.php b/tests/src/FacadeTest.php
@@ -8,9 +8,9 @@
 use Cycle\ActiveRecord\Facade;
 use Cycle\ORM\EntityManager;
 use Cycle\ORM\ORMInterface;
+use Exception as CoreException;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\Exception;
-use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
 
@@ -39,9 +39,6 @@ protected function tearDown(): void
 
     /**
      * @test
-     *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     #[Test]
     public function it_fails_to_get_orm_from_facade_when_container_is_not_set(): void
@@ -55,8 +52,6 @@ public function it_fails_to_get_orm_from_facade_when_container_is_not_set(): voi
     /**
      * @test
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Exception
      */
     #[Test]
@@ -80,8 +75,6 @@ public function it_gets_orm_from_facade_when_container_has_orm(): void
     /**
      * @test
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      * @throws Exception
      */
     #[Test]
@@ -99,16 +92,45 @@ public function it_throws_exception_when_container_does_not_have_orm(): void
 
         // Assert that an exception is thrown when the ORM is requested but not available
         $this->expectException(ConfigurationException::class);
-        $this->expectExceptionMessage('The ORM Carrier is not configured.');
+        $this->expectExceptionMessage('Failed to get ORMInterface from container.');
 
         Facade::getOrm();
     }
 
     /**
      * @test
      *
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
+     * @throws Exception
+     */
+    #[Test]
+    public function it_throws_exception_when_container_does_not_have_orm_set(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+        $exception = new class() extends CoreException implements NotFoundExceptionInterface {};
+
+        $container
+            ->expects($this::once())
+            ->method('get')
+            ->with(ORMInterface::class)
+            ->willThrowException($exception);
+
+        Facade::setContainer($container);
+
+        // Assert that an exception is thrown when the ORM is requested but not available
+        $this->expectException(ConfigurationException::class);
+        $this->expectExceptionMessage('Container has no ORMInterface service.');
+
+        try {
+            Facade::getOrm();
+        } catch (ConfigurationException $e) {
+            $this::assertSame($exception, $e->getPrevious());
+            throw $e;
+        }
+    }
+
+    /**
+     * @test
+     *
      * @throws Exception
      */
     #[Test]