Allows registration of filter/function/test with an attribute

GromNaN · GromNaN · commit 6bde02d24266 · 2023-11-26T00:45:43.000+01:00
diff --git a/src/Extension/Attribute/AsTwigFilter.php b/src/Extension/Attribute/AsTwigFilter.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Twig\Extension\Attribute;
+
+use Twig\TwigFilter;
+
+/**
+ * Registers a method as template filter.
+ *
+ * @see TwigFilter
+ */
+#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class AsTwigFilter
+{
+    public function __construct(
+        /**
+         * The name of the filter in Twig (defaults to the method name).
+         *
+         * @var non-empty-string|null $name
+         */
+        public ?string $name = null,
+
+        /**
+         * @var array{needs_environment?:bool, needs_context?:bool, is_variadic?:bool, is_safe?:array|null, is_safe_callback?:callable|null, pre_escape?:string|null, preserves_safety?:array|null, node_class?:class-string, deprecated?:bool|string, alternative?:string}
+         */
+        public array $options = [],
+    ) {
+    }
+}
diff --git a/src/Extension/Attribute/AsTwigFunction.php b/src/Extension/Attribute/AsTwigFunction.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Twig\Extension\Attribute;
+
+use Twig\TwigFunction;
+
+/**
+ * Registers a method as template function.
+ *
+ * @see TwigFunction
+ */
+#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class AsTwigFunction
+{
+    public function __construct(
+        /**
+         * The name of the function in Twig (defaults to the method name).
+         *
+         * @var non-empty-string|null $name
+         */
+        public ?string $name = null,
+
+        /**
+         * @var array{needs_environment?:bool, needs_context?:bool, is_variadic?:bool, is_safe?:array|null, is_safe_callback?:callable|null, node_class?:class-string, deprecated?:bool|string, alternative?:string}
+         */
+        public array $options = [],
+    ) {
+    }
+}
diff --git a/src/Extension/Attribute/AsTwigTest.php b/src/Extension/Attribute/AsTwigTest.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Twig\Extension\Attribute;
+
+use Twig\TwigTest;
+
+/**
+ * Registers a method as template test.
+ *
+ * @see TwigTest
+ */
+#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class AsTwigTest
+{
+    public function __construct(
+        /**
+         * The name of the filter in Twig (defaults to the method name).
+         *
+         * @var non-empty-string|null $name
+         */
+        public ?string $name = null,
+
+        /**
+         * @var array{is_variadic?:bool, node_class?:class-string, deprecated?:bool|string, alternative?:string, one_mandatory_argument?:bool}
+         */
+        public array $options = [],
+
+        /**
+         * @var array<int, mixed>
+         */
+        public array $arguments = [],
+    ) {
+    }
+}
diff --git a/src/Extension/Extension.php b/src/Extension/Extension.php
@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) Fabien Potencier
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Twig\Extension;
+
+use Twig\Environment;
+use Twig\Extension\Attribute\AsTwigFilter;
+use Twig\Extension\Attribute\AsTwigFunction;
+use Twig\Extension\Attribute\AsTwigTest;
+use Twig\TwigFilter;
+use Twig\TwigFunction;
+use Twig\TwigTest;
+
+/**
+ * Abstract class for extension using the new PHP 8 attributes to define filters, functions, and tests.
+ *
+ * @author Jérôme Tamarelle <jerome@tamarelle.net>
+ */
+abstract class Extension extends AbstractExtension
+{
+    public function getFilters(): \Generator
+    {
+        $reflectionClass = new \ReflectionClass($this);
+        foreach ($reflectionClass->getMethods() as $method) {
+            foreach ($method->getAttributes(AsTwigFilter::class) as $attribute) {
+                $attribute = $attribute->newInstance();
+                $options = $attribute->options;
+                if (!\array_key_exists('needs_environment', $options)) {
+                    $param = $method->getParameters()[0] ?? null;
+                    $options['needs_environment'] = $param && 'env' === $param->getName() && Environment::class === $param->getType()->getName();
+                }
+                $firstParam = $options['needs_environment'] ? 1 : 0;
+                if (!\array_key_exists('needs_context', $options)) {
+                    $param = $method->getParameters()[$firstParam] ?? null;
+                    $options['needs_context'] = $param && 'context' === $param->getName() && 'array' === $param->getType()->getName();
+                }
+                $firstParam += $options['needs_context'] ? 1 : 0;
+                if (!\array_key_exists('is_variadic', $options)) {
+                    $param = $method->getParameters()[$firstParam] ?? null;
+                    $options['is_variadic'] = $param && $param->isVariadic();
+                }
+
+                yield new TwigFilter($attribute->name ?? $method->getName(), [$this, $method->getName()], $options);
+            }
+        }
+    }
+
+    public function getFunctions(): \Generator
+    {
+        $reflectionClass = new \ReflectionClass($this);
+        foreach ($reflectionClass->getMethods() as $method) {
+            foreach ($method->getAttributes(AsTwigFunction::class) as $attribute) {
+                $attribute = $attribute->newInstance();
+                $options = $attribute->options;
+                if (!\array_key_exists('needs_environment', $options)) {
+                    $param = $method->getParameters()[0] ?? null;
+                    $options['needs_environment'] = $param && 'env' === $param->getName() && Environment::class === $param->getType()->getName();
+                }
+                $firstParam = $options['needs_environment'] ? 1 : 0;
+                if (!\array_key_exists('needs_context', $options)) {
+                    $param = $method->getParameters()[$firstParam] ?? null;
+                    $options['needs_context'] = $param && 'context' === $param->getName() && 'array' === $param->getType()->getName();
+                }
+                $firstParam += $options['needs_context'] ? 1 : 0;
+                if (!\array_key_exists('is_variadic', $options)) {
+                    $param = $method->getParameters()[$firstParam] ?? null;
+                    $options['is_variadic'] = $param && $param->isVariadic();
+                }
+
+                yield new TwigFunction($attribute->name ?? $method->getName(), [$this, $method->getName()], $options);
+            }
+        }
+    }
+
+    public function getTests(): \Generator
+    {
+        $reflectionClass = new \ReflectionClass($this);
+        foreach ($reflectionClass->getMethods() as $method) {
+            foreach ($method->getAttributes(AsTwigTest::class) as $attribute) {
+                $attribute = $attribute->newInstance();
+                $options = $attribute->options;
+
+                if (!\array_key_exists('is_variadic', $options)) {
+                    $param = $method->getParameters()[0] ?? null;
+                    $options['is_variadic'] = $param && $param->isVariadic();
+                }
+
+                yield new TwigTest($attribute->name ?? $method->getName(), [$this, $method->getName()], $options);
+            }
+        }
+    }
+}
diff --git a/tests/Extension/AttributeExtensionTest.php b/tests/Extension/AttributeExtensionTest.php
@@ -0,0 +1,100 @@
+<?php
+
+namespace Twig\Tests\Extension;
+
+use PHPUnit\Framework\TestCase;
+use Twig\Tests\Extension\Fixtures\AttributeExtension;
+use Twig\TwigFilter;
+use Twig\TwigFunction;
+use Twig\TwigTest;
+
+/**
+ * @requires PHP 8.0
+ */
+class AttributeExtensionTest extends TestCase
+{
+    private AttributeExtension $extension;
+
+    protected function setUp(): void
+    {
+        $this->extension = new AttributeExtension();
+    }
+
+    /**
+     * @dataProvider provideFilters
+     */
+    public function testFilter(string $name, string $method, array $options)
+    {
+        foreach ($this->extension->getFilters() as $filter) {
+            if ($filter->getName() === $name) {
+                $this->assertEquals(new TwigFilter($name, [$this->extension, $method], $options), $filter);
+
+                return;
+            }
+        }
+
+        $this->fail(sprintf('Filter "%s" is not registered.', $name));
+    }
+
+    public static function provideFilters()
+    {
+        yield 'basic' => ['fooFilter', 'fooFilter', []];
+        yield 'with name' => ['bar', 'barFilter', []];
+        yield 'with env' => ['withEnvFilter', 'withEnvFilter', ['needs_environment' => true]];
+        yield 'with context' => ['withContextFilter', 'withContextFilter', ['needs_context' => true]];
+        yield 'with env and context' => ['withEnvAndContextFilter', 'withEnvAndContextFilter', ['needs_environment' => true, 'needs_context' => true]];
+        yield 'variadic' => ['variadicFilter', 'variadicFilter', ['is_variadic' => true]];
+        yield 'deprecated' => ['deprecatedFilter', 'deprecatedFilter', ['deprecated' => true, 'alternative' => 'bar']];
+    }
+
+    /**
+     * @dataProvider provideFunctions
+     */
+    public function testFunction(string $name, string $method, array $options)
+    {
+        foreach ($this->extension->getFunctions() as $function) {
+            if ($function->getName() === $name) {
+                $this->assertEquals(new TwigFunction($name, [$this->extension, $method], $options), $function);
+
+                return;
+            }
+        }
+
+        $this->fail(sprintf('Function "%s" is not registered.', $name));
+    }
+
+    public static function provideFunctions()
+    {
+        yield 'basic' => ['fooFunction', 'fooFunction', []];
+        yield 'with name' => ['bar', 'barFunction', []];
+        yield 'with env' => ['withEnvFunction', 'withEnvFunction', ['needs_environment' => true]];
+        yield 'with context' => ['withContextFunction', 'withContextFunction', ['needs_context' => true]];
+        yield 'with env and context' => ['withEnvAndContextFunction', 'withEnvAndContextFunction', ['needs_environment' => true, 'needs_context' => true]];
+        yield 'variadic' => ['variadicFunction', 'variadicFunction', ['is_variadic' => true]];
+        yield 'deprecated' => ['deprecatedFunction', 'deprecatedFunction', ['deprecated' => true, 'alternative' => 'bar']];
+    }
+
+    /**
+     * @dataProvider provideTests
+     */
+    public function testTest(string $name, string $method, array $options)
+    {
+        foreach ($this->extension->getTests() as $test) {
+            if ($test->getName() === $name) {
+                $this->assertEquals(new TwigTest($name, [$this->extension, $method], $options), $test);
+
+                return;
+            }
+        }
+
+        $this->fail(sprintf('Function "%s" is not registered.', $name));
+    }
+
+    public static function provideTests()
+    {
+        yield 'basic' => ['fooTest', 'fooTest', []];
+        yield 'with name' => ['bar', 'barTest', []];
+        yield 'variadic' => ['variadicTest', 'variadicTest', ['is_variadic' => true]];
+        yield 'deprecated' => ['deprecatedTest', 'deprecatedTest', ['deprecated' => true, 'alternative' => 'bar']];
+    }
+}
diff --git a/tests/Extension/Fixtures/AttributeExtension.php b/tests/Extension/Fixtures/AttributeExtension.php
@@ -0,0 +1,102 @@
+<?php
+
+namespace Twig\Tests\Extension\Fixtures;
+
+use Twig\Environment;
+use Twig\Extension\Attribute\AsTwigFilter;
+use Twig\Extension\Attribute\AsTwigFunction;
+use Twig\Extension\Attribute\AsTwigTest;
+use Twig\Extension\Extension;
+
+class AttributeExtension extends Extension
+{
+    #[AsTwigFilter]
+    public function fooFilter(string $string)
+    {
+    }
+
+    #[AsTwigFilter(name: 'bar')]
+    public function barFilter(string $string)
+    {
+    }
+
+    #[AsTwigFilter]
+    public function withContextFilter(array $context, string $string)
+    {
+    }
+
+    #[AsTwigFilter]
+    public function withEnvFilter(Environment $env, string $string)
+    {
+    }
+
+    #[AsTwigFilter]
+    public function withEnvAndContextFilter(Environment $env, array $context, string $string)
+    {
+    }
+
+    #[AsTwigFilter]
+    public function variadicFilter(string ...$strings)
+    {
+    }
+
+    #[AsTwigFilter(options: ['deprecated' => true, 'alternative' => 'bar'])]
+    public function deprecatedFilter(string $string)
+    {
+    }
+
+    #[AsTwigFunction]
+    public function fooFunction(string $string)
+    {
+    }
+
+    #[AsTwigFunction(name: 'bar')]
+    public function barFunction(string $string)
+    {
+    }
+
+    #[AsTwigFunction]
+    public function withContextFunction(array $context, string $string)
+    {
+    }
+
+    #[AsTwigFunction]
+    public function withEnvFunction(Environment $env, string $string)
+    {
+    }
+
+    #[AsTwigFunction]
+    public function withEnvAndContextFunction(Environment $env, array $context, string $string)
+    {
+    }
+
+    #[AsTwigFunction]
+    public function variadicFunction(string ...$strings)
+    {
+    }
+
+    #[AsTwigFunction(options: ['deprecated' => true, 'alternative' => 'bar'])]
+    public function deprecatedFunction(string $string)
+    {
+    }
+
+    #[AsTwigTest]
+    public function fooTest(string $string)
+    {
+    }
+
+    #[AsTwigTest(name: 'bar')]
+    public function barTest(string $string)
+    {
+    }
+
+    #[AsTwigTest]
+    public function variadicTest(string ...$strings)
+    {
+    }
+
+    #[AsTwigTest(options: ['deprecated' => true, 'alternative' => 'bar'])]
+    public function deprecatedTest(string $strings)
+    {
+    }
+}
