Merge branch '4.4' into 5.0

nicolas-grekas · nicolas-grekas · commit 27254bcedd4f · 2019-12-10T12:06:55.000+01:00
* 4.4: [Validator] Fix auto-mapping constraints should not be validated [Debug] Updated the README to deprecate the component [Cache] fix memory leak when using PhpFilesAdapter [Yaml] Implement multiline string as scalar block for tagged values [HttpFoundation] Use `Cache-Control: must-revalidate` only if explicit lifetime has been given [FrameworkBundle] Use UserInterface to @return in getUser method [CI] Replace php7.4snapshot with php7.4 in Travis configuration [ExpressionLanguage][Node][BinaryNode] Process division by zero Fixing bad order of operations with null coalescing operator forward caught exception [Validator][ConstraintValidator] Stop passing unnecessary timezone argument to \DateTime add tags before processing them [FrameworkBundle][ContainerLintCommand] Reinitialize bundles when the container is reprepared [Process] change the syntax of portable prepared command lines [MonologBridge] Fix debug processor datetime type
diff --git a/ConstraintValidator.php b/ConstraintValidator.php
@@ -93,10 +93,7 @@ protected function formatValue($value, int $format = 0)
                 // neither the native nor the stub IntlDateFormatter support
                 // DateTimeImmutable as of yet
                 if (!$value instanceof \DateTime) {
-                    $value = new \DateTime(
-                        $value->format('Y-m-d H:i:s.u e'),
-                        $value->getTimezone()
-                    );
+                    $value = new \DateTime($value->format('Y-m-d H:i:s.u e'));
                 }
 
                 return $formatter->format($value);
diff --git a/Mapping/AutoMappingStrategy.php b/Mapping/AutoMappingStrategy.php
@@ -0,0 +1,42 @@
+<?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\Mapping;
+
+/**
+ * Specifies how the auto-mapping feature should behave.
+ *
+ * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
+ */
+final class AutoMappingStrategy
+{
+    /**
+     * Nothing explicitly set, rely on auto-mapping configured regex.
+     */
+    public const NONE = 0;
+
+    /**
+     * Explicitly enabled.
+     */
+    public const ENABLED = 1;
+
+    /**
+     * Explicitly disabled.
+     */
+    public const DISABLED = 2;
+
+    /**
+     * Not instantiable.
+     */
+    private function __construct()
+    {
+    }
+}
diff --git a/Mapping/GenericMetadata.php b/Mapping/GenericMetadata.php
@@ -12,6 +12,13 @@
 namespace Symfony\Component\Validator\Mapping;
 
 use Symfony\Component\Validator\Constraint;
+<<<<<<< HEAD
+=======
+use Symfony\Component\Validator\Constraints\DisableAutoMapping;
+use Symfony\Component\Validator\Constraints\EnableAutoMapping;
+use Symfony\Component\Validator\Constraints\Length;
+use Symfony\Component\Validator\Constraints\NotBlank;
+>>>>>>> 4.4
 use Symfony\Component\Validator\Constraints\Traverse;
 use Symfony\Component\Validator\Constraints\Valid;
 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
@@ -73,6 +80,19 @@ class GenericMetadata implements MetadataInterface
      */
     public $traversalStrategy = TraversalStrategy::NONE;
 
+    /**
+     * Is auto-mapping enabled?
+     *
+     * @var int
+     *
+     * @see AutoMappingStrategy
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link getAutoMappingStrategy()} instead.
+     */
+    public $autoMappingStrategy = AutoMappingStrategy::NONE;
+
     /**
      * Returns the names of the properties that should be serialized.
      *
@@ -85,6 +105,7 @@ public function __sleep()
             'constraintsByGroup',
             'cascadingStrategy',
             'traversalStrategy',
+            'autoMappingStrategy',
         ];
     }
 
@@ -137,6 +158,13 @@ public function addConstraint(Constraint $constraint)
             return $this;
         }
 
+        if ($constraint instanceof DisableAutoMapping || $constraint instanceof EnableAutoMapping) {
+            $this->autoMappingStrategy = $constraint instanceof EnableAutoMapping ? AutoMappingStrategy::ENABLED : AutoMappingStrategy::DISABLED;
+
+            // The constraint is not added
+            return $this;
+        }
+
         $this->constraints[] = $constraint;
 
         foreach ($constraint->groups as $group) {
@@ -205,4 +233,12 @@ public function getTraversalStrategy()
     {
         return $this->traversalStrategy;
     }
+
+    /**
+     * @see AutoMappingStrategy
+     */
+    public function getAutoMappingStrategy(): int
+    {
+        return $this->autoMappingStrategy;
+    }
 }
diff --git a/Mapping/Loader/AutoMappingTrait.php b/Mapping/Loader/AutoMappingTrait.php
@@ -11,8 +11,7 @@
 
 namespace Symfony\Component\Validator\Mapping\Loader;
 
-use Symfony\Component\Validator\Constraints\DisableAutoMapping;
-use Symfony\Component\Validator\Constraints\EnableAutoMapping;
+use Symfony\Component\Validator\Mapping\AutoMappingStrategy;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
 
 /**
@@ -25,14 +24,8 @@ trait AutoMappingTrait
     private function isAutoMappingEnabledForClass(ClassMetadata $metadata, string $classValidatorRegexp = null): bool
     {
         // Check if AutoMapping constraint is set first
-        foreach ($metadata->getConstraints() as $constraint) {
-            if ($constraint instanceof DisableAutoMapping) {
-                return false;
-            }
-
-            if ($constraint instanceof EnableAutoMapping) {
-                return true;
-            }
+        if (AutoMappingStrategy::NONE !== $strategy = $metadata->getAutoMappingStrategy()) {
+            return AutoMappingStrategy::ENABLED === $strategy;
         }
 
         // Fallback on the config
diff --git a/Mapping/Loader/PropertyInfoLoader.php b/Mapping/Loader/PropertyInfoLoader.php
@@ -16,11 +16,10 @@
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
 use Symfony\Component\PropertyInfo\Type as PropertyInfoType;
 use Symfony\Component\Validator\Constraints\All;
-use Symfony\Component\Validator\Constraints\DisableAutoMapping;
-use Symfony\Component\Validator\Constraints\EnableAutoMapping;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Constraints\NotNull;
 use Symfony\Component\Validator\Constraints\Type;
+use Symfony\Component\Validator\Mapping\AutoMappingStrategy;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
 
 /**
@@ -77,16 +76,16 @@ public function loadClassMetadata(ClassMetadata $metadata): bool
             $hasNotBlankConstraint = false;
             $allConstraint = null;
             foreach ($metadata->getPropertyMetadata($property) as $propertyMetadata) {
-                foreach ($propertyMetadata->getConstraints() as $constraint) {
-                    // Enabling or disabling auto-mapping explicitly always takes precedence
-                    if ($constraint instanceof DisableAutoMapping) {
-                        continue 3;
-                    }
+                // Enabling or disabling auto-mapping explicitly always takes precedence
+                if (AutoMappingStrategy::DISABLED === $propertyMetadata->getAutoMappingStrategy()) {
+                    continue 2;
+                }
 
-                    if ($constraint instanceof EnableAutoMapping) {
-                        $enabledForProperty = true;
-                    }
+                if (AutoMappingStrategy::ENABLED === $propertyMetadata->getAutoMappingStrategy()) {
+                    $enabledForProperty = true;
+                }
 
+                foreach ($propertyMetadata->getConstraints() as $constraint) {
                     if ($constraint instanceof Type) {
                         $hasTypeConstraint = true;
                     } elseif ($constraint instanceof NotNull) {
diff --git a/Tests/Constraints/AbstractComparisonValidatorTestCase.php b/Tests/Constraints/AbstractComparisonValidatorTestCase.php
@@ -53,10 +53,7 @@ protected static function addPhp5Dot5Comparisons(array $comparisons)
 
             foreach ($comparison as $i => $value) {
                 if ($value instanceof \DateTime) {
-                    $comparison[$i] = new \DateTimeImmutable(
-                        $value->format('Y-m-d H:i:s.u e'),
-                        $value->getTimezone()
-                    );
+                    $comparison[$i] = new \DateTimeImmutable($value->format('Y-m-d H:i:s.u e'));
                     $add = true;
                 } elseif ('DateTime' === $value) {
                     $comparison[$i] = 'DateTimeImmutable';
diff --git a/Tests/Mapping/Loader/PropertyInfoLoaderTest.php b/Tests/Mapping/Loader/PropertyInfoLoaderTest.php
@@ -15,13 +15,14 @@
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Validator\Constraints\All;
-use Symfony\Component\Validator\Constraints\DisableAutoMapping;
 use Symfony\Component\Validator\Constraints\Iban;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Constraints\NotNull;
 use Symfony\Component\Validator\Constraints\Type as TypeConstraint;
+use Symfony\Component\Validator\Mapping\AutoMappingStrategy;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
 use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
+use Symfony\Component\Validator\Mapping\PropertyMetadata;
 use Symfony\Component\Validator\Tests\Fixtures\Entity;
 use Symfony\Component\Validator\Tests\Fixtures\PropertyInfoLoaderEntity;
 use Symfony\Component\Validator\Tests\Fixtures\PropertyInfoLoaderNoAutoMappingEntity;
@@ -164,11 +165,12 @@ public function testLoadClassMetadata()
         $readOnlyMetadata = $classMetadata->getPropertyMetadata('readOnly');
         $this->assertEmpty($readOnlyMetadata);
 
+        /** @var PropertyMetadata[] $noAutoMappingMetadata */
         $noAutoMappingMetadata = $classMetadata->getPropertyMetadata('noAutoMapping');
         $this->assertCount(1, $noAutoMappingMetadata);
+        $this->assertSame(AutoMappingStrategy::DISABLED, $noAutoMappingMetadata[0]->getAutoMappingStrategy());
         $noAutoMappingConstraints = $noAutoMappingMetadata[0]->getConstraints();
-        $this->assertCount(1, $noAutoMappingConstraints);
-        $this->assertInstanceOf(DisableAutoMapping::class, $noAutoMappingConstraints[0]);
+        $this->assertCount(0, $noAutoMappingConstraints, 'DisableAutoMapping constraint is not added in the list');
     }
 
     /**
@@ -222,8 +224,10 @@ public function testClassNoAutoMapping()
             ->getValidator()
         ;
 
+        /** @var ClassMetadata $classMetadata */
         $classMetadata = $validator->getMetadataFor(new PropertyInfoLoaderNoAutoMappingEntity());
         $this->assertEmpty($classMetadata->getPropertyMetadata('string'));
-        $this->assertCount(3, $classMetadata->getPropertyMetadata('autoMappingExplicitlyEnabled')[0]->constraints);
+        $this->assertCount(2, $classMetadata->getPropertyMetadata('autoMappingExplicitlyEnabled')[0]->constraints);
+        $this->assertSame(AutoMappingStrategy::ENABLED, $classMetadata->getPropertyMetadata('autoMappingExplicitlyEnabled')[0]->getAutoMappingStrategy());
     }
 }
