[Validator] use constants for Email (#900)

Author: JohJohan

config/sets/symfony/symfony5/symfony52/symfony52-validator.php

@@ -4,10 +4,27 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Symfony\Symfony52\Rector\MethodCall\ValidatorBuilderEnableAnnotationMappingRector;
+use Rector\Transform\Rector\Attribute\AttributeKeyToClassConstFetchRector;
+use Rector\Transform\ValueObject\AttributeKeyToClassConstFetch;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
         # https://github.com/symfony/symfony/blob/5.x/UPGRADE-5.2.md#validator
         ValidatorBuilderEnableAnnotationMappingRector::class,
     ]);
+
+    // Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_* added in Symfony 4.1
+    // When using PHP 8 attributes (available from Symfony 5.2 set), map string modes to constants
+    $rectorConfig->ruleWithConfiguration(AttributeKeyToClassConstFetchRector::class, [
+        new AttributeKeyToClassConstFetch(
+            'Symfony\\Component\\Validator\\Constraints\\Email',
+            'mode',
+            'Symfony\\Component\\Validator\\Constraints\\Email',
+            [
+                'strict' => 'VALIDATION_MODE_STRICT',
+                'loose' => 'VALIDATION_MODE_LOOSE',
+                'html5' => 'VALIDATION_MODE_HTML5',
+            ]
+        ),
+    ]);
 };

config/sets/symfony/symfony6/symfony61/symfony61-validator.php

@@ -5,6 +5,8 @@
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\Name\RenameClassRector;
 use Rector\Symfony\Symfony61\Rector\StaticPropertyFetch\ErrorNamesPropertyToConstantRector;
+use Rector\Transform\Rector\Attribute\AttributeKeyToClassConstFetchRector;
+use Rector\Transform\ValueObject\AttributeKeyToClassConstFetch;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rule(ErrorNamesPropertyToConstantRector::class);
@@ -13,4 +15,16 @@
         'Symfony\Component\Validator\Constraints\ExpressionLanguageSyntax' => 'Symfony\Component\Validator\Constraints\ExpressionSyntax',
         'Symfony\Component\Validator\Constraints\ExpressionLanguageSyntaxValidator' => 'Symfony\Component\Validator\Constraints\ExpressionSyntaxValidator',
     ]);
+
+    // @see https://github.com/symfony/validator/blob/6.1/Constraints/Email.php
+    $rectorConfig->ruleWithConfiguration(AttributeKeyToClassConstFetchRector::class, [
+        new AttributeKeyToClassConstFetch(
+            'Symfony\\Component\\Validator\\Constraints\\Email',
+            'mode',
+            'Symfony\\Component\\Validator\\Constraints\\Email',
+            [
+                'html5-allow-no-tld' => 'VALIDATION_MODE_HTML5_ALLOW_NO_TLD',
+            ]
+        ),
+    ]);
 };

config/sets/symfony/symfony6/symfony62.php

@@ -30,4 +30,5 @@
     $rectorConfig->import(__DIR__ . '/symfony62/symfony62-doctrine-bridge.php');
     $rectorConfig->import(__DIR__ . '/symfony62/symfony62-messenger.php');
     $rectorConfig->import(__DIR__ . '/symfony62/symfony62-mail-pace-mailer.php');
+    $rectorConfig->import(__DIR__ . '/symfony62/symfony62-validator.php');
 };

config/sets/symfony/symfony6/symfony62/symfony62-validator.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Renaming\Rector\ClassConstFetch\RenameClassConstFetchRector;
+use Rector\Renaming\ValueObject\RenameClassConstFetch;
+
+return static function (RectorConfig $rectorConfig): void {
+    // Symfony 6.2: Email::VALIDATION_MODE_LOOSE deprecated, use Email::VALIDATION_MODE_HTML5 instead
+    // @see https://github.com/symfony/validator/blob/6.2/Constraints/Email.php
+    $rectorConfig->ruleWithConfiguration(RenameClassConstFetchRector::class, [
+        new RenameClassConstFetch(
+            'Symfony\\Component\\Validator\\Constraints\\Email',
+            'VALIDATION_MODE_LOOSE',
+            'VALIDATION_MODE_HTML5'
+        ),
+    ]);
+};

src/Set/SetProvider/Symfony6SetProvider.php

@@ -264,6 +264,12 @@ public function provide(): array
                 '6.2',
                 __DIR__ . '/../../../config/sets/symfony/symfony6/symfony62/symfony62-mail-pace-mailer.php'
             ),
+            new ComposerTriggeredSet(
+                SetGroup::SYMFONY,
+                'symfony/validator',
+                '6.2',
+                __DIR__ . '/../../../config/sets/symfony/symfony6/symfony62/symfony62-validator.php'
+            ),
 
             new ComposerTriggeredSet(
                 SetGroup::SYMFONY,

tests/Set/Symfony52/Fixture/email_attribute_modes_to_constants.php.inc

@@ -0,0 +1,59 @@
+<?php
+
+use Symfony\Component\Validator\Constraints\Email;
+
+class EmailModeStrictToConst
+{
+    #[Email(mode: 'strict')]
+    public function runStrict(): void
+    {
+    }
+}
+
+class EmailModeLooseToConst
+{
+    #[Email(mode: 'loose')]
+    public function runLoose(): void
+    {
+    }
+}
+
+class EmailModeHtml5ToConst
+{
+    #[Email(mode: 'html5')]
+    public function runHtml5(): void
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+use Symfony\Component\Validator\Constraints\Email;
+
+class EmailModeStrictToConst
+{
+    #[Email(mode: \Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_STRICT)]
+    public function runStrict(): void
+    {
+    }
+}
+
+class EmailModeLooseToConst
+{
+    #[Email(mode: \Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_LOOSE)]
+    public function runLoose(): void
+    {
+    }
+}
+
+class EmailModeHtml5ToConst
+{
+    #[Email(mode: \Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_HTML5)]
+    public function runHtml5(): void
+    {
+    }
+}
+
+?>

tests/Set/Symfony52/Symfony52Test.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Tests\Set\Symfony52;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class Symfony52Test extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/symfony52.php';
+    }
+}

tests/Set/Symfony52/config/symfony52.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Symfony\Set\SymfonySetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([SymfonySetList::SYMFONY_52]);
+};

tests/Set/Symfony61/Fixture/email_html5_allow_no_tld_attribute.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+use Symfony\Component\Validator\Constraints\Email;
+
+class Html5AllowNoTld
+{
+    #[Email(mode: 'html5-allow-no-tld')]
+    public function run(): void
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+use Symfony\Component\Validator\Constraints\Email;
+
+class Html5AllowNoTld
+{
+    #[Email(mode: \Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_HTML5_ALLOW_NO_TLD)]
+    public function run(): void
+    {
+    }
+}
+
+?>

tests/Set/Symfony62/Fixture/email_loose_to_html5.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+use Symfony\Component\Validator\Constraints\Email;
+
+class EmailModeLooseToHtml5
+{
+    #[Email(mode: \Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_LOOSE)]
+    public function run(): void
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+use Symfony\Component\Validator\Constraints\Email;
+
+class EmailModeLooseToHtml5
+{
+    #[Email(mode: \Symfony\Component\Validator\Constraints\Email::VALIDATION_MODE_HTML5)]
+    public function run(): void
+    {
+    }
+}
+
+?>