ADD canRun action (#14)

Author: Riccardo Dalla Via

README.md

@@ -30,20 +30,33 @@ This is the contents of the published config file:
 
 ```php
 return [
+
     /*
     |--------------------------------------------------------------------------
-    | Sortable permission action
+    | See sortable action permission
     |--------------------------------------------------------------------------
     |
     | Here you may specify the fully qualified class name of the invokable class
-    | used to determine whether a user can see and perform sorts to a given model
-    | or not.
+    | used to determine whether a user can see sortable actions or not.
     | If null, all users who have access to Nova will have the permission.
     |
     */
 
     'can_see_sortable_action' => null,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Run sortable action permission
+    |--------------------------------------------------------------------------
+    |
+    | Here you may specify the fully qualified class name of the invokable class
+    | used to determine whether a user can sort a given model or not.
+    | If null, all users who have access to Nova will have the permission.
+    |
+    */
+
+    'can_run_sortable_action' => null,
+
 ];
 ```
 
@@ -71,10 +84,10 @@ use Maize\NovaEloquentSortable\Actions\MoveToStartAction;
 public function actions(NovaRequest $request)
 {
     return [
-        MoveOrderDownAction::for($this),
-        MoveToEndAction::for($this),
-        MoveOrderUpAction::for($this),
-        MoveToStartAction::for($this),
+        MoveOrderDownAction::make(),
+        MoveToEndAction::make(),
+        MoveOrderUpAction::make(),
+        MoveToStartAction::make(),
     ];
 }
 ```
@@ -127,7 +140,7 @@ The action is automatically hidden when the model is already in the first positi
 
 By default, all users who have access to Laravel Nova will be able to see all included sort actions.
 
-If you want to restrict their visibility to some users, you can define a custom `CanSeeSortableAction` invokable class.
+If you want to restrict their visibility for some users, you can define a custom `CanSeeSortableAction` invokable class.
 
 Here's an example class checking user's permissions:
 
@@ -136,7 +149,7 @@ use Laravel\Nova\Http\Requests\NovaRequest;
 
 class CanSeeSortableAction
 {
-    public function __invoke(NovaRequest $request, $model = null, $resource = null): bool
+    public function __invoke(NovaRequest $request): bool
     {
         return $request->user()->can('sort_models');
     }
@@ -149,6 +162,33 @@ Once done, all you have to do is reference your custom class in `can_see_sortabl
 'can_see_sortable_action' => \Path\To\CanSeeSortableAction::class,
 ```
 
+## Define a custom run permission
+
+By default, all users who have access to Laravel Nova will be able to run all included sort actions.
+
+If you want to restrict the permission for some users, you can define a custom `CanRunSortableAction` invokable class.
+
+Here's an example class checking user's permissions:
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Nova\Http\Requests\NovaRequest;
+
+class CanRunSortableAction
+{
+    public function __invoke(NovaRequest $request, Model $model): bool
+    {
+        return $request->user()->can('sort_model', $model);
+    }
+}
+```
+
+Once done, all you have to do is reference your custom class in `can_run_sortable_action` attribute under `config/nova-eloquent-sortable.php`:
+
+``` php
+'can_run_sortable_action' => \Path\To\CanRunSortableAction::class,
+```
+
 ## Testing
 
 ```bash

config/nova-eloquent-sortable.php

@@ -1,18 +1,31 @@
 <?php
 
 return [
+
     /*
     |--------------------------------------------------------------------------
-    | Sortable permission action
+    | See sortable action permission
     |--------------------------------------------------------------------------
     |
     | Here you may specify the fully qualified class name of the invokable class
-    | used to determine whether a user can see and perform sorts to a given model
-    | or not.
+    | used to determine whether a user can see sortable actions or not.
     | If null, all users who have access to Nova will have the permission.
     |
     */
 
     'can_see_sortable_action' => null,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Run sortable action permission
+    |--------------------------------------------------------------------------
+    |
+    | Here you may specify the fully qualified class name of the invokable class
+    | used to determine whether a user can sort a given model or not.
+    | If null, all users who have access to Nova will have the permission.
+    |
+    */
+
+    'can_run_sortable_action' => null,
+
 ];

src/Actions/CanRunSortableAction.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Maize\NovaEloquentSortable\Actions;
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Nova\Http\Requests\NovaRequest;
+
+class CanRunSortableAction
+{
+    public function __invoke(NovaRequest $request, Model $model): bool
+    {
+        return true;
+    }
+}

src/Actions/CanSeeSortableAction.php

@@ -6,7 +6,7 @@
 
 class CanSeeSortableAction
 {
-    public function __invoke(NovaRequest $request, $model = null, $resource = null): bool
+    public function __invoke(NovaRequest $request): bool
     {
         return true;
     }

src/Actions/EloquentSortableAction.php

@@ -2,32 +2,28 @@
 
 namespace Maize\NovaEloquentSortable\Actions;
 
+use Illuminate\Database\Eloquent\Model;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Http\Requests\NovaRequest;
-use Laravel\Nova\Resource;
 use Maize\NovaEloquentSortable\Support\Config;
 
 abstract class EloquentSortableAction extends Action
 {
-    public static function for(Resource $resource): self
+    public function __construct()
     {
-        return static::make()
-            ->withoutConfirmation()
+        $this
             ->onlyInline()
-            ->canSee(fn (NovaRequest $request) => static::canSeeSortable(
-                $request,
-                $resource->model(),
-                $resource
-            ));
+            ->canSee(fn (NovaRequest $request) => static::canSeeSortable($request))
+            ->canRun(fn (NovaRequest $request, Model $model) => static::canRunSortable($request, $model));
     }
 
-    public static function canSeeSortable(NovaRequest $request, $model = null, $resource = null): bool
+    public static function canSeeSortable(NovaRequest $request): bool
     {
-        return Config::getCanSeeSortableAction()($request, $model, $resource);
+        return Config::getCanSeeSortableAction()($request);
     }
 
-    public static function isUriKey(?string $uri): bool
+    public static function canRunSortable(NovaRequest $request, Model $model): bool
     {
-        return $uri === static::make()->uriKey();
+        return Config::getCanRunSortableAction()($request, $model);
     }
 }

src/Actions/MoveOrderDownAction.php

@@ -2,6 +2,7 @@
 
 namespace Maize\NovaEloquentSortable\Actions;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Fields\ActionFields;
@@ -14,17 +15,13 @@ public function name(): string
         return __('Move order down');
     }
 
-    public static function canSeeSortable(NovaRequest $request, $model = null, $resource = null): bool
+    public static function canRunSortable(NovaRequest $request, Model $model): bool
     {
-        if ($model?->isLastInOrder()) {
+        if ($model->isLastInOrder()) {
             return false;
         }
 
-        if (static::isUriKey($request->action)) {
-            return true;
-        }
-
-        return parent::canSeeSortable($request, $model, $resource);
+        return parent::canRunSortable($request, $model);
     }
 
     public function handle(ActionFields $fields, Collection $models): mixed

src/Actions/MoveOrderUpAction.php

@@ -2,6 +2,7 @@
 
 namespace Maize\NovaEloquentSortable\Actions;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Fields\ActionFields;
@@ -14,17 +15,13 @@ public function name(): string
         return __('Move order up');
     }
 
-    public static function canSeeSortable(NovaRequest $request, $model = null, $resource = null): bool
+    public static function canRunSortable(NovaRequest $request, Model $model): bool
     {
-        if ($model?->isFirstInOrder()) {
+        if ($model->isFirstInOrder()) {
             return false;
         }
 
-        if (static::isUriKey($request->action)) {
-            return true;
-        }
-
-        return parent::canSeeSortable($request, $model, $resource);
+        return parent::canRunSortable($request, $model);
     }
 
     public function handle(ActionFields $fields, Collection $models): mixed

src/Actions/MoveToEndAction.php

@@ -2,6 +2,7 @@
 
 namespace Maize\NovaEloquentSortable\Actions;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Fields\ActionFields;
@@ -14,17 +15,13 @@ public function name(): string
         return __('Move to end');
     }
 
-    public static function canSeeSortable(NovaRequest $request, $model = null, $resource = null): bool
+    public static function canRunSortable(NovaRequest $request, Model $model): bool
     {
-        if ($model?->isLastInOrder()) {
+        if ($model->isLastInOrder()) {
             return false;
         }
 
-        if (static::isUriKey($request->action)) {
-            return true;
-        }
-
-        return parent::canSeeSortable($request, $model, $resource);
+        return parent::canRunSortable($request, $model);
     }
 
     public function handle(ActionFields $fields, Collection $models): mixed

src/Actions/MoveToStartAction.php

@@ -2,6 +2,7 @@
 
 namespace Maize\NovaEloquentSortable\Actions;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Fields\ActionFields;
@@ -14,17 +15,13 @@ public function name(): string
         return __('Move to start');
     }
 
-    public static function canSeeSortable(NovaRequest $request, $model = null, $resource = null): bool
+    public static function canRunSortable(NovaRequest $request, Model $model): bool
     {
-        if ($model?->isFirstInOrder()) {
+        if ($model->isFirstInOrder()) {
             return false;
         }
 
-        if (static::isUriKey($request->action)) {
-            return true;
-        }
-
-        return parent::canSeeSortable($request, $model, $resource);
+        return parent::canRunSortable($request, $model);
     }
 
     public function handle(ActionFields $fields, Collection $models): mixed

src/Support/Config.php

@@ -2,6 +2,7 @@
 
 namespace Maize\NovaEloquentSortable\Support;
 
+use Maize\NovaEloquentSortable\Actions\CanRunSortableAction;
 use Maize\NovaEloquentSortable\Actions\CanSeeSortableAction;
 
 class Config
@@ -13,4 +14,12 @@ public static function getCanSeeSortableAction(): CanSeeSortableAction
 
         return app($action);
     }
+
+    public static function getCanRunSortableAction(): CanRunSortableAction
+    {
+        $action = config('nova-eloquent-sortable.can_run_sortable_action')
+            ?? CanRunSortableAction::class;
+
+        return app($action);
+    }
 }