Merge pull request #207 from RonasIT/202-resource-fields

[202] resource fields

Author: DenTray

src/Generators/ResourceGenerator.php

@@ -2,6 +2,7 @@
 
 namespace RonasIT\Support\Generators;
 
+use Illuminate\Support\Arr;
 use RonasIT\Support\Events\SuccessCreateMessage;
 use RonasIT\Support\Exceptions\ResourceAlreadyExistsException;
 
@@ -53,6 +54,7 @@ public function generateResource(): void
             'entity' => $this->model,
             'namespace' => $this->getNamespace('resources'),
             'model_namespace' => $this->getNamespace('models', $this->modelSubFolder),
+            'fields' => when($this->fields, fn () => Arr::flatten($this->fields)),
         ]);
 
         $this->saveClass('resources', "{$this->model}Resource", $resourceContent, $this->model);

stubs/resource.blade.php

@@ -8,9 +8,19 @@
  */
 class {{ $entity }}Resource extends BaseResource
 {
+@if (empty($fields))
     //TODO implement custom serialization logic or remove method redefining
+@endif
     public function toArray($request): array
     {
-        return parent::toArray($request);
-    }
+    @if (!empty($fields))
+    return [
+    @foreach($fields as $field)
+        '{{ $field }}' => $this->resource->{{ $field }},
+    @endforeach
+    ];
+    @else
+    return parent::toArray($request);
+    @endif
+}
 }

tests/ResourceGeneratorTest.php

@@ -69,6 +69,36 @@ public function testCreateResources()
         ]);
     }
 
+    public function testCreateResourcesWithFields()
+    {
+        app(ResourceGenerator::class)
+            ->setModel('Post')
+            ->setFields([
+                'integer' => ['priority'],
+                'integer-required' => ['media_id'],
+                'float' => ['seo_score'],
+                'float-required' => ['rating'],
+                'string' => ['description'],
+                'string-required' => ['title'],
+                'boolean' => ['is_reviewed'],
+                'boolean-required' => ['is_published'],
+                'timestamp' => ['reviewed_at', 'created_at', 'updated_at'],
+                'timestamp-required' => ['published_at'],
+                'json' => ['meta'],
+            ])
+            ->generate();
+
+        $this->assertGeneratedFileEquals('post_resource_with_fields.php', 'app/Http/Resources/Post/PostResource.php');
+        $this->assertGeneratedFileEquals('post_collection_resource.php', 'app/Http/Resources/Post/PostsCollectionResource.php');
+
+        $this->assertEventPushedChain([
+            SuccessCreateMessage::class => [
+                'Created a new Resource: PostResource',
+                'Created a new CollectionResource: PostsCollectionResource',
+            ],
+        ]);
+    }
+
     public function testCreateResourcesResourceStubNotExist()
     {
         config(['entity-generator.stubs.resource' => 'incorrect_stub']);

tests/fixtures/ResourceGeneratorTest/post_resource_with_fields.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Http\Resources\Post;
+
+use RonasIT\Support\Http\BaseResource;
+use App\Models\Post;
+
+/**
+ * @property Post $resource
+ */
+class PostResource extends BaseResource
+{
+    public function toArray($request): array
+    {
+        return [
+            'priority' => $this->resource->priority,
+            'media_id' => $this->resource->media_id,
+            'seo_score' => $this->resource->seo_score,
+            'rating' => $this->resource->rating,
+            'description' => $this->resource->description,
+            'title' => $this->resource->title,
+            'is_reviewed' => $this->resource->is_reviewed,
+            'is_published' => $this->resource->is_published,
+            'reviewed_at' => $this->resource->reviewed_at,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
+            'published_at' => $this->resource->published_at,
+            'meta' => $this->resource->meta,
+        ];
+    }
+}