From 634b9721095104e45006fafe37fafe0476c71408 Mon Sep 17 00:00:00 2001
From: Dawid Parafinski <dawid.parafinski@ibexa.co>
Date: Thu, 31 Oct 2024 12:18:32 +0100
Subject: [PATCH] Move from helper to Repository namespace + unit tests

---
 src/bundle/Core/Resources/config/helpers.yml  |  4 -
 .../ContentService/RelationListFacade.php     | 22 +++++
 .../ContentService/RelationListFacade.php}    | 16 ++-
 .../Resources/settings/repository/inner.yml   |  6 ++
 .../ContentService/RelationListFacadeTest.php | 98 +++++++++++++++++++
 5 files changed, 132 insertions(+), 14 deletions(-)
 create mode 100644 src/contracts/Repository/ContentService/RelationListFacade.php
 rename src/lib/{Helper/RelationListHelper.php => Repository/ContentService/RelationListFacade.php} (71%)
 create mode 100644 tests/lib/Repository/ContentService/RelationListFacadeTest.php

diff --git a/src/bundle/Core/Resources/config/helpers.yml b/src/bundle/Core/Resources/config/helpers.yml
index 9f7d8ce313..1ea501e559 100644
--- a/src/bundle/Core/Resources/config/helpers.yml
+++ b/src/bundle/Core/Resources/config/helpers.yml
@@ -65,7 +65,3 @@ services:
     Ibexa\Bundle\Core\SiteAccess\Config\IOConfigResolver:
         arguments:
             $complexConfigProcessor: '@Ibexa\Bundle\Core\SiteAccess\Config\ComplexConfigProcessor'
-
-    Ibexa\Core\Helper\RelationListHelper:
-        arguments:
-            $contentService: '@ibexa.api.service.content'
diff --git a/src/contracts/Repository/ContentService/RelationListFacade.php b/src/contracts/Repository/ContentService/RelationListFacade.php
new file mode 100644
index 0000000000..16d8ebda16
--- /dev/null
+++ b/src/contracts/Repository/ContentService/RelationListFacade.php
@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\ContentService;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
+
+/**
+ * @internal
+ */
+interface RelationListFacade
+{
+    /**
+     * @return \Ibexa\Contracts\Core\Repository\Values\Content\Relation[]
+     */
+    public function getRelations(VersionInfo $versionInfo): iterable;
+}
diff --git a/src/lib/Helper/RelationListHelper.php b/src/lib/Repository/ContentService/RelationListFacade.php
similarity index 71%
rename from src/lib/Helper/RelationListHelper.php
rename to src/lib/Repository/ContentService/RelationListFacade.php
index 8bdb40045c..61fead67be 100644
--- a/src/lib/Helper/RelationListHelper.php
+++ b/src/lib/Repository/ContentService/RelationListFacade.php
@@ -6,14 +6,14 @@
  */
 declare(strict_types=1);
 
-namespace Ibexa\Core\Helper;
+namespace Ibexa\Core\Repository\ContentService;
 
 use Ibexa\Contracts\Core\Repository\ContentService;
 use Ibexa\Contracts\Core\Repository\Iterator\BatchIterator;
 use Ibexa\Contracts\Core\Repository\Iterator\BatchIteratorAdapter\RelationListIteratorAdapter;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
 
-final class RelationListHelper
+final class RelationListFacade implements ContentService\RelationListFacade
 {
     public function __construct(
         private readonly ContentService $contentService
@@ -21,9 +21,9 @@ public function __construct(
     }
 
     /**
-     * @return \Ibexa\Core\Repository\Values\Content\Relation[]
+     * @return \Ibexa\Contracts\Core\Repository\Values\Content\Relation[]
      */
-    public function getRelations(VersionInfo $versionInfo): array
+    public function getRelations(VersionInfo $versionInfo): iterable
     {
         $relationListIterator = new BatchIterator(
             new RelationListIteratorAdapter(
@@ -32,16 +32,12 @@ public function getRelations(VersionInfo $versionInfo): array
             )
         );
 
-        $relations = [];
         /** @var \Ibexa\Contracts\Core\Repository\Values\Content\RelationList\RelationListItemInterface $relationListItem */
         foreach ($relationListIterator as $relationListItem) {
             if ($relationListItem->hasRelation()) {
-                /** @var \Ibexa\Core\Repository\Values\Content\Relation $relation */
-                $relation = $relationListItem->getRelation();
-                $relations[] = $relation;
+                /** @var \Ibexa\Contracts\Core\Repository\Values\Content\Relation $relation */
+                yield $relationListItem->getRelation();
             }
         }
-
-        return $relations;
     }
 }
diff --git a/src/lib/Resources/settings/repository/inner.yml b/src/lib/Resources/settings/repository/inner.yml
index d5098b4811..7af5069fee 100644
--- a/src/lib/Resources/settings/repository/inner.yml
+++ b/src/lib/Resources/settings/repository/inner.yml
@@ -272,3 +272,9 @@ services:
 
     Ibexa\Core\Repository\Validator\TargetContentValidatorInterface:
         alias: Ibexa\Core\Repository\Validator\TargetContentValidator
+
+    Ibexa\Contracts\Core\Repository\ContentService\RelationListFacade: '@Ibexa\Core\Repository\ContentService\RelationListFacade'
+
+    Ibexa\Core\Repository\ContentService\RelationListFacade:
+        arguments:
+            $contentService: '@ibexa.api.service.content'
diff --git a/tests/lib/Repository/ContentService/RelationListFacadeTest.php b/tests/lib/Repository/ContentService/RelationListFacadeTest.php
new file mode 100644
index 0000000000..af8c7400e2
--- /dev/null
+++ b/tests/lib/Repository/ContentService/RelationListFacadeTest.php
@@ -0,0 +1,98 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\Core\Repository\ContentService;
+
+use Ibexa\Contracts\Core\Repository\ContentService;
+use Ibexa\Contracts\Core\Repository\Values\Content\Relation;
+use Ibexa\Contracts\Core\Repository\Values\Content\RelationList;
+use Ibexa\Contracts\Core\Repository\Values\Content\RelationList\RelationListItemInterface;
+use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
+use Ibexa\Core\Repository\ContentService\RelationListFacade;
+use PHPUnit\Framework\TestCase;
+
+final class RelationListFacadeTest extends TestCase
+{
+    private ContentService $contentService;
+
+    private RelationListFacade $relationListFacade;
+
+    private VersionInfo $versionInfo;
+
+    protected function setUp(): void
+    {
+        $this->contentService = $this->createMock(ContentService::class);
+        $this->versionInfo = $this->createMock(VersionInfo::class);
+        $this->relationListFacade = new RelationListFacade($this->contentService);
+    }
+
+    public function testGetRelationsReturnsEmptyIteratorWhenNoRelations(): void
+    {
+        $relationList = $this->createMock(RelationList::class);
+        $relationList->method('getIterator')
+            ->willReturn(new \ArrayIterator([]));
+
+        $this->contentService->expects(self::once())
+            ->method('loadRelationList')
+            ->with($this->versionInfo)
+            ->willReturn($relationList);
+
+        $result = iterator_to_array($this->relationListFacade->getRelations($this->versionInfo));
+
+        self::assertEmpty($result);
+    }
+
+    public function testGetRelationsIgnoresItemsWithoutRelations(): void
+    {
+        $relationListItem = $this->createMock(RelationListItemInterface::class);
+        $relationListItem
+            ->expects(self::any())
+            ->method('hasRelation')
+            ->willReturn(false);
+
+        $relationList = $this->createMock(RelationList::class);
+        $relationList->method('getIterator')
+            ->willReturn(new \ArrayIterator([$relationListItem]));
+
+        $this->contentService->expects(self::once())
+            ->method('loadRelationList')
+            ->with($this->versionInfo)
+            ->willReturn($relationList);
+
+        $result = iterator_to_array($this->relationListFacade->getRelations($this->versionInfo));
+
+        self::assertEmpty($result);
+    }
+
+    public function testGetRelationsYieldsRelationsWhenPresent(): void
+    {
+        $relation = $this->createMock(Relation::class);
+
+        $relationListItem = $this->createMock(RelationListItemInterface::class);
+        $relationListItem->expects(self::any())
+            ->method('hasRelation')
+            ->willReturn(true);
+        $relationListItem->expects(self::any())
+            ->method('getRelation')
+            ->willReturn($relation);
+
+        $relationList = $this->createMock(RelationList::class);
+        $relationList->method('getIterator')
+            ->willReturn(new \ArrayIterator([$relationListItem]));
+
+        $this->contentService->expects(self::once())
+            ->method('loadRelationList')
+            ->with($this->versionInfo)
+            ->willReturn($relationList);
+
+        $result = iterator_to_array($this->relationListFacade->getRelations($this->versionInfo));
+
+        self::assertCount(1, $result);
+        self::assertSame($relation, $result[0]);
+    }
+}