[FEATURE] Introduce php case and backed enums

TYPO3-Documentation · Dec 12, 2023 · a5e56fc · a5e56fc
1 parent d28541f
commit a5e56fc
Show file tree

Hide file tree

Showing 16 changed files with 345 additions and 4 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -2,7 +2,7 @@ parameters:
 	ignoreErrors:
 		-
 			message: "#^Function phpDocumentor\\\\Guides\\\\DependencyInjection\\\\template not found\\.$#"
-			count: 10
+			count: 11
 			path: src/DependencyInjection/GuidesPhpDomainExtension.php
 
 		-

diff --git a/resources/config/php-domain.php b/resources/config/php-domain.php
@@ -7,6 +7,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\DirectiveContentRule;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
+use T3Docs\GuidesPhpDomain\Directives\Php\CaseDirective;
 use T3Docs\GuidesPhpDomain\Directives\Php\ClassDirective;
 use T3Docs\GuidesPhpDomain\Directives\Php\ConstDirective;
 use T3Docs\GuidesPhpDomain\Directives\Php\ExceptionDirective;
@@ -35,7 +36,7 @@
         ->bind('$startingRule', service(DirectiveContentRule::class))
         ->instanceof(BaseDirective::class)
         ->tag('phpdoc.guides.directive')
-        ->set(ClassDirective::class)
+        ->set(CaseDirective::class)
         ->set(ClassDirective::class)
         ->set(ConstDirective::class)
         ->set(EnumDirective::class)

diff --git a/resources/template/html/body/directive/php/case.html.twig b/resources/template/html/body/directive/php/case.html.twig
@@ -0,0 +1,7 @@
+<dl class="php case">
+    <dt class="sig sig-object php" id="{{ node.id }}">
+        <em class="property"><span class="pre">case</span></em>
+        {{ renderNode(node.memberName) }} : {% if node.backedValue -%}<span class="pre">{{ node.backedValue }}</span> {% endif -%}
+    </dt>
+    <dd>{{ renderNode(node.value) }}</dd>
+</dl>
diff --git a/resources/template/html/body/directive/php/component.html.twig b/resources/template/html/body/directive/php/component.html.twig
@@ -5,7 +5,7 @@
             {{- renderNode(modifier) }}{{ ' ' -}}
         {%- endfor -%}
         <em class="property"><span class="pre">{{ node.type }}</span> </em>
-        {{ renderNode(node.name) }}
+        {{ renderNode(node.name) }} {%- if node.type == 'enum' and node.phpType -%}<span class="pre"> : {{ node.phpType }}</span> {% endif -%}
     </dt>
     <dd>
         {{ renderNode(node.value) }}

diff --git a/src/DependencyInjection/GuidesPhpDomainExtension.php b/src/DependencyInjection/GuidesPhpDomainExtension.php
@@ -12,8 +12,10 @@
 use T3Docs\GuidesPhpDomain\Nodes\FullyQualifiedNameNode;
 use T3Docs\GuidesPhpDomain\Nodes\MemberNameNode;
 use T3Docs\GuidesPhpDomain\Nodes\MethodNameNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpCaseNode;
 use T3Docs\GuidesPhpDomain\Nodes\PhpComponentNode;
 use T3Docs\GuidesPhpDomain\Nodes\PhpConstNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpEnumNode;
 use T3Docs\GuidesPhpDomain\Nodes\PhpGlobalNode;
 use T3Docs\GuidesPhpDomain\Nodes\PhpMethodNode;
 use T3Docs\GuidesPhpDomain\Nodes\PhpModifierNode;
@@ -44,6 +46,7 @@ public function prepend(ContainerBuilder $container): void
                 'base_template_paths' => [dirname(__DIR__, 2) . '/resources/template/html'],
                 'templates' => [
                     template(FullyQualifiedNameNode::class, 'body/directive/php/fullyQualifiedName.html.twig'),
+                    template(PhpCaseNode::class, 'body/directive/php/case.html.twig'),
                     template(PhpComponentNode::class, 'body/directive/php/component.html.twig'),
                     template(PhpConstNode::class, 'body/directive/php/const.html.twig'),
                     template(PhpGlobalNode::class, 'body/directive/php/global.html.twig'),

diff --git a/src/Directives/Php/CaseDirective.php b/src/Directives/Php/CaseDirective.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace T3Docs\GuidesPhpDomain\Directives\Php;
+
+use phpDocumentor\Guides\Nodes\CollectionNode;
+use phpDocumentor\Guides\Nodes\Node;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\RestructuredText\Directives\SubDirective;
+use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
+use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
+use phpDocumentor\Guides\RestructuredText\TextRoles\GenericLinkProvider;
+use Psr\Log\LoggerInterface;
+use T3Docs\GuidesPhpDomain\Nodes\MemberNameNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpCaseNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpConstNode;
+use T3Docs\GuidesPhpDomain\PhpDomain\ModifierService;
+
+final class CaseDirective extends SubDirective
+{
+    public function __construct(
+        Rule $startingRule,
+        GenericLinkProvider $genericLinkProvider,
+        private readonly AnchorReducer $anchorReducer,
+    ) {
+        parent::__construct($startingRule);
+        $genericLinkProvider->addGenericLink($this->getName(), $this->getName());
+    }
+
+    public function getName(): string
+    {
+        return 'php:case';
+    }
+
+    protected function processSub(
+        BlockContext $blockContext,
+        CollectionNode $collectionNode,
+        Directive $directive,
+    ): Node|null {
+        $name = new MemberNameNode(trim($directive->getData()));
+        $id = $this->anchorReducer->reduceAnchor($name->toString());
+
+        $value = null;
+        if ($directive->hasOption('value')) {
+            $value = $directive->getOption('value')->toString();
+        }
+
+        return new PhpCaseNode(
+            $id,
+            $name,
+            $collectionNode->getChildren(),
+            $value,
+        );
+    }
+}
diff --git a/src/Directives/Php/EnumDirective.php b/src/Directives/Php/EnumDirective.php
@@ -12,6 +12,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 use phpDocumentor\Guides\RestructuredText\TextRoles\GenericLinkProvider;
+use Psr\Log\LoggerInterface;
 use T3Docs\GuidesPhpDomain\Nodes\PhpEnumNode;
 use T3Docs\GuidesPhpDomain\PhpDomain\FullyQualifiedNameService;
 
@@ -22,6 +23,7 @@ public function __construct(
         GenericLinkProvider $genericLinkProvider,
         private readonly FullyQualifiedNameService $fullyQualifiedNameService,
         private readonly AnchorReducer $anchorReducer,
+        private readonly LoggerInterface $logger,
     ) {
         parent::__construct($startingRule);
         $genericLinkProvider->addGenericLink($this->getName(), $this->getName());
@@ -38,17 +40,33 @@ protected function processSub(
         Directive $directive,
     ): Node|null {
         $name = trim($directive->getData());
-        $fqn = $this->fullyQualifiedNameService->getFullyQualifiedName($name, true);
+        $type = null;
+
+        if (str_contains($name, ':')) {
+            [$name, $type] = explode(':', $name, 2);
+            $type = trim($type);
+            $this->logger->warning('Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead.', $blockContext->getDocumentParserContext()->getLoggerInformation());
+        }
+
+        $fqn = $this->fullyQualifiedNameService->getFullyQualifiedName(trim($name), true);
 
         $id = $this->anchorReducer->reduceAnchor($fqn->toString());
 
+        if ($directive->hasOption('type')) {
+            if ($type != null) {
+                $this->logger->warning('The type of the backed enum was set twice. The type from the option will be prefered.', $blockContext->getDocumentParserContext()->getLoggerInformation());
+            }
+            $type = $directive->getOption('type')->toString();
+        }
+
         return new PhpEnumNode(
             $id,
             $fqn,
             $collectionNode->getChildren(),
             null,
             [],
             [],
+            $type,
         );
     }
 }
diff --git a/src/Nodes/PhpCaseNode.php b/src/Nodes/PhpCaseNode.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace T3Docs\GuidesPhpDomain\Nodes;
+
+use phpDocumentor\Guides\Nodes\Node;
+
+final class PhpCaseNode extends PhpMemberNode
+{
+    private const TYPE = 'const';
+
+    /**
+     * @param Node[] $value
+     */
+    public function __construct(
+        string                          $id,
+        private readonly MemberNameNode $memberName,
+        array                           $value = [],
+        private readonly string|null    $backedValue = null,
+    ) {
+        parent::__construct($id, self::TYPE, $memberName->toString(), $value);
+    }
+
+    public function getMemberName(): MemberNameNode
+    {
+        return $this->memberName;
+    }
+
+    public function getBackedValue(): ?string
+    {
+        return $this->backedValue;
+    }
+}
diff --git a/src/Nodes/PhpEnumNode.php b/src/Nodes/PhpEnumNode.php
@@ -22,7 +22,13 @@ public function __construct(
         PhpNamespaceNode|null $namespace = null,
         array $members = [],
         array $modifiers = [],
+        private readonly ?string $phpType = null,
     ) {
         parent::__construct($id, self::TYPE, $name, $value, $namespace, $members, $modifiers);
     }
+
+    public function getPhpType(): ?string
+    {
+        return $this->phpType;
+    }
 }
diff --git a/tests/integration/enum-backed-with-cases/expected/index.html b/tests/integration/enum-backed-with-cases/expected/index.html
@@ -0,0 +1,33 @@
+<!-- content start -->
+    <div class="section" id="php-enum-with-const">
+    <h1>PHP Enum with Const</h1>
+
+            <dl class="php enum">
+    <dt class="sig sig-object php"
+        id="redsuit">
+        <em class="property"><span class="pre">enum</span> </em>
+        <span class="sig-name descname"><span class="pre">RedSuit</span></span>
+<span class="pre"> : string</span> </dt>
+    <dd>
+        <p>In playing cards, a suit is one of the categories into which the
+cards of a deck are divided.</p><dl class="php case">
+    <dt class="sig sig-object php" id="hearts">
+        <em class="property"><span class="pre">case</span></em>
+        <span class="sig-name descname"><span class="pre">Hearts</span></span>
+ : <span class="pre">&#039;H&#039;</span> </dt>
+    <dd><p>Hearts is one of the four suits in playing cards.</p></dd>
+</dl>
+<dl class="php case">
+    <dt class="sig sig-object php" id="diamonds">
+        <em class="property"><span class="pre">case</span></em>
+        <span class="sig-name descname"><span class="pre">Diamonds</span></span>
+ : <span class="pre">&#039;D&#039;</span> </dt>
+    <dd><p>Diamonds is one of the four suits in playing cards.</p></dd>
+</dl>
+
+    </dd>
+</dl>
+
+    </div>
+
+<!-- content end -->
diff --git a/tests/integration/enum-backed-with-cases/input/index.rst b/tests/integration/enum-backed-with-cases/input/index.rst
@@ -0,0 +1,19 @@
+===================
+PHP Enum with Const
+===================
+
+..  php:enum:: RedSuit
+    :type: string
+
+    In playing cards, a suit is one of the categories into which the
+    cards of a deck are divided.
+
+    ..  php:case:: Hearts
+        :value: 'H'
+
+        Hearts is one of the four suits in playing cards.
+
+    ..  php:case:: Diamonds
+        :value: 'D'
+
+        Diamonds is one of the four suits in playing cards.
diff --git a/tests/integration/enum-with-cases/expected/index.html b/tests/integration/enum-with-cases/expected/index.html
@@ -0,0 +1,48 @@
+<!-- content start -->
+    <div class="section" id="php-enum-with-const">
+    <h1>PHP Enum with Const</h1>
+
+            <dl class="php enum">
+    <dt class="sig sig-object php"
+        id="suit">
+        <em class="property"><span class="pre">enum</span> </em>
+        <span class="sig-name descname"><span class="pre">Suit</span></span>
+
+    </dt>
+    <dd>
+        <p>In playing cards, a suit is one of the categories into which the
+cards of a deck are divided.</p><dl class="php case">
+    <dt class="sig sig-object php" id="hearts">
+        <em class="property"><span class="pre">case</span></em>
+        <span class="sig-name descname"><span class="pre">Hearts</span></span>
+ : </dt>
+    <dd><p>Hearts is one of the four suits in playing cards.</p></dd>
+</dl>
+<dl class="php case">
+    <dt class="sig sig-object php" id="diamonds">
+        <em class="property"><span class="pre">case</span></em>
+        <span class="sig-name descname"><span class="pre">Diamonds</span></span>
+ : </dt>
+    <dd><p>Diamonds is one of the four suits in playing cards.</p></dd>
+</dl>
+<dl class="php case">
+    <dt class="sig sig-object php" id="clubs">
+        <em class="property"><span class="pre">case</span></em>
+        <span class="sig-name descname"><span class="pre">Clubs</span></span>
+ : </dt>
+    <dd><p>Clubs is one of the four suits in playing cards.</p></dd>
+</dl>
+<dl class="php case">
+    <dt class="sig sig-object php" id="spades">
+        <em class="property"><span class="pre">case</span></em>
+        <span class="sig-name descname"><span class="pre">Spades</span></span>
+ : </dt>
+    <dd><p>Spades is one of the four suits in playing cards.</p></dd>
+</dl>
+
+    </dd>
+</dl>
+
+    </div>
+
+<!-- content end -->
diff --git a/tests/integration/enum-with-cases/input/index.rst b/tests/integration/enum-with-cases/input/index.rst
@@ -0,0 +1,24 @@
+===================
+PHP Enum with Const
+===================
+
+.. php:enum:: Suit
+
+    In playing cards, a suit is one of the categories into which the
+    cards of a deck are divided.
+
+    .. php:case:: Hearts
+
+        Hearts is one of the four suits in playing cards.
+
+    .. php:case:: Diamonds
+
+        Diamonds is one of the four suits in playing cards.
+
+    .. php:case:: Clubs
+
+        Clubs is one of the four suits in playing cards.
+
+    .. php:case:: Spades
+
+        Spades is one of the four suits in playing cards.