Merge pull request #22 from dmaicher/remove_if_no_childs

add Node::setRemoveIfNoChildren
dmaicher · May 20, 2021 · 7b7dec0 · 7b7dec0
2 parents bd2c7ad + 648096d
commit 7b7dec0
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 3 deletions.
diff --git a/src/Node/Node.php b/src/Node/Node.php
@@ -74,6 +74,11 @@ class Node
      */
     protected $ifTrue = null;
 
+    /**
+     * @var bool
+     */
+    protected $removeIfNoChildren = false;
+
     /**
      * @param null $label
      */
@@ -476,4 +481,19 @@ public function hasUrl()
     {
         return $this->url !== null;
     }
+
+    public function isRemoveIfNoChildren(): bool
+    {
+        return $this->removeIfNoChildren;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setRemoveIfNoChildren(bool $removeIfNoChildren): self
+    {
+        $this->removeIfNoChildren = $removeIfNoChildren;
+
+        return $this;
+    }
 }
diff --git a/src/NodeVisitor/NodeFilter.php b/src/NodeVisitor/NodeFilter.php
@@ -37,10 +37,23 @@ public function visit(Node $node)
     {
         foreach ($node->getRequiredPermissions() as $permission) {
             if (!$this->tokenStorage->getToken() || !$this->authChecker->isGranted($permission)) {
-                $node->getParent()->removeChild($node);
+                $this->removeNode($node);
 
                 return MenuTreeTraverserInterface::STOP_TRAVERSAL;
             }
         }
     }
+
+    private function removeNode(Node $node): void
+    {
+        $parentNode = $node->getParent();
+        $parentNode->removeChild($node);
+
+        if (!$parentNode->isRootNode()
+            && $parentNode->isRemoveIfNoChildren()
+            && count($parentNode->getChildren()) === 0
+        ) {
+            $parentNode->getParent()->removeChild($parentNode);
+        }
+    }
 }
diff --git a/tests/NodeVisitor/NodeFilterTest.php b/tests/NodeVisitor/NodeFilterTest.php
@@ -4,6 +4,7 @@
 
 use DAMA\MenuBundle\MenuTree\MenuTreeTraverserInterface;
 use DAMA\MenuBundle\Node\Node;
+use DAMA\MenuBundle\Node\NodeFactory;
 use DAMA\MenuBundle\NodeVisitor\NodeFilter;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -19,12 +20,12 @@ class NodeFilterTest extends TestCase
     private $filter;
 
     /**
-     * @var TokenStorageInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var TokenStorageInterface|MockObject
      */
     private $tokenStorage;
 
     /**
-     * @var AuthorizationCheckerInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var AuthorizationCheckerInterface|MockObject
      */
     private $authChecker;
 
@@ -82,6 +83,39 @@ public function testVisit(array $permissions, $getTokenReturn, $isGrantedReturn,
         }
     }
 
+    /**
+     * @testWith [true]
+     *           [false]
+     */
+    public function testRemoveParentIfNoActiveChildren(bool $remove): void
+    {
+        $tree = (new NodeFactory())->create();
+        $tree
+            ->child('foo')
+                ->setRemoveIfNoChildren($remove)
+                ->child('bar')
+                    ->setRequiredPermissions(['foo'])
+                ->end()
+            ->end()
+        ;
+
+        $this->tokenStorage
+            ->expects($this->any())
+            ->method('getToken')
+            ->will($this->returnValue(null))
+        ;
+
+        $children = $tree->getChildren();
+        $foo = reset($children);
+        $this->filter->visit($foo);
+        $this->assertCount(1, $tree->getChildren());
+
+        $children = $foo->getChildren();
+        $bar = reset($children);
+        $this->filter->visit($bar);
+        $this->assertCount($remove ? 0 : 1, $tree->getChildren());
+    }
+
     public function getTestData()
     {
         return [