Merge pull request #1316 from wouterj/tabs-directive-to-rst-package

Move tabs/tab directive to rst package

Author: jaapio

packages/guides-restructured-text/resources/config/guides-restructured-text.php

@@ -48,7 +48,9 @@
 use phpDocumentor\Guides\RestructuredText\Directives\SeeAlsoDirective;
 use phpDocumentor\Guides\RestructuredText\Directives\SidebarDirective;
 use phpDocumentor\Guides\RestructuredText\Directives\SubDirective;
+use phpDocumentor\Guides\RestructuredText\Directives\TabDirective;
 use phpDocumentor\Guides\RestructuredText\Directives\TableDirective;
+use phpDocumentor\Guides\RestructuredText\Directives\TabsDirective;
 use phpDocumentor\Guides\RestructuredText\Directives\TestLoggerDirective;
 use phpDocumentor\Guides\RestructuredText\Directives\TipDirective;
 use phpDocumentor\Guides\RestructuredText\Directives\TitleDirective;
@@ -232,6 +234,8 @@
         ->set(TableDirective::class)
         ->set(TestLoggerDirective::class)
         ->set(TipDirective::class)
+        ->set(TabDirective::class)
+        ->set(TabsDirective::class)
         ->set(TitleDirective::class)
         ->set(ToctreeDirective::class)
         ->bind('$startingRule', service(InlineMarkupRule::class))

packages/guides-restructured-text/resources/template/html/body/directive/tab.html.twig

@@ -0,0 +1 @@
+{{ renderNode(tab.value) }}

packages/guides-restructured-text/resources/template/html/body/directive/tabs.html.twig

@@ -0,0 +1,14 @@
+<div class="tabs">
+    <ul>
+        {% for tab in node.tabs -%}
+            <li><button type="button" data-tabs="{{ node.key }}" data-target="{{ node.key }}-{{ tab.key }}" class="{{ tab.active ? 'active' }}">{{ renderNode(tab.content) }}</button></li>
+        {%- endfor %}
+    </ul>
+    <div class="tab-content" id="tab-content-{{ node.key }}">
+        {% for tab in node.tabs -%}
+            <div class="tab {{- tab.active ? ' active' }}" id="{{ node.key }}-{{ tab.key }}">
+                {{- renderNode(tab.value) -}}
+            </div>
+        {%- endfor %}
+    </div>
+</div>

packages/guides-restructured-text/src/RestructuredText/DependencyInjection/ReStructuredTextExtension.php

@@ -16,6 +16,8 @@
 use phpDocumentor\Guides\RestructuredText\DependencyInjection\Compiler\TextRolePass;
 use phpDocumentor\Guides\RestructuredText\Nodes\ConfvalNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\OptionNode;
+use phpDocumentor\Guides\RestructuredText\Nodes\TabNode;
+use phpDocumentor\Guides\RestructuredText\Nodes\TabsNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\VersionChangeNode;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -69,7 +71,8 @@ public function prepend(ContainerBuilder $container): void
                     template(VersionChangeNode::class, 'body/version-change.html.twig'),
                     template(ConfvalNode::class, 'body/directive/confval.tex.twig', 'tex'),
                     template(OptionNode::class, 'body/directive/option.html.twig'),
-
+                    template(TabNode::class, 'body/directive/tab.html.twig'),
+                    template(TabsNode::class, 'body/directive/tabs.html.twig'),
                 ],
             ],
         );

packages/guides-restructured-text/src/RestructuredText/Directives/TabDirective.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link https://phpdoc.org
+ */
+
+namespace phpDocumentor\Guides\RestructuredText\Directives;
+
+use phpDocumentor\Guides\Nodes\CollectionNode;
+use phpDocumentor\Guides\Nodes\InlineCompoundNode;
+use phpDocumentor\Guides\Nodes\Node;
+use phpDocumentor\Guides\RestructuredText\Nodes\TabNode;
+use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
+use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+
+use function class_alias;
+use function class_exists;
+use function is_string;
+use function preg_replace;
+use function str_replace;
+use function strtolower;
+
+final class TabDirective extends SubDirective
+{
+    public function getName(): string
+    {
+        return 'tab';
+    }
+
+    /** {@inheritDoc}
+     *
+     * @param Directive $directive
+     */
+    protected function processSub(
+        BlockContext $blockContext,
+        CollectionNode $collectionNode,
+        Directive $directive,
+    ): Node|null {
+        if (is_string($directive->getOption('key')->getValue())) {
+            $key = strtolower($directive->getOption('key')->getValue());
+        } else {
+            $key = strtolower($directive->getData());
+        }
+
+        $key = str_replace(' ', '-', $key);
+        $key = (string) (preg_replace('/[^a-zA-Z0-9\-_]/', '', $key));
+        $active = $directive->hasOption('active');
+
+        return new TabNode(
+            'tab',
+            $directive->getData(),
+            $directive->getDataNode() ?? new InlineCompoundNode(),
+            $key,
+            $active,
+            $collectionNode->getChildren(),
+        );
+    }
+}
+
+if (!class_exists(\phpDocumentor\Guides\Bootstrap\Directives\TabDirective::class, false)) {
+    class_alias(TabDirective::class, \phpDocumentor\Guides\Bootstrap\Directives\TabDirective::class);
+}

packages/guides-restructured-text/src/RestructuredText/Directives/TabsDirective.php

@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link https://phpdoc.org
+ */
+
+namespace phpDocumentor\Guides\RestructuredText\Directives;
+
+use phpDocumentor\Guides\Nodes\CollectionNode;
+use phpDocumentor\Guides\Nodes\InlineCompoundNode;
+use phpDocumentor\Guides\Nodes\Node;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
+use phpDocumentor\Guides\RestructuredText\Nodes\AbstractTabNode;
+use phpDocumentor\Guides\RestructuredText\Nodes\TabsNode;
+use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
+use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
+use Psr\Log\LoggerInterface;
+
+use function class_alias;
+use function class_exists;
+use function is_string;
+
+final class TabsDirective extends SubDirective
+{
+    private int $tabsCounter = 0;
+
+    /** @param Rule<CollectionNode> $startingRule */
+    public function __construct(
+        protected Rule $startingRule,
+        private readonly LoggerInterface $logger,
+        private readonly AnchorNormalizer $anchorReducer,
+    ) {
+        parent::__construct($startingRule);
+    }
+
+    public function getName(): string
+    {
+        return 'tabs';
+    }
+
+    /** {@inheritDoc}
+     *
+     * @param Directive $directive
+     */
+    protected function processSub(
+        BlockContext $blockContext,
+        CollectionNode $collectionNode,
+        Directive $directive,
+    ): Node|null {
+        $tabs = [];
+        $hasActive = false;
+        foreach ($collectionNode->getChildren() as $child) {
+            if ($child instanceof AbstractTabNode) {
+                if ($child->isActive()) {
+                    if (!$hasActive) {
+                        $hasActive = true;
+                    } else {
+                        // There may only be one active child, first wins
+                        $child->setActive(false);
+                    }
+                }
+
+                $tabs[] = $child;
+            } else {
+                $this->logger->warning(
+                    'The "tabs" directive may only contain children of type "tab". The following node was found: ' . $child::class,
+                    $blockContext->getLoggerInformation(),
+                );
+            }
+        }
+
+        if (!$hasActive && isset($tabs[0])) {
+            $tabs[0]->setActive(true);
+        }
+
+        if (is_string($directive->getOption('key')->getValue())) {
+            $key = $this->anchorReducer->reduceAnchor($directive->getOption('key')->getValue());
+        } else {
+            $this->tabsCounter++;
+            $key = 'tabs-' . $this->tabsCounter;
+        }
+
+        return new TabsNode(
+            'tabs',
+            $directive->getData(),
+            $directive->getDataNode() ?? new InlineCompoundNode(),
+            $key,
+            $tabs,
+        );
+    }
+}
+
+if (!class_exists(\phpDocumentor\Guides\Bootstrap\Directives\TabsDirective::class, false)) {
+    class_alias(TabsDirective::class, \phpDocumentor\Guides\Bootstrap\Directives\TabsDirective::class);
+}

packages/guides-restructured-text/src/RestructuredText/Nodes/AbstractTabNode.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link https://phpdoc.org
+ */
+
+namespace phpDocumentor\Guides\RestructuredText\Nodes;
+
+use phpDocumentor\Guides\Nodes\InlineCompoundNode;
+use phpDocumentor\Guides\Nodes\Node;
+
+use function class_alias;
+use function class_exists;
+
+abstract class AbstractTabNode extends GeneralDirectiveNode
+{
+    /** @param list<Node> $value */
+    public function __construct(
+        string $name,
+        string $plainContent,
+        InlineCompoundNode $content,
+        private readonly string $key,
+        private bool $active,
+        array $value = [],
+    ) {
+        parent::__construct($name, $plainContent, $content, $value);
+    }
+
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+
+    public function isActive(): bool
+    {
+        return $this->active;
+    }
+
+    public function setActive(bool $active): void
+    {
+        $this->active = $active;
+    }
+}
+
+if (!class_exists(\phpDocumentor\Guides\Bootstrap\Nodes\AbstractTabNode::class, false)) {
+    class_alias(AbstractTabNode::class, \phpDocumentor\Guides\Bootstrap\Nodes\AbstractTabNode::class);
+}

packages/guides-restructured-text/src/RestructuredText/Nodes/GeneralDirectiveNode.php

@@ -20,11 +20,12 @@
 /**
  * A catch-all directive Node containing all information about the original directive in rst.
  *
- * @extends CompoundNode<Node>
+ * @template TValue of Node = Node
+ * @extends CompoundNode<TValue>
  */
 class GeneralDirectiveNode extends CompoundNode
 {
-    /** @param list<Node> $value */
+    /** @param list<TValue> $value */
     public function __construct(
         private readonly string $name,
         private readonly string $plainContent,

packages/guides-restructured-text/src/RestructuredText/Nodes/TabNode.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link https://phpdoc.org
+ */
+
+namespace phpDocumentor\Guides\RestructuredText\Nodes;
+
+use function class_alias;
+use function class_exists;
+
+final class TabNode extends AbstractTabNode
+{
+}
+
+
+if (!class_exists(\phpDocumentor\Guides\Bootstrap\Nodes\TabNode::class, false)) {
+    class_alias(TabNode::class, \phpDocumentor\Guides\Bootstrap\Nodes\TabNode::class);
+}

packages/guides-restructured-text/src/RestructuredText/Nodes/TabsNode.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link https://phpdoc.org
+ */
+
+namespace phpDocumentor\Guides\RestructuredText\Nodes;
+
+use phpDocumentor\Guides\Nodes\InlineCompoundNode;
+
+use function class_alias;
+use function class_exists;
+
+/** @extends GeneralDirectiveNode<AbstractTabNode> */
+final class TabsNode extends GeneralDirectiveNode
+{
+    /** @param list<AbstractTabNode> $value */
+    public function __construct(
+        string $name,
+        string $plainContent,
+        InlineCompoundNode $content,
+        private readonly string $key,
+        array $value,
+    ) {
+        parent::__construct($name, $plainContent, $content, $value);
+    }
+
+    /** @return list<AbstractTabNode> */
+    public function getTabs(): array
+    {
+        return $this->getChildren();
+    }
+
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+}
+
+if (!class_exists(\phpDocumentor\Guides\Bootstrap\Nodes\TabsNode::class, false)) {
+    class_alias(TabsNode::class, \phpDocumentor\Guides\Bootstrap\Nodes\TabsNode::class);
+}