Merge pull request #1379 from phpDocumentor/task/migrate-directive-attributes-trivial

[TASK] Migrate 7 trivial directives to the #[Directive] attribute model

Author: linawolf

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

@@ -13,39 +13,21 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
-use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RestructuredText\Nodes\ContainerNode;
-use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
-use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Nodes\DirectiveNode;
 
 /**
  * Divs a sub document in a div with a given class or set of classes.
  *
  * @link https://docutils.sourceforge.io/docs/ref/rst/directives.html#container
  */
+#[Attributes\Directive(name: 'container', aliases: ['div'])]
 final class ContainerDirective extends SubDirective
 {
-    public function getName(): string
+    public function createNode(DirectiveNode $directiveNode): Node
     {
-        return 'container';
-    }
-
-    /** {@inheritDoc} */
-    public function getAliases(): array
-    {
-        return ['div'];
-    }
-
-    /** {@inheritDoc}
-     *
-     * @param Directive $directive
-     */
-    protected function processSub(
-        BlockContext $blockContext,
-        CollectionNode $collectionNode,
-        Directive $directive,
-    ): Node {
-        return (new ContainerNode($collectionNode->getChildren()))->withOptions(['class' => $directive->getData()]);
+        return (new ContainerNode($directiveNode->getChildren()))
+            ->withOptions(['class' => $directiveNode->getDirective()->getData()]);
     }
 }

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

@@ -13,11 +13,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
-use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
-use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Nodes\DirectiveNode;
 
 /**
  * An epigraph is an apposite (suitable, apt, or pertinent) short inscription,
@@ -26,22 +24,11 @@
  *
  * https://docutils.sourceforge.io/docs/ref/rst/directives.html#epigraph
  */
+#[Attributes\Directive(name: 'epigraph')]
 final class EpigraphDirective extends SubDirective
 {
-    public function getName(): string
+    public function createNode(DirectiveNode $directiveNode): Node
     {
-        return 'epigraph';
-    }
-
-    /** {@inheritDoc}
-     *
-     * @param Directive $directive
-     */
-    protected function processSub(
-        BlockContext $blockContext,
-        CollectionNode $collectionNode,
-        Directive $directive,
-    ): Node {
-        return new QuoteNode($collectionNode->getChildren(), ['epigraph']);
+        return new QuoteNode($directiveNode->getChildren(), ['epigraph']);
     }
 }

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

@@ -13,34 +13,21 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
-use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
-use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Nodes\DirectiveNode;
 
 /**
  * Highlights summarize the main points of a document or section, often consisting of a list.
  * The "highlights" directive produces a "highlights"-class block quote.
  *
  * https://docutils.sourceforge.io/docs/ref/rst/directives.html#highlights
  */
+#[Attributes\Directive(name: 'highlights')]
 final class HighlightsDirective extends SubDirective
 {
-    public function getName(): string
+    public function createNode(DirectiveNode $directiveNode): Node
     {
-        return 'highlights';
-    }
-
-    /** {@inheritDoc}
-     *
-     * @param Directive $directive
-     */
-    protected function processSub(
-        BlockContext $blockContext,
-        CollectionNode $collectionNode,
-        Directive $directive,
-    ): Node {
-        return new QuoteNode($collectionNode->getChildren(), ['highlights']);
+        return new QuoteNode($directiveNode->getChildren(), ['highlights']);
     }
 }

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

@@ -13,10 +13,7 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+#[Attributes\Directive(name: 'index')]
 final class IndexDirective extends SubDirective
 {
-    public function getName(): string
-    {
-        return 'index';
-    }
 }

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

@@ -13,11 +13,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
-use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
-use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Nodes\DirectiveNode;
 
 /**
  * A pull-quote is a small selection of text "pulled out and quoted", typically in
@@ -26,22 +24,11 @@
  *
  * https://docutils.sourceforge.io/docs/ref/rst/directives.html#pull-quote
  */
+#[Attributes\Directive(name: 'pull-quote')]
 final class PullQuoteDirective extends SubDirective
 {
-    public function getName(): string
+    public function createNode(DirectiveNode $directiveNode): Node
     {
-        return 'pull-quote';
-    }
-
-    /** {@inheritDoc}
-     *
-     * @param Directive $directive
-     */
-    protected function processSub(
-        BlockContext $blockContext,
-        CollectionNode $collectionNode,
-        Directive $directive,
-    ): Node {
-        return new QuoteNode($collectionNode->getChildren(), ['pull-quote']);
+        return new QuoteNode($directiveNode->getChildren(), ['pull-quote']);
     }
 }

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

@@ -13,13 +13,11 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
-use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\ParagraphNode;
 use phpDocumentor\Guides\Nodes\ReplacementNode;
-use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
-use phpDocumentor\Guides\RestructuredText\Parser\Directive;
+use phpDocumentor\Guides\RestructuredText\Nodes\DirectiveNode;
 
 use function count;
 
@@ -28,25 +26,14 @@
  *
  * .. |test| replace:: The Test String!
  */
+#[Attributes\Directive(name: 'replace')]
 final class ReplaceDirective extends SubDirective
 {
-    public function getName(): string
+    public function createNode(DirectiveNode $directiveNode): Node
     {
-        return 'replace';
-    }
-
-    /** {@inheritDoc}
-     *
-     * @param Directive $directive
-     */
-    final protected function processSub(
-        BlockContext $blockContext,
-        CollectionNode $collectionNode,
-        Directive $directive,
-    ): Node {
         /** @var array<InlineCompoundNode> $children */
-        $children = $collectionNode->getChildren();
-        $data = $directive->getDataNode();
+        $children = $directiveNode->getChildren();
+        $data = $directiveNode->getDirective()->getDataNode();
         if ($data !== null) {
             if (count($children) > 0) {
                 $children[] = new ParagraphNode([$data]);

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

@@ -13,37 +13,26 @@
 
 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\DirectiveNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\SidebarNode;
-use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
-use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 /**
  * Divs a sub document in a div with a given class or set of classes.
  *
  * https://docutils.sourceforge.io/docs/ref/rst/directives.html#sidebar
  */
+#[Attributes\Directive(name: 'sidebar')]
 final class SidebarDirective extends SubDirective
 {
-    public function getName(): string
+    public function createNode(DirectiveNode $directiveNode): Node
     {
-        return 'sidebar';
-    }
+        $directive = $directiveNode->getDirective();
 
-    /** {@inheritDoc}
-     *
-     * @param Directive $directive
-     */
-    protected function processSub(
-        BlockContext $blockContext,
-        CollectionNode $collectionNode,
-        Directive $directive,
-    ): Node {
         return new SidebarNode(
             $directive->getDataNode() ?? InlineCompoundNode::getPlainTextInlineNode($directive->getData()),
-            $collectionNode->getChildren(),
+            $directiveNode->getChildren(),
         );
     }
 }