✨ standalone action

Author: GautierDele

src/Actions/Action.php

@@ -49,6 +49,13 @@ class Action implements \JsonSerializable
      */
     public $name;
 
+    /**
+     * Indicates if the action can be run with no model.
+     *
+     * @var bool
+     */
+    public $standalone = false;
+
     /**
      * The number of models that should be included in each chunk.
      *
@@ -76,6 +83,28 @@ public function uriKey()
         return Str::slug($this->name(), '-', null);
     }
 
+    /**
+     * Mark the action as a standalone action.
+     *
+     * @return $this
+     */
+    public function standalone()
+    {
+        $this->standalone = true;
+
+        return $this;
+    }
+
+    /**
+     * Determine if the action is a standalone action.
+     *
+     * @return bool
+     */
+    public function isStandalone()
+    {
+        return $this->standalone;
+    }
+
     /**
      * Prepare the action for JSON serialization.
      *
@@ -90,6 +119,7 @@ public function jsonSerialize(): array
             'uriKey' => $this->uriKey(),
             'fields' => $this->fields($request),
             'meta'   => $this->meta(),
+            'standalone' => $this->isStandalone()
         ];
     }
 

src/Actions/DispatchAction.php

@@ -95,6 +95,26 @@ protected function configureBatchJob(\Lomkit\Rest\Actions\Action $action, array
      */
     public function dispatch($chunkCount)
     {
+        if ($this->action->isStandalone()) {
+            $modelsImpacted = $this->handleStandalone();
+        } else {
+            $modelsImpacted = $this->handleClassic($chunkCount);
+        }
+
+        if (!is_null($this->batchJob)) {
+            $this->batchJob->dispatch();
+        }
+
+        return $modelsImpacted;
+    }
+
+    /**
+     * Dispatch the given action.
+     *
+     * @param  int  $chunkCount
+     * @return int
+     */
+    public function handleClassic(int $chunkCount) {
         $searchQuery =
             app()->make(QueryBuilder::class, ['resource' => $this->request->resource, 'query' => null])
                 ->search($this->request->input('search', []));
@@ -112,25 +132,34 @@ function ($chunk) {
                 }
             );
 
-        if (!is_null($this->batchJob)) {
-            $this->batchJob->dispatch();
-        }
-
         return $searchQuery->count();
     }
 
+    /**
+     * Dispatch the given standalone action.
+     *
+     * @return int
+     *
+     */
+    public function handleStandalone() {
+
+        $this->forModels(
+            \Illuminate\Database\Eloquent\Collection::make()
+        );
+
+        return 0;
+    }
+
     /**
      * Dispatch the given action.
      *
      * @param Collection $models
      *
-     * @throws \Throwable
-     *
      * @return mixed|void
      */
     public function forModels(Collection $models)
     {
-        if ($models->isEmpty()) {
+        if ($models->isEmpty() && !$this->action->isStandalone()) {
             return;
         }
 

src/Http/Requests/OperateRequest.php

@@ -44,7 +44,12 @@ public function operateRules(Resource $resource)
         $operatedAction = $resource->action($this, $this->route()->parameter('action'));
 
         return array_merge(
-            app(SearchRequest::class)->searchRules($resource, 'search'),
+            $operatedAction->isStandalone() ? [
+                'search' => [
+                    'prohibited'
+                ]
+            ] : [],
+            !$operatedAction->isStandalone() ? app(SearchRequest::class)->searchRules($resource, 'search') : [],
             [
                 'fields.*.name' => [
                     Rule::in(array_keys($operatedAction->fields($this))),

tests/Feature/Controllers/ActionsOperationsTest.php

@@ -36,6 +36,58 @@ public function test_operate_action(): void
         );
     }
 
+    public function test_operate_standalone_action(): void
+    {
+        $model = ModelFactory::new()->create();
+        ModelFactory::new()->create();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/models/actions/standalone-modify-number',
+            [],
+            ['Accept' => 'application/json']
+        );
+
+        $response->assertJson([
+            'data' => [
+                'impacted' => 0,
+            ],
+        ]);
+        $this->assertEquals(
+            1,
+            Model::where('number', 100000000)->count()
+        );
+    }
+
+    public function test_operate_standalone_action_with_fields(): void
+    {
+        $model = ModelFactory::new()->create();
+        ModelFactory::new()->create();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/models/actions/standalone-modify-number',
+            [
+                'fields' => [
+                    ['name' => 'number', 'value' => 100000001],
+                ],
+            ],
+            ['Accept' => 'application/json']
+        );
+
+        $response->assertJson([
+            'data' => [
+                'impacted' => 0,
+            ],
+        ]);
+        $this->assertEquals(
+            1,
+            Model::where('number', 100000001)->count()
+        );
+    }
+
     public function test_operate_not_found_action(): void
     {
         ModelFactory::new()->count(2)->create();

tests/Support/Rest/Actions/StandaloneModifyNumberAction.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Lomkit\Rest\Tests\Support\Rest\Actions;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+use Lomkit\Rest\Actions\Action;
+use Lomkit\Rest\Http\Requests\RestRequest;
+
+class StandaloneModifyNumberAction extends ModifyNumberAction
+{
+    /**
+     * Perform the action on the given models.
+     *
+     * @param array                          $fields
+     * @param \Illuminate\Support\Collection $models
+     *
+     * @return mixed
+     */
+    public function handle(array $fields, Collection $models)
+    {
+        \Lomkit\Rest\Tests\Support\Models\Model::first()
+            ->forceFill(['number' => $fields['number'] ?? 100000000])
+            ->save();
+    }
+}

tests/Support/Rest/Resources/ModelResource.php

@@ -22,6 +22,7 @@
 use Lomkit\Rest\Tests\Support\Rest\Actions\BatchableModifyNumberAction;
 use Lomkit\Rest\Tests\Support\Rest\Actions\ModifyNumberAction;
 use Lomkit\Rest\Tests\Support\Rest\Actions\QueueableModifyNumberAction;
+use Lomkit\Rest\Tests\Support\Rest\Actions\StandaloneModifyNumberAction;
 use Lomkit\Rest\Tests\Support\Rest\Actions\WithMetaModifyNumberAction;
 use Lomkit\Rest\Tests\Support\Rest\Instructions\NumberedInstruction;
 
@@ -133,6 +134,7 @@ public function actions(RestRequest $request): array
     {
         return [
             ModifyNumberAction::make(),
+            StandaloneModifyNumberAction::make()->standalone(),
             QueueableModifyNumberAction::make(),
             WithMetaModifyNumberAction::make(),
             BatchableModifyNumberAction::make(),