Add decorated stubs and fixed model camel case

Admin · Admin · commit 0e98c9645fd1 · 2025-03-31T15:17:37.000+03:00
diff --git a/README.md b/README.md
@@ -16,9 +16,9 @@ Library for [laravel-crud-wizard-free](https://github.com/macropay-solutions/lar
 
 ## Usage
 
-``` php artisan make:api-resource {resourceName} ```
+``` php artisan make:api-resource {resourceName} {--decorated}```
 
-This will create a template for **controller**, **service** and **model** and will print instructions on what is left to be done manually.
+This will create a template for **controller**, **service** and **model** (optionally, with the --decorated flag it will create also a **decorator** and **middleware**) and will print instructions on what is left to be done manually.
 
 Example:
 ```
@@ -31,6 +31,12 @@ TODO:
 - Fill the model's properties,
 - Define validations in controller,
 - Expose resource in DbCrudMap::MODEL_FQN_TO_CONTROLLER_MAP.
+Created Decorator: /var/www/html/project/app/Decorators/OperationDecorator.php
+Created Middleware: /var/www/html/project/app/Http/Midleware/Decorators/OperationsMiddleware.php
+TODO:
+- Fill the decorator,
+- Register middleware decorator as route middleware,
+- Use the middleware alias as middleware in your crud route definition for each method.
 ```
 
 
diff --git a/src/Console/MakeLaravelCrudWizard.php b/src/Console/MakeLaravelCrudWizard.php
@@ -4,6 +4,8 @@
 
 use Illuminate\Console\Command;
 use MacropaySolutions\LaravelCrudWizardGenerator\Services\MakeControllerService;
+use MacropaySolutions\LaravelCrudWizardGenerator\Services\MakeDecoratorService;
+use MacropaySolutions\LaravelCrudWizardGenerator\Services\MakeMiddlewareService;
 use MacropaySolutions\LaravelCrudWizardGenerator\Services\MakeModelService;
 use MacropaySolutions\LaravelCrudWizardGenerator\Services\MakeServiceService;
 
@@ -14,7 +16,7 @@ class MakeLaravelCrudWizard extends Command
      *
      * @var string
      */
-    protected $signature = 'make:api-resource {resourceName}';
+    protected $signature = 'make:api-resource {resourceName} {--decorated}';
 
     /**
      * The console command description.
@@ -26,7 +28,9 @@ class MakeLaravelCrudWizard extends Command
     public function __construct(
         protected MakeControllerService $makeControllerService,
         protected MakeModelService $makeModelService,
-        protected MakeServiceService $makeServiceService
+        protected MakeServiceService $makeServiceService,
+        protected MakeDecoratorService $makeDecoratorService,
+        protected MakeMiddlewareService $makeMiddlewareService
     ) {
         parent::__construct();
     }
@@ -40,5 +44,12 @@ public function handle(): void
         $this->makeModelService->makeCompleteModelFile($resourceName, $ns = $this->laravel->getNamespace());
         $this->makeServiceService->makeCompleteServiceFile($resourceName, $ns);
         $this->makeControllerService->makeCompleteControllerFile($resourceName, $ns);
+
+        if (!$this->option('decorated')) {
+            return;
+        }
+
+        $this->makeDecoratorService->makeCompleteDecoratorFile($resourceName, $ns);
+        $this->makeMiddlewareService->makeCompleteMiddlewareFile($resourceName, $ns);
     }
 }
diff --git a/src/Services/MakeControllerService.php b/src/Services/MakeControllerService.php
@@ -37,7 +37,7 @@ protected function replaceContentControllerStub(string $resourceName, string $la
             'DummyClass',
         ], [
             \trim($laravelNamespace, '\\'),
-            \ucfirst(Str::singular($resourceName)),
+            \ucfirst(Str::camel(Str::singular($resourceName))),
             ($plural = \ucfirst(Str::camel(Str::plural($resourceName)))) . 'Service',
             $plural . 'Controller',
         ], File::get($this->pathsAndNamespacesService->getControllerStubPath()));
diff --git a/src/Services/MakeDecoratorService.php b/src/Services/MakeDecoratorService.php
@@ -0,0 +1,52 @@
+<?php
+
+namespace MacropaySolutions\LaravelCrudWizardGenerator\Services;
+
+use Illuminate\Console\Concerns\InteractsWithIO;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Str;
+use Symfony\Component\Console\Output\ConsoleOutput;
+
+class MakeDecoratorService
+{
+    use InteractsWithIO;
+
+    public function __construct(
+        protected PathsAndNamespacesService $pathsAndNamespacesService,
+        ConsoleOutput $consoleOutput,
+    ) {
+        $this->output = $consoleOutput;
+    }
+
+    public function makeCompleteDecoratorFile(string $resourceName, string $laravelNamespace): void
+    {
+        $this->createDecoratorFile($this->replaceContentDecoratorStub($resourceName, $laravelNamespace), $resourceName);
+    }
+
+    protected function replaceContentDecoratorStub(string $resourceName, string $laravelNamespace): string
+    {
+        return \str_replace([
+            'DummyNamespace',
+            'DummyClass',
+        ], [
+            \trim($laravelNamespace, '\\'),
+            \ucfirst(Str::camel(Str::singular($resourceName))) . 'Decorator',
+        ], File::get($this->pathsAndNamespacesService->getDecoratorStubPath()));
+    }
+
+    protected function createDecoratorFile(string $decoratorStub, string $resourceName): void
+    {
+        if (!File::exists($path = $this->pathsAndNamespacesService->getRealpathBaseDecorator())) {
+            File::makeDirectory($path);
+        }
+
+        if (!File::exists($path = $this->pathsAndNamespacesService->getRealpathBaseCustomDecorator($resourceName))) {
+            File::put($path, $decoratorStub);
+            $this->line('<info>Created Decorator:</info> ' . $path);
+
+            return;
+        }
+
+        $this->error('Decorator ' . $path . ' already exists');
+    }
+}
diff --git a/src/Services/MakeMiddlewareService.php b/src/Services/MakeMiddlewareService.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace MacropaySolutions\LaravelCrudWizardGenerator\Services;
+
+use Illuminate\Console\Concerns\InteractsWithIO;
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Str;
+use Symfony\Component\Console\Output\ConsoleOutput;
+
+class MakeMiddlewareService
+{
+    use InteractsWithIO;
+
+    public function __construct(
+        protected PathsAndNamespacesService $pathsAndNamespacesService,
+        protected Application $application,
+        ConsoleOutput $consoleOutput,
+    ) {
+        $this->output = $consoleOutput;
+    }
+
+    public function makeCompleteMiddlewareFile(string $resourceName, string $laravelNamespace): void
+    {
+        $this->createMiddlewareFile(
+            $this->replaceContentMiddlewareStub($resourceName, $laravelNamespace),
+            $resourceName
+        );
+    }
+
+    protected function replaceContentMiddlewareStub(string $resourceName, string $laravelNamespace): string
+    {
+        return \str_replace([
+            'DummyNamespace',
+            'DummyModel',
+            'DummyClass',
+        ], [
+            \trim($laravelNamespace, '\\'),
+            \ucfirst(Str::camel(Str::singular($resourceName))),
+            \ucfirst(Str::camel(Str::plural($resourceName))) . 'Middleware',
+        ], File::get($this->pathsAndNamespacesService->getMiddlewareStubPath()));
+    }
+
+    protected function createMiddlewareFile(string $middlewareStub, string $resourceName): void
+    {
+        if (!File::exists($path = $this->pathsAndNamespacesService->getRealpathBaseMiddleware())) {
+            File::makeDirectory($path);
+        }
+
+        if (!File::exists($path = $this->pathsAndNamespacesService->getRealpathBaseCustomMiddleware($resourceName))) {
+            File::put($path, $middlewareStub);
+            $this->line('<info>Created Middleware:</info> ' . $path);
+            $this->info('TODO:');
+            $this->info('- Fill the decorator,');
+            $this->info('- Register middleware decorator as route middleware,');
+            $this->info('- Use the middleware alias as middleware in your crud route definition for each method.');
+
+            return;
+        }
+
+        $this->error('Middleware ' . $path . ' already exists');
+    }
+}
diff --git a/src/Services/MakeModelService.php b/src/Services/MakeModelService.php
@@ -34,7 +34,7 @@ protected function replaceContentModelStub(string $laravelNamespace, string $res
             \trim($laravelNamespace, '\\'),
             Str::snake(Str::plural($resourceName), '-'),
             Str::snake(Str::plural($resourceName)),
-            \ucfirst(Str::singular($resourceName)),
+            \ucfirst(Str::camel(Str::singular($resourceName))),
         ], File::get($this->pathsAndNamespacesService->getModelStubPath()));
     }
 
diff --git a/src/Services/MakeServiceService.php b/src/Services/MakeServiceService.php
@@ -31,7 +31,7 @@ protected function replaceContentServiceStub(string $resourceName, string $larav
             'DummyClass',
         ], [
             \trim($laravelNamespace, '\\'),
-            \ucfirst(Str::singular($resourceName)),
+            \ucfirst(Str::camel(Str::singular($resourceName))),
             \ucfirst(Str::camel(Str::plural($resourceName))) . 'Service',
         ], File::get($this->pathsAndNamespacesService->getServiceStubPath()));
     }
diff --git a/src/Services/PathsAndNamespacesService.php b/src/Services/PathsAndNamespacesService.php
@@ -31,14 +31,25 @@ public function getControllerStubPath(): string
         return $this->getStubPath() . DIRECTORY_SEPARATOR . 'Controller.stub';
     }
 
+    public function getDecoratorStubPath(): string
+    {
+        return $this->getStubPath() . DIRECTORY_SEPARATOR . 'Decorator.stub';
+    }
+
+    public function getMiddlewareStubPath(): string
+    {
+        return $this->getStubPath() . DIRECTORY_SEPARATOR . 'Middleware.stub';
+    }
+
     public function getRealpathBaseModel(): string
     {
         return $this->getRealpathBase('app') . DIRECTORY_SEPARATOR . 'Models';
     }
 
     public function getRealpathBaseCustomModel(string $resourceName): string
     {
-        return $this->getRealpathBaseModel() . DIRECTORY_SEPARATOR . \ucfirst(Str::singular($resourceName)) . '.php';
+        return $this->getRealpathBaseModel() . DIRECTORY_SEPARATOR .
+            \ucfirst(Str::camel(Str::singular($resourceName))) . '.php';
     }
 
     public function getRealpathBaseService(): string
@@ -62,4 +73,26 @@ public function getRealpathBaseCustomController(string $resourceName): string
         return $this->getRealpathBaseController() . DIRECTORY_SEPARATOR .
             \ucfirst(Str::camel(Str::plural($resourceName))) . 'Controller.php';
     }
+
+    public function getRealpathBaseDecorator(): string
+    {
+        return $this->getRealpathBase('app') . DIRECTORY_SEPARATOR . 'Decorators';
+    }
+
+    public function getRealpathBaseCustomDecorator(string $resourceName): string
+    {
+        return $this->getRealpathBaseDecorator() . DIRECTORY_SEPARATOR .
+            \ucfirst(Str::camel(Str::singular($resourceName))) . 'Decorator.php';
+    }
+
+    public function getRealpathBaseMiddleware(): string
+    {
+        return $this->getRealpathBase('app' . DIRECTORY_SEPARATOR . 'Http' . DIRECTORY_SEPARATOR . 'Middleware' . DIRECTORY_SEPARATOR . 'Decorators');
+    }
+
+    public function getRealpathBaseCustomMiddleware(string $resourceName): string
+    {
+        return $this->getRealpathBaseMiddleware() . DIRECTORY_SEPARATOR .
+            \ucfirst(Str::camel(Str::plural($resourceName))) . 'Middleware.php';
+    }
 }
diff --git a/src/stubs/Decorator.stub b/src/stubs/Decorator.stub
@@ -0,0 +1,37 @@
+<?php
+
+namespace DummyNamespace\Decorators;
+
+use MacropaySolutions\LaravelCrudWizardDecorator\Decorators\AbstractResourceDecorator
+
+class DummyClass extends AbstractResourceDecorator
+{
+    public function getResourceMappings(): array
+    {
+        return [
+//            'col' => 'decoratedCol',
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getRelationMappings(): array
+    {
+        return [
+//            'relationName' => [
+//                'relColumn' => 'decoratedRelColumn',
+//            ],
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getComposedColumns(): array
+    {
+        return [
+            // 'custom' => fn(array $row): string => '',
+        ];
+    }
+}
diff --git a/src/stubs/Middleware.stub b/src/stubs/Middleware.stub
@@ -0,0 +1,17 @@
+<?php
+
+namespace DummyNamespace\Http\Middleware\Decorators;
+
+use DummyNamespace\Models\DummyModel;
+use DummyNamespace\Decorators\DummyModelDecorator;
+use MacropaySolutions\LaravelCrudWizardDecorator\Http\Middleware\Decorators
+
+class DummyClass extends AbstractDecoratorMiddleware
+{
+    protected string $decoratorClass = DummyModelDecorator::class;
+
+    public function setResourceModel(): void
+    {
+        $this->resourceModel = new DummyModel();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ protected function replaceContentModelStub(string $laravelNamespace, string $res`
`34`	`34`	`\trim($laravelNamespace, '\\'),`
`35`	`35`	`Str::snake(Str::plural($resourceName), '-'),`
`36`	`36`	`Str::snake(Str::plural($resourceName)),`
`37`		`- \ucfirst(Str::singular($resourceName)),`
	`37`	`+ \ucfirst(Str::camel(Str::singular($resourceName))),`
`38`	`38`	`], File::get($this->pathsAndNamespacesService->getModelStubPath()));`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ protected function replaceContentServiceStub(string $resourceName, string $larav`
`31`	`31`	`'DummyClass',`
`32`	`32`	`], [`
`33`	`33`	`\trim($laravelNamespace, '\\'),`
`34`		`- \ucfirst(Str::singular($resourceName)),`
	`34`	`+ \ucfirst(Str::camel(Str::singular($resourceName))),`
`35`	`35`	`\ucfirst(Str::camel(Str::plural($resourceName))) . 'Service',`
`36`	`36`	`], File::get($this->pathsAndNamespacesService->getServiceStubPath()));`
`37`	`37`	`}`