Standalone actions. (#259)

* Standalone actions.

* Apply fixes from StyleCI (#258)

* Docs

Author: binaryk

docs/docs/3.0/actions/actions.md

@@ -236,3 +236,44 @@ public function handle(ActionRequest $request, Post $post): JsonResponse
     //
 }
 ```
+
+## Standalone actions
+
+Sometimes you don't need to have an action with models. Let's say for example the authenticated user wants to disable his account. For this we have `standalone` actions:
+
+
+```php
+// UserRepository
+
+    public function actions(RestifyRequest $request)
+    {
+        return [
+            DisableProfileAction::new()->standalone(),
+        ];
+    }
+```
+
+Just mark it as standalone with `->standalone` or override the property directly into the action: 
+
+```php
+class DisableProfileAction extends Action
+{
+    public $standalone = true;
+
+    //...
+}
+```
+
+
+## URI Key
+
+Usually the URL for the action is make based on the action name. You can use your own URI key if you want: 
+
+```php
+class DisableProfileAction extends Action
+{
+    public static $uriKey = 'disable_profile';
+
+    //...
+}
+```

src/Actions/Action.php

@@ -14,18 +14,34 @@
 use Closure;
 use Exception;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
-use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use JsonSerializable;
 
 abstract class Action extends RestController implements JsonSerializable
 {
     use AuthorizedToSee, ProxiesCanSeeToGate, Make, Visibility;
 
+    /**
+     * Number of models into a chunk when action for 'all'.
+     *
+     * @var int
+     */
     public static int $chunkCount = 200;
 
+    /**
+     * Indicated if this action don't require any models.
+     *
+     * @var bool
+     */
+    public bool $standalone = false;
+
+    /**
+     * Default uri key for the action.
+     * @var string
+     */
+    public static $uriKey;
+
     public static function indexQuery(RestifyRequest $request, $query)
     {
         return $query;
@@ -50,7 +66,7 @@ public function name()
      */
     public function uriKey()
     {
-        return Str::slug($this->name(), '-', null);
+        return static::$uriKey ?? Str::slug($this->name(), '-', null);
     }
 
     /**
@@ -88,6 +104,29 @@ public function payload(): array
         return [];
     }
 
+    /**
+     * Make current action being standalone. No model query will be performed.
+     *
+     * @param bool $standalone
+     * @return self
+     */
+    public function standalone(bool $standalone = true): self
+    {
+        $this->standalone = $standalone;
+
+        return $this;
+    }
+
+    /**
+     * Check if the action is standalone.
+     *
+     * @return bool
+     */
+    public function isStandalone(): bool
+    {
+        return $this->standalone;
+    }
+
 //    abstract public function handle(ActionRequest $request, Collection $models): JsonResponse;
 
     public function handleRequest(ActionRequest $request)
@@ -96,6 +135,10 @@ public function handleRequest(ActionRequest $request)
             throw new Exception('Missing handle method from the action.');
         }
 
+        if ($this->isStandalone()) {
+            return Transaction::run(fn () => $this->handle($request));
+        }
+
         $response = null;
 
         if (! $request->isForRepositoryRequest()) {

src/Http/Controllers/PerformActionController.php

@@ -8,12 +8,14 @@ class PerformActionController extends RepositoryController
 {
     public function __invoke(ActionRequest $request)
     {
-        $request->validate([
-            'repositories' => 'required',
-        ]);
-
         $action = $request->action();
 
+        if (! $action->isStandalone()) {
+            $request->validate([
+                'repositories' => 'required',
+            ]);
+        }
+
         return $action->handleRequest(
             $request,
         );

tests/Actions/PerformActionsControllerTest.php

@@ -4,6 +4,7 @@
 
 use Binaryk\LaravelRestify\Tests\Fixtures\Post\PublishPostAction;
 use Binaryk\LaravelRestify\Tests\Fixtures\User\ActivateAction;
+use Binaryk\LaravelRestify\Tests\Fixtures\User\DisableProfileAction;
 use Binaryk\LaravelRestify\Tests\IntegrationTest;
 
 class PerformActionsControllerTest extends IntegrationTest
@@ -64,4 +65,15 @@ public function test_show_action_not_need_repositories()
 
         $this->assertEquals(1, ActivateAction::$applied[0]->id);
     }
+
+    public function test_could_perform_standalone_action()
+    {
+        $this->post('/restify-api/users/action?action='.(new DisableProfileAction())->uriKey())
+            ->assertSuccessful()
+            ->assertJsonStructure([
+                'data',
+            ]);
+
+        $this->assertEquals('foo', DisableProfileAction::$applied[0]);
+    }
 }

tests/Fixtures/User/DisableProfileAction.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Fixtures\User;
+
+use Binaryk\LaravelRestify\Actions\Action;
+use Binaryk\LaravelRestify\Http\Requests\ActionRequest;
+use Illuminate\Http\JsonResponse;
+
+class DisableProfileAction extends Action
+{
+    public static $applied = [];
+
+    public static $uriKey = 'disable_profile';
+
+    public function handle(ActionRequest $request, $foo = 'foo'): JsonResponse
+    {
+        static::$applied[] = $foo;
+
+        return $this->response()->data(['succes' => 'true'])->respond();
+    }
+}

tests/Fixtures/User/UserRepository.php

@@ -44,6 +44,8 @@ public function actions(RestifyRequest $request)
     {
         return [
             ActivateAction::new(),
+
+            DisableProfileAction::new()->standalone(),
         ];
     }