From cba8f7b8e050e65544fe5a85cd312045c17de27a Mon Sep 17 00:00:00 2001
From: "lina.wolf" <lwolf@w-commerce.de>
Date: Sat, 9 Dec 2023 07:05:04 +0000
Subject: [PATCH] [FEATURE] PHP domain object struct

See https://wiki.php.net/rfc/structs
---
 resources/config/php-domain.php               |  2 +
 src/Directives/Php/StructDirective.php        | 57 +++++++++++++++++++
 src/Nodes/PhpStructNode.php                   | 26 +++++++++
 .../struct-directive/expected/index.html      | 48 ++++++++++++++++
 .../struct-directive/input/index.rst          | 19 +++++++
 5 files changed, 152 insertions(+)
 create mode 100644 src/Directives/Php/StructDirective.php
 create mode 100644 src/Nodes/PhpStructNode.php
 create mode 100644 tests/integration/struct-directive/expected/index.html
 create mode 100644 tests/integration/struct-directive/input/index.rst

diff --git a/resources/config/php-domain.php b/resources/config/php-domain.php
index 0f49f8e..7bef5f3 100644
--- a/resources/config/php-domain.php
+++ b/resources/config/php-domain.php
@@ -13,6 +13,7 @@
 use T3Docs\GuidesPhpDomain\Directives\Php\PropertyDirective;
 use T3Docs\GuidesPhpDomain\Directives\Php\StaticMethodDirective;
 use T3Docs\GuidesPhpDomain\Directives\Php\GlobalDirective;
+use T3Docs\GuidesPhpDomain\Directives\Php\StructDirective;
 use T3Docs\GuidesPhpDomain\PhpDomain\ModifierService;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 
@@ -45,6 +46,7 @@
         ->set(NamespaceDirective::class)
         ->set(PropertyDirective::class)
         ->set(StaticMethodDirective::class)
+        ->set(StructDirective::class)
         ->set(FullyQualifiedNameService::class)
         ->set(MethodNameService::class)
         ->set(ModifierService::class)
diff --git a/src/Directives/Php/StructDirective.php b/src/Directives/Php/StructDirective.php
new file mode 100644
index 0000000..998c149
--- /dev/null
+++ b/src/Directives/Php/StructDirective.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\PhpClassNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpInterfaceNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpModifierNode;
+use T3Docs\GuidesPhpDomain\Nodes\PhpStructNode;
+use T3Docs\GuidesPhpDomain\PhpDomain\FullyQualifiedNameService;
+use T3Docs\GuidesPhpDomain\PhpDomain\ModifierService;
+
+final class StructDirective extends SubDirective
+{
+    public function __construct(
+        Rule $startingRule,
+        GenericLinkProvider $genericLinkProvider,
+        private readonly FullyQualifiedNameService $fullyQualifiedNameService,
+        private readonly AnchorReducer $anchorReducer,
+    ) {
+        parent::__construct($startingRule);
+        $genericLinkProvider->addGenericLink($this->getName(), $this->getName());
+    }
+
+    public function getName(): string
+    {
+        return 'php:struct';
+    }
+
+    protected function processSub(
+        BlockContext $blockContext,
+        CollectionNode $collectionNode,
+        Directive $directive,
+    ): Node|null {
+        $name = trim($directive->getData());
+        $fqn = $this->fullyQualifiedNameService->getFullyQualifiedName($name, true);
+        $id = $this->anchorReducer->reduceAnchor($fqn->toString());
+
+        return new PhpStructNode(
+            $id,
+            $fqn,
+            $collectionNode->getChildren(),
+            null,
+            [],
+        );
+    }
+}
diff --git a/src/Nodes/PhpStructNode.php b/src/Nodes/PhpStructNode.php
new file mode 100644
index 0000000..ce45367
--- /dev/null
+++ b/src/Nodes/PhpStructNode.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace T3Docs\GuidesPhpDomain\Nodes;
+
+use phpDocumentor\Guides\Nodes\Node;
+
+final class PhpStructNode extends PhpComponentNode
+{
+    private const TYPE = 'struct';
+
+    /**
+     * @param list<Node> $value
+     * @param list<PhpMemberNode> $members
+     */
+    public function __construct(
+        string $id,
+        FullyQualifiedNameNode $name,
+        array $value = [],
+        PhpNamespaceNode|null $namespace = null,
+        array $members = [],
+    ) {
+        parent::__construct($id, self::TYPE, $name, $value, $namespace, $members);
+    }
+}
diff --git a/tests/integration/struct-directive/expected/index.html b/tests/integration/struct-directive/expected/index.html
new file mode 100644
index 0000000..aa8bc3d
--- /dev/null
+++ b/tests/integration/struct-directive/expected/index.html
@@ -0,0 +1,48 @@
+<!-- content start -->
+    <div class="section" id="php-static-method">
+    <h1>PHP static method</h1>
+
+            <dl class="php struct">
+    <dt class="sig sig-object php"
+        id="app-accounting-employee">
+        <em class="property"><span class="pre">struct</span> </em>
+            <span class="sig-prename descclassname"><span class="pre">\App\Accounting\</span></span>
+<span class="sig-name descname"><span class="pre">Employee</span></span>
+
+    </dt>
+    <dd>
+        <dl class="php property">
+    <dt class="sig sig-object php" id="firstname">
+        <span class="pre">string</span> <span class="sig-name descname"><span class="pre">firstName</span></span>
+
+    </dt>
+    <dd></dd>
+</dl>
+<dl class="php property">
+    <dt class="sig sig-object php" id="lastname">
+        <span class="pre">string</span> <span class="sig-name descname"><span class="pre">lastName</span></span>
+
+    </dt>
+    <dd></dd>
+</dl>
+<dl class="php property">
+    <dt class="sig sig-object php" id="salary">
+        <span class="pre">int</span> <span class="sig-name descname"><span class="pre">salary</span></span>
+
+    </dt>
+    <dd></dd>
+</dl>
+<dl class="php property">
+    <dt class="sig sig-object php" id="fulltime">
+        <span class="pre">bool</span> <span class="sig-name descname"><span class="pre">fullTime</span></span>
+
+    </dt>
+    <dd></dd>
+</dl>
+
+    </dd>
+</dl>
+
+    </div>
+
+<!-- content end -->
diff --git a/tests/integration/struct-directive/input/index.rst b/tests/integration/struct-directive/input/index.rst
new file mode 100644
index 0000000..e7ac5e1
--- /dev/null
+++ b/tests/integration/struct-directive/input/index.rst
@@ -0,0 +1,19 @@
+=================
+PHP static method
+=================
+
+..  php:namespace:: App\Accounting
+
+..  php:struct:: Employee
+
+    ..  php:property:: firstName
+        :type: string
+
+    ..  php:property:: lastName
+        :type: string
+
+    ..  php:property:: salary
+        :type: int
+
+    ..  php:property:: fullTime
+        :type: bool