Turn Document Entries into nodes

linawolf · linawolf · commit d2dc8e41fa58 · 2023-07-06T20:25:22.000Z
diff --git a/packages/guides-restructured-text/src/RestructuredText/Directives/ToctreeDirective.php b/packages/guides-restructured-text/src/RestructuredText/Directives/ToctreeDirective.php
@@ -4,8 +4,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TocNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use phpDocumentor\Guides\RestructuredText\Toc\ToctreeBuilder;
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/TopicNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/TopicNodeRenderer.php
@@ -15,8 +15,8 @@
 
 use InvalidArgumentException;
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TocNode;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\RestructuredText\Nodes\TopicNode;
 use phpDocumentor\Guides\TemplateRenderer;
diff --git a/packages/guides/src/Compiler/NodeTransformers/DocumentBlockNodeTransformer.php b/packages/guides/src/Compiler/NodeTransformers/DocumentBlockNodeTransformer.php
@@ -7,8 +7,8 @@
 use phpDocumentor\Guides\Compiler\CompilerContext;
 use phpDocumentor\Guides\Compiler\NodeTransformer;
 use phpDocumentor\Guides\Nodes\DocumentBlockNode;
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TocNode;
 
 use function array_merge;
 
diff --git a/packages/guides/src/Compiler/NodeTransformers/MenuNodeTransformer.php b/packages/guides/src/Compiler/NodeTransformers/MenuNodeTransformer.php
@@ -7,13 +7,13 @@
 use ArrayIterator;
 use phpDocumentor\Guides\Compiler\CompilerContext;
 use phpDocumentor\Guides\Compiler\NodeTransformer;
-use phpDocumentor\Guides\Meta\DocumentEntry;
 use phpDocumentor\Guides\Meta\DocumentReferenceEntry;
-use phpDocumentor\Guides\Meta\Entry as MetaEntry;
-use phpDocumentor\Guides\Meta\SectionEntry;
-use phpDocumentor\Guides\Nodes\MenuNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\Entry as MetaEntry;
+use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
+use phpDocumentor\Guides\Nodes\Menu\Entry;
+use phpDocumentor\Guides\Nodes\Menu\MenuNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TableOfContents\Entry;
 use Traversable;
 
 use function array_merge;
@@ -30,7 +30,7 @@ public function enterNode(Node $node, CompilerContext $compilerContext): Node
 
         foreach ($node->getFiles() as $file) {
             $metaEntry = $compilerContext->getProjectNode()->findDocumentEntry(ltrim($file, '/'));
-            if (!($metaEntry instanceof DocumentEntry)) {
+            if (!($metaEntry instanceof DocumentEntryNode)) {
                 continue;
             }
 
@@ -58,7 +58,7 @@ public function supports(Node $node): bool
     }
 
     /** @return iterable<Entry> */
-    private function buildFromDocumentEntry(DocumentEntry $document, int $depth, MenuNode $node, CompilerContext $compilerContext): iterable
+    private function buildFromDocumentEntry(DocumentEntryNode $document, int $depth, MenuNode $node, CompilerContext $compilerContext): iterable
     {
         if ($depth > $node->getDepth()) {
             return new ArrayIterator([]);
@@ -75,8 +75,8 @@ private function buildFromDocumentEntry(DocumentEntry $document, int $depth, Men
 
     /** @return Traversable<Entry> */
     private function buildFromSection(
-        DocumentEntry $document,
-        SectionEntry $entry,
+        DocumentEntryNode $document,
+        SectionEntryNode $entry,
         int $depth,
         MenuNode $node,
         CompilerContext $compilerContext,
@@ -93,12 +93,12 @@ private function buildFromSection(
     /** @return Traversable<Entry> */
     private function buildLevel(
         MetaEntry $child,
-        DocumentEntry $document,
+        DocumentEntryNode $document,
         int $depth,
         MenuNode $node,
         CompilerContext $compilerContext,
     ): Traversable {
-        if ($child instanceof SectionEntry) {
+        if ($child instanceof SectionEntryNode) {
             if (!$node->isPageLevelOnly() || $depth === 1) {
                 yield new Entry(
                     $document->getFile(),
@@ -113,7 +113,7 @@ private function buildLevel(
         }
 
         $subDocument = $compilerContext->getProjectNode()->findDocumentEntry($child->getFile());
-        if (!($subDocument instanceof DocumentEntry)) {
+        if (!($subDocument instanceof DocumentEntryNode)) {
             return;
         }
 
diff --git a/packages/guides/src/Compiler/Passes/MetasPass.php b/packages/guides/src/Compiler/Passes/MetasPass.php
@@ -6,13 +6,13 @@
 
 use phpDocumentor\Guides\Compiler\CompilerContext;
 use phpDocumentor\Guides\Compiler\CompilerPass;
-use phpDocumentor\Guides\Meta\DocumentEntry;
 use phpDocumentor\Guides\Meta\DocumentReferenceEntry;
-use phpDocumentor\Guides\Meta\Entry;
-use phpDocumentor\Guides\Meta\SectionEntry;
 use phpDocumentor\Guides\Nodes\DocumentNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\Entry;
+use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\SectionNode;
-use phpDocumentor\Guides\Nodes\TocNode;
 
 final class MetasPass implements CompilerPass
 {
@@ -24,7 +24,7 @@ public function run(array $documents, CompilerContext $compilerContext): array
                 continue;
             }
 
-            $entry = new DocumentEntry($document->getFilePath(), $document->getTitle());
+            $entry = new DocumentEntryNode($document->getFilePath(), $document->getTitle());
             $this->traverse($document, $entry);
             $compilerContext->getProjectNode()->addDocumentEntry($entry);
         }
@@ -41,7 +41,7 @@ private function traverse(DocumentNode|SectionNode $node, Entry $currentSection)
     {
         foreach ($node->getChildren() as $child) {
             if ($child instanceof SectionNode) {
-                $entry = new SectionEntry($child->getTitle());
+                $entry = new SectionEntryNode($child->getTitle());
                 $currentSection->addChild($entry);
                 $this->traverse($child, $entry);
             }
diff --git a/packages/guides/src/Meta/ChildEntry.php b/packages/guides/src/Meta/ChildEntry.php
diff --git a/packages/guides/src/Meta/DocumentReferenceEntry.php b/packages/guides/src/Meta/DocumentReferenceEntry.php
@@ -4,7 +4,9 @@
 
 namespace phpDocumentor\Guides\Meta;
 
-class DocumentReferenceEntry implements ChildEntry
+use phpDocumentor\Guides\Nodes\DocumentTree\Entry;
+
+class DocumentReferenceEntry implements Entry
 {
     public function __construct(private readonly string $file)
     {
@@ -15,7 +17,7 @@ public function getFile(): string
         return $this->file;
     }
 
-    public function addChild(ChildEntry $child): void
+    public function addChild(Entry $child): void
     {
         //This does not have entries
     }
diff --git a/packages/guides/src/NodeRenderers/Html/MenuEntryRenderer.php b/packages/guides/src/NodeRenderers/Html/MenuEntryRenderer.php
@@ -5,8 +5,8 @@
 namespace phpDocumentor\Guides\NodeRenderers\Html;
 
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
+use phpDocumentor\Guides\Nodes\Menu\Entry;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TableOfContents\Entry;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
diff --git a/packages/guides/src/NodeRenderers/Html/MenuNodeRenderer.php b/packages/guides/src/NodeRenderers/Html/MenuNodeRenderer.php
@@ -15,9 +15,9 @@
 
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
 use phpDocumentor\Guides\Nodes\ContentMenuNode;
-use phpDocumentor\Guides\Nodes\MenuNode;
+use phpDocumentor\Guides\Nodes\Menu\MenuNode;
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TocNode;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 use Webmozart\Assert\Assert;
diff --git a/packages/guides/src/NodeRenderers/LaTeX/TocNodeRenderer.php b/packages/guides/src/NodeRenderers/LaTeX/TocNodeRenderer.php
@@ -15,8 +15,8 @@
 
 use InvalidArgumentException;
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\TocNode;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
diff --git a/packages/guides/src/Nodes/ContentMenuNode.php b/packages/guides/src/Nodes/ContentMenuNode.php
@@ -13,6 +13,8 @@
 
 namespace phpDocumentor\Guides\Nodes;
 
+use phpDocumentor\Guides\Nodes\Menu\MenuNode;
+
 use function is_scalar;
 
 /** @link https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#table-of-contents */
diff --git a/packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php b/packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php
@@ -2,13 +2,16 @@
 
 declare(strict_types=1);
 
-namespace phpDocumentor\Guides\Meta;
+namespace phpDocumentor\Guides\Nodes\DocumentTree;
 
+use phpDocumentor\Guides\Nodes\AbstractNode;
+use phpDocumentor\Guides\Nodes\DocumentNode;
 use phpDocumentor\Guides\Nodes\TitleNode;
 
-class DocumentEntry implements Entry
+/** @extends AbstractNode<DocumentNode> */
+class DocumentEntryNode extends AbstractNode implements Entry
 {
-    /** @var ChildEntry[] */
+    /** @var Entry[] */
     private array $entries = [];
 
     public function __construct(private readonly string $file, private readonly TitleNode $titleNode)
@@ -20,7 +23,7 @@ public function getTitle(): TitleNode
         return $this->titleNode;
     }
 
-    public function addChild(ChildEntry $child): void
+    public function addChild(Entry $child): void
     {
         $this->entries[] = $child;
     }
diff --git a/packages/guides/src/Nodes/DocumentTree/Entry.php b/packages/guides/src/Nodes/DocumentTree/Entry.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace phpDocumentor\Guides\Meta;
+namespace phpDocumentor\Guides\Nodes\DocumentTree;
 
 interface Entry
 {
-    public function addChild(ChildEntry $child): void;
+    public function addChild(Entry $child): void;
 
     /** @return Entry[] */
     public function getChildren(): array;
diff --git a/packages/guides/src/Nodes/DocumentTree/SectionEntryNode.php b/packages/guides/src/Nodes/DocumentTree/SectionEntryNode.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace phpDocumentor\Guides\Meta;
+namespace phpDocumentor\Guides\Nodes\DocumentTree;
 
 use phpDocumentor\Guides\Nodes\TitleNode;
 
-class SectionEntry implements ChildEntry
+class SectionEntryNode implements Entry
 {
-    /** @var ChildEntry[] */
+    /** @var Entry[] */
     private array $children = [];
 
     public function __construct(private readonly TitleNode $title)
@@ -25,7 +25,7 @@ public function getTitle(): TitleNode
         return $this->title;
     }
 
-    public function addChild(ChildEntry $child): void
+    public function addChild(Entry $child): void
     {
         $this->children[] = $child;
     }
diff --git a/packages/guides/src/Nodes/Inline/DocReferenceNode.php b/packages/guides/src/Nodes/Inline/DocReferenceNode.php
@@ -4,7 +4,7 @@
 
 namespace phpDocumentor\Guides\Nodes\Inline;
 
-use phpDocumentor\Guides\Meta\DocumentEntry;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
 
 /**
  * Represents a link to document
@@ -22,7 +22,7 @@ class DocReferenceNode extends AbstractLinkInlineNode
     // URL can only be resolved during rendering as it contains file endings for html / latex etc
     private string $url = '';
     // Is resolved in the compiler
-    private DocumentEntry|null $documentEntry = null;
+    private DocumentEntryNode|null $documentEntry = null;
 
     public function __construct(
         string $documentLink,
@@ -72,12 +72,12 @@ public function setUrl(string $url): void
         $this->url = $url;
     }
 
-    public function getDocumentEntry(): DocumentEntry|null
+    public function getDocumentEntry(): DocumentEntryNode|null
     {
         return $this->documentEntry;
     }
 
-    public function setDocumentEntry(DocumentEntry $documentEntry): void
+    public function setDocumentEntry(DocumentEntryNode $documentEntry): void
     {
         $this->documentEntry = $documentEntry;
     }
diff --git a/packages/guides/src/Nodes/Menu/Entry.php b/packages/guides/src/Nodes/Menu/Entry.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace phpDocumentor\Guides\Nodes\TableOfContents;
+namespace phpDocumentor\Guides\Nodes\Menu;
 
 use phpDocumentor\Guides\Nodes\AbstractNode;
 use phpDocumentor\Guides\Nodes\TitleNode;
diff --git a/packages/guides/src/Nodes/Menu/MenuNode.php b/packages/guides/src/Nodes/Menu/MenuNode.php
@@ -11,9 +11,10 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Nodes;
+namespace phpDocumentor\Guides\Nodes\Menu;
 
-use phpDocumentor\Guides\Nodes\TableOfContents\Entry;
+use phpDocumentor\Guides\Nodes\CompoundNode;
+use phpDocumentor\Guides\Nodes\Node;
 
 use const PHP_INT_MAX;
 
diff --git a/packages/guides/src/Nodes/Menu/TocNode.php b/packages/guides/src/Nodes/Menu/TocNode.php
@@ -11,7 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Nodes;
+namespace phpDocumentor\Guides\Nodes\Menu;
 
 use function is_scalar;
 
diff --git a/packages/guides/src/Nodes/ProjectNode.php b/packages/guides/src/Nodes/ProjectNode.php
@@ -5,8 +5,8 @@
 namespace phpDocumentor\Guides\Nodes;
 
 use phpDocumentor\Guides\Meta\CitationTarget;
-use phpDocumentor\Guides\Meta\DocumentEntry;
 use phpDocumentor\Guides\Meta\InternalTarget;
+use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
 use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 
 use function date;
@@ -31,7 +31,7 @@ class ProjectNode extends CompoundNode
     /** @var array<string, InternalTarget> */
     private array $internalLinkTargets = [];
 
-    /** @var DocumentEntry[] */
+    /** @var DocumentEntryNode[] */
     private array $documentEntries = [];
 
     public function __construct(
@@ -103,24 +103,24 @@ public function getAllInternalTargets(): array
         return $this->internalLinkTargets;
     }
 
-    public function addDocumentEntry(DocumentEntry $documentEntry): void
+    public function addDocumentEntry(DocumentEntryNode $documentEntry): void
     {
         $this->documentEntries[$documentEntry->getFile()] = $documentEntry;
     }
 
-    /** @return DocumentEntry[] */
+    /** @return DocumentEntryNode[] */
     public function getAllDocumentEntries(): array
     {
         return $this->documentEntries;
     }
 
-    /** @param DocumentEntry[] $documentEntries */
+    /** @param DocumentEntryNode[] $documentEntries */
     public function setDocumentEntries(array $documentEntries): void
     {
         $this->documentEntries = $documentEntries;
     }
 
-    public function findDocumentEntry(string $filePath): DocumentEntry|null
+    public function findDocumentEntry(string $filePath): DocumentEntryNode|null
     {
         return $this->documentEntries[$filePath] ?? null;
     }
diff --git a/packages/guides/src/RenderContext.php b/packages/guides/src/RenderContext.php
diff --git a/packages/guides/tests/unit/Compiler/DocumentNodeTraverserTest.php b/packages/guides/tests/unit/Compiler/DocumentNodeTraverserTest.php
diff --git a/packages/guides/tests/unit/Compiler/NodeTransformers/MenuNodeTransformerTest.php b/packages/guides/tests/unit/Compiler/NodeTransformers/MenuNodeTransformerTest.php
diff --git a/packages/guides/tests/unit/Compiler/Passes/MetasPassTest.php b/packages/guides/tests/unit/Compiler/Passes/MetasPassTest.php
diff --git a/packages/guides/tests/unit/RenderContextTest.php b/packages/guides/tests/unit/RenderContextTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace phpDocumentor\Guides\Meta;`
`6`	`6`
`7`		`-class DocumentReferenceEntry implements ChildEntry`
	`7`	`+use phpDocumentor\Guides\Nodes\DocumentTree\Entry;`
	`8`	`+`
	`9`	`+class DocumentReferenceEntry implements Entry`
`8`	`10`	`{`
`9`	`11`	`public function __construct(private readonly string $file)`
`10`	`12`	`{`
`@@ -15,7 +17,7 @@ public function getFile(): string`
`15`	`17`	`return $this->file;`
`16`	`18`	`}`
`17`	`19`
`18`		`- public function addChild(ChildEntry $child): void`
	`20`	`+ public function addChild(Entry $child): void`
`19`	`21`	`{`
`20`	`22`	`//This does not have entries`
`21`	`23`	`}`