[TwigComponent] Add new ComponentReflection to extract properties from TwigComponent

src/TwigComponent/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.23.0
+
+- Add `ComponentPropertiesExtractor` to extract component properties from a Twig component (experimental)
+
 ## 2.20.0
 
 -  Add Anonymous Component support for 3rd-party bundles #2019

src/TwigComponent/src/Command/TwigComponentDebugCommand.php

@@ -21,27 +21,29 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Finder\Finder;
-use Symfony\UX\TwigComponent\Attribute\ExposeInTemplate;
 use Symfony\UX\TwigComponent\ComponentFactory;
 use Symfony\UX\TwigComponent\ComponentMetadata;
-use Symfony\UX\TwigComponent\Twig\PropsNode;
+use Symfony\UX\TwigComponent\ComponentPropertiesExtractor;
 use Twig\Environment;
 use Twig\Loader\FilesystemLoader;
 
 #[AsCommand(name: 'debug:twig-component', description: 'Display components and them usages for an application')]
 class TwigComponentDebugCommand extends Command
 {
     private readonly string $anonymousDirectory;
+    private readonly ComponentPropertiesExtractor $componentPropertiesExtractor;
 
     public function __construct(
         private string $twigTemplatesPath,
         private ComponentFactory $componentFactory,
         private Environment $twig,
         private readonly array $componentClassMap,
         ?string $anonymousDirectory = null,
+        ?ComponentPropertiesExtractor $componentPropertiesExtractor = null,
     ) {
         parent::__construct();
         $this->anonymousDirectory = $anonymousDirectory ?? 'components';
+        $this->componentPropertiesExtractor = $componentPropertiesExtractor ?? new ComponentPropertiesExtractor($this->twig);
     }
 
     protected function configure(): void
@@ -212,12 +214,18 @@ private function displayComponentDetails(SymfonyStyle $io, string $name): void
             ['Template', $metadata->getTemplate()],
         ]);
 
+        $properties = $this->componentPropertiesExtractor->getComponentProperties($metadata);
+        $propertiesAsArrayOfStrings = array_filter(array_map(
+            fn (array $property) => $property['display'],
+            $properties,
+        ));
+
         // Anonymous Component
         if ($metadata->isAnonymous()) {
             $table->addRows([
                 ['Type', '<comment>Anonymous</comment>'],
                 new TableSeparator(),
-                ['Properties', implode("\n", $this->getAnonymousComponentProperties($metadata))],
+                ['Properties', implode("\n", $propertiesAsArrayOfStrings)],
             ]);
             $table->render();
 
@@ -229,7 +237,7 @@ private function displayComponentDetails(SymfonyStyle $io, string $name): void
             new TableSeparator(),
             // ['Attributes Var', $metadata->get('attributes_var')],
             ['Public Props', $metadata->isPublicPropsExposed() ? 'Yes' : 'No'],
-            ['Properties', implode("\n", $this->getComponentProperties($metadata))],
+            ['Properties', implode("\n", $propertiesAsArrayOfStrings)],
         ]);
 
         $logMethod = function (\ReflectionMethod $m) {
@@ -280,80 +288,4 @@ private function displayComponentsTable(SymfonyStyle $io, array $components): vo
         }
         $table->render();
     }
-
-    /**
-     * @return array<string, string>
-     */
-    private function getComponentProperties(ComponentMetadata $metadata): array
-    {
-        $properties = [];
-        $reflectionClass = new \ReflectionClass($metadata->getClass());
-        foreach ($reflectionClass->getProperties() as $property) {
-            $propertyName = $property->getName();
-
-            if ($metadata->isPublicPropsExposed() && $property->isPublic()) {
-                $type = $property->getType();
-                if ($type instanceof \ReflectionNamedType) {
-                    $typeName = $type->getName();
-                } else {
-                    $typeName = (string) $type;
-                }
-                $value = $property->getDefaultValue();
-                $propertyDisplay = $typeName.' $'.$propertyName.(null !== $value ? ' = '.json_encode($value) : '');
-                $properties[$property->name] = $propertyDisplay;
-            }
-
-            foreach ($property->getAttributes(ExposeInTemplate::class) as $exposeAttribute) {
-                /** @var ExposeInTemplate $attribute */
-                $attribute = $exposeAttribute->newInstance();
-                $properties[$property->name] = $attribute->name ?? $property->name;
-            }
-        }
-
-        return $properties;
-    }
-
-    /**
-     * Extract properties from {% props %} tag in anonymous template.
-     *
-     * @return array<string, string>
-     */
-    private function getAnonymousComponentProperties(ComponentMetadata $metadata): array
-    {
-        $source = $this->twig->load($metadata->getTemplate())->getSourceContext();
-        $tokenStream = $this->twig->tokenize($source);
-        $moduleNode = $this->twig->parse($tokenStream);
-
-        $propsNode = null;
-        foreach ($moduleNode->getNode('body') as $bodyNode) {
-            foreach ($bodyNode as $node) {
-                if (PropsNode::class === $node::class) {
-                    $propsNode = $node;
-                    break 2;
-                }
-            }
-        }
-        if (!$propsNode instanceof PropsNode) {
-            return [];
-        }
-
-        $propertyNames = $propsNode->getAttribute('names');
-        $properties = array_combine($propertyNames, $propertyNames);
-        foreach ($propertyNames as $propName) {
-            if ($propsNode->hasNode($propName)
-                && ($valueNode = $propsNode->getNode($propName))
-                && $valueNode->hasAttribute('value')
-            ) {
-                $value = $valueNode->getAttribute('value');
-                if (\is_bool($value)) {
-                    $value = $value ? 'true' : 'false';
-                } else {
-                    $value = json_encode($value);
-                }
-                $properties[$propName] = $propName.' = '.$value;
-            }
-        }
-
-        return $properties;
-    }
 }

src/TwigComponent/src/ComponentPropertiesExtractor.php

@@ -0,0 +1,150 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\TwigComponent;
+
+use Symfony\UX\TwigComponent\Attribute\ExposeInTemplate;
+use Symfony\UX\TwigComponent\Twig\PropsNode;
+use Twig\Environment;
+
+/**
+ * @author Jean-François Lépine <[email protected]>
+ *
+ * @experimental This class is not covered by the BC promise yet
+ */
+final class ComponentPropertiesExtractor
+{
+    public function __construct(
+        private readonly Environment $twig,
+    ) {
+    }
+
+    /**
+     * Returns a list of properties from a Component.
+     *
+     * Warning: We do not recommend using this method at runtime, as it is rather slow.
+     *
+     * @return array<string, array{display: string, name: string, type: string, default: mixed}>
+     */
+    public function getComponentProperties(ComponentMetadata $metadata): array
+    {
+        if ($metadata->isAnonymous()) {
+            return $this->getAnonymousComponentProperties($metadata);
+        }
+
+        return $this->getNonAnonymousComponentProperties($metadata);
+    }
+
+    /**
+     * @return array<string, array{display: string, name: string, type: string, default: mixed}>
+     */
+    private function getNonAnonymousComponentProperties(ComponentMetadata $metadata): array
+    {
+        $properties = [];
+        $reflectionClass = new \ReflectionClass($metadata->getClass());
+        foreach ($reflectionClass->getProperties() as $property) {
+            $propertyName = $property->getName();
+
+            if ($metadata->isPublicPropsExposed() && $property->isPublic()) {
+                $type = $property->getType();
+                if ($type instanceof \ReflectionNamedType) {
+                    $typeName = $type->getName();
+                } else {
+                    $typeName = (string) $type;
+                }
+                $value = $property->getDefaultValue();
+                $propertyDisplay = $typeName.' $'.$propertyName.(null !== $value ? ' = '.json_encode(
+                    $value
+                ) : '');
+                $properties[$property->name] = [
+                    'name' => $propertyName,
+                    'display' => $propertyDisplay,
+                    'type' => $typeName,
+                    'default' => $value,
+                ];
+            }
+
+            foreach ($property->getAttributes(ExposeInTemplate::class) as $exposeAttribute) {
+                /** @var ExposeInTemplate $attribute */
+                $attribute = $exposeAttribute->newInstance();
+                $properties[$property->name] = [
+                    'name' => $attribute->name ?? $property->name,
+                    'display' => $attribute->name ?? $property->name,
+                    'type' => 'mixed',
+                    'default' => null,
+                ];
+            }
+        }
+
+        return $properties;
+    }
+
+    /**
+     * Extract properties from {% props %} tag in anonymous template.
+     *
+     * @return array<array{display: string, name: string, type: string, default: mixed}>
+     */
+    private function getAnonymousComponentProperties(ComponentMetadata $metadata): array
+    {
+        $source = $this->twig->load($metadata->getTemplate())->getSourceContext();
+        $tokenStream = $this->twig->tokenize($source);
+        $moduleNode = $this->twig->parse($tokenStream);
+
+        $propsNode = null;
+        foreach ($moduleNode->getNode('body') as $bodyNode) {
+            foreach ($bodyNode as $node) {
+                if (PropsNode::class === $node::class) {
+                    $propsNode = $node;
+                    break 2;
+                }
+            }
+        }
+        if (!$propsNode instanceof PropsNode) {
+            return [];
+        }
+
+        $propertyNames = $propsNode->getAttribute('names');
+        $properties = array_combine($propertyNames, $propertyNames);
+        foreach ($propertyNames as $propName) {
+            if ($propsNode->hasNode($propName)
+                && ($valueNode = $propsNode->getNode($propName))
+                && $valueNode->hasAttribute('value')
+            ) {
+                $value = $valueNode->getAttribute('value');
+                if (\is_bool($value)) {
+                    $value = $value ? 'true' : 'false';
+                } else {
+                    $value = json_encode($value);
+                }
+                $display = $propName.' = '.$value;
+                $properties[$propName] = [
+                    'name' => $propName,
+                    'display' => $display,
+                    'type' => \is_bool($value) ? 'bool' : 'mixed',
+                    'default' => $value,
+                ];
+            }
+        }
+
+        foreach ($properties as $propertyData) {
+            if (\is_string($propertyData)) {
+                $properties[$propertyData] = [
+                    'name' => $propertyData,
+                    'display' => $propertyData,
+                    'type' => 'mixed',
+                    'default' => null,
+                ];
+            }
+        }
+
+        return $properties;
+    }
+}

src/TwigComponent/src/DependencyInjection/TwigComponentExtension.php

@@ -32,6 +32,7 @@
 use Symfony\UX\TwigComponent\Command\TwigComponentDebugCommand;
 use Symfony\UX\TwigComponent\ComponentFactory;
 use Symfony\UX\TwigComponent\ComponentProperties;
+use Symfony\UX\TwigComponent\ComponentPropertiesExtractor;
 use Symfony\UX\TwigComponent\ComponentRenderer;
 use Symfony\UX\TwigComponent\ComponentRendererInterface;
 use Symfony\UX\TwigComponent\ComponentStack;
@@ -134,13 +135,19 @@ static function (ChildDefinition $definition, AsTwigComponent $attribute) {
             ->setDecoratedService(new Reference('twig.configurator.environment'))
             ->setArguments([new Reference('ux.twig_component.twig.environment_configurator.inner')]);
 
+        $container->register('ux.twig_component.extractor_properties', ComponentPropertiesExtractor::class)
+            ->setArguments([
+                new Reference('twig'),
+            ]);
+
         $container->register('ux.twig_component.command.debug', TwigComponentDebugCommand::class)
             ->setArguments([
                 new Parameter('twig.default_path'),
                 new Reference('ux.twig_component.component_factory'),
                 new Reference('twig'),
                 new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
                 $config['anonymous_template_directory'],
+                new Reference('ux.twig_component.extractor_properties'),
             ])
             ->addTag('console.command')
         ;