Merge pull request #443 from linawolf/menu-2

Create a Document Tree and the Menus from it

Author: jaapio

Makefile

@@ -38,9 +38,20 @@ test-functional: ## Runs functional tests with phpunit/phpunit
 test-integration: ## Runs integration tests with phpunit/phpunit
 	$(PHP_BIN) vendor/bin/phpunit --testsuite=integration
 
+.PHONY: cleanup
+cleanup: cleanup-tests cleanup-build cleanup-cache
+
 .PHONY: cleanup-tests
 cleanup-tests: ## Cleans up temp directories created by test-integration
-	$(PHP_BIN) find ./tests -type d -name 'temp' -exec rm -rf {} \;
+	@find ./tests -type d -name 'temp' -exec sudo rm -rf {} \;
+
+.PHONY: cleanup-build
+cleanup-build:
+	@sudo rm -rf .build
+
+.PHONY: cleanup-cache
+cleanup-cache:
+	@sudo rm -rf .phpunit.cache
 
 .PHONY: test-architecture
 test-architecture: vendor ## Runs deptrac to enfore architecural rules

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;

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;

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

@@ -6,19 +6,12 @@
 
 use phpDocumentor\Guides\ParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\LinesIterator;
-use phpDocumentor\Guides\UrlGeneratorInterface;
 
 use function array_filter;
 use function array_map;
-use function in_array;
-use function str_contains;
 
 class ToctreeBuilder
 {
-    public function __construct(private readonly GlobSearcher $globSearcher, private readonly UrlGeneratorInterface $urlGenerator)
-    {
-    }
-
     /**
      * @param mixed[] $options
      *
@@ -32,29 +25,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;
@@ -68,10 +39,4 @@ private function parseToctreeFiles(LinesIterator $lines): array
             static fn (string $file): bool => $file !== '',
         );
     }
-
-    /** @param mixed[] $options */
-    private function isGlob(array $options, string $file): bool
-    {
-        return isset($options['glob']) && str_contains($file, '*');
-    }
 }

packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/menu-level.html.twig

@@ -1,9 +1,11 @@
 <div class="level-x">
-    {% for entry in node.entries -%}
+    {% for entry in node.menuEntries -%}
+        {% spaceless %}
         <a href="{{ renderLink(entry.url) }}"
            class="nav-link {% if entry.options.active %} active {% endif %}"
                 {% if entry.options.active %}  aria-current="page" {% endif %} >
             {{ renderNode(entry.value.value) }}
         </a>
+        {% endspaceless %}
     {% endfor %}
 </div>

packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/table-of-content.html.twig

@@ -1,9 +1,9 @@
 
 <nav class="nav flex-column">
-    {% for entry in node.entries -%}
+    {% for entry in node.menuEntries -%}
         <a href="{{ renderLink(entry.url) }}"
            class="nav-link {% if entry.options.active %} active {% endif %}"
-                {% if entry.options.active %}  aria-current="page" {% endif %} >
+                {%- if entry.options.active %}  aria-current="page" {% endif -%} >
             {{ renderNode(entry.value.value) }}
         </a>
 

packages/guides-theme-bootstrap/resources/template/body/menu/navbar/menu-level.html.twig

@@ -1,12 +1,13 @@
 <ul class="level-{{ node.level }}">
-    {% for entry in node.entries -%}
-
+    {% for entry in node.menuEntries -%}
+    {% spaceless %}
         <li class="nav-item">
             <a href="{{ renderLink(entry.url) }}"
                class="nav-link {% if entry.options.active %} active {% endif %}"
                     {% if entry.options.active %}  aria-current="page" {% endif %} >
                 {{ renderNode(entry.value.value) }}
             </a>
         </li>
-    {% endfor %}
+        {% endspaceless %}
+    {%- endfor %}
 </ul>

packages/guides-theme-bootstrap/resources/template/body/menu/navbar/table-of-content.html.twig

@@ -1,10 +1,9 @@
 
 <ul class="navbar-nav me-auto mb-2 mb-lg-0">
-    {% for entry in node.entries -%}
+    {% for entry in node.menuEntries -%}
         <li class="nav-item">
-                <a href="{{ renderLink(entry.url) }}"
-           class="nav-link {% if entry.options.active %} active {% endif %}"
-                {% if entry.options.active %}  aria-current="page" {% endif %} >
+                <a href="{{ renderLink(entry.url) }}" class="nav-link {% if entry.options.active %} active {% endif %}"
+                {%- if entry.options.active %}  aria-current="page" {% endif %} >
             {{ renderNode(entry.value.value) }}
         </a>
         </li>

packages/guides-theme-bootstrap/resources/template/body/menu/table-of-content.html.twig

@@ -4,7 +4,7 @@
     {% include "body/menu/navbar/table-of-content.html.twig" %}
 {% else %}
 <div class="toc">
-    {% for entry in node.entries -%}
+    {% for entry in node.menuEntries -%}
         {{ renderNode(entry) }}
     {% endfor %}
 </div>

packages/guides/resources/template/html/body/menu/menu-item.html.twig

@@ -1,8 +1,16 @@
 <li class="toc-item"><a href="{{ url }}">{{ renderNode(node.value.value) }}</a>
-
     {%- if node.children|length %}
-        {% include "body/menu/menu-level.html.twig" with {
-            tocItems:tocItem.children
-        } %}
+        <ul class="menu-level-{{ node.level }}">
+            {% for child in node.children -%}
+                {{ renderNode(child) }}
+            {% endfor %}
+        </ul>
+    {%- endif -%}
+    {%- if node.sections|length %}
+        <ul class="section-level-{{ node.level }}">
+            {% for subsection in node.sections -%}
+                {{ renderNode(subsection) }}
+            {% endfor %}
+        </ul>
     {%- endif -%}
 </li>