Accept a class name to leverage runtime lazy-loading

twigphp · Nov 26, 2023 · d4a3560 · d4a3560
1 parent 50f7c1f
commit d4a3560
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 13 deletions.
diff --git a/src/Extension/AttributeExtension.php b/src/Extension/AttributeExtension.php
@@ -32,7 +32,10 @@ final class AttributeExtension extends AbstractExtension
 
     public function __construct(
         /**
-         * @var iterable<object>
+         * A list of objects or class names defining filters, functions, and tests using the new PHP attributes.
+         * When passing a class name, it must be available as runtime extension.
+         *
+         * @var iterable<object|class-string>
          */
         private iterable $objects,
     ) {
@@ -69,11 +72,12 @@ private function initFromAttributes()
     {
         $filters = $functions = $tests = [];
 
-        foreach ($this->objects as $object) {
-            if (!\is_object($object)) {
-                throw new \LogicException(sprintf('"%s" class requires a list of objects, "%s" given.', __CLASS__, get_debug_type($object)));
+        foreach ($this->objects as $objectOrClass) {
+            try {
+                $reflectionClass = new \ReflectionClass($objectOrClass);
+            } catch (\ReflectionException $e) {
+                throw new \LogicException(sprintf('"%s" class requires a list of objects or class name, "%s" given.', __CLASS__, get_debug_type($objectOrClass)), 0, $e);
             }
-            $reflectionClass = new \ReflectionClass($object);
 
             foreach ($reflectionClass->getMethods() as $method) {
                 // Filters
@@ -92,7 +96,7 @@ private function initFromAttributes()
                     $firstParam += $needsContext ? 1 : 0;
                     $isVariadic = isset($parameters[$firstParam]) && $parameters[$firstParam]->isVariadic();
 
-                    $filters[$name] = new TwigFilter($name, [$object, $method->getName()], [
+                    $filters[$name] = new TwigFilter($name, [$objectOrClass, $method->getName()], [
                         'needs_environment' => $needsEnvironment,
                         'needs_context' => $needsContext,
                         'is_variadic' => $isVariadic,
@@ -121,7 +125,7 @@ private function initFromAttributes()
                     $firstParam += $needsContext ? 1 : 0;
                     $isVariadic = isset($parameters[$firstParam]) && $parameters[$firstParam]->isVariadic();
 
-                    $functions[$name] = new TwigFunction($name, [$object, $method->getName()], [
+                    $functions[$name] = new TwigFunction($name, [$objectOrClass, $method->getName()], [
                         'needs_environment' => $needsEnvironment,
                         'needs_context' => $needsContext,
                         'is_variadic' => $isVariadic,
@@ -144,7 +148,7 @@ private function initFromAttributes()
                     $parameters = $method->getParameters();
                     $isVariadic = isset($parameters[0]) && $parameters[0]->isVariadic();
 
-                    $tests[$name] = new TwigTest($name, [$object, $method->getName()], [
+                    $tests[$name] = new TwigTest($name, [$objectOrClass, $method->getName()], [
                         'is_variadic' => $isVariadic,
                         'deprecated' => $attribute->deprecated,
                         'alternative' => $attribute->alternative,

diff --git a/tests/Extension/AttributeExtensionTest.php b/tests/Extension/AttributeExtensionTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Twig\Extension\AttributeExtension;
-use Twig\Tests\Extension\Fixtures\ObjectWithAttributes;
+use Twig\Tests\Extension\Fixtures\ExtensionWithAttributes;
 use Twig\TwigFilter;
 use Twig\TwigFunction;
 use Twig\TwigTest;
@@ -19,7 +19,7 @@ class AttributeExtensionTest extends TestCase
      */
     public function testFilter(string $name, string $method, array $options)
     {
-        $object = new ObjectWithAttributes();
+        $object = new ExtensionWithAttributes();
         $extension = new AttributeExtension([$object]);
         foreach ($extension->getFilters() as $filter) {
             if ($filter->getName() === $name) {
@@ -48,7 +48,7 @@ public static function provideFilters()
      */
     public function testFunction(string $name, string $method, array $options)
     {
-        $object = new ObjectWithAttributes();
+        $object = new ExtensionWithAttributes();
         $extension = new AttributeExtension([$object]);
         foreach ($extension->getFunctions() as $function) {
             if ($function->getName() === $name) {
@@ -77,7 +77,7 @@ public static function provideFunctions()
      */
     public function testTest(string $name, string $method, array $options)
     {
-        $object = new ObjectWithAttributes();
+        $object = new ExtensionWithAttributes();
         $extension = new AttributeExtension([$object]);
         foreach ($extension->getTests() as $test) {
             if ($test->getName() === $name) {
@@ -97,4 +97,14 @@ public static function provideTests()
         yield 'variadic' => ['variadicTest', 'variadicTest', ['is_variadic' => true]];
         yield 'deprecated' => ['deprecatedTest', 'deprecatedTest', ['deprecated' => true, 'alternative' => 'bar']];
     }
+
+    public function testRuntimeExtension()
+    {
+        $class = ExtensionWithAttributes::class;
+        $extension = new AttributeExtension([$class]);
+
+        $this->assertSame([$class, 'fooFilter'], $extension->getFilters()['foo']->getCallable());
+        $this->assertSame([$class, 'fooFunction'], $extension->getFunctions()['foo']->getCallable());
+        $this->assertSame([$class, 'fooTest'], $extension->getTests()['foo']->getCallable());
+    }
 }
diff --git a/...tension/Fixtures/ObjectWithAttributes.php → ...sion/Fixtures/ExtensionWithAttributes.php b/...tension/Fixtures/ObjectWithAttributes.php → ...sion/Fixtures/ExtensionWithAttributes.php
@@ -6,8 +6,9 @@
 use Twig\Extension\Attribute\AsTwigFilter;
 use Twig\Extension\Attribute\AsTwigFunction;
 use Twig\Extension\Attribute\AsTwigTest;
+use Twig\Extension\RuntimeExtensionInterface;
 
-class ObjectWithAttributes
+class ExtensionWithAttributes implements RuntimeExtensionInterface
 {
     #[AsTwigFilter]
     #[AsTwigFilter(name: 'foo')]

diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -12,6 +12,7 @@
  */
 
 use Twig\Extension\AbstractExtension;
+use Twig\Extension\AttributeExtension;
 use Twig\Extension\DebugExtension;
 use Twig\Extension\SandboxExtension;
 use Twig\Extension\StringLoaderExtension;
@@ -44,6 +45,7 @@ public function getExtensions()
             new SandboxExtension($policy, false),
             new StringLoaderExtension(),
             new TwigTestExtension(),
+            new AttributeExtension(new \ArrayIterator(['']))
         ];
     }