feature symfony#38382 [Validator] Use comparison constraints as attributes (derrabus)

This PR was merged into the 5.2-dev branch.

Discussion
----------

[Validator] Use comparison constraints as attributes

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | yes
| Tickets       | symfony#38096
| License       | MIT
| Doc PR        | TODO, let's add it to symfony/symfony-docs#14305

This PR enables all child classes of `AbstractComparison` to be used as attributes.

Some of those constraints used a trait called `NumberConstraintTrait` for a shared implementation. After my changes, that trait did not fit well anymore, so I've added a new `ZeroComparisonConstraintTrait` as a replacement. Although I don't expect `NumberConstraintTrait` to provide much value outside of the Symfony codebase, I think we cannot safely change it because it was not labelled as `@internal`. This is basically why I went for the deprecation.

Commits
-------

b5bdf82 [Validator] Use comparison constraints as attributes.

Author: fabpot

UPGRADE-5.2.md

@@ -105,6 +105,8 @@ Validator
     */
    ```
 
+ * Deprecated the `NumberConstraintTrait` trait.
+
 Security
 --------
 

UPGRADE-6.0.md

@@ -184,6 +184,8 @@ Validator
     */
    ```
 
+ * Removed the `NumberConstraintTrait` trait.
+
 Yaml
 ----
 

src/Symfony/Component/Validator/CHANGELOG.md

@@ -33,6 +33,7 @@ CHANGELOG
  * added the `ULID` constraint and validator
  * added support for UUIDv6 in `Uuid` constraint
  * enabled the validator to load constraints from PHP attributes
+ * deprecated the `NumberConstraintTrait` trait
 
 5.1.0
 -----

src/Symfony/Component/Validator/Constraints/AbstractComparison.php

@@ -30,28 +30,33 @@ abstract class AbstractComparison extends Constraint
 
     /**
      * {@inheritdoc}
+     *
+     * @param mixed $value the value to compare or a set of options
      */
-    public function __construct($options = null)
+    public function __construct($value = null, $propertyPath = null, string $message = null, array $groups = null, $payload = null, array $options = [])
     {
-        if (null === $options) {
-            $options = [];
+        if (\is_array($value)) {
+            $options = array_merge($value, $options);
+        } elseif (null !== $value) {
+            $options['value'] = $value;
         }
 
-        if (\is_array($options)) {
-            if (!isset($options['value']) && !isset($options['propertyPath'])) {
-                throw new ConstraintDefinitionException(sprintf('The "%s" constraint requires either the "value" or "propertyPath" option to be set.', static::class));
-            }
+        parent::__construct($options, $groups, $payload);
 
-            if (isset($options['value']) && isset($options['propertyPath'])) {
-                throw new ConstraintDefinitionException(sprintf('The "%s" constraint requires only one of the "value" or "propertyPath" options to be set, not both.', static::class));
-            }
+        $this->message = $message ?? $this->message;
+        $this->propertyPath = $propertyPath ?? $this->propertyPath;
 
-            if (isset($options['propertyPath']) && !class_exists(PropertyAccess::class)) {
-                throw new LogicException(sprintf('The "%s" constraint requires the Symfony PropertyAccess component to use the "propertyPath" option.', static::class));
-            }
+        if (null === $this->value && null === $this->propertyPath) {
+            throw new ConstraintDefinitionException(sprintf('The "%s" constraint requires either the "value" or "propertyPath" option to be set.', static::class));
         }
 
-        parent::__construct($options);
+        if (null !== $this->value && null !== $this->propertyPath) {
+            throw new ConstraintDefinitionException(sprintf('The "%s" constraint requires only one of the "value" or "propertyPath" options to be set, not both.', static::class));
+        }
+
+        if (null !== $this->propertyPath && !class_exists(PropertyAccess::class)) {
+            throw new LogicException(sprintf('The "%s" constraint requires the Symfony PropertyAccess component to use the "propertyPath" option.', static::class));
+        }
     }
 
     /**

src/Symfony/Component/Validator/Constraints/DivisibleBy.php

@@ -17,6 +17,7 @@
  *
  * @author Colin O'Dell <[email protected]>
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class DivisibleBy extends AbstractComparison
 {
     const NOT_DIVISIBLE_BY = '6d99d6c3-1464-4ccf-bdc7-14d083cf455c';

src/Symfony/Component/Validator/Constraints/EqualTo.php

@@ -18,6 +18,7 @@
  * @author Daniel Holmes <[email protected]>
  * @author Bernhard Schussek <[email protected]>
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class EqualTo extends AbstractComparison
 {
     const NOT_EQUAL_ERROR = '478618a7-95ba-473d-9101-cabd45e49115';

src/Symfony/Component/Validator/Constraints/GreaterThan.php

@@ -18,6 +18,7 @@
  * @author Daniel Holmes <[email protected]>
  * @author Bernhard Schussek <[email protected]>
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class GreaterThan extends AbstractComparison
 {
     const TOO_LOW_ERROR = '778b7ae0-84d3-481a-9dec-35fdb64b1d78';

src/Symfony/Component/Validator/Constraints/GreaterThanOrEqual.php

@@ -18,6 +18,7 @@
  * @author Daniel Holmes <[email protected]>
  * @author Bernhard Schussek <[email protected]>
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class GreaterThanOrEqual extends AbstractComparison
 {
     const TOO_LOW_ERROR = 'ea4e51d1-3342-48bd-87f1-9e672cd90cad';

src/Symfony/Component/Validator/Constraints/IdenticalTo.php

@@ -18,6 +18,7 @@
  * @author Daniel Holmes <[email protected]>
  * @author Bernhard Schussek <[email protected]>
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class IdenticalTo extends AbstractComparison
 {
     const NOT_IDENTICAL_ERROR = '2a8cc50f-58a2-4536-875e-060a2ce69ed5';

src/Symfony/Component/Validator/Constraints/LessThan.php

@@ -18,6 +18,7 @@
  * @author Daniel Holmes <[email protected]>
  * @author Bernhard Schussek <[email protected]>
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class LessThan extends AbstractComparison
 {
     const TOO_HIGH_ERROR = '079d7420-2d13-460c-8756-de810eeb37d2';