Register Document Entries

Author: linawolf

packages/guides-restructured-text/src/RestructuredText/Toc/ToctreeBuilder.php

@@ -32,29 +32,7 @@ public function buildToctreeFiles(
         $toctreeFiles = [];
 
         foreach ($this->parseToctreeFiles($lines) as $file) {
-            if ($this->isGlob($options, $file)) {
-                $globPattern = $file;
-
-                $globFiles = $this->globSearcher
-                    ->globSearch($parserContext, $globPattern);
-
-                foreach ($globFiles as $globFile) {
-                    // if glob finds a file already explicitly defined
-                    // don't duplicate it in the toctree again
-                    if (in_array($globFile, $toctreeFiles, true)) {
-                        continue;
-                    }
-
-                    $toctreeFiles[] = $globFile;
-                }
-            } else {
-                $absoluteUrl = $this->urlGenerator->absoluteUrl(
-                    $parserContext->getDirName(),
-                    $file,
-                );
-
-                $toctreeFiles[] = $absoluteUrl;
-            }
+            $toctreeFiles[] = $file;
         }
 
         return $toctreeFiles;

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

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Compiler\NodeTransformers;
+
+use phpDocumentor\Guides\Compiler\CompilerContext;
+use phpDocumentor\Guides\Compiler\NodeTransformer;
+use phpDocumentor\Guides\Nodes\DocumentNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\Node;
+use phpDocumentor\Guides\Nodes\TitleNode;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @implements NodeTransformer<Node>
+ *
+ */
+class DocumentEntryRegistrationTransformer implements NodeTransformer
+{
+    public function __construct(
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+
+    public function enterNode(Node $node, CompilerContext $compilerContext): Node
+    {
+        return $node;
+    }
+
+    public function leaveNode(Node $node, CompilerContext $compilerContext): Node|null
+    {
+        if (!$node instanceof DocumentNode) {
+            return $node;
+        }
+
+        if ($node->getTitle() === null) {
+            $this->logger->warning('Document has not title', $node->getLoggerInformation());
+        }
+
+        $entry = new DocumentEntryNode($node->getFilePath(), $node->getTitle()??TitleNode::emptyNode());
+        $compilerContext->getProjectNode()->addDocumentEntry($entry);
+
+        return $node->withDocumentEntry($entry);
+    }
+
+    public function supports(Node $node): bool
+    {
+        return $node instanceof DocumentNode;
+    }
+
+    public function getPriority(): int
+    {
+        // Before MenuNodeTransformer
+        return 5000;
+    }
+}

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

@@ -1,3 +1,4 @@
+
 <?php
 
 declare(strict_types=1);

packages/guides/src/Compiler/Passes/MetasPass.php

@@ -14,6 +14,8 @@
 namespace phpDocumentor\Guides\Nodes;
 
 use phpDocumentor\Guides\Meta\FootnoteTarget;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
 use phpDocumentor\Guides\Nodes\Metadata\MetadataNode;
 
 use function array_filter;
@@ -61,6 +63,8 @@ final class DocumentNode extends CompoundNode
     private bool $titleFound = false;
 
     private string|null $metaTitle = null;
+    private DocumentEntryNode|null $documentEntry = null;
+    private SectionEntryNode|null $rootSectionEntry = null;
 
     public function __construct(
         private readonly string $hash,
@@ -240,4 +244,29 @@ public function getFootnoteTargetAnonymous(): FootnoteTarget|null
 
         return null;
     }
+    public function getDocumentEntry(): DocumentEntryNode|null
+    {
+        return $this->documentEntry;
+    }
+
+    public function withDocumentEntry(DocumentEntryNode $documentEntry): DocumentNode
+    {
+        $node = clone($this);
+        $node->documentEntry = $documentEntry;
+        return $node;
+    }
+
+    /**
+     * @return SectionEntryNode|null
+     */
+    public function getRootSectionEntry(): ?SectionEntryNode
+    {
+        return $this->rootSectionEntry;
+    }
+
+    public function setRootSectionEntry(?SectionEntryNode $rootSectionEntry): void
+    {
+        $this->rootSectionEntry = $rootSectionEntry;
+    }
+
 }

packages/guides/src/Nodes/DocumentNode.php

@@ -27,7 +27,7 @@ public function __construct(InlineCompoundNode $value, protected int $level, pro
 
     public static function emptyNode(): self
     {
-        return new TitleNode(new InlineCompoundNode([new PlainTextInlineNode('<Unknown>')]), 0, '');
+        return new TitleNode(new InlineCompoundNode([new PlainTextInlineNode('<Unknown>')]), 1, '');
     }
 
     public function getLevel(): int

packages/guides/src/Nodes/TitleNode.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace phpDocumentor\Guides\Compiler\NodeTransformers;
+
+use Monolog\Logger;
+use phpDocumentor\Guides\Compiler\CompilerContext;
+use phpDocumentor\Guides\Nodes\ClassNode;
+use phpDocumentor\Guides\Nodes\DocumentNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\ProjectNode;
+use phpDocumentor\Guides\Nodes\SectionNode;
+use phpDocumentor\Guides\Nodes\TitleNode;
+use PHPUnit\Framework\MockObject\Invocation;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class DocumentEntryRegistrationTransformerTest 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());
+
+        return $context->withShadowTree(new DocumentNode('123', $path));
+    }
+
+    public function testLeaveNodeWillReturnDocumentNodeWithEntry(): void
+    {
+        $node = new DocumentNode('', '');
+        $node->setValue([new SectionNode(TitleNode::emptyNode())]);
+        $mockLogger = $this->createMock(LoggerInterface::class);
+        $mockLogger->expects($this->never())->method('warning');
+        $mockLogger->expects($this->never())->method('error');
+
+        $transformer = new DocumentEntryRegistrationTransformer($mockLogger);
+
+        $result = $transformer->leaveNode($node, $this->context);
+        self::assertInstanceOf(DocumentNode::class, $result);
+        self::assertInstanceOf(DocumentEntryNode::class, $result->getDocumentEntry());
+    }
+
+    public function testDocumentWithoutTitleCausesWarning(): void
+    {
+        $node = new DocumentNode('', '');
+        $mockLogger = $this->createMock(LoggerInterface::class);
+        $mockLogger->expects($this->once())->method('warning');
+
+        $transformer = new DocumentEntryRegistrationTransformer($mockLogger);
+
+        $result = $transformer->leaveNode($node, $this->context);
+        self::assertInstanceOf(DocumentNode::class, $result);
+        self::assertInstanceOf(DocumentEntryNode::class, $result->getDocumentEntry());
+    }
+}