Merge pull request #14 from Lomkit/feature/actions

✨ actions

Author: GautierDele

.github/ISSUE_TEMPLATE/Question__or_Enhancement proposal.yml

@@ -0,0 +1,9 @@
+name: Question / Enchancement proposal
+description: "Ask a question or for a feature"
+body:
+  - type: textarea
+    attributes:
+      label: Description
+      description: Leave a comment
+    validations:
+      required: true

README.md

@@ -84,12 +84,17 @@ TODO
 
 ## Contributing
 
-
 TODO
 
 ## Roadmap for the end of bêta (Estimated delivery October 2023)
 
 - Custom directives (Filters / sorting)
-- Actions / Metrics
 - Automatic documentation with extension possible
+- Alias for includes / aggregates
+- 
+
+## Roadmap
+
+- Metrics support
 - Refactor the response class
+- Plain text search using Laravel Scout

src/Actions/Action.php

@@ -0,0 +1,140 @@
+<?php
+
+namespace Lomkit\Rest\Actions;
+
+use Illuminate\Bus\Batchable;
+use Illuminate\Bus\PendingBatch;
+use Illuminate\Bus\Queueable;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+use Lomkit\Rest\Concerns\Makeable;
+use Lomkit\Rest\Concerns\Metable;
+use Lomkit\Rest\Http\Requests\OperateRequest;
+use Lomkit\Rest\Http\Requests\RestRequest;
+
+class Action implements \JsonSerializable
+{
+    use Makeable, Metable, Batchable, Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * The name of the connection the job should be sent to.
+     *
+     * @var string|null
+     */
+    public $connection;
+
+    /**
+     * The name of the queue the job should be sent to.
+     *
+     * @var string|null
+     */
+    public $queue;
+
+    /**
+     * The displayable name of the action.
+     *
+     * @var string
+     */
+    public $name;
+
+    /**
+     * The number of models that should be included in each chunk.
+     *
+     * @var int
+     */
+    public $chunkCount = 100;
+
+    /**
+     * Get the name of the action.
+     *
+     * @return string
+     */
+    public function name()
+    {
+        return $this->name ?: Str::of(class_basename(get_class($this)))->beforeLast('Action')->snake(' ')->title();
+    }
+
+    /**
+     * Get the URI key for the action.
+     *
+     * @return string
+     */
+    public function uriKey()
+    {
+        return Str::slug($this->name(), '-', null);
+    }
+
+    /**
+     * Prepare the action for JSON serialization.
+     *
+     * @return array<string, mixed>
+     */
+    public function jsonSerialize(): array
+    {
+        $request = app()->make(RestRequest::class);
+
+        return [
+            'name' => $this->name(),
+            'uriKey' => $this->uriKey(),
+            'fields' => $this->fields($request),
+            'meta' => $this->meta()
+        ];
+    }
+
+    /**
+     * Perform the action on the given models.
+     *
+     * @param  array  $fields
+     * @param  \Illuminate\Support\Collection  $models
+     * @return mixed
+     */
+    public function handle(array $fields, \Illuminate\Support\Collection $models)
+    {
+        //
+    }
+
+    /**
+     * Called in an action failed.
+     *
+     * @param  \Lomkit\Rest\Http\Requests\RestRequest $request
+     * @return array
+     */
+    public function fields(\Lomkit\Rest\Http\Requests\RestRequest $request)
+    {
+        return [];
+    }
+
+    /**
+     * Register callbacks on the pending batch.
+     *
+     * @param  array  $fields
+     * @param  \Illuminate\Bus\PendingBatch  $batch
+     * @return void
+     */
+    public function withBatch(array $fields, PendingBatch $batch)
+    {
+        //
+    }
+
+    /**
+     * Execute the action for the given request.
+     *
+     * @param  OperateRequest  $request
+     * @return int
+     *
+     * @throws \Throwable
+     */
+    public function handleRequest(OperateRequest $request)
+    {
+        $fields = $request->resolveFields($this);
+
+        $dispatcher = new DispatchAction($request, $this, $fields);
+
+        $count = $dispatcher->dispatch($this->chunkCount);
+
+        return $count;
+    }
+}

src/Actions/Actionable.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Lomkit\Rest\Actions;
+
+use Lomkit\Rest\Http\Requests\RestRequest;
+
+trait Actionable
+{
+    /**
+     * The actions that should be linked
+     * @param RestRequest $request
+     * @return array
+     */
+    public function actions(RestRequest $request): array {
+        return [];
+    }
+
+    public function actionExists(RestRequest $request, string $actionKey): bool {
+        return collect($this->actions($request))
+            ->contains(function (Action $action) use ($actionKey) {
+                return $action->uriKey() === $actionKey;
+            });
+    }
+
+    public function action(RestRequest $request, string $actionKey): Action {
+        return collect($this->actions($request))
+            ->sole(function (Action $action) use ($actionKey) {
+                return $action->uriKey() === $actionKey;
+            });
+    }
+}

src/Actions/CallRestApiAction.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Lomkit\Rest\Actions;
+
+use Illuminate\Bus\Batchable;
+use Illuminate\Bus\Queueable;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+
+class CallRestApiAction
+{
+    use Batchable, Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Models collection.
+     *
+     * @var \Illuminate\Database\Eloquent\Collection|\Illuminate\Support\Collection
+     */
+    protected $models;
+
+    /**
+     * The action instance.
+     *
+     * @var \Lomkit\Rest\Actions\Action
+     */
+    protected \Lomkit\Rest\Actions\Action $action;
+
+    /**
+     * The fields for the action instance.
+     *
+     * @var array
+     */
+    protected array $fields;
+
+    /**
+     * Create a new job instance.
+     *
+     * @param  \Lomkit\Rest\Actions\Action  $action
+     * @param  array  $fields
+     * @param  \Illuminate\Database\Eloquent\Collection|\Illuminate\Support\Collection  $models
+     * @return void
+     */
+    public function __construct(Action $action, array $fields, Collection $models)
+    {
+        $this->action = $action;
+        $this->fields = $fields;
+        $this->models = $models;
+    }
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $this->action->setJob($this->job)->handle($this->fields, $this->models);
+    }
+
+    /**
+     * Get the display name for the queued job.
+     *
+     * @return string
+     */
+    public function displayName()
+    {
+        return get_class($this->action);
+    }
+}