Merge branch 'feat/make-command' into feat/custom-states

Author: julian-farbcode

src/Console/Commands/StatefulResourceMakeCommand.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Farbcode\StatefulResources\Console\Commands;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+#[AsCommand(name: 'make:stateful-resource')]
+class StatefulResourceMakeCommand extends \Illuminate\Console\GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'make:stateful-resource';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new stateful resource';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Stateful Resource';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        parent::handle();
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('/stubs/stateful-resource.stub');
+    }
+
+    /**
+     * Resolve the fully-qualified path to the stub.
+     *
+     * @param  string  $stub
+     * @return string
+     */
+    protected function resolveStubPath($stub)
+    {
+        return __DIR__.$stub;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Http\Resources';
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the resource already exists'],
+        ];
+    }
+}

src/Console/Commands/stubs/stateful-resource.stub

@@ -0,0 +1,19 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Http\Request;
+use Farbcode\StatefulResources\StatefulJsonResource;
+
+class {{ class }} extends StatefulJsonResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray(Request $request): array
+    {
+        return parent::toArray($request);
+    }
+}

src/StatefulResourcesServiceProvider.php

@@ -17,6 +17,9 @@ public function configurePackage(Package $package): void
          */
         $package
             ->name('stateful-resources')
+            ->hasCommands([
+                Console\Commands\StatefulResourceMakeCommand::class,
+            ])
             ->hasConfigFile();
     }
 

tests/Feature/MakeCommandTest.php

@@ -0,0 +1,25 @@
+<?php
+
+use Farbcode\StatefulResources\Tests\TestCase;
+use Illuminate\Support\Facades\File;
+
+beforeEach(function () {
+    $this->testResourcePath = app_path('Http/Resources/TestResource.php');
+});
+
+afterEach(function () {
+    if (File::exists($this->testResourcePath)) {
+        File::delete($this->testResourcePath);
+    }
+});
+
+it('can create a new stateful resource', function () {
+    /** @var TestCase $this */
+    $this->artisan('make:stateful-resource', [
+        'name' => 'TestResource',
+    ])
+        ->assertExitCode(0)
+        ->expectsOutputToContain('created successfully.');
+
+    $this->assertFileExists(app_path('Http/Resources/TestResource.php'));
+});

workbench/app/Models/Cat.php

@@ -2,6 +2,7 @@
 
 namespace Workbench\App\Models;
 
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 
 /**
@@ -15,5 +16,12 @@
  */
 class Cat extends Model
 {
+    use HasFactory;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array<string>
+     */
     protected $fillable = ['name', 'breed', 'fluffyness', 'color'];
 }