chore: Use attributes-php/options instead of custom options

Author: matapatos

composer.json

@@ -10,7 +10,8 @@
     "license": "MIT",
     "require": {
         "php": "^8.1",
-        "respect/validation": "^2.0"
+        "respect/validation": "^2.0",
+        "attributes-php/options": "^0.1"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -4,12 +4,12 @@
 
 namespace Attributes\Validation;
 
+use Attributes\Options;
+use Attributes\Options\Exceptions\InvalidOptionException;
 use Attributes\Validation\Exceptions\ContextPropertyException;
 use Attributes\Validation\Exceptions\ContinueValidationException;
-use Attributes\Validation\Exceptions\InvalidOptionException;
 use Attributes\Validation\Exceptions\StopValidationException;
 use Attributes\Validation\Exceptions\ValidationException;
-use Attributes\Validation\Options as Options;
 use Attributes\Validation\Validators\AttributesValidator;
 use Attributes\Validation\Validators\ChainValidator;
 use Attributes\Validation\Validators\PropertyValidator;
@@ -56,6 +56,7 @@ public function __construct(?PropertyValidator $validator = null, bool $stopFirs
      * @throws ValidationException - If validation fails
      * @throws ContextPropertyException - If unable to retrieve a given context property
      * @throws ReflectionException
+     * @throws InvalidOptionException
      */
     public function validate(array $data, string|object $model): object
     {
@@ -75,6 +76,10 @@ public function validate(array $data, string|object $model): object
         $this->context->set(ErrorHolder::class, $errorInfo, override: true);
         $defaultAliasGenerator = $this->getDefaultAliasGenerator($reflectionClass);
         foreach ($reflectionClass->getProperties() as $reflectionProperty) {
+            if (! $this->isToValidate($reflectionProperty)) {
+                continue;
+            }
+
             $propertyName = $reflectionProperty->getName();
             $aliasName = $this->getAliasName($reflectionProperty, $defaultAliasGenerator);
             $this->context->push('internal.currentProperty', $propertyName);
@@ -162,4 +167,19 @@ private function getAliasName(ReflectionProperty $reflectionProperty, callable $
 
         return $defaultAliasGenerator($propertyName);
     }
+
+    /**
+     * Checks if a given property is to be ignored
+     */
+    private function isToValidate(ReflectionProperty $reflectionProperty): bool
+    {
+        $allAttributes = $reflectionProperty->getAttributes(Options\Ignore::class);
+        foreach ($allAttributes as $attribute) {
+            $instance = $attribute->newInstance();
+
+            return ! $instance->ignoreValidation();
+        }
+
+        return true;
+    }
 }

src/Exceptions/InvalidOptionException.php

@@ -12,11 +12,14 @@
 
 namespace Attributes\Validation\Tests\Integration;
 
-use Attributes\Validation\Exceptions\ValidationException;
-use Attributes\Validation\Options as Options;
+use Attributes\Options as Options;
+use Attributes\Options\Exceptions\InvalidOptionException;
+use Attributes\Options\Ignore;
 use Attributes\Validation\Tests\Models as Models;
 use Attributes\Validation\Validator;
 
+// Alias and alias generator
+
 test('Alias/AliasGenerator options', function (bool $isStrict) {
     $validator = new Validator(strict: $isStrict);
     $rawData = [
@@ -37,7 +40,9 @@
         ->toHaveProperty('my_title', 'My Post Title');
 })
     ->with([true, false])
-    ->group('validator', 'options', 'nested');
+    ->group('validator', 'options', 'alias', 'alias-generator');
+
+// Alias generator
 
 test('AliasGenerator camelCase', function (bool $isStrict) {
     $validator = new Validator(strict: $isStrict);
@@ -60,7 +65,7 @@
         ->toHaveProperty('camelCaseName', 'camel');
 })
     ->with([true, false])
-    ->group('validator', 'options', 'basic');
+    ->group('validator', 'options', 'alias-generator');
 
 test('AliasGenerator PascalCase', function (bool $isStrict) {
     $validator = new Validator(strict: $isStrict);
@@ -83,7 +88,7 @@
         ->toHaveProperty('camelCaseName', 'camel');
 })
     ->with([true, false])
-    ->group('validator', 'options', 'basic');
+    ->group('validator', 'options', 'alias-generator');
 
 test('AliasGenerator SnakeCase', function (bool $isStrict) {
     $validator = new Validator(strict: $isStrict);
@@ -106,7 +111,7 @@
         ->toHaveProperty('camelCaseName', 'camel');
 })
     ->with([true, false])
-    ->group('validator', 'options', 'basic');
+    ->group('validator', 'options', 'alias-generator');
 
 test('Invalid AliasGenerator', function (bool $isStrict) {
     $validator = new Validator(strict: $isStrict);
@@ -116,5 +121,32 @@
     });
 })
     ->with([true, false])
-    ->throws(ValidationException::class, 'Invalid alias generator \'invalid\'')
-    ->group('validator', 'options', 'basic');
+    ->throws(InvalidOptionException::class, 'Invalid alias generator \'invalid\'')
+    ->group('validator', 'options', 'alias-generator');
+
+// Ignore
+
+test('Ignore', function (bool $isStrict) {
+    $validator = new Validator(strict: $isStrict);
+    $rawData = [
+        'value' => 'my value',
+        'ignore' => 'ignored',
+        'ignoreValidation' => 'ignored',
+    ];
+    $model = $validator->validate($rawData, new class
+    {
+        public string $value;
+
+        #[Ignore]
+        public string $ignore = 'original';
+
+        #[Ignore(serialization: false)]
+        public string $ignoreValidation = 'original';
+    });
+    expect($model)
+        ->toHaveProperty('value', 'my value')
+        ->toHaveProperty('ignore', 'original')
+        ->toHaveProperty('ignoreValidation', 'original');
+})
+    ->with([true, false])
+    ->group('validator', 'options', 'ignore');

src/Options/Alias.php

@@ -153,7 +153,7 @@
         ->toMatchArray($value);
 })
     ->with([[[1, 2, 3]], [['hello', 'bro', 'another']]])
-    ->group('validator', 'union', 'hey');
+    ->group('validator', 'union');
 
 /*** Intersection ***/
 

src/Options/AliasGenerator.php

@@ -2,8 +2,9 @@
 
 namespace Attributes\Validation\Tests\Models\Complex;
 
-use Attributes\Validation\Options\Alias;
-use Attributes\Validation\Options\AliasGenerator;
+use Attributes\Options\Alias;
+use Attributes\Options\AliasGenerator;
+use Attributes\Options\Ignore;
 use Respect\Validation\Rules as Rules;
 
 #[AliasGenerator('camel')]
@@ -14,6 +15,9 @@ class Post
 
     #[Rules\NotEmpty]
     public string $my_title;
+
+    #[Ignore]
+    public string $privateData;
 }
 
 class Profile