Merge pull request #1 from alibori/LARG-3-Add-option-to-create-multip…

…le-resources-at-once

LARG-3 feat(command): Add option to generate multiple resources at once

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-api-resource-generator` will be documented in this file.
 
+## 1.4.0 - 2024-04-16
+
+- Added option to generate multiple resources at once.
+
 ## 1.3.2 - 2024-03-08
 
 ### Added

README.md

@@ -22,7 +22,13 @@ All you need to do is run the following command:
 php artisan api-resource:generate <model-name>
 ```
 
-This command will generate a new resource for the given model name with the properties defined in the model.
+If you want to generate multiple resources at once, you can pass multiple model names separated by a comma:
+
+``` bash
+php artisan api-resource:generate <model-name>,<model-name>,<model-name>
+```
+
+This command will generate a new resource for the given model/s name/s with the properties defined in the model.
 
 If you want to set the array keys of the resource as *camelCase*, you will be prompted to do it.
 

app/Models/Post.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Alibori\LaravelApiResourceGenerator\App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    use HasFactory;
+
+    protected $table = 'posts';
+
+    protected $fillable = [
+        'title',
+        'created_at',
+        'updated_at',
+    ];
+}

build/report.junit.xml

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites>
-  <testsuite name="" tests="2" assertions="2" errors="0" warnings="0" failures="0" skipped="0" time="0.207782">
-    <testsuite name="P\Tests\Feature\Test" file="C:\laragon\www\custom-packages\laravel-api-resource-generator\vendor\pestphp\pest\src\Factories\TestCaseFactory.php(223) : eval()'d code" tests="2" assertions="2" errors="0" warnings="0" failures="0" skipped="0" time="0.207782">
-      <testcase name="it database users table has been created" assertions="1" time="0.103244"/>
-      <testcase name="it can generate a resource" assertions="1" time="0.104538"/>
+  <testsuite name="" tests="3" assertions="4" errors="0" warnings="0" failures="0" skipped="0" time="0.203934">
+    <testsuite name="P\Tests\Feature\Test" file="C:\laragon\www\custom-packages\laravel-api-resource-generator\vendor\pestphp\pest\src\Factories\TestCaseFactory.php(223) : eval()'d code" tests="3" assertions="4" errors="0" warnings="0" failures="0" skipped="0" time="0.203934">
+      <testcase name="it database users table has been created" assertions="1" time="0.096050"/>
+      <testcase name="it can generate a resource" assertions="1" time="0.093684"/>
+      <testcase name="it can generate a resource for multiple models" assertions="2" time="0.014201"/>
     </testsuite>
   </testsuite>
 </testsuites>

src/Console/GenerateApiResourceCommand.php

@@ -26,41 +26,20 @@ class GenerateApiResourceCommand extends Command
     /**
      * @var string
      */
-    protected $description = 'Generate a Laravel API Resource for a given model.';
+    protected $description = 'Generate a Laravel API Resource for a given model or models.';
 
-    /**
-     * @var string
-     */
     protected string $dir;
 
-    /**
-     * @var string
-     */
     protected string $namespace;
 
-    /**
-     * @var Filesystem
-     */
     protected Filesystem $files;
 
-    /**
-     * @var array
-     */
     protected array $properties = [];
 
-    /**
-     * @var array
-     */
     protected array $php_docs_properties = [];
 
-    /**
-     * @var string
-     */
     protected string $stub = __DIR__.'/stubs/api-resource.php.stub';
 
-    /**
-     * @var string
-     */
     protected string $return_case = 'snake_case';
 
     public function __construct(Filesystem $files)
@@ -82,11 +61,24 @@ public function handle(): void
         $this->dir = $this->defaultResourcesDir();
         $this->namespace = config('apiresourcegenerator.resources.namespace');
 
-        $model = $this->loadModel($this->argument('model'));
+        // If the model argument contains a comma, we assume it's a list of models. We will generate a resource for each model.
+        if (Str::contains($this->argument('model'), ',')) {
+            $models = explode(',', $this->argument('model'));
+
+            foreach ($models as $model_classname) {
+                $model = $this->loadModel($model_classname);
 
-        $this->getPropertiesFromTable($model);
+                $this->getPropertiesFromTable($model);
 
-        $this->generateResource($model);
+                $this->generateResource($model);
+            }
+        } else {
+            $model = $this->loadModel($this->argument('model'));
+
+            $this->getPropertiesFromTable($model);
+
+            $this->generateResource($model);
+        }
     }
 
     protected function getArguments(): array
@@ -144,7 +136,6 @@ protected function getPropertiesFromTable(Model $model): void
             [$database, $table] = explode('.', $table);
         }
 
-        //$columns = $schema->listTableColumns($table, $database);
         // Check if listTableColumns method exists to deal with Laravel 11 upgrade
         if (method_exists($schema, 'listTableColumns')) {
             $columns = $schema->listTableColumns($table, $database);
@@ -239,6 +230,7 @@ protected function buildResource(string $name): string
         $stub = str_replace('{{ docblock }}', $doc_block, $stub);
         $stub = str_replace('{{ class }}', $name.'Resource', $stub);
         $stub = str_replace('{{ namespace }}', $this->namespace, $stub);
+
         return str_replace('{{ fields }}', $fields, $stub);
     }
 

tests/Feature/Test.php

@@ -22,3 +22,16 @@
 
     unlink(__DIR__.'/../../app/Http/Resources/UserResource.php');
 });
+
+// Test to check if GenerateApiResourceCommand is working well with multiple models
+it('can generate a resource for multiple models', function (): void {
+    $command = $this->app->make(GenerateApiResourceCommand::class);
+
+    $this->runCommand($command, ['model' => 'User,Post']);
+
+    expect(file_exists(__DIR__.'/../../app/Http/Resources/UserResource.php'))->toBeTrue()
+        ->and(file_exists(__DIR__.'/../../app/Http/Resources/PostResource.php'))->toBeTrue();
+
+    unlink(__DIR__.'/../../app/Http/Resources/UserResource.php');
+    unlink(__DIR__.'/../../app/Http/Resources/PostResource.php');
+});