Compute constraint names list in a compiler pass

welcoMattic · welcoMattic · commit 13ae2bc7c289 · 2022-09-26T11:14:11.000+02:00
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -4,8 +4,8 @@ CHANGELOG
 6.2
 ---
 
-* Deprecate `PhpExtractor` in favor of `PhpAstExtractor`
-* Add `PhpAstExtractor` (which require [nikic/php-parser](https://github.com/nikic/php-parser) to be installed)
+ * Deprecate `PhpExtractor` in favor of `PhpAstExtractor`
+ * Add `PhpAstExtractor` (requires [nikic/php-parser](https://github.com/nikic/php-parser) to be installed)
 
 6.1
 ---
diff --git a/src/Symfony/Component/Translation/DependencyInjection/TranslatorPass.php b/src/Symfony/Component/Translation/DependencyInjection/TranslatorPass.php
@@ -70,5 +70,16 @@ public function process(ContainerBuilder $container)
                 $definition->replaceArgument(7, $paths);
             }
         }
+
+        if ($container->hasDefinition('validator') && $container->hasDefinition('translation.extractor.visitor.constraint')) {
+            $definition = $container->findDefinition('translation.extractor.visitor.constraint');
+            $constraintClassNames = [];
+
+            foreach (array_keys($container->findTaggedServiceIds('validator.constraint_validator', true)) as $serviceId) {
+                $constraintClassNames[] = str_replace('Validator', '', $serviceId);
+            }
+
+            $definition->setArgument(0, $constraintClassNames);
+        }
     }
 }
diff --git a/src/Symfony/Component/Translation/Extractor/PhpExtractor.php b/src/Symfony/Component/Translation/Extractor/PhpExtractor.php
@@ -20,6 +20,7 @@
  * PhpExtractor extracts translation messages from a PHP template.
  *
  * @author Michel Salib <michelsalib@hotmail.com>
+ * @deprecated since Symfony 6.2, use the PhpAstExtractor instead
  */
 class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
 {
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php
@@ -17,7 +17,7 @@
 /**
  * @author Mathieu Santostefano <msantostefano@protonmail.com>
  */
-abstract class AbstractVisitor implements Visitor
+abstract class AbstractVisitor
 {
     protected MessageCatalogue $catalogue;
     protected \SplFileInfo $file;
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/ConstraintVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/ConstraintVisitor.php
@@ -21,72 +21,10 @@
  */
 final class ConstraintVisitor extends AbstractVisitor implements NodeVisitor
 {
-    public const CONSTRAINT_CLASS_NAMES = [
-        'AbstractComparison',
-        'All',
-        'Bic',
-        'Blank',
-        'Callback',
-        'CardScheme',
-        'Choice',
-        'Collection',
-        'Composite',
-        'Count',
-        'Country',
-        'Currency',
-        'Date',
-        'DateTime',
-        'DisableAutoMapping',
-        'DivisibleBy',
-        'Email',
-        'EnableAutoMapping',
-        'EqualTo',
-        'Existence',
-        'Expression',
-        'File',
-        'GreaterThan',
-        'GreaterThanOrEqual',
-        'GroupSequence',
-        'GroupSequenceProvider',
-        'Iban',
-        'IdenticalTo',
-        'Image',
-        'Ip',
-        'Isbn',
-        'IsFalse',
-        'IsNull',
-        'Issn',
-        'IsTrue',
-        'Json',
-        'Language',
-        'Length',
-        'LessThan',
-        'LessThanOrEqual',
-        'Locale',
-        'Luhn',
-        'Negative',
-        'NegativeOrZero',
-        'NotBlank',
-        'NotCompromisedPassword',
-        'NotEqualTo',
-        'NotIdenticalTo',
-        'NotNull',
-        'NumberConstraintTrait',
-        'Optional',
-        'Positive',
-        'PositiveOrZero',
-        'Range',
-        'Regex',
-        'Required',
-        'Time',
-        'Timezone',
-        'Traverse',
-        'Type',
-        'Unique',
-        'Url',
-        'Uuid',
-        'Valid',
-    ];
+    public function __construct(
+        private readonly array $constraintClassNames = []
+    ) {
+    }
 
     public function beforeTraverse(array $nodes): ?Node
     {
@@ -108,7 +46,7 @@ public function enterNode(Node $node): ?Node
         $isConstraintClass = false;
 
         foreach ($parts as $part) {
-            if (\in_array($part, self::CONSTRAINT_CLASS_NAMES, true)) {
+            if (\in_array($part, $this->constraintClassNames, true)) {
                 $isConstraintClass = true;
 
                 break;
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/Visitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/Visitor.php
diff --git a/src/Symfony/Component/Translation/Tests/Extractor/PhpAstExtractorTest.php b/src/Symfony/Component/Translation/Tests/Extractor/PhpAstExtractorTest.php
@@ -28,7 +28,11 @@ public function testExtraction(iterable|string $resource)
         $extractor = new PhpAstExtractor([
             new TransMethodVisitor(),
             new TranslatableMessageVisitor(),
-            new ConstraintVisitor(),
+            new ConstraintVisitor([
+                'NotBlank',
+                'Isbn',
+                'Length',
+            ]),
         ]);
         $extractor->setPrefix('prefix');
         $catalogue = new MessageCatalogue('en');
@@ -150,7 +154,11 @@ public function testExtractionFromIndentedHeredocNowdoc()
         $extractor = new PhpAstExtractor([
             new TransMethodVisitor(),
             new TranslatableMessageVisitor(),
-            new ConstraintVisitor(),
+            new ConstraintVisitor([
+                'NotBlank',
+                'Isbn',
+                'Length',
+            ]),
         ]);
         $extractor->setPrefix('prefix');
         $extractor->extract(__DIR__.'/../fixtures/extractor-7.3/translation.html.php', $catalogue);

Original file line number	Diff line number	Diff line change
`@@ -70,5 +70,16 @@ public function process(ContainerBuilder $container)`
`70`	`70`	`$definition->replaceArgument(7, $paths);`
`71`	`71`	`}`
`72`	`72`	`}`
	`73`	`+`
	`74`	`+ if ($container->hasDefinition('validator') && $container->hasDefinition('translation.extractor.visitor.constraint')) {`
	`75`	`+ $definition = $container->findDefinition('translation.extractor.visitor.constraint');`
	`76`	`+ $constraintClassNames = [];`
	`77`	`+`
	`78`	`+ foreach (array_keys($container->findTaggedServiceIds('validator.constraint_validator', true)) as $serviceId) {`
	`79`	`+ $constraintClassNames[] = str_replace('Validator', '', $serviceId);`
	`80`	`+ }`
	`81`	`+`
	`82`	`+ $definition->setArgument(0, $constraintClassNames);`
	`83`	`+ }`
`73`	`84`	`}`
`74`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`* PhpExtractor extracts translation messages from a PHP template.`
`21`	`21`	`*`
`22`	`22`	`* @author Michel Salib <[email protected]>`
	`23`	`+ * @deprecated since Symfony 6.2, use the PhpAstExtractor instead`
`23`	`24`	`*/`
`24`	`25`	`class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface`
`25`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`/**`
`18`	`18`	`* @author Mathieu Santostefano <[email protected]>`
`19`	`19`	`*/`
`20`		`-abstract class AbstractVisitor implements Visitor`
	`20`	`+abstract class AbstractVisitor`
`21`	`21`	`{`
`22`	`22`	`protected MessageCatalogue $catalogue;`
`23`	`23`	`protected \SplFileInfo $file;`