✨ instructions stub

Author: GautierDele

src/Console/Commands/InstructionCommand.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Lomkit\Rest\Console\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Contracts\Console\PromptsForMissingInput;
+use Illuminate\Database\Migrations\MigrationCreator;
+use Illuminate\Support\Composer;
+use Illuminate\Support\Str;
+use Lomkit\Rest\Console\ResolvesStubPath;
+
+class InstructionCommand extends GeneratorCommand implements PromptsForMissingInput
+{
+    use ResolvesStubPath;
+
+    /**
+     * The console command signature.
+     *
+     * @var string
+     */
+    protected $signature = 'rest:instruction {name : The name of instruction action}
+        {--path= : The location where the instruction file should be created}';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Instruction';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new instruction class';
+
+    public function handle()
+    {
+        parent::handle();
+    }
+
+    /**
+     * Build the class with the given name.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function buildClass($name)
+    {
+        return parent::buildClass($name);
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('/stubs/rest/instruction.stub');
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Rest\Instructions';
+    }
+}

src/Console/stubs/action.stub

@@ -21,7 +21,7 @@ class {{ class }} extends RestAction
         }
 
         /**
-         * Called in an action failed.
+         * The action fields.
          *
          * @param  \Lomkit\Rest\Http\Requests\RestRequest $request
          * @return array

src/Console/stubs/instruction.stub

@@ -0,0 +1,35 @@
+<?php
+
+namespace {{ namespace }};
+
+use Lomkit\Rest\Instructions\Instruction as RestInstruction;
+
+class {{ class }} extends RestInstruction
+{
+    /**
+         * Perform the action on the given models.
+         *
+         * @param  array  $fields
+         * @param  \Illuminate\Database\Eloquent\Builder $query
+         * @return void
+         */
+        public function handle(array $fields, \Illuminate\Database\Eloquent\Builder $query)
+        {
+            // ...
+        }
+
+        /**
+         * The instruction fields.
+         *
+         * @param  \Lomkit\Rest\Http\Requests\RestRequest $request
+         * @return array
+         */
+        public function fields(\Lomkit\Rest\Http\Requests\RestRequest $request)
+        {
+            return [
+                'id' => [
+                    'required'
+                ]
+            ];
+        }
+}

src/Console/stubs/resource.stub

@@ -67,4 +67,13 @@ class {{ class }} extends RestResource
     public function actions(RestRequest $request): array {
         return [];
     }
+
+    /**
+     * The instructions that should be linked
+     * @param RestRequest $request
+     * @return array
+     */
+    public function instructions(RestRequest $request): array {
+        return [];
+    }
 }

src/RestServiceProvider.php

@@ -8,6 +8,7 @@
 use Lomkit\Rest\Console\Commands\BaseControllerCommand;
 use Lomkit\Rest\Console\Commands\BaseResourceCommand;
 use Lomkit\Rest\Console\Commands\ControllerCommand;
+use Lomkit\Rest\Console\Commands\InstructionCommand;
 use Lomkit\Rest\Console\Commands\QuickStartCommand;
 use Lomkit\Rest\Console\Commands\ResourceCommand;
 use Lomkit\Rest\Console\Commands\ResponseCommand;
@@ -55,7 +56,8 @@ protected function registerCommands()
                 ResourceCommand::class,
                 ResponseCommand::class,
                 QuickStartCommand::class,
-                ActionCommand::class
+                ActionCommand::class,
+                InstructionCommand::class
             ]);
         }
     }

tests/Support/Rest/Instructions/NumberedInstruction.php

@@ -8,7 +8,7 @@ class NumberedInstruction extends Instruction
 {
     public function handle(array $fields, \Illuminate\Database\Eloquent\Builder $query)
     {
-        return $query->where('number', '>', $fields['number'] ?? 0);
+        $query->where('number', '>', $fields['number'] ?? 0);
     }
 
     public function fields(\Lomkit\Rest\Http\Requests\RestRequest $request): array