Merge pull request #784 from wouterj/node-renderer-factory-perf

jaapio · web-flow · commit dce1c96f8b38 · 2023-12-27T22:33:50.000+01:00
Cache matching node renderers
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/AdmonitionNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/AdmonitionNodeRenderer.php
@@ -21,6 +21,7 @@
 use phpDocumentor\Guides\TemplateRenderer;
 
 use function implode;
+use function is_a;
 
 /** @implements NodeRenderer<AdmonitionNode> */
 class AdmonitionNodeRenderer implements NodeRenderer
@@ -29,9 +30,9 @@ public function __construct(private readonly TemplateRenderer $renderer)
     {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof AdmonitionNode;
+        return $nodeFqcn === AdmonitionNode::class || is_a($nodeFqcn, AdmonitionNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/CollectionNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/CollectionNodeRenderer.php
@@ -20,16 +20,18 @@
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<CollectionNode> */
 final class CollectionNodeRenderer implements NodeRenderer
 {
     public function __construct(private readonly TemplateRenderer $renderer)
     {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof CollectionNode;
+        return $nodeFqcn === CollectionNode::class || is_a($nodeFqcn, CollectionNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/ContainerNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/ContainerNodeRenderer.php
@@ -20,16 +20,18 @@
 use phpDocumentor\Guides\RestructuredText\Nodes\ContainerNode;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<ContainerNode> */
 final class ContainerNodeRenderer implements NodeRenderer
 {
     public function __construct(private readonly TemplateRenderer $renderer)
     {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof ContainerNode;
+        return $nodeFqcn === ContainerNode::class || is_a($nodeFqcn, ContainerNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/GeneralDirectiveNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/GeneralDirectiveNodeRenderer.php
@@ -21,6 +21,7 @@
 use phpDocumentor\Guides\TemplateRenderer;
 use Psr\Log\LoggerInterface;
 
+use function is_a;
 use function preg_replace;
 use function sprintf;
 use function str_replace;
@@ -34,9 +35,9 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof GeneralDirectiveNode;
+        return $nodeFqcn === GeneralDirectiveNode::class || is_a($nodeFqcn, GeneralDirectiveNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/SidebarNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/SidebarNodeRenderer.php
@@ -20,16 +20,18 @@
 use phpDocumentor\Guides\RestructuredText\Nodes\SidebarNode;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<SidebarNode> */
 final class SidebarNodeRenderer implements NodeRenderer
 {
     public function __construct(private readonly TemplateRenderer $renderer)
     {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof SidebarNode;
+        return $nodeFqcn === SidebarNode::class || is_a($nodeFqcn, SidebarNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/TopicNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/TopicNodeRenderer.php
@@ -21,16 +21,18 @@
 use phpDocumentor\Guides\RestructuredText\Nodes\TopicNode;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<TocNode> */
 final class TopicNodeRenderer implements NodeRenderer
 {
     public function __construct(private readonly TemplateRenderer $renderer)
     {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof TopicNode;
+        return $nodeFqcn === TopicNode::class || is_a($nodeFqcn, TopicNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/LaTeX/GeneralDirectiveNodeRenderer.php b/packages/guides-restructured-text/src/RestructuredText/NodeRenderers/LaTeX/GeneralDirectiveNodeRenderer.php
@@ -21,6 +21,7 @@
 use phpDocumentor\Guides\TemplateRenderer;
 use Psr\Log\LoggerInterface;
 
+use function is_a;
 use function preg_replace;
 use function sprintf;
 use function str_replace;
@@ -34,9 +35,9 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof GeneralDirectiveNode;
+        return $nodeFqcn === GeneralDirectiveNode::class || is_a($nodeFqcn, GeneralDirectiveNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides/src/NodeRenderers/DefaultNodeRenderer.php b/packages/guides/src/NodeRenderers/DefaultNodeRenderer.php
@@ -74,7 +74,7 @@ public function render(Node $node, RenderContext $renderContext): string
         return '';
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
         return true;
     }
diff --git a/packages/guides/src/NodeRenderers/DelegatingNodeRenderer.php b/packages/guides/src/NodeRenderers/DelegatingNodeRenderer.php
@@ -21,7 +21,7 @@ public function setNodeRendererFactory(NodeRendererFactory $nodeRendererFactory)
         $this->nodeRendererFactory = $nodeRendererFactory;
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
         return true;
     }
diff --git a/packages/guides/src/NodeRenderers/Html/BreadCrumbNodeRenderer.php b/packages/guides/src/NodeRenderers/Html/BreadCrumbNodeRenderer.php
@@ -14,6 +14,7 @@
 
 use function array_reverse;
 use function assert;
+use function is_a;
 
 /**
  * @template T as Node
@@ -28,9 +29,9 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof BreadCrumbNode;
+        return $nodeFqcn === BreadCrumbNode::class || is_a($nodeFqcn, BreadCrumbNode::class, true);
     }
     
     /** @param T $node */
diff --git a/packages/guides/src/NodeRenderers/Html/DocumentNodeRenderer.php b/packages/guides/src/NodeRenderers/Html/DocumentNodeRenderer.php
@@ -11,6 +11,7 @@
 use phpDocumentor\Guides\TemplateRenderer;
 
 use function assert;
+use function is_a;
 
 /**
  * @template T as Node
@@ -25,9 +26,9 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof DocumentNode;
+        return $nodeFqcn === DocumentNode::class || is_a($nodeFqcn, DocumentNode::class, true);
     }
 
     /** @param T $node */
diff --git a/packages/guides/src/NodeRenderers/Html/MenuEntryRenderer.php b/packages/guides/src/NodeRenderers/Html/MenuEntryRenderer.php
@@ -11,6 +11,8 @@
 use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<MenuEntryNode> */
 final class MenuEntryRenderer implements NodeRenderer
 {
@@ -20,9 +22,9 @@ public function __construct(
     ) {
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof MenuEntryNode;
+        return $nodeFqcn === MenuEntryNode::class || is_a($nodeFqcn, MenuEntryNode::class, true);
     }
 
     public function render(Node $node, RenderContext $renderContext): string
diff --git a/packages/guides/src/NodeRenderers/Html/MenuNodeRenderer.php b/packages/guides/src/NodeRenderers/Html/MenuNodeRenderer.php
@@ -22,6 +22,8 @@
 use phpDocumentor\Guides\TemplateRenderer;
 use Webmozart\Assert\Assert;
 
+use function is_a;
+
 /** @implements NodeRenderer<MenuNode> */
 final class MenuNodeRenderer implements NodeRenderer
 {
@@ -57,8 +59,8 @@ private function getTemplate(Node $node): string
         return 'body/menu/menu.html.twig';
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof MenuNode;
+        return $nodeFqcn === MenuNode::class || is_a($nodeFqcn, MenuNode::class, true);
     }
 }
diff --git a/packages/guides/src/NodeRenderers/Html/TableNodeRenderer.php b/packages/guides/src/NodeRenderers/Html/TableNodeRenderer.php
@@ -19,6 +19,8 @@
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<TableNode> */
 class TableNodeRenderer implements NodeRenderer
 {
@@ -42,8 +44,8 @@ public function render(Node $node, RenderContext $renderContext): string
         );
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof TableNode;
+        return $nodeFqcn === TableNode::class || is_a($nodeFqcn, TableNode::class, true);
     }
 }
diff --git a/packages/guides/src/NodeRenderers/Html/TemplatedNodeRenderer.php b/packages/guides/src/NodeRenderers/Html/TemplatedNodeRenderer.php
@@ -11,6 +11,8 @@
 use phpDocumentor\Guides\TemplateRenderer;
 use Webmozart\Assert\Assert;
 
+use function is_a;
+
 /** @implements NodeRenderer<TemplatedNode> */
 final class TemplatedNodeRenderer implements NodeRenderer
 {
@@ -25,8 +27,8 @@ public function render(Node $node, RenderContext $renderContext): string
         return $this->renderer->renderTemplate($renderContext, $node->getValue(), $node->getData());
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof TemplatedNode;
+        return $nodeFqcn === TemplatedNode::class || is_a($nodeFqcn, TemplatedNode::class, true);
     }
 }
diff --git a/packages/guides/src/NodeRenderers/InMemoryNodeRendererFactory.php b/packages/guides/src/NodeRenderers/InMemoryNodeRendererFactory.php
@@ -17,6 +17,9 @@
 
 class InMemoryNodeRendererFactory implements NodeRendererFactory
 {
+    /** @var array<class-string<Node>, NodeRenderer<Node>> */
+    private array $cache = [];
+
     /**
      * @param iterable<NodeRenderer<Node>> $nodeRenderers
      * @param NodeRenderer<Node> $defaultNodeRenderer
@@ -40,12 +43,17 @@ public function __construct(private readonly iterable $nodeRenderers, private re
 
     public function get(Node $node): NodeRenderer
     {
+        $nodeFqcn = $node::class;
+        if (isset($this->cache[$nodeFqcn])) {
+            return $this->cache[$nodeFqcn];
+        }
+
         foreach ($this->nodeRenderers as $nodeRenderer) {
-            if ($nodeRenderer->supports($node)) {
-                return $nodeRenderer;
+            if ($nodeRenderer->supports($nodeFqcn)) {
+                return $this->cache[$nodeFqcn] = $nodeRenderer;
             }
         }
 
-        return $this->defaultNodeRenderer;
+        return $this->cache[$nodeFqcn] = $this->defaultNodeRenderer;
     }
 }
diff --git a/packages/guides/src/NodeRenderers/LaTeX/TableNodeRenderer.php b/packages/guides/src/NodeRenderers/LaTeX/TableNodeRenderer.php
@@ -25,6 +25,7 @@
 use function assert;
 use function count;
 use function implode;
+use function is_a;
 use function max;
 
 /** @implements NodeRenderer<TableNode> */
@@ -77,8 +78,8 @@ public function render(Node $node, RenderContext $renderContext): string
         return "\\begin{tabular}{" . $aligns . "}\n" . $rows . "\n\\end{tabular}\n";
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof TableNode;
+        return $nodeFqcn === TableNode::class || is_a($nodeFqcn, TableNode::class, true);
     }
 }
diff --git a/packages/guides/src/NodeRenderers/LaTeX/TitleNodeRenderer.php b/packages/guides/src/NodeRenderers/LaTeX/TitleNodeRenderer.php
@@ -20,6 +20,8 @@
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements NodeRenderer<TitleNode> */
 class TitleNodeRenderer implements NodeRenderer
 {
@@ -53,8 +55,8 @@ public function render(Node $node, RenderContext $renderContext): string
         );
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof TitleNode;
+        return $nodeFqcn === TitleNode::class || is_a($nodeFqcn, TitleNode::class, true);
     }
 }
diff --git a/packages/guides/src/NodeRenderers/LaTeX/TocNodeRenderer.php b/packages/guides/src/NodeRenderers/LaTeX/TocNodeRenderer.php
@@ -20,6 +20,8 @@
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
+use function is_a;
+
 /** @implements  NodeRenderer<TocNode> */
 class TocNodeRenderer implements NodeRenderer
 {
@@ -40,8 +42,8 @@ public function render(Node $node, RenderContext $renderContext): string
         );
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
-        return $node instanceof TocNode;
+        return $nodeFqcn === TocNode::class || is_a($nodeFqcn, TocNode::class, true);
     }
 }
diff --git a/packages/guides/src/NodeRenderers/NodeRenderer.php b/packages/guides/src/NodeRenderers/NodeRenderer.php
@@ -19,7 +19,8 @@
 /** @template T of Node */
 interface NodeRenderer
 {
-    public function supports(Node $node): bool;
+    /** @param class-string<Node> $nodeFqcn */
+    public function supports(string $nodeFqcn): bool;
 
     /** @param T $node */
     public function render(Node $node, RenderContext $renderContext): string;
diff --git a/packages/guides/src/NodeRenderers/OutputAwareDelegatingNodeRenderer.php b/packages/guides/src/NodeRenderers/OutputAwareDelegatingNodeRenderer.php
@@ -28,7 +28,7 @@ public function __construct(iterable $nodeRenderers)
         $this->nodeRenderers = $nodeRenderers;
     }
 
-    public function supports(Node $node): bool
+    public function supports(string $nodeFqcn): bool
     {
         return true;
     }
diff --git a/packages/guides/src/NodeRenderers/PreRenderers/PreRenderer.php b/packages/guides/src/NodeRenderers/PreRenderers/PreRenderer.php
diff --git a/packages/guides/src/NodeRenderers/TemplateNodeRenderer.php b/packages/guides/src/NodeRenderers/TemplateNodeRenderer.php

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`use phpDocumentor\Guides\TemplateRenderer;`
`22`	`22`
`23`	`23`	`use function implode;`
	`24`	`+use function is_a;`
`24`	`25`
`25`	`26`	`/** @implements NodeRenderer<AdmonitionNode> */`
`26`	`27`	`class AdmonitionNodeRenderer implements NodeRenderer`
`@@ -29,9 +30,9 @@ public function __construct(private readonly TemplateRenderer $renderer)`
`29`	`30`	`{`
`30`	`31`	`}`
`31`	`32`
`32`		`- public function supports(Node $node): bool`
	`33`	`+ public function supports(string $nodeFqcn): bool`
`33`	`34`	`{`
`34`		`- return $node instanceof AdmonitionNode;`
	`35`	`+ return $nodeFqcn === AdmonitionNode::class \|\| is_a($nodeFqcn, AdmonitionNode::class, true);`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`public function render(Node $node, RenderContext $renderContext): string`
Original file line number	Diff line number	Diff line change
`@@ -20,16 +20,18 @@`
`20`	`20`	`use phpDocumentor\Guides\RenderContext;`
`21`	`21`	`use phpDocumentor\Guides\TemplateRenderer;`
`22`	`22`
	`23`	`+use function is_a;`
	`24`	`+`
`23`	`25`	`/** @implements NodeRenderer<CollectionNode> */`
`24`	`26`	`final class CollectionNodeRenderer implements NodeRenderer`
`25`	`27`	`{`
`26`	`28`	`public function __construct(private readonly TemplateRenderer $renderer)`
`27`	`29`	`{`
`28`	`30`	`}`
`29`	`31`
`30`		`- public function supports(Node $node): bool`
	`32`	`+ public function supports(string $nodeFqcn): bool`
`31`	`33`	`{`
`32`		`- return $node instanceof CollectionNode;`
	`34`	`+ return $nodeFqcn === CollectionNode::class \|\| is_a($nodeFqcn, CollectionNode::class, true);`
`33`	`35`	`}`
`34`	`36`
`35`	`37`	`public function render(Node $node, RenderContext $renderContext): string`
Original file line number	Diff line number	Diff line change
`@@ -21,16 +21,18 @@`
`21`	`21`	`use phpDocumentor\Guides\RestructuredText\Nodes\TopicNode;`
`22`	`22`	`use phpDocumentor\Guides\TemplateRenderer;`
`23`	`23`
	`24`	`+use function is_a;`
	`25`	`+`
`24`	`26`	`/** @implements NodeRenderer<TocNode> */`
`25`	`27`	`final class TopicNodeRenderer implements NodeRenderer`
`26`	`28`	`{`
`27`	`29`	`public function __construct(private readonly TemplateRenderer $renderer)`
`28`	`30`	`{`
`29`	`31`	`}`
`30`	`32`
`31`		`- public function supports(Node $node): bool`
	`33`	`+ public function supports(string $nodeFqcn): bool`
`32`	`34`	`{`
`33`		`- return $node instanceof TopicNode;`
	`35`	`+ return $nodeFqcn === TopicNode::class \|\| is_a($nodeFqcn, TopicNode::class, true);`
`34`	`36`	`}`
`35`	`37`
`36`	`38`	`public function render(Node $node, RenderContext $renderContext): string`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public function render(Node $node, RenderContext $renderContext): string`
`74`	`74`	`return '';`
`75`	`75`	`}`
`76`	`76`
`77`		`- public function supports(Node $node): bool`
	`77`	`+ public function supports(string $nodeFqcn): bool`
`78`	`78`	`{`
`79`	`79`	`return true;`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function setNodeRendererFactory(NodeRendererFactory $nodeRendererFactory)`
`21`	`21`	`$this->nodeRendererFactory = $nodeRendererFactory;`
`22`	`22`	`}`
`23`	`23`
`24`		`- public function supports(Node $node): bool`
	`24`	`+ public function supports(string $nodeFqcn): bool`
`25`	`25`	`{`
`26`	`26`	`return true;`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`use function array_reverse;`
`16`	`16`	`use function assert;`
	`17`	`+use function is_a;`
`17`	`18`
`18`	`19`	`/**`
`19`	`20`	`* @template T as Node`
`@@ -28,9 +29,9 @@ public function __construct(`
`28`	`29`	`) {`
`29`	`30`	`}`
`30`	`31`
`31`		`- public function supports(Node $node): bool`
	`32`	`+ public function supports(string $nodeFqcn): bool`
`32`	`33`	`{`
`33`		`- return $node instanceof BreadCrumbNode;`
	`34`	`+ return $nodeFqcn === BreadCrumbNode::class \|\| is_a($nodeFqcn, BreadCrumbNode::class, true);`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`/** @param T $node */`