Merge pull request #35 from WendellAdriel/feature/simple-dto

Add SimpleDTO class

Author: WendellAdriel

README.md

@@ -17,6 +17,7 @@
     <a href="#features">Features</a> |
     <a href="#installation">Installation</a> |
     <a href="#generating-dtos">Generating DTOs</a> |
+    <a href="#simple-dtos">Simple DTOs</a> |
     <a href="#credits">Credits</a> |
     <a href="#contributing">Contributing</a>
 </p>
@@ -85,7 +86,7 @@ With this package you **define the validation once** and can **reuse it where yo
 
 You can create `DTOs` using the `make:dto` command:
 
-```
+```bash
 php artisan make:dto UserDTO
 ```
 
@@ -955,6 +956,58 @@ class AttributesDTO extends ValidatedDTO
 }
 ```
 
+## Simple DTOs
+
+If you don't need to validate the data, you can use the `SimpleDTO` class instead of the `ValidatedDTO` class.
+The DTOs created with this class will not validate the data, but will still have all the other features of the `ValidatedDTO` class:
+
+```php
+class SimpleUserDTO extends SimpleDTO
+{
+    public string $name;
+
+    public string $email;
+
+    public int $age;
+
+    protected function defaults(): array
+    {
+        return [];
+    }
+
+    protected function casts(): array
+    {
+        return [
+            'name' => new StringCast(),
+            'email' => new StringCast(),
+            'age' => new IntegerCast(),
+        ];
+    }
+
+    protected function mapBeforeValidation(): array
+    {
+        return [
+            'username' => 'name',
+            'user_email' => 'email',
+        ];
+    }
+
+    protected function mapBeforeExport(): array
+    {
+        return [
+            'name' => 'customer_name',
+            'email' => 'customer_email',
+        ];
+    }
+}
+```
+
+To generate a `SimpleDTO` you can use the `--simple` flag:
+
+```bash
+php artisan make:dto SimpleUserDTO --simple
+```
+
 ## Credits
 
 - [Wendell Adriel](https://github.com/WendellAdriel)

src/Casting/DTOCast.php

@@ -6,7 +6,7 @@
 use Throwable;
 use WendellAdriel\ValidatedDTO\Exceptions\CastException;
 use WendellAdriel\ValidatedDTO\Exceptions\CastTargetException;
-use WendellAdriel\ValidatedDTO\ValidatedDTO;
+use WendellAdriel\ValidatedDTO\SimpleDTO;
 
 class DTOCast implements Castable
 {
@@ -17,7 +17,7 @@ public function __construct(private string $dtoClass)
     /**
      * @throws CastException|CastTargetException|ValidationException
      */
-    public function cast(string $property, mixed $value): ValidatedDTO
+    public function cast(string $property, mixed $value): SimpleDTO
     {
         if (is_string($value)) {
             $value = json_decode($value, true);
@@ -35,7 +35,7 @@ public function cast(string $property, mixed $value): ValidatedDTO
             throw new CastException($property);
         }
 
-        if (! ($dto instanceof ValidatedDTO)) {
+        if (! ($dto instanceof SimpleDTO)) {
             throw new CastTargetException($property);
         }
 

src/Console/Commands/MakeDTOCommand.php

@@ -70,7 +70,9 @@ protected function getPath($name)
      */
     protected function getStub(): string
     {
-        return __DIR__.'/../stubs/dto.stub';
+        return $this->option('simple')
+            ? __DIR__.'/../stubs/simple_dto.stub'
+            : __DIR__.'/../stubs/dto.stub';
     }
 
     /**
@@ -80,6 +82,7 @@ protected function getOptions(): array
     {
         return [
             ['force', null, InputOption::VALUE_NONE, 'Create the class even if the DTO already exists'],
+            ['simple', null, InputOption::VALUE_NONE, 'If the DTO should be a SimpleDTO instead of a ValidatedDTO'],
         ];
     }
 }

src/Console/stubs/dto.stub

@@ -8,8 +8,6 @@ class {{ class }} extends ValidatedDTO
 {
     /**
      * Defines the validation rules for the DTO.
-     *
-     * @return array
      */
     protected function rules(): array
     {
@@ -18,8 +16,6 @@ class {{ class }} extends ValidatedDTO
 
     /**
      * Defines the default values for the properties of the DTO.
-     *
-     * @return array
      */
     protected function defaults(): array
     {
@@ -28,18 +24,30 @@ class {{ class }} extends ValidatedDTO
 
     /**
      * Defines the type casting for the properties of the DTO.
-     *
-     * @return array
      */
     protected function casts(): array
     {
         return [];
     }
 
+    /**
+     * Maps the DTO properties before the DTO instantiation.
+     */
+    protected function mapBeforeValidation(): array
+    {
+        return [];
+    }
+
+    /**
+     * Maps the DTO properties before the DTO export.
+     */
+    protected function mapBeforeExport(): array
+    {
+        return [];
+    }
+
     /**
      * Defines the custom messages for validator errors.
-     *
-     * @return array
      */
     public function messages(): array
     {
@@ -48,8 +56,6 @@ class {{ class }} extends ValidatedDTO
 
     /**
      * Defines the custom attributes for validator errors.
-     *
-     * @return array
      */
     public function attributes(): array
     {

src/Console/stubs/simple_dto.stub

@@ -0,0 +1,40 @@
+<?php
+
+namespace {{ namespace }};
+
+use WendellAdriel\ValidatedDTO\SimpleDTO;
+
+class {{ class }} extends SimpleDTO
+{
+    /**
+     * Defines the default values for the properties of the DTO.
+     */
+    protected function defaults(): array
+    {
+        return [];
+    }
+
+    /**
+     * Defines the type casting for the properties of the DTO.
+     */
+    protected function casts(): array
+    {
+        return [];
+    }
+
+    /**
+     * Maps the DTO properties before the DTO instantiation.
+     */
+    protected function mapBeforeValidation(): array
+    {
+        return [];
+    }
+
+    /**
+     * Maps the DTO properties before the DTO export.
+     */
+    protected function mapBeforeExport(): array
+    {
+        return [];
+    }
+}