Support Symfony v6 with PHP8 minimum

iquito · iquito · commit 10299d2fd487 · 2021-12-16T21:40:24.000+01:00
- Remove all annotations
- Improve tests to be more thorough
- Update documentation
diff --git a/.travis.yml b/.travis.yml
@@ -5,8 +5,8 @@ env:
         - XDEBUG_MODE=coverage
 language: php
 php:
-    - '7.4'
     - '8.0'
+    - '8.1'
 
 before_script:
     - composer self-update
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@ Squirrel Validator Cascade
 
 [![Build Status](https://img.shields.io/travis/com/squirrelphp/validator-cascade.svg)](https://travis-ci.com/squirrelphp/validator-cascade) [![Test Coverage](https://api.codeclimate.com/v1/badges/e056be025c6db0eb31f1/test_coverage)](https://codeclimate.com/github/squirrelphp/validator-cascade/test_coverage) ![PHPStan](https://img.shields.io/badge/style-level%208-success.svg?style=flat-round&label=phpstan) [![Packagist Version](https://img.shields.io/packagist/v/squirrelphp/validator-cascade.svg?style=flat-round)](https://packagist.org/packages/squirrelphp/validator-cascade)  [![PHP Version](https://img.shields.io/packagist/php-v/squirrelphp/validator-cascade.svg)](https://packagist.org/packages/squirrelphp/validator-cascade) [![Software License](https://img.shields.io/badge/license-MIT-success.svg?style=flat-round)](LICENSE)
 
-Reimplements the `Valid` constraint in the Symfony validator component as `Cascade` annotation/attribute which is more straightforward to use than `Valid` and has no surprising behavior.
+Reimplements the `Valid` constraint in the Symfony validator component as `Cascade` attribute which is more straightforward to use than `Valid` and has no surprising behavior.
 
-This component is compatible with the Symfony validator component in version 5.0+ and will be adapted to support future versions of Symfony (if any changes are necessary for that).
+This component is compatible with the Symfony validator component in version 5.x (v2.x with annotation/attribute support) and 6.x (v3.x with only attribute support) and will be adapted to support future versions of Symfony (if any changes are necessary for that).
 
 Installation
 ------------
@@ -45,82 +45,6 @@ Below is a common example in real applications: You might have an order and mult
 use Squirrel\ValidatorCascade\Cascade;
 use Symfony\Component\Validator\Constraints as Assert;
 
-class Order
-{
-    /**
-     * Validate $shippingAddress if validation with no validation
-     * group or the "Default" validation group is triggered
-     *
-     * Validates "Default" and "phoneNumberMandatory" validation groups in $shippingAddress
-     *
-     * @Cascade(trigger={"Default", "phoneNumberMandatory"})
-     */
-    public Address $shippingAddress;
-
-    /**
-     * Validate $invoiceAddress only if validation group
-     * "alternateInvoiceAddress" is passed to validator
-     *
-     * Validates only "Default" validation group in $invoiceAddress, so phone number is optional
-     *
-     * @Assert\NotNull(groups={"alternateInvoiceAddress"})
-     * @Cascade(groups={"alternateInvoiceAddress"})
-     */
-    public ?Address $invoiceAddress = null;
-}
-
-class Address
-{
-    /**
-     * @Assert\Length(
-     *     min = 1,
-     *     max = 50
-     * )
-     */
-    public string $street = '';
-
-    /**
-     * @Assert\Length(
-     *     min = 1,
-     *     max = 50
-     * )
-     */
-    public string $city = '';
-
-    /**
-     * @Assert\Length(
-     *     min = 1,
-     *     max = 50,
-     *     groups = {"phoneNumberMandatory"}
-     * )
-     *
-     * @var string
-     */
-    public string $phoneNumber = '';
-}
-
-$order = new Order();
-$order->shippingAddress = new Address();
-$order->invoiceAddress = new Address();
-
-// This validates with the "Default" validation group,
-// so only shippingAddress must be specified
-$symfonyValidator->validate($order);
-
-// This also validates the invoice address in addition
-// to the shipping address
-$symfonyValidator->validate($order, null, [
-    "Default",
-    "alternateInvoiceAddress",
-]);
-```
-
-If you are using PHP8+, you should use attributes instead (although annotations will still work):
-
-```php
-use Squirrel\ValidatorCascade\Cascade;
-use Symfony\Component\Validator\Constraints as Assert;
-
 class Order
 {
     /**
@@ -179,9 +103,7 @@ The current implementation of the `Valid` constraint in the Symfony validator co
 ### `Valid` constraint without validation group
 
 ```php
-/**
- * @Assert\Valid()
- */
+#[Assert\Valid]
 public $someobject;
 ```
 
@@ -195,9 +117,7 @@ This is fine for simple objects or when you don't need any validation groups at
 ### `Valid` constraint with validation group(s)
 
 ```php
-/**
- * @Assert\Valid(groups={"invoice"})
- */
+#[Assert\Valid(groups: ['invoice'])]
 public $someobject;
 ```
 
@@ -207,6 +127,6 @@ The `Valid` assertion above only triggers when you validate the "invoice" valida
 - There is no way to change which validation groups are triggered in $someobject
 - The "traverse" option for `Valid` is not used when a validation group is defined. Although the "traverse" option should probably not be used or needed in general
 
-Having validation groups both as a trigger and as a filter severly limits how you can use it, and makes most use cases (like our [example with addresses](#example)) impossible to do with `Valid`. Even if you manage to make it work, your code will not be self explanatory and it is easy to make mistakes or misunderstand the annotations.
+Having validation groups both as a trigger and as a filter severly limits how you can use it, and makes most use cases (like our [example with addresses](#example)) impossible to do with `Valid`. Even if you manage to make it work, your code will not be self explanatory and it is easy to make mistakes or misunderstand the attributes.
 
 `Cascade` as defined in this component separates which validation group the constraint belongs to and which validation groups are triggered in the child object(s). What it cannot do is cascade the validation groups of the parent to the child object, as this information is only available in the `RecursiveContextualValidator` class of the validator component and cannot be accessed without changing a lot of the internals of the validator component (unfortunately).
diff --git a/composer.json b/composer.json
@@ -19,11 +19,10 @@
         }
     ],
     "require": {
-        "php": ">=7.4",
-        "symfony/validator": "^5.0"
+        "php": ">=8.0",
+        "symfony/validator": "^6.0"
     },
     "require-dev": {
-        "doctrine/annotations": "^1.6",
         "bamarni/composer-bin-plugin": "^1.3",
         "captainhook/plugin-composer": "^5.0",
         "phpunit/phpunit": "^9.0",
diff --git a/examples/Address.php b/examples/Address.php
@@ -6,42 +6,12 @@
 
 class Address
 {
-    /**
-     * @Assert\NotNull()
-     * @Assert\NotBlank()
-     * @Assert\Length(
-     *     min = 1,
-     *     max = 50
-     * )
-     *
-     * @var string
-     */
-    public $street;
-
-    /**
-     * @Assert\NotNull()
-     * @Assert\NotBlank()
-     * @Assert\Length(
-     *     min = 1,
-     *     max = 50
-     * )
-     *
-     * @var string
-     */
-    public $city;
+    #[Assert\Length(min: 1, max: 50)]
+    public string $street = '';
 
-    /**
-     * @Assert\NotNull(groups={"phoneNumberMandatory"})
-     * @Assert\NotBlank(groups={"phoneNumberMandatory"})
-     * @Assert\Length(
-     *     min = 1,
-     *     max = 50
-     * )
-     *
-     * @var string
-     */
-    #[Assert\NotNull(groups: ['phoneNumberMandatory'])]
-    #[Assert\NotBlank(groups: ['phoneNumberMandatory'])]
     #[Assert\Length(min: 1, max: 50)]
-    public $phoneNumber;
+    public string $city = '';
+
+    #[Assert\Length(min: 1, max: 50, groups: ['phoneNumberMandatory'])]
+    public string $phoneNumber = '';
 }
diff --git a/examples/Order.php b/examples/Order.php
@@ -13,42 +13,25 @@ class Order
      *
      * Validates "Default" and "phoneNumberMandatory" validation groups
      * in $shippingAddress
-     *
-     * @Assert\NotNull()
-     * @Assert\Type(type="Squirrel\ValidatorCascade\Examples\Address")
-     * @Cascade(trigger={"Default", "phoneNumberMandatory"})
-     *
-     * @var Address
      */
-    #[Assert\NotNull()]
-    #[Assert\Type(type: 'Squirrel\ValidatorCascade\Examples\Address')]
     #[Cascade(trigger: ['Default', 'phoneNumberMandatory'])]
-    public $shippingAddress;
+    public Address $shippingAddress;
 
     /**
      * Validate $invoiceAddress only if validation group
      * "alternateInvoiceAddress" is passed to validator
      *
      * Validates only "Default" validation group in $invoiceAddress,
      * so phone number is optional
-     *
-     * @Assert\NotNull()
-     * @Assert\Type(type="Squirrel\ValidatorCascade\Examples\Address")
-     * @Cascade(groups={"alternateInvoiceAddress"})
-     *
-     * @var Address
      */
-    public $invoiceAddress;
+    #[Assert\NotNull(groups: ['alternateInvoiceAddress'])]
+    #[Cascade(groups: ['alternateInvoiceAddress'])]
+    public ?Address $invoiceAddress = null;
 
     /**
      * Validates only the phone number in the address, as the Default group
      * is not passed in
-     *
-     * @Assert\NotNull()
-     * @Assert\Type(type="Squirrel\ValidatorCascade\Examples\Address")
-     * @Cascade(trigger={"phoneNumberMandatory"})
-     *
-     * @var Address
      */
-    public $phoneNumberOnlyAddress;
+    #[Cascade(trigger: ['phoneNumberMandatory'])]
+    public Address $phoneNumberOnlyAddress;
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="vendor/autoload.php">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="vendor/autoload.php">
   <coverage>
     <include>
       <directory suffix=".php">src</directory>
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,2 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.3.1@2feba22a005a18bf31d4c7b9bdb9252c73897476"/>
+<files psalm-version="v4.15.0@a1b5e489e6fcebe40cb804793d964e99fc347820">
+  <file src="src/Cascade.php">
+    <PropertyNotSetInConstructor occurrences="1">
+      <code>Cascade</code>
+    </PropertyNotSetInConstructor>
+  </file>
+</files>
diff --git a/src/Cascade.php b/src/Cascade.php
@@ -4,38 +4,16 @@
 
 use Symfony\Component\Validator\Constraint;
 
-/**
- * @Annotation
- * @Target({"PROPERTY", "METHOD"})
- */
 #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD)]
 class Cascade extends Constraint
 {
-    /**
-     * @var array Which validation groups to trigger in any child objects
-     */
-    protected array $trigger = [Constraint::DEFAULT_GROUP];
-
-    /**
-     * @param array|null $options
-     * @param string[] $groups
-     * @param string[] $trigger
-     */
     public function __construct(
-        $options = null,
+        /** @var string[] For which groups to trigger this contraint (default Symfony Validator behavior) */
         array $groups = [Constraint::DEFAULT_GROUP],
-        array $trigger = [Constraint::DEFAULT_GROUP]
+        /** @var string[] Which validation groups to trigger in any child objects */
+        protected array $trigger = [Constraint::DEFAULT_GROUP]
     ) {
-        if (isset($options['groups'])) {
-            $groups = $options['groups'];
-        }
-
-        if (isset($options['trigger'])) {
-            $trigger = $options['trigger'];
-        }
-
-        $this->groups = $groups;
-        $this->trigger = $trigger;
+        parent::__construct(groups: $groups);
     }
 
     public function getTrigger(): array
diff --git a/src/CascadeValidator.php b/src/CascadeValidator.php
@@ -8,7 +8,7 @@
 
 class CascadeValidator extends ConstraintValidator
 {
-    public function validate($value, Constraint $constraint): void
+    public function validate(mixed $value, Constraint $constraint): void
     {
         if (!$constraint instanceof Cascade) {
             throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\Cascade');
@@ -22,6 +22,6 @@ public function validate($value, Constraint $constraint): void
         $this->context
             ->getValidator()
             ->inContext($this->context)
-            ->validate($value, null, $constraint->getTrigger());
+            ->validate($value, groups: $constraint->getTrigger());
     }
 }
diff --git a/tests/OrderTest.php b/tests/OrderTest.php
diff --git a/vendor-bin/phpcs/composer.json b/vendor-bin/phpcs/composer.json
diff --git a/vendor-bin/phpstan/composer.json b/vendor-bin/phpstan/composer.json

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`class CascadeValidator extends ConstraintValidator`
`10`	`10`	`{`
`11`		`- public function validate($value, Constraint $constraint): void`
	`11`	`+ public function validate(mixed $value, Constraint $constraint): void`
`12`	`12`	`{`
`13`	`13`	`if (!$constraint instanceof Cascade) {`
`14`	`14`	`throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\Cascade');`
`@@ -22,6 +22,6 @@ public function validate($value, Constraint $constraint): void`
`22`	`22`	`$this->context`
`23`	`23`	`->getValidator()`
`24`	`24`	`->inContext($this->context)`
`25`		`- ->validate($value, null, $constraint->getTrigger());`
	`25`	`+ ->validate($value, groups: $constraint->getTrigger());`
`26`	`26`	`}`
`27`	`27`	`}`