Merge pull request #26 from ingenerator/include-warden-symfony-validator

Include warden-validator-symfony as part of the core package

.github/workflows/test.yaml

@@ -14,11 +14,18 @@ jobs:
       fail-fast: false
       matrix:
         php_version:
-        - '8.0'
         - '8.1'
         - '8.2'
+        - '8.3'
         dependencies:
         - 'default'
+        include:
+        - php_version: '8.1'
+          dependencies: 'lowest'
+        - php_version: '8.2'
+          dependencies: 'lowest'
+        - php_version: '8.3'
+          dependencies: 'lowest'
 
     steps:
     - name: Setup PHP

CHANGELOG.md

@@ -1,5 +1,12 @@
 ### Unreleased
 
+### v2.0.0 (2024-09-25)
+
+* [BREAKING] Remove @Assert docblock annotations from request objects. Migrated to using attributes
+* Include a validator with this core package (using symfony) with attribute tagging on request objects  
+* Drop support for PHP 8.0
+* Support PHP 8.3
+
 ### v1.2.2 (2022-10-31)
 
 * Fix deprecation on password ->isCorrect() when hash is null - e.g. if a user's password has never been initialised.

README.md

@@ -18,6 +18,21 @@ This isn't in packagist yet : you'll need to add our package repository to your
 
 `$> composer require ingenerator/warden-core`
 
+# Validation
+
+A default validation interface is included, along with an implementation using symfony validator and a factory to create a validator.
+
+## Using attribute based mapping
+
+The warden-core package defines validation mapping by default with attributes on the 
+various entity and request objects.
+
+## Using alternate mapping
+
+If you want to use an alternate validation mapping method (e.g. yaml files / xml files) you will
+need to define the appropriate mappings based on the constraints specified in the warden class
+annotations, and populate your validation builder appropriately.
+
 # Contributing
 
 Contributions are welcome but please contact us before you start work on anything to check your

composer.json

@@ -22,7 +22,9 @@
     }
   ],
   "require": {
-    "php": "~8.0.0 || ~8.1.0 || ~8.2.0"
+    "egulias/email-validator": "^4.0",
+    "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
+    "symfony/validator": "^6.4"
   },
   "require-dev": {
     "phpunit/phpunit": "^9.5.5"
@@ -36,6 +38,7 @@
     }
   },
   "config": {
-    "preferred-install": "dist"
+    "preferred-install": "dist",
+    "sort-packages": true
   }
 }

src/Interactor/ActivateAccountRequest.php

@@ -8,15 +8,13 @@
 
 use Symfony\Component\Validator\Constraints as Assert;
 
-/** @var Assert $annotations keep me to stop phpstorm deleting the import */
-
 class ActivateAccountRequest extends AbstractRequest implements TokenSignedRequest
 {
     /**
-     * @Assert\NotBlank
-     * @Assert\Regex("/^\w+/")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Regex('/^\w+$/')]
     protected $user_id;
 
     /**

src/Interactor/ChangeEmailRequest.php

@@ -8,23 +8,21 @@
 
 use Symfony\Component\Validator\Constraints as Assert;
 
-/** @var Assert $annotations keep me to stop phpstorm deleting the import */
-
 class ChangeEmailRequest extends AbstractRequest implements TokenSignedRequest
 {
 
     /**
-     * @Assert\NotBlank
-     * @Assert\Regex("/^\w+/")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Regex('/^\w+$/')]
     protected $user_id;
 
     /**
-     * @Assert\NotBlank
-     * @Assert\Email(mode = "strict")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Email(mode: 'strict')]
     protected $email;
 
     /**

src/Interactor/ChangePasswordRequest.php

@@ -8,21 +8,20 @@
 
 use Symfony\Component\Validator\Constraints as Assert;
 
-/** @var Assert $annotations keep me to stop phpstorm deleting the import */
 class ChangePasswordRequest extends AbstractRequest
 {
 
     /**
-     * @Assert\NotBlank
      * @var string
      */
+    #[Assert\NotBlank]
     protected $current_password;
 
     /**
-     * @Assert\Length(min = 8)
-     * @Assert\NotBlank
      * @var string
      */
+    #[Assert\Length(min: 8)]
+    #[Assert\NotBlank]
     protected $new_password;
 
     /**

src/Interactor/EmailVerificationRequest.php

@@ -10,7 +10,6 @@
 use Ingenerator\Warden\Core\Support\UrlProvider;
 use Symfony\Component\Validator\Constraints as Assert;
 
-/** @var Assert $annotations keep me to stop phpstorm deleting the import */
 class EmailVerificationRequest extends AbstractRequest
 {
 
@@ -26,10 +25,10 @@ class EmailVerificationRequest extends AbstractRequest
     protected $action;
 
     /**
-     * @Assert\NotBlank
-     * @Assert\Email(mode = "strict")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Email(mode: 'strict')]
     protected $email;
 
     /**

src/Interactor/LoginRequest.php

@@ -5,17 +5,17 @@
  */
 
 namespace Ingenerator\Warden\Core\Interactor;
-use Symfony\Component\Validator\Constraints as Assert;
 
+use Symfony\Component\Validator\Constraints as Assert;
 
 class LoginRequest extends AbstractRequest
 {
 
     /**
-     * @Assert\NotBlank
-     * @Assert\Email(mode = "loose")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Email(mode: 'loose')]
     protected $email;
 
     /**

src/Interactor/PasswordResetRequest.php

@@ -7,23 +7,21 @@
 namespace Ingenerator\Warden\Core\Interactor;
 use Symfony\Component\Validator\Constraints as Assert;
 
-/** @var Assert $annotations keep me to stop phpstorm deleting the import */
-
 class PasswordResetRequest extends AbstractRequest implements TokenSignedRequest
 {
 
     /**
-     * @Assert\NotBlank
-     * @Assert\Regex("/^\w+/")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Regex('/^\w+$/')]
     protected $user_id;
 
     /**
-     * @Assert\Length(min = 8)
-     * @Assert\NotBlank
      * @var string
      */
+    #[Assert\Length(min: 8)]
+    #[Assert\NotBlank]
     protected $new_password;
 
     /**

src/Interactor/UserRegistrationRequest.php

@@ -6,19 +6,16 @@
 
 namespace Ingenerator\Warden\Core\Interactor;
 
-
 use Ingenerator\Warden\Core\Entity\User;
 use Symfony\Component\Validator\Constraints as Assert;
 
-/** @var Assert $annotations keep me to stop phpstorm deleting the import */
-
 class UserRegistrationRequest extends AbstractRequest implements TokenSignedRequest
 {
     /**
-     * @Assert\NotBlank
-     * @Assert\Email(mode = "strict")
      * @var string
      */
+    #[Assert\NotBlank]
+    #[Assert\Email(mode: 'strict')]
     protected $email;
 
     /**
@@ -27,10 +24,10 @@ class UserRegistrationRequest extends AbstractRequest implements TokenSignedRequ
     protected $email_confirmation_token;
 
     /**
-     * @Assert\Length(min = 8)
-     * @Assert\NotBlank
      * @var string
      */
+    #[Assert\Length(min: 8)]
+    #[Assert\NotBlank]
     protected $password;
 
     /**

src/Validator/SymfonyValidator.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * @author    Andrew Coulton <andrew@ingenerator.com>
+ * @licence   proprietary
+ */
+
+namespace Ingenerator\Warden\Core\Validator;
+
+use Symfony\Component\Validator\ConstraintViolationInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+
+class SymfonyValidator implements Validator
+{
+
+    public function __construct(protected ValidatorInterface $validator)
+    {
+    }
+
+    public function validate($object): array
+    {
+        $errors         = $this->validator->validate($object);
+        $error_messages = [];
+        foreach ($errors as $error) {
+            /** @var ConstraintViolationInterface $error */
+            $error_messages[$error->getPropertyPath()] = $error->getMessage();
+        }
+
+        return $error_messages;
+    }
+}

src/Validator/SymfonyValidatorFactory.php

@@ -0,0 +1,20 @@
+<?php
+/**
+ * @author    Craig Gosman <craig@ingenerator.com>
+ * @licence   proprietary
+ */
+
+namespace Ingenerator\Warden\Core\Validator;
+
+use Symfony\Component\Validator\Validation;
+
+class SymfonyValidatorFactory
+{
+    public static function factory(): SymfonyValidator
+    {
+        $builder = Validation::createValidatorBuilder();
+        $builder->enableAttributeMapping();
+
+        return new SymfonyValidator($builder->getValidator());
+    }
+}

test/integration/Repository/ArrayUserRepositoryTest.php

@@ -9,7 +9,7 @@
 
 use Ingenerator\Warden\Core\Repository\ArrayUserRepository;
 
-class ArrayUserRepositoryTest extends UserRepositoryTest
+class ArrayUserRepositoryTest extends UserRepositoryTestCase
 {
     /**
      * @var \ArrayObject

test/integration/Repository/UserRepositoryTest.php → test/integration/Repository/UserRepositoryTestCase.php

@@ -15,7 +15,7 @@
 use Ingenerator\Warden\Core\Repository\UserRepository;
 use PHPUnit\Framework\TestCase;
 
-abstract class UserRepositoryTest extends TestCase
+abstract class UserRepositoryTestCase extends TestCase
 {
     /**
      * @var Configuration