Merge pull request #726 from phpDocumentor/fix/next-node

[TASK] nextnode should not step when already set
phpDocumentor · Nov 30, 2023 · 44d0cbd · 44d0cbd
2 parents 7b48fa6 + a8fc1bb
commit 44d0cbd
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/packages/guides/src/Renderer/DocumentListIterator.php b/packages/guides/src/Renderer/DocumentListIterator.php
@@ -76,10 +76,12 @@ public function valid(): bool
 
     public function nextNode(): DocumentNode|null
     {
-        $this->innerIterator->next();
+        if ($this->nextDocument === null) {
+            $this->innerIterator->next();
 
-        if ($this->innerIterator->valid()) {
-            $this->nextDocument = WeakReference::create($this->current());
+            if ($this->innerIterator->valid()) {
+                $this->nextDocument = WeakReference::create($this->current());
+            }
         }
 
         return $this->nextDocument?->get();

diff --git a/packages/guides/tests/unit/Renderer/DocumentListIteratorTest.php b/packages/guides/tests/unit/Renderer/DocumentListIteratorTest.php
@@ -82,6 +82,24 @@ public function testPreviousStepsBackToDeepestLevelInPreviousNode(): void
         self::assertSame('1.1.2', $iterator->previousNode()?->getTitle()?->toString());
     }
 
+    public function testNextNode(): void
+    {
+        $iterator = new DocumentListIterator(
+            new DocumentTreeIterator([$this->entry1, $this->entry2], $this->randomOrderedDocuments),
+            $this->randomOrderedDocuments,
+        );
+
+        $iterator->next(); // 1
+        $iterator->next(); // 1.1
+        $iterator->next(); // 1.1.1
+        self::assertSame('2', $iterator->nextNode()?->getTitle()?->toString());
+        self::assertSame('2', $iterator->nextNode()->getTitle()->toString());
+        $iterator->next();
+        self::assertSame('2', $iterator->current()->getTitle()?->toString());
+        $iterator->next();
+        self::assertSame('2.1', $iterator->current()->getTitle()?->toString());
+    }
+
     public function testPreviousReturnsNullWhenNoPrevious(): void
     {
         $iterator = new DocumentListIterator(