Add custom label to the field

Author: binaryk

src/Fields/Field.php

@@ -107,6 +107,8 @@ class Field extends OrganicField implements JsonSerializable
      */
     public $afterUpdateCallback;
 
+    public $label;
+
     /**
      * Create a new field.
      *
@@ -117,6 +119,8 @@ public function __construct($attribute, callable $resolveCallback = null)
     {
         $this->attribute = $attribute;
 
+        $this->label = $attribute;
+
         $this->resolveCallback = $resolveCallback;
 
         $this->default(null);
@@ -313,7 +317,7 @@ public function resolveForShow($repository, $attribute = null)
             return;
         }
 
-        if (! $this->showCallback) {
+        if (!$this->showCallback) {
             $this->resolve($repository, $attribute);
         } elseif (is_callable($this->showCallback)) {
             tap($this->value ?? $this->resolveAttribute($repository, $attribute), function ($value) use ($repository, $attribute) {
@@ -336,7 +340,7 @@ public function resolveForIndex($repository, $attribute = null)
             return;
         }
 
-        if (! $this->indexCallback) {
+        if (!$this->indexCallback) {
             $this->resolve($repository, $attribute);
         } elseif (is_callable($this->indexCallback)) {
             tap($this->value ?? $this->resolveAttribute($repository, $attribute), function ($value) use ($repository, $attribute) {
@@ -356,7 +360,7 @@ public function resolve($repository, $attribute = null)
             return;
         }
 
-        if (! $this->resolveCallback) {
+        if (!$this->resolveCallback) {
             $this->value = $this->resolveAttribute($repository, $attribute);
         } elseif (is_callable($this->resolveCallback)) {
             tap($this->resolveAttribute($repository, $attribute), function ($value) use ($repository, $attribute) {
@@ -388,16 +392,23 @@ public function jsonSerialize()
     {
         return with(app(RestifyRequest::class), function ($request) {
             return [
-                'attribute' => $this->attribute,
+                'attribute' => $this->label ?? $this->attribute,
                 'value' => $this->resolveDefaultValue($request) ?? $this->value,
             ];
         });
     }
 
+    public function label($label)
+    {
+        $this->label = $label;
+
+        return $this;
+    }
+
     public function serializeToValue($request)
     {
         return [
-            $this->attribute => $this->resolveDefaultValue($request) ?? $this->value,
+            $this->label ?? $this->attribute => $this->resolveDefaultValue($request) ?? $this->value,
         ];
     }
 

tests/Controllers/RepositoryUpdateControllerTest.php

@@ -76,7 +76,9 @@ public function test_do_not_update_fields_without_permission()
         $response = $this->putJson('/restify-api/post-with-unathorized-fields/'.$post->id, [
             'title' => 'Updated title',
             'user_id' => 2,
-        ])->assertStatus(200);
+        ])
+            ->dump()
+            ->assertStatus(200);
 
         $this->assertEquals('Title', $response->json('data.attributes.title'));
         $this->assertEquals(2, $response->json('data.attributes.user_id'));

tests/Unit/FieldTest.php

@@ -240,4 +240,13 @@ public function test_field_after_update_called()
 
         $field->invokeAfter($request, $model);
     }
+
+    public function test_field_can_have_custom_label()
+    {
+        $field = Field::make('name')->label('custom_label');
+
+        $field->resolveForIndex((object) ['name' => 'Binaryk'], 'name');
+
+        $this->assertEquals('custom_label', $field->label);
+    }
 }