feat: allow to define validation groups

zenstruck · Feb 3, 2025 · c2b6e9a · c2b6e9a
1 parent ea75772
commit c2b6e9a
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 2 deletions.
diff --git a/src/Object/ValidationListener.php b/src/Object/ValidationListener.php
@@ -21,7 +21,7 @@ public function __invoke(AfterInstantiate $event): void
             return;
         }
 
-        $violations = $this->validator->validate($event->object);
+        $violations = $this->validator->validate($event->object, groups: $event->factory->getValidationGroups());
 
         if ($violations->count() > 0) {
             throw new ValidationFailedException($event->object, $violations);

diff --git a/src/ObjectFactory.php b/src/ObjectFactory.php
@@ -11,6 +11,7 @@
 
 namespace Zenstruck\Foundry;
 
+use Symfony\Component\Validator\Constraints\GroupSequence;
 use Zenstruck\Foundry\Object\Event\AfterInstantiate;
 use Zenstruck\Foundry\Object\Event\BeforeInstantiate;
 use Zenstruck\Foundry\Object\Instantiator;
@@ -37,6 +38,9 @@ abstract class ObjectFactory extends Factory
 
     private bool $validationEnabled;
 
+    /** @var string|GroupSequence|list<string>|null */
+    private string|GroupSequence|array|null $validationGroups = [];
+
     // keep an empty constructor for BC
     public function __construct()
     {
@@ -116,10 +120,12 @@ public function afterInstantiate(callable $callback): static
     }
 
     /**
+     * @param string|GroupSequence|list<string>|null $groups
+     *
      * @psalm-return static<T>
      * @phpstan-return static
      */
-    public function withValidation(): static
+    public function withValidation(string|GroupSequence|array|null $groups = null): static
     {
         if (!Configuration::instance()->validationAvailable) {
             throw new \LogicException('Validation is not available. Make sure the "symfony/validator" package is installed and validation enabled.');
@@ -128,6 +134,10 @@ public function withValidation(): static
         $clone = clone $this;
         $clone->validationEnabled = true;
 
+        if ($groups !== null) {
+            $clone->validationGroups = $groups;
+        }
+
         return $clone;
     }
 
@@ -143,6 +153,24 @@ public function withoutValidation(): static
         return $clone;
     }
 
+    /**
+     * @param string|GroupSequence|list<string>|null $groups
+     *
+     * @psalm-return static<T>
+     * @phpstan-return static
+     */
+    public function withValidationGroups(string|GroupSequence|array|null $groups): static
+    {
+        if (!Configuration::instance()->validationAvailable) {
+            throw new \LogicException('Validation is not available. Make sure the "symfony/validator" package is installed and validation enabled.');
+        }
+
+        $clone = clone $this;
+        $clone->validationGroups = $groups;
+
+        return $clone;
+    }
+
     /**
      * @internal
      */
@@ -151,6 +179,16 @@ public function validationEnabled(): bool
         return $this->validationEnabled;
     }
 
+    /**
+     * @return string|GroupSequence|list<string>|null
+     *
+     * @internal
+     */
+    public function getValidationGroups(): string|GroupSequence|array|null
+    {
+        return $this->validationGroups;
+    }
+
     /**
      * @internal
      */

diff --git a/tests/Fixture/Entity/EntityForValidation.php b/tests/Fixture/Entity/EntityForValidation.php
@@ -24,6 +24,10 @@ public function __construct(
         #[ORM\Column()]
         #[Assert\NotBlank()]
         public string $name = '',
+
+        #[ORM\Column()]
+        #[Assert\GreaterThan(10, groups: ['validation_group'])]
+        public int $number = 0,
     ) {
     }
 }
diff --git a/tests/Integration/ValidationTest.php b/tests/Integration/ValidationTest.php
@@ -44,6 +44,7 @@ public function test_it_throws_if_validation_enabled_in_foundry_but_disabled_in_
     public function test_it_validates_object_if_validation_forced(): void
     {
         self::expectException(ValidationFailedException::class);
+        self::expectExceptionMessageMatches('/This value should not be blank/');
 
         self::bootKernel(['environment' => 'validation_available']);
 
@@ -67,4 +68,34 @@ public function test_validation_can_be_disabled(): void
 
         factory(EntityForValidation::class)->withoutValidation()->create();
     }
+
+    public function test_it_validates_object_with_validation_groups(): void
+    {
+        self::expectException(ValidationFailedException::class);
+        self::expectExceptionMessageMatches('/This value should be greater than 10/');
+
+        self::bootKernel(['environment' => 'validation_available']);
+
+        factory(EntityForValidation::class)->withValidation('validation_group')->create();
+    }
+
+    public function test_it_validates_object_with_validation_groups_when_validation_enabled_globally(): void
+    {
+        self::expectException(ValidationFailedException::class);
+        self::expectExceptionMessageMatches('/This value should be greater than 10/');
+
+        self::bootKernel(['environment' => 'validation_enabled']);
+
+        factory(EntityForValidation::class)->withValidationGroups('validation_group')->create();
+    }
+
+    public function test_it_can_erase_validation_groups(): void
+    {
+        self::expectException(ValidationFailedException::class);
+        self::expectExceptionMessageMatches('/This value should not be blank/');
+
+        self::bootKernel(['environment' => 'validation_available']);
+
+        factory(EntityForValidation::class)->withValidation('validation_group')->withValidationGroups(null)->create();
+    }
 }