Merge pull request #118 from WendellAdriel/feat/skip-on-transform

Add new SkipOnTransform attribute

Author: WendellAdriel

src/Attributes/SkipOnTransform.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WendellAdriel\ValidatedDTO\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class SkipOnTransform {}

src/SimpleDTO.php

@@ -25,6 +25,7 @@
 use WendellAdriel\ValidatedDTO\Attributes\Provide;
 use WendellAdriel\ValidatedDTO\Attributes\Receive;
 use WendellAdriel\ValidatedDTO\Attributes\Rules;
+use WendellAdriel\ValidatedDTO\Attributes\SkipOnTransform;
 use WendellAdriel\ValidatedDTO\Casting\ArrayCast;
 use WendellAdriel\ValidatedDTO\Casting\Castable;
 use WendellAdriel\ValidatedDTO\Casting\DTOCast;
@@ -71,6 +72,9 @@ abstract class SimpleDTO implements BaseDTO, CastsAttributes, JsonSerializable
     /** @internal */
     protected array $dtoMapTransform = [];
 
+    /** @internal */
+    protected array $dtoSkipOnTransform = [];
+
     /** @internal */
     private static array $classReflections = [];
 
@@ -345,6 +349,10 @@ protected function buildDataForExport(): array
             if (! array_key_exists($property, $data) && isset($this->{$property})) {
                 $data[$property] = $this->{$property};
             }
+
+            if (in_array($property, $this->dtoSkipOnTransform)) {
+                unset($data[$property]);
+            }
         }
 
         return $this->mapDTOData($mapping, $data);
@@ -388,6 +396,10 @@ private function buildAttributesData(): void
             $this->dtoCasts[$property] = $attributeInstance;
         }
 
+        $this->dtoSkipOnTransform = array_keys(
+            $this->getPropertiesForAttribute($publicProperties, SkipOnTransform::class)
+        );
+
         $classReflection = $this->classReflection($this::class);
         $classAttributes = collect($classReflection->getAttributes());
         $lazyAttribute = $classAttributes->first(
@@ -612,6 +624,7 @@ private function isforbiddenProperty(string $property): bool
             'dtoCasts',
             'dtoMapData',
             'dtoMapTransform',
+            'dtoSkipOnTransform',
             'lazyValidation',
         ]);
     }

tests/Datasets/SkipDTO.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WendellAdriel\ValidatedDTO\Tests\Datasets;
+
+use WendellAdriel\ValidatedDTO\Attributes\Cast;
+use WendellAdriel\ValidatedDTO\Attributes\Rules;
+use WendellAdriel\ValidatedDTO\Attributes\SkipOnTransform;
+use WendellAdriel\ValidatedDTO\Casting\IntegerCast;
+use WendellAdriel\ValidatedDTO\Concerns\EmptyCasts;
+use WendellAdriel\ValidatedDTO\Concerns\EmptyDefaults;
+use WendellAdriel\ValidatedDTO\Concerns\EmptyRules;
+use WendellAdriel\ValidatedDTO\ValidatedDTO;
+
+final class SkipDTO extends ValidatedDTO
+{
+    use EmptyCasts,
+        EmptyDefaults,
+        EmptyRules;
+
+    #[Rules(['required', 'string'])]
+    public string $name;
+
+    #[Cast(IntegerCast::class)]
+    #[SkipOnTransform]
+    #[Rules(['required', 'integer'])]
+    public int $age;
+}

tests/Unit/SkipOnTransformTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+use WendellAdriel\ValidatedDTO\Tests\Datasets\SkipDTO;
+use WendellAdriel\ValidatedDTO\ValidatedDTO;
+
+beforeEach(function () {
+    $this->name = fake()->name;
+    $this->age = fake()->numberBetween(1, 20);
+});
+
+it('skip attribute when transforming to array', function () {
+    $dto = new SkipDTO([
+        'name' => $this->name,
+        'age' => $this->age,
+    ]);
+
+    expect($dto)->toBeInstanceOf(ValidatedDTO::class)
+        ->and($dto->name)->toBe($this->name)
+        ->and($dto->toArray())->toBe(['name' => $this->name]);
+});
+
+it('skip attribute when transforming to json', function () {
+    $dto = new SkipDTO([
+        'name' => $this->name,
+        'age' => $this->age,
+    ]);
+
+    expect($dto)->toBeInstanceOf(ValidatedDTO::class)
+        ->and($dto->name)->toBe($this->name)
+        ->and($dto->toJson())->toBe('{"name":"' . $this->name . '"}');
+});