Add AsTwigExtension attribute and make function name required

GromNaN · GromNaN · commit c7f20abea62d · 2023-11-30T09:39:47.000+01:00
diff --git a/src/Extension/Attribute/AsTwigExtension.php b/src/Extension/Attribute/AsTwigExtension.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Twig\Extension\Attribute;
+
+use Twig\TwigFilter;
+
+/**
+ * Identifies a class that uses PHP attributes to define filters, functions, or tests.
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class AsTwigExtension
+{
+}
diff --git a/src/Extension/Attribute/AsTwigFilter.php b/src/Extension/Attribute/AsTwigFilter.php
@@ -14,11 +14,11 @@ class AsTwigFilter
 {
     public function __construct(
         /**
-         * The name of the filter in Twig (defaults to the method name).
+         * The name of the filter in Twig
          *
-         * @var non-empty-string|null $name
+         * @var non-empty-string $name
          */
-        public ?string $name = null,
+        public string $name,
         public ?array $isSafe = null,
         public ?string $isSafeCallback = null,
         public ?string $preEscape = null,
diff --git a/src/Extension/Attribute/AsTwigFunction.php b/src/Extension/Attribute/AsTwigFunction.php
@@ -14,11 +14,11 @@ class AsTwigFunction
 {
     public function __construct(
         /**
-         * The name of the function in Twig (defaults to the method name).
+         * The name of the function in Twig
          *
-         * @var non-empty-string|null $name
+         * @var non-empty-string $name
          */
-        public ?string $name = null,
+        public string $name,
         public ?array $isSafe = null,
         public ?string $isSafeCallback = null,
         public bool|string $deprecated = false,
diff --git a/src/Extension/Attribute/AsTwigTest.php b/src/Extension/Attribute/AsTwigTest.php
@@ -14,11 +14,11 @@ class AsTwigTest
 {
     public function __construct(
         /**
-         * The name of the filter in Twig (defaults to the method name).
+         * The name of the filter in Twig.
          *
-         * @var non-empty-string|null $name
+         * @var non-empty-string $name
          */
-        public ?string $name = null,
+        public string $name,
         public bool|string $deprecated = false,
         public ?string $alternative = null,
     ) {
diff --git a/tests/Extension/AttributeExtensionTest.php b/tests/Extension/AttributeExtensionTest.php
@@ -34,14 +34,13 @@ public function testFilter(string $name, string $method, array $options)
 
     public static function provideFilters()
     {
-        yield 'basic' => ['fooFilter', 'fooFilter', []];
         yield 'with name' => ['foo', 'fooFilter', []];
-        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 'no argument' => ['noArgFilter', 'noArgFilter', []];
-        yield 'variadic' => ['variadicFilter', 'variadicFilter', ['is_variadic' => true]];
-        yield 'deprecated' => ['deprecatedFilter', 'deprecatedFilter', ['deprecated' => true, 'alternative' => 'bar']];
+        yield 'with env' => ['with_env_filter', 'withEnvFilter', ['needs_environment' => true]];
+        yield 'with context' => ['with_context_filter', 'withContextFilter', ['needs_context' => true]];
+        yield 'with env and context' => ['with_env_and_context_filter', 'withEnvAndContextFilter', ['needs_environment' => true, 'needs_context' => true]];
+        yield 'no argument' => ['no_arg_filter', 'noArgFilter', []];
+        yield 'variadic' => ['variadic_filter', 'variadicFilter', ['is_variadic' => true]];
+        yield 'deprecated' => ['deprecated_filter', 'deprecatedFilter', ['deprecated' => true, 'alternative' => 'bar']];
     }
 
     /**
@@ -64,14 +63,13 @@ public function testFunction(string $name, string $method, array $options)
 
     public static function provideFunctions()
     {
-        yield 'basic' => ['fooFunction', 'fooFunction', []];
         yield 'with name' => ['foo', 'fooFunction', []];
-        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 'no argument' => ['noArgFunction', 'noArgFunction', []];
-        yield 'variadic' => ['variadicFunction', 'variadicFunction', ['is_variadic' => true]];
-        yield 'deprecated' => ['deprecatedFunction', 'deprecatedFunction', ['deprecated' => true, 'alternative' => 'bar']];
+        yield 'with env' => ['with_env_function', 'withEnvFunction', ['needs_environment' => true]];
+        yield 'with context' => ['with_context_function', 'withContextFunction', ['needs_context' => true]];
+        yield 'with env and context' => ['with_env_and_context_function', 'withEnvAndContextFunction', ['needs_environment' => true, 'needs_context' => true]];
+        yield 'no argument' => ['no_arg_function', 'noArgFunction', []];
+        yield 'variadic' => ['variadic_function', 'variadicFunction', ['is_variadic' => true]];
+        yield 'deprecated' => ['deprecated_function', 'deprecatedFunction', ['deprecated' => true, 'alternative' => 'bar']];
     }
 
     /**
@@ -94,10 +92,9 @@ public function testTest(string $name, string $method, array $options)
 
     public static function provideTests()
     {
-        yield 'basic' => ['fooTest', 'fooTest', []];
         yield 'with name' => ['foo', 'fooTest', []];
-        yield 'variadic' => ['variadicTest', 'variadicTest', ['is_variadic' => true]];
-        yield 'deprecated' => ['deprecatedTest', 'deprecatedTest', ['deprecated' => true, 'alternative' => 'bar']];
+        yield 'variadic' => ['variadic_test', 'variadicTest', ['is_variadic' => true]];
+        yield 'deprecated' => ['deprecated_test', 'deprecatedTest', ['deprecated' => true, 'alternative' => 'bar']];
     }
 
     public function testRuntimeExtension()
diff --git a/tests/Extension/Fixtures/ExtensionWithAttributes.php b/tests/Extension/Fixtures/ExtensionWithAttributes.php
@@ -3,97 +3,95 @@
 namespace Twig\Tests\Extension\Fixtures;
 
 use Twig\Environment;
+use Twig\Extension\Attribute\AsTwigExtension;
 use Twig\Extension\Attribute\AsTwigFilter;
 use Twig\Extension\Attribute\AsTwigFunction;
 use Twig\Extension\Attribute\AsTwigTest;
-use Twig\Extension\RuntimeExtensionInterface;
 
-class ExtensionWithAttributes implements RuntimeExtensionInterface
+#[AsTwigExtension]
+class ExtensionWithAttributes
 {
-    #[AsTwigFilter]
     #[AsTwigFilter(name: 'foo')]
     public function fooFilter(string $string)
     {
     }
 
-    #[AsTwigFilter]
+    #[AsTwigFilter('with_context_filter')]
     public function withContextFilter(array $context, string $string)
     {
     }
 
-    #[AsTwigFilter]
+    #[AsTwigFilter('with_env_filter')]
     public function withEnvFilter(Environment $env, string $string)
     {
     }
 
-    #[AsTwigFilter]
+    #[AsTwigFilter('with_env_and_context_filter')]
     public function withEnvAndContextFilter(Environment $env, array $context, string $string)
     {
     }
 
-    #[AsTwigFilter]
+    #[AsTwigFilter('no_arg_filter')]
     public function noArgFilter()
     {
     }
 
-    #[AsTwigFilter]
+    #[AsTwigFilter('variadic_filter')]
     public function variadicFilter(string ...$strings)
     {
     }
 
-    #[AsTwigFilter(deprecated: true, alternative: 'bar')]
+    #[AsTwigFilter('deprecated_filter', deprecated: true, alternative: 'bar')]
     public function deprecatedFilter(string $string)
     {
     }
 
-    #[AsTwigFunction]
     #[AsTwigFunction(name: 'foo')]
     public function fooFunction(string $string)
     {
     }
 
-    #[AsTwigFunction]
+    #[AsTwigFunction('with_context_function')]
     public function withContextFunction(array $context, string $string)
     {
     }
 
-    #[AsTwigFunction]
+    #[AsTwigFunction('with_env_function')]
     public function withEnvFunction(Environment $env, string $string)
     {
     }
 
-    #[AsTwigFunction]
+    #[AsTwigFunction('with_env_and_context_function')]
     public function withEnvAndContextFunction(Environment $env, array $context, string $string)
     {
     }
 
-    #[AsTwigFunction]
+    #[AsTwigFunction('no_arg_function')]
     public function noArgFunction()
     {
     }
 
-    #[AsTwigFunction]
+    #[AsTwigFunction('variadic_function')]
     public function variadicFunction(string ...$strings)
     {
     }
 
-    #[AsTwigFunction(deprecated: true, alternative: 'bar')]
+    #[AsTwigFunction('deprecated_function', deprecated: true, alternative: 'bar')]
     public function deprecatedFunction(string $string)
     {
     }
 
-    #[AsTwigTest]
     #[AsTwigTest(name: 'foo')]
     public function fooTest(string $string)
     {
     }
 
-    #[AsTwigTest]
+    #[AsTwigTest('variadic_test')]
     public function variadicTest(string ...$strings)
     {
     }
 
-    #[AsTwigTest(deprecated: true, alternative: 'bar')]
+    #[AsTwigTest('deprecated_test', deprecated: true, alternative: 'bar')]
     public function deprecatedTest(string $string)
     {
     }

Original file line number	Diff line number	Diff line change
`@@ -3,97 +3,95 @@`
`3`	`3`	`namespace Twig\Tests\Extension\Fixtures;`
`4`	`4`
`5`	`5`	`use Twig\Environment;`
	`6`	`+use Twig\Extension\Attribute\AsTwigExtension;`
`6`	`7`	`use Twig\Extension\Attribute\AsTwigFilter;`
`7`	`8`	`use Twig\Extension\Attribute\AsTwigFunction;`
`8`	`9`	`use Twig\Extension\Attribute\AsTwigTest;`
`9`		`-use Twig\Extension\RuntimeExtensionInterface;`
`10`	`10`
`11`		`-class ExtensionWithAttributes implements RuntimeExtensionInterface`
	`11`	`+#[AsTwigExtension]`
	`12`	`+class ExtensionWithAttributes`
`12`	`13`	`{`
`13`		`- #[AsTwigFilter]`
`14`	`14`	`#[AsTwigFilter(name: 'foo')]`
`15`	`15`	`public function fooFilter(string $string)`
`16`	`16`	`{`
`17`	`17`	`}`
`18`	`18`
`19`		`- #[AsTwigFilter]`
	`19`	`+ #[AsTwigFilter('with_context_filter')]`
`20`	`20`	`public function withContextFilter(array $context, string $string)`
`21`	`21`	`{`
`22`	`22`	`}`
`23`	`23`
`24`		`- #[AsTwigFilter]`
	`24`	`+ #[AsTwigFilter('with_env_filter')]`
`25`	`25`	`public function withEnvFilter(Environment $env, string $string)`
`26`	`26`	`{`
`27`	`27`	`}`
`28`	`28`
`29`		`- #[AsTwigFilter]`
	`29`	`+ #[AsTwigFilter('with_env_and_context_filter')]`
`30`	`30`	`public function withEnvAndContextFilter(Environment $env, array $context, string $string)`
`31`	`31`	`{`
`32`	`32`	`}`
`33`	`33`
`34`		`- #[AsTwigFilter]`
	`34`	`+ #[AsTwigFilter('no_arg_filter')]`
`35`	`35`	`public function noArgFilter()`
`36`	`36`	`{`
`37`	`37`	`}`
`38`	`38`
`39`		`- #[AsTwigFilter]`
	`39`	`+ #[AsTwigFilter('variadic_filter')]`
`40`	`40`	`public function variadicFilter(string ...$strings)`
`41`	`41`	`{`
`42`	`42`	`}`
`43`	`43`
`44`		`- #[AsTwigFilter(deprecated: true, alternative: 'bar')]`
	`44`	`+ #[AsTwigFilter('deprecated_filter', deprecated: true, alternative: 'bar')]`
`45`	`45`	`public function deprecatedFilter(string $string)`
`46`	`46`	`{`
`47`	`47`	`}`
`48`	`48`
`49`		`- #[AsTwigFunction]`
`50`	`49`	`#[AsTwigFunction(name: 'foo')]`
`51`	`50`	`public function fooFunction(string $string)`
`52`	`51`	`{`
`53`	`52`	`}`
`54`	`53`
`55`		`- #[AsTwigFunction]`
	`54`	`+ #[AsTwigFunction('with_context_function')]`
`56`	`55`	`public function withContextFunction(array $context, string $string)`
`57`	`56`	`{`
`58`	`57`	`}`
`59`	`58`
`60`		`- #[AsTwigFunction]`
	`59`	`+ #[AsTwigFunction('with_env_function')]`
`61`	`60`	`public function withEnvFunction(Environment $env, string $string)`
`62`	`61`	`{`
`63`	`62`	`}`
`64`	`63`
`65`		`- #[AsTwigFunction]`
	`64`	`+ #[AsTwigFunction('with_env_and_context_function')]`
`66`	`65`	`public function withEnvAndContextFunction(Environment $env, array $context, string $string)`
`67`	`66`	`{`
`68`	`67`	`}`
`69`	`68`
`70`		`- #[AsTwigFunction]`
	`69`	`+ #[AsTwigFunction('no_arg_function')]`
`71`	`70`	`public function noArgFunction()`
`72`	`71`	`{`
`73`	`72`	`}`
`74`	`73`
`75`		`- #[AsTwigFunction]`
	`74`	`+ #[AsTwigFunction('variadic_function')]`
`76`	`75`	`public function variadicFunction(string ...$strings)`
`77`	`76`	`{`
`78`	`77`	`}`
`79`	`78`
`80`		`- #[AsTwigFunction(deprecated: true, alternative: 'bar')]`
	`79`	`+ #[AsTwigFunction('deprecated_function', deprecated: true, alternative: 'bar')]`
`81`	`80`	`public function deprecatedFunction(string $string)`
`82`	`81`	`{`
`83`	`82`	`}`
`84`	`83`
`85`		`- #[AsTwigTest]`
`86`	`84`	`#[AsTwigTest(name: 'foo')]`
`87`	`85`	`public function fooTest(string $string)`
`88`	`86`	`{`
`89`	`87`	`}`
`90`	`88`
`91`		`- #[AsTwigTest]`
	`89`	`+ #[AsTwigTest('variadic_test')]`
`92`	`90`	`public function variadicTest(string ...$strings)`
`93`	`91`	`{`
`94`	`92`	`}`
`95`	`93`
`96`		`- #[AsTwigTest(deprecated: true, alternative: 'bar')]`
	`94`	`+ #[AsTwigTest('deprecated_test', deprecated: true, alternative: 'bar')]`
`97`	`95`	`public function deprecatedTest(string $string)`
`98`	`96`	`{`
`99`	`97`	`}`