New extractor for constraints

Author: lukepass

src/Visitor/Php/Symfony/Constraint.php

@@ -0,0 +1,173 @@
+<?php
+
+namespace Translation\Extractor\Visitor\Php\Symfony;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor;
+use Translation\Extractor\Visitor\Php\BasePHPVisitor;
+
+final class Constraint extends BasePHPVisitor implements NodeVisitor
+{
+    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',
+    ];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function beforeTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function enterNode(Node $node): ?Node
+    {
+        if (!$node instanceof Node\Expr\New_) {
+            return null;
+        }
+
+        $className = $node->class;
+        if (!$className instanceof Node\Name) {
+            return null;
+        }
+
+        $parts = $className->parts;
+        $isConstraintClass = false;
+        foreach ($parts as $part) {
+            if (\in_array($part, self::CONSTRAINT_CLASS_NAMES)) {
+                $isConstraintClass = true;
+            }
+        }
+
+        if (!$isConstraintClass) {
+            return null;
+        }
+
+        $args = $node->args;
+        if (0 === \count($args)) {
+            return null;
+        }
+
+        $arg = $args[0];
+        if (!$arg instanceof Node\Arg) {
+            return null;
+        }
+
+        $options = $arg->value;
+        if (!$options instanceof Node\Expr\Array_) {
+            return null;
+        }
+
+        $message = null;
+        $messageNode = null;
+
+        foreach ($options->items as $item) {
+            if (!$item->key instanceof Node\Scalar\String_) {
+                continue;
+            }
+
+            if ('message' !== $item->key->value) {
+                continue;
+            }
+
+            if (!$item->value instanceof Node\Scalar\String_) {
+                $this->addError($item, 'Constraint message is not a scalar string');
+
+                continue;
+            }
+
+            $message = $item->value->value;
+            $messageNode = $item;
+
+            break;
+        }
+
+        if (!empty($message) && null !== $messageNode) {
+            $this->addLocation($message, $messageNode->getAttribute('startLine'), $messageNode, ['domain' => 'validators']);
+        }
+
+        return null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function leaveNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function afterTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+}