Add the twig constraint and its validator

sfmok · sfmok · commit a8f450d768f7 · 2024-11-07T18:46:42.000+01:00
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * Add the `Week` constraint
  * Add `CompoundConstraintTestCase` to ease testing Compound Constraints
  * Add context variable to `WhenValidator`
+ * Add the `twig` constraint for validating Twig content
 
 7.1
 ---
diff --git a/src/Symfony/Component/Validator/Constraints/Twig.php b/src/Symfony/Component/Validator/Constraints/Twig.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Attribute\HasNamedArguments;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\LogicException;
+use Twig\Environment;
+
+/**
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class Twig extends Constraint
+{
+    public const INVALID_TWIG_ERROR = 'e7fc55d5-e586-4cc1-924e-d27ee7fcd1b5';
+
+    protected const ERROR_NAMES = [
+        self::INVALID_TWIG_ERROR => 'INVALID_TWIG_ERROR',
+    ];
+
+    #[HasNamedArguments]
+    public function __construct(
+        public string $message = 'This value is not valid Twig.',
+        ?array $groups = null,
+        mixed $payload = null,
+    ) {
+        if (!class_exists(Environment::class)) {
+            throw new LogicException('The twig/twig library is required to use the Twig constraint. Try running "composer require twig/twig".');
+        }
+
+        parent::__construct(null, $groups, $payload);
+    }
+}
diff --git a/src/Symfony/Component/Validator/Constraints/TwigValidator.php b/src/Symfony/Component/Validator/Constraints/TwigValidator.php
@@ -0,0 +1,70 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+use Symfony\Component\Validator\Exception\UnexpectedValueException;
+use Twig\Environment;
+use Twig\Error\Error;
+use Twig\Loader\ArrayLoader;
+use Twig\Source;
+
+/**
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+class TwigValidator extends ConstraintValidator
+{
+    public function validate(mixed $value, Constraint $constraint): void
+    {
+        if (!$constraint instanceof Twig) {
+            throw new UnexpectedTypeException($constraint, Twig::class);
+        }
+
+        if (null === $value || '' === $value) {
+            return;
+        }
+
+        if (!\is_scalar($value) && !$value instanceof \Stringable) {
+            throw new UnexpectedValueException($value, 'string');
+        }
+
+        $value = (string) $value;
+
+        $prevErrorHandler = set_error_handler(static function ($level, $message, $file, $line) use (&$prevErrorHandler) {
+            if (\E_USER_DEPRECATED === $level) {
+                $templateLine = 0;
+                if (preg_match('/ at line (\d+)[ .]/', $message, $matches)) {
+                    $templateLine = $matches[1];
+                }
+
+                throw new Error($message, $templateLine);
+            }
+
+            return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;
+        });
+
+        try {
+            $twig = new Environment(new ArrayLoader([$value]));
+            $twig->parse($twig->tokenize(new Source($value, '')));
+        } catch (Error $e) {
+            $this->context->buildViolation($constraint->message)
+                ->setParameter('{{ error }}', $e->getMessage())
+                ->setParameter('{{ line }}', $e->getTemplateLine())
+                ->setCode(Twig::INVALID_TWIG_ERROR)
+                ->addViolation();
+        } finally {
+            restore_error_handler();
+        }
+    }
+}
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/TwigTest.php b/src/Symfony/Component/Validator/Tests/Constraints/TwigTest.php
@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Constraints;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraints\Twig;
+use Symfony\Component\Validator\Mapping\ClassMetadata;
+use Symfony\Component\Validator\Mapping\Loader\AttributeLoader;
+
+/**
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+class TwigTest extends TestCase
+{
+    public function testAttributes()
+    {
+        $metadata = new ClassMetadata(TwigDummy::class);
+        $loader = new AttributeLoader();
+        self::assertTrue($loader->loadClassMetadata($metadata));
+
+        [$bConstraint] = $metadata->properties['b']->getConstraints();
+        self::assertSame('myMessage', $bConstraint->message);
+        self::assertSame(['Default', 'TwigDummy'], $bConstraint->groups);
+
+        [$cConstraint] = $metadata->properties['c']->getConstraints();
+        self::assertSame(['my_group'], $cConstraint->groups);
+        self::assertSame('some attached data', $cConstraint->payload);
+    }
+}
+
+class TwigDummy
+{
+    #[Twig]
+    private $a;
+
+    #[Twig(message: 'myMessage')]
+    private $b;
+
+    #[Twig(groups: ['my_group'], payload: 'some attached data')]
+    private $c;
+}
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/TwigValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/TwigValidatorTest.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Constraints;
+
+use Symfony\Component\Validator\Constraints\Twig;
+use Symfony\Component\Validator\Constraints\TwigValidator;
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+/**
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+class TwigValidatorTest extends ConstraintValidatorTestCase
+{
+    protected function createValidator(): TwigValidator
+    {
+        return new TwigValidator();
+    }
+
+    /**
+     * @dataProvider getValidValues
+     */
+    public function testTwigIsValid($value)
+    {
+        $this->validator->validate($value, new Twig());
+
+        $this->assertNoViolation();
+    }
+
+    /**
+     * @dataProvider getInvalidValues
+     */
+    public function testInvalidValues($value, $message, $line)
+    {
+        $constraint = new Twig('myMessageTest');
+
+        $this->validator->validate($value, $constraint);
+
+        $this->buildViolation('myMessageTest')
+            ->setParameter('{{ error }}', $message)
+            ->setParameter('{{ line }}', $line)
+            ->setCode(Twig::INVALID_TWIG_ERROR)
+            ->assertRaised();
+    }
+
+    public static function getValidValues()
+    {
+        return [
+            ['Hello {{ name }}'],
+            ['{% if condition %}Yes{% else %}No{% endif %}'],
+            ['{# Comment #}'],
+            ['Hello {{ "world" | upper }}'],
+            ['{% for i in 1..3 %}Item {{ i }}{% endfor %}'],
+        ];
+    }
+
+    public static function getInvalidValues()
+    {
+        return [
+            // Invalid syntax example (missing end tag)
+            ['{% if condition %}Oops', 'Unexpected end of template at line 1.', 1],
+            // Another syntax error example (unclosed variable)
+            ['Hello {{ name', 'Unexpected token "end of template" ("end of print statement" expected) at line 1.', 1],
+            // Unknown filter error
+            ['Hello {{ name | unknown_filter }}', 'Unknown "unknown_filter" filter at line 1.', 1],
+            // Invalid variable syntax
+            ['Hello {{ .name }}', 'Unexpected token "punctuation" of value "." at line 1.', 1],
+        ];
+    }
+}
