IBX-10221: Replaced IsContentStructureRoot with IsInContextualTreeRootIds specification and added corresponding tests

Author: tbialcz

src/lib/Menu/ContentRightSidebarBuilder.php

@@ -12,7 +12,7 @@
 use Ibexa\AdminUi\Siteaccess\SiteaccessResolverInterface;
 use Ibexa\AdminUi\Specification\ContentType\ContentTypeIsUser;
 use Ibexa\AdminUi\Specification\ContentType\ContentTypeIsUserGroup;
-use Ibexa\AdminUi\Specification\Location\IsContentStructureRoot;
+use Ibexa\AdminUi\Specification\Location\IsInContextualTreeRootIds;
 use Ibexa\AdminUi\Specification\Location\IsRoot;
 use Ibexa\AdminUi\Specification\Location\IsWithinCopySubtreeLimit;
 use Ibexa\AdminUi\UniversalDiscovery\ConfigResolver;
@@ -295,9 +295,9 @@ public function createStructure(array $options): ItemInterface
         }
 
         $isAtRootLevel = (new IsRoot())->isSatisfiedBy($location);
-        $isContentStructureRoot = (new IsContentStructureRoot($this->configResolver))->isSatisfiedBy($location);
+        $isInContextualRootIds = (new IsInContextualTreeRootIds($this->configResolver))->isSatisfiedBy($location);
 
-        if (!$contentIsUser && !$isAtRootLevel && !$isContentStructureRoot && $canTrashLocation) {
+        if (!$contentIsUser && !$isAtRootLevel && !$isInContextualRootIds && $canTrashLocation) {
             $menu->addChild(
                 $this->createMenuItem(
                     self::ITEM__SEND_TO_TRASH,
@@ -309,7 +309,7 @@ public function createStructure(array $options): ItemInterface
             );
         }
 
-        if ($isAtRootLevel || $isContentStructureRoot) {
+        if ($isAtRootLevel || $isInContextualRootIds) {
             $menu[self::ITEM__MOVE]->setAttribute('disabled', 'disabled');
         }
 

src/lib/Specification/Location/IsContentStructureRoot.php

@@ -25,6 +25,6 @@ public function __construct(ConfigResolverInterface $configResolver)
      */
     public function isSatisfiedBy($item): bool
     {
-        return $item->getDepth() === (int)$this->configResolver->getParameter('location_ids.content_structure');
+        return $item->getId() === (int)$this->configResolver->getParameter('location_ids.content_structure');
     }
 }

src/lib/Specification/Location/IsInContextualTreeRootIds.php

@@ -0,0 +1,34 @@
+<?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\AdminUi\Specification\Location;
+
+use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
+use Ibexa\Contracts\Core\Specification\AbstractSpecification;
+
+final class IsInContextualTreeRootIds extends AbstractSpecification
+{
+    private ConfigResolverInterface $configResolver;
+
+    public function __construct(ConfigResolverInterface $configResolver)
+    {
+        $this->configResolver = $configResolver;
+    }
+
+    /**
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Location $item
+     */
+    public function isSatisfiedBy($item): bool
+    {
+        $contextualRootIds = $this->configResolver->getParameter(
+            'content_tree_module.contextual_tree_root_location_ids'
+        );
+
+        return in_array($item->getId(), $contextualRootIds, true);
+    }
+}

tests/lib/Specification/Location/IsContentStructureRootTest.php

@@ -20,14 +20,14 @@ final class IsContentStructureRootTest extends TestCase
      */
     public function testReturnsTrueWhenLocationDepthMatchesRoot(): void
     {
-        $depth = 1;
+        $id = 1;
 
         $specification = new IsContentStructureRoot(
-            $this->createConfigResolverReturning($depth)
+            $this->createConfigResolverReturning($id)
         );
 
         self::assertTrue(
-            $specification->isSatisfiedBy($this->createLocationWithDepth($depth))
+            $specification->isSatisfiedBy($this->createLocationWithId($id))
         );
     }
 
@@ -41,25 +41,25 @@ public function testReturnsFalseWhenLocationDepthDoesNotMatchRoot(): void
         );
 
         self::assertFalse(
-            $specification->isSatisfiedBy($this->createLocationWithDepth(3))
+            $specification->isSatisfiedBy($this->createLocationWithId(3))
         );
     }
 
-    private function createLocationWithDepth(int $depth): Location
+    private function createLocationWithId(int $id): Location
     {
         $location = $this->createMock(Location::class);
-        $location->method('getDepth')->willReturn($depth);
+        $location->method('getId')->willReturn($id);
 
         return $location;
     }
 
-    private function createConfigResolverReturning(int $depth): ConfigResolverInterface
+    private function createConfigResolverReturning(int $id): ConfigResolverInterface
     {
         $configResolver = $this->createMock(ConfigResolverInterface::class);
         $configResolver
             ->method('getParameter')
             ->with('location_ids.content_structure')
-            ->willReturn($depth);
+            ->willReturn($id);
 
         return $configResolver;
     }

tests/lib/Specification/Location/IsInContextualTreeRootIdsTest.php

@@ -0,0 +1,66 @@
+<?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\AdminUi\Specification\Location;
+
+use Ibexa\AdminUi\Specification\Location\IsInContextualTreeRootIds;
+use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
+use PHPUnit\Framework\TestCase;
+
+final class IsInContextualTreeRootIdsTest extends TestCase
+{
+    private const CONTEXTUAL_ROOT_IDS = [2, 5, 43, 55, 56, 67];
+
+    /**
+     * @covers \Ibexa\AdminUi\Specification\Location\IsInContextualTreeRootIds::isSatisfiedBy
+     */
+    public function testReturnsTrueWhenLocationIdIsInContextualRootList(): void
+    {
+        $specification = new IsInContextualTreeRootIds(
+            $this->createConfigResolverReturning()
+        );
+
+        self::assertTrue(
+            $specification->isSatisfiedBy($this->createLocationWithId(43))
+        );
+    }
+
+    /**
+     * @covers \Ibexa\AdminUi\Specification\Location\IsInContextualTreeRootIds::isSatisfiedBy
+     */
+    public function testReturnsFalseWhenLocationIdIsNotInContextualRootList(): void
+    {
+        $specification = new IsInContextualTreeRootIds(
+            $this->createConfigResolverReturning()
+        );
+
+        self::assertFalse(
+            $specification->isSatisfiedBy($this->createLocationWithId(999))
+        );
+    }
+
+    private function createLocationWithId(int $id): Location
+    {
+        $location = $this->createMock(Location::class);
+        $location->method('getId')->willReturn($id);
+
+        return $location;
+    }
+
+    private function createConfigResolverReturning(): ConfigResolverInterface
+    {
+        $configResolver = $this->createMock(ConfigResolverInterface::class);
+        $configResolver
+            ->method('getParameter')
+            ->with('content_tree_module.contextual_tree_root_location_ids')
+            ->willReturn(self::CONTEXTUAL_ROOT_IDS);
+
+        return $configResolver;
+    }
+}