Register Section Entries

Author: linawolf

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

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Compiler\NodeTransformers;
+
+use phpDocumentor\Guides\Compiler\CompilerContext;
+use phpDocumentor\Guides\Compiler\NodeTransformer;
+use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
+use phpDocumentor\Guides\Nodes\Node;
+use phpDocumentor\Guides\Nodes\SectionNode;
+
+use function array_pop;
+use function assert;
+use function end;
+use function sizeof;
+
+/** @implements NodeTransformer<Node> */
+class SectionEntryRegistrationTransformer implements NodeTransformer
+{
+    /** @var SectionEntryNode $sectionStack */
+    private array $sectionStack = [];
+
+    public function enterNode(Node $node, CompilerContext $compilerContext): Node
+    {
+        if (!$node instanceof SectionNode) {
+            return $node;
+        }
+
+        $sectionEntryNode = new SectionEntryNode($node->getTitle());
+        if (sizeof($this->sectionStack) === 0) {
+            $compilerContext->getDocumentNode()->getDocumentEntry()->addSection($sectionEntryNode);
+        } else {
+            $parentSection = end($this->sectionStack);
+            assert($parentSection instanceof SectionEntryNode);
+            $parentSection->addChild($sectionEntryNode);
+        }
+
+        $this->sectionStack[] = $sectionEntryNode;
+
+        return $node;
+    }
+
+    public function leaveNode(Node $node, CompilerContext $compilerContext): Node|null
+    {
+        if (!$node instanceof SectionNode) {
+            return $node;
+        }
+
+        array_pop($this->sectionStack);
+
+        return $node;
+    }
+
+    public function supports(Node $node): bool
+    {
+        return $node instanceof SectionNode;
+    }
+
+    public function getPriority(): int
+    {
+        // After DocumentEntryRegistrationTransformer
+        return 4900;
+    }
+}

packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php

@@ -13,6 +13,8 @@ class DocumentEntryNode extends AbstractNode implements Entry
 {
     /** @var Entry[] */
     private array $entries = [];
+    /** @var SectionEntryNode[]  */
+    private array $sections = [];
     private DocumentEntryNode|null $parent = null;
 
     public function __construct(private readonly string $file, private readonly TitleNode $titleNode)
@@ -45,6 +47,17 @@ public function setParent(DocumentEntryNode|null $parent): void
         $this->parent = $parent;
     }
 
+    /** @return SectionEntryNode[] */
+    public function getSections(): array
+    {
+        return $this->sections;
+    }
+
+    public function addSection(SectionEntryNode $section): void
+    {
+        $this->sections[] = $section;
+    }
+
     public function getFile(): string
     {
         return $this->file;

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

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Compiler\NodeTransformers;
+
+use phpDocumentor\Guides\Compiler\CompilerContext;
+use phpDocumentor\Guides\Nodes\DocumentNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
+use phpDocumentor\Guides\Nodes\ProjectNode;
+use phpDocumentor\Guides\Nodes\SectionNode;
+use phpDocumentor\Guides\Nodes\TitleNode;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class SectionEntryRegistrationTransformerTest extends TestCase
+{
+    private CompilerContext $context;
+
+    protected function setUp(): void
+    {
+        $this->context = self::getCompilerContext('some/path');
+    }
+
+    private static function getCompilerContext(string $path): CompilerContext
+    {
+        $context = new CompilerContext(new ProjectNode());
+        $document = new DocumentNode('123', $path);
+        $document = $document->withDocumentEntry(new DocumentEntryNode($path, TitleNode::emptyNode()));
+
+        return $context->withShadowTree($document);
+    }
+
+    public function testSectionGetsRegistered(): void
+    {
+        $node = new SectionNode(TitleNode::emptyNode());
+
+        $transformer = new SectionEntryRegistrationTransformer();
+
+        $transformer->enterNode($node, $this->context);
+        $transformer->leaveNode($node, $this->context);
+        self::assertCount(1, $this->context->getDocumentNode()->getDocumentEntry()->getSections());
+        self::assertInstanceOf(SectionEntryNode::class, $this->context->getDocumentNode()->getDocumentEntry()->getSections()[0]);
+    }
+}