✨ added meta to actions

Author: GautierDele

src/Actions/Action.php

@@ -6,12 +6,13 @@
 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;
+    use Makeable, Metable;
 
     /**
      * The name of the connection the job should be sent to.
@@ -73,7 +74,8 @@ public function jsonSerialize(): array
         return [
             'name' => $this->name(),
             'uriKey' => $this->uriKey(),
-            'fields' => $this->fields($request)
+            'fields' => $this->fields($request),
+            'meta' => $this->meta()
         ];
     }
 

src/Concerns/Metable.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Lomkit\Rest\Concerns;
+
+trait Metable
+{
+    /**
+     * The meta array
+     *
+     * @var array<string, mixed>
+     */
+    public $meta = [];
+
+    /**
+     * Get the meta data
+     *
+     * @return array
+     */
+    public function meta()
+    {
+        return $this->meta;
+    }
+
+    /**
+     * Set additional meta information for the element.
+     *
+     * @param  array $meta
+     * @return $this
+     */
+    public function withMeta(array $meta)
+    {
+        return tap($this, function () use ($meta) {
+            $this->meta = array_merge($this->meta, $meta);
+        });
+    }
+}

tests/Feature/Controllers/ActionsOperationsTest.php

@@ -33,7 +33,7 @@ public function test_getting_actions(): void
             '/api/models/actions',
             ['Accept' => 'application/json']
         );
-
+        
         $response->assertJson(
             ['data' => collect(new ModelResource)->each->jsonSerialize()->toArray()]
         );

tests/Support/Rest/Actions/WithMetaModifyNumberAction.php

@@ -0,0 +1,51 @@
+<?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 WithMetaModifyNumberAction extends Action
+{
+    public function __construct()
+    {
+        $this->withMeta([
+            'color' => '#FFFFFF'
+        ]);
+    }
+
+    /**
+     * Perform the action on the given models.
+     *
+     * @param  array  $fields
+     * @param  \Illuminate\Support\Collection  $models
+     * @return mixed
+     */
+    public function handle(array $fields, Collection $models)
+    {
+        foreach ($models as $model) {
+            /** @var Model $model */
+            $model->forceFill(
+                ['number' => $fields['number'] ?? 100000000]
+            )
+                ->save();
+        }
+    }
+
+    /**
+     * Called in an action failed.
+     *
+     * @param  RestRequest $request
+     * @return array
+     */
+    public function fields(RestRequest $request)
+    {
+        return [
+            'number' => [
+                'min: 100'
+            ]
+        ];
+    }
+}

tests/Support/Rest/Resources/ModelResource.php

@@ -23,6 +23,7 @@
 use Lomkit\Rest\Tests\Support\Models\MorphOneRelation;
 use Lomkit\Rest\Tests\Support\Rest\Actions\ModifyNumberAction;
 use Lomkit\Rest\Tests\Support\Rest\Actions\QueueableModifyNumberAction;
+use Lomkit\Rest\Tests\Support\Rest\Actions\WithMetaModifyNumberAction;
 
 class ModelResource extends Resource
 {
@@ -124,7 +125,8 @@ public function defaultOrderBy(RestRequest $request): array
     public function actions(RestRequest $request): array {
         return [
             ModifyNumberAction::make(),
-            QueueableModifyNumberAction::make()
+            QueueableModifyNumberAction::make(),
+            WithMetaModifyNumberAction::make()
         ];
     }
 }