Fix tests to pass

Author: jaapio

packages/guides/src/Compiler/NodeTransformers/CollectLinkTargetsTransformer.php

@@ -14,6 +14,8 @@
 use SplStack;
 use Webmozart\Assert\Assert;
 
+use function assert;
+
 /** @implements NodeTransformer<DocumentNode|AnchorNode> */
 final class CollectLinkTargetsTransformer implements NodeTransformer
 {
@@ -36,12 +38,16 @@ public function enterNode(Node $node, CompilerContext $compilerContext): Node
             $this->documentStack->push($node);
         } elseif ($node instanceof AnchorNode) {
             $currentDocument = $compilerContext->getDocumentNode();
-            $parentSection = $compilerContext->getShadowTree()->getParent()->getNode();
+            $parentSection = $compilerContext->getShadowTree()->getParent()?->getNode();
             assert($parentSection instanceof SectionNode);
 
             $compilerContext->getProjectNode()->addLinkTarget(
                 $node->toString(),
-                new InternalTarget($currentDocument->getFilePath(), $node->toString()),
+                new InternalTarget(
+                    $currentDocument->getFilePath(),
+                    $node->toString(),
+                    $parentSection->getTitle()->toString(),
+                ),
             );
         } elseif ($node instanceof SectionNode) {
             $currentDocument = $this->documentStack->top();

packages/guides/src/Compiler/NodeTransformers/MoveAnchorTransformer.php

@@ -35,6 +35,10 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
 
         $this->seen[spl_object_hash($node)] = spl_object_hash($node);
         $parent = $compilerContext->getShadowTree()->getParent();
+        if ($parent === null) {
+            throw new LogicException('Node not found in shadow tree');
+        }
+
         $position = $parent->findPosition($node);
         if ($position === null) {
             throw new LogicException('Node not found in shadow tree');

packages/guides/src/Nodes/CompoundNode.php

@@ -40,6 +40,7 @@ public function addChildNode(Node $node): void
         $this->value[] = $node;
     }
 
+    /** @param TValue $node */
     public function pushChildNode(Node $node): void
     {
         array_unshift($this->value, $node);

packages/guides/tests/unit/Compiler/NodeTransformers/MoveAnchorTransformerTest.php

@@ -24,6 +24,7 @@ protected function setUp(): void
             /** @return iterable<MoveAnchorTransformer> */
             public function getTransformers(): iterable
             {
+                //phpstan:ignore-next-line
                 yield new MoveAnchorTransformer();
             }
 
@@ -98,12 +99,11 @@ public function testAnchorShouldNotBeMovedTwice(): void
 
         self::assertCount(1, $context->getDocumentNode()->getChildren());
         $updatedSection = $context->getDocumentNode()->getChildren()[0];
-
-        self::assertCount(2, $updatedSection->getChildren());
-        self::assertEquals([$node1, $subSection], $context->getDocumentNode()->getChildren()[0]->getChildren());
-
+        self::assertInstanceOf(SectionNode::class, $updatedSection);
+        self::assertEquals([$node1, $subSection], $updatedSection->getChildren());
         $updatedSubSection = $updatedSection->getChildren()[1];
-        self::assertCount(1, $updatedSubSection->getChildren());
+        self::assertInstanceOf(SectionNode::class, $updatedSubSection);
+        self::assertEquals([new AnchorNode('bar')], $updatedSubSection->getChildren());
     }
 
     public function testNoMoveWhenAnchorIsOnlyChild(): void
@@ -140,8 +140,11 @@ public function testMoveAnchorsAtTheEndOfSectionToNextSection(): void
         $this->documentNodeTraverser->traverse($document, $context);
 
         self::assertCount(2, $context->getDocumentNode()->getChildren());
-        self::assertCount(0, $context->getDocumentNode()->getChildren()[0]->getChildren());
-        self::assertCount(2, $context->getDocumentNode()->getChildren()[1]->getChildren());
+        [$firstChild, $secondChild] = $context->getDocumentNode()->getChildren();
+        self::assertInstanceOf(SectionNode::class, $firstChild);
+        self::assertInstanceOf(SectionNode::class, $secondChild);
+        self::assertCount(0, $firstChild->getChildren());
+        self::assertCount(2, $secondChild->getChildren());
     }
 
     public function testMoveAnchorsAtTheEndOfSectionToNextParentNeighbourSection(): void
@@ -165,7 +168,10 @@ public function testMoveAnchorsAtTheEndOfSectionToNextParentNeighbourSection():
         $this->documentNodeTraverser->traverse($document, $context);
 
         self::assertCount(2, $context->getDocumentNode()->getChildren());
-        self::assertCount(1, $context->getDocumentNode()->getChildren()[0]->getChildren());
-        self::assertCount(2, $context->getDocumentNode()->getChildren()[1]->getChildren());
+        [$firstChild, $secondChild] = $context->getDocumentNode()->getChildren();
+        self::assertInstanceOf(SectionNode::class, $firstChild);
+        self::assertInstanceOf(SectionNode::class, $secondChild);
+        self::assertCount(1, $firstChild->getChildren());
+        self::assertCount(2, $secondChild->getChildren());
     }
 }

phpstan.neon

@@ -24,6 +24,10 @@ parameters:
         - packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/TextRoleRule.php
         - packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/VariableInlineRule.php
 
+    -
+       message: '#^Return type \(iterable<phpDocumentor\\Guides\\Compiler\\NodeTransformers\\MoveAnchorTransformer>\) of method class@anonymous\/guides\/tests\/unit\/Compiler\/.*#'
+       paths:
+         - packages/guides/tests/unit/Compiler/NodeTransformers/MoveAnchorTransformerTest.php
   paths:
     - packages/guides/src
     - packages/guides-markdown/src

tests/Integration/tests/anchor-ref-title-equals-title/expected/overview.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Overview</title>
+</head>
+<body>
+<div class="section" id="overview">
+    <h1>Overview</h1>
+    <div class="section" id="overview-1">
+        <h2>Overview 1</h2>
+        <a id="rst-overview"></a>
+        <p>RST Overview content</p>
+    </div>
+    <div class="section" id="overview-2">
+        <h2>Overview 2</h2>
+        <a id="sphinx-overview"></a>
+        <p>Sphinx Overview content</p>
+    </div>
+</div>
+</body>
+</html>

tests/Integration/tests/anchor-to-page/expected/objects.inv.json

@@ -26,6 +26,12 @@
             "index.html#page",
             "Page"
         ],
+        "overview": [
+        null,
+        null,
+        "sphinx-overview.html#overview",
+        "Overview"
+        ],
         "rst-overview": [
             null,
             null,
@@ -39,4 +45,4 @@
             "Overview"
         ]
     }
-}
+}

tests/Integration/tests/inventory_ref_json/expected/objects.inv.json

@@ -38,12 +38,24 @@
         ]
     },
     "std:label": {
+        "document-title": [
+            "My Project",
+            "3.1.4",
+            "index.html#document-title",
+            "Document Title"
+        ],
         "my_index": [
             "My Project",
             "3.1.4",
             "index.html#my_index",
             "Document Title"
         ],
+        "page-1": [
+        "My Project",
+        "3.1.4",
+        "page1.html#page-1",
+        "Page 1"
+        ],
         "my_cool_page": [
             "My Project",
             "3.1.4",
@@ -62,6 +74,12 @@
             "subfolder\/index.html#subfolder-index",
             "Subfolder Index"
         ],
+        "subpage-1": [
+        "My Project",
+        "3.1.4",
+        "subfolder\/subpage1.html#subpage-1",
+        "Subpage 1"
+        ],
         "another_cool_page": [
             "My Project",
             "3.1.4",
@@ -75,4 +93,4 @@
             "Subpage 2"
         ]
     }
-}
+}

tests/Integration/tests/references/expected/index.html

@@ -14,7 +14,7 @@ <h1>Overview</h1>
     <a id="Other Overview"></a>
             <p>Other Overview content</p>
             <p>This is a link to the RST Overview: <a href="/index.html#RST Overview">alternative</a></p>
-            <p>This is a link to the Other Overview: <a href="/index.html#Other Overview">Other Overview</a></p>
+            <p>This is a link to the Other Overview: <a href="/index.html#Other Overview">Overview</a></p>
             <p>This is a link to <a href="/page.html">Page 1</a>
 This is a link to with alternative text <a href="/page.html">alternative</a></p>
     </div>