Merge pull request #165 from code16/fix/multiple-select-formatter

dvlpp · web-flow · commit e0d1244a8ae9 · 2019-08-13T11:59:42.000+02:00
Fix/multiple select formatter
diff --git a/src/Form/Fields/Formatters/AutocompleteFormatter.php b/src/Form/Fields/Formatters/AutocompleteFormatter.php
@@ -3,6 +3,7 @@
 namespace Code16\Sharp\Form\Fields\Formatters;
 
 use Code16\Sharp\Form\Fields\SharpFormField;
+use Code16\Sharp\Utils\Transformers\ArrayConverter;
 
 class AutocompleteFormatter extends SharpFieldFormatter
 {
@@ -14,6 +15,8 @@ class AutocompleteFormatter extends SharpFieldFormatter
      */
     function toFront(SharpFormField $field, $value)
     {
+        $value = ArrayConverter::modelToArray($value);
+
         return is_null($value) || is_array($value)
             ? $value
             : [$field->itemIdAttribute() => $value];
diff --git a/src/Form/Fields/Formatters/AutocompleteListFormatter.php b/src/Form/Fields/Formatters/AutocompleteListFormatter.php
@@ -16,14 +16,16 @@ function toFront(SharpFormField $field, $value)
     {
         $autocompleteField = $field->autocompleteField();
 
-        return collect($value)->map(function ($item) use($field, $autocompleteField) {
-            return [
-                $autocompleteField->itemIdAttribute() => $item[$autocompleteField->itemIdAttribute()],
-                $autocompleteField->key() => $autocompleteField->formatter()->toFront(
-                    $autocompleteField, $item
-                )
-            ];
-        })->all();
+        return collect($value)
+            ->map(function ($item) use($field, $autocompleteField) {
+                return [
+                    $autocompleteField->itemIdAttribute() => $item[$autocompleteField->itemIdAttribute()],
+                    $autocompleteField->key() => $autocompleteField->formatter()->toFront(
+                        $autocompleteField, $item
+                    )
+                ];
+            })
+            ->all();
     }
 
     /**
@@ -36,14 +38,16 @@ function fromFront(SharpFormField $field, string $attribute, $value)
     {
         $autocompleteField = $field->autocompleteField();
 
-        return collect($value)->map(function ($item) use($field, $autocompleteField) {
-            $item = $item[$autocompleteField->key()];
-
-            return [
-                $autocompleteField->itemIdAttribute() => $autocompleteField->formatter()->fromFront(
-                    $autocompleteField, $autocompleteField->key(), $item
-                )
-            ];
-        })->all();
+        return collect($value)
+            ->map(function ($item) use($field, $autocompleteField) {
+                $item = $item[$autocompleteField->key()];
+
+                return [
+                    $autocompleteField->itemIdAttribute() => $autocompleteField->formatter()->fromFront(
+                        $autocompleteField, $autocompleteField->key(), $item
+                    )
+                ];
+            })
+            ->all();
     }
 }
diff --git a/src/Form/Fields/Formatters/ListFormatter.php b/src/Form/Fields/Formatters/ListFormatter.php
@@ -14,22 +14,25 @@ class ListFormatter extends SharpFieldFormatter
      */
     function toFront(SharpFormField $field, $value)
     {
-        return collect($value)->map(function ($item) use($field) {
-            $itemArray = [
-                $field->itemIdAttribute() => $item[$field->itemIdAttribute()]
-            ];
+        return collect($value)
+            ->map(function ($item) use($field) {
+                $itemArray = [
+                    $field->itemIdAttribute() => $item[$field->itemIdAttribute()]
+                ];
 
-            $field->itemFields()->each(function($itemField) use($item, &$itemArray) {
-                $key = $itemField->key();
+                $field
+                    ->itemFields()
+                    ->each(function($itemField) use($item, &$itemArray) {
+                        $key = $itemField->key();
 
-                $itemArray[$key] = isset($item[$key])
-                    ? $itemField->formatter()->toFront($itemField, $item[$key])
-                    : null;
-            });
+                        $itemArray[$key] = isset($item[$key])
+                            ? $itemField->formatter()->toFront($itemField, $item[$key])
+                            : null;
+                    });
 
-            return $itemArray;
-
-        })->all();
+                return $itemArray;
+            })
+            ->all();
     }
 
     /**
@@ -40,23 +43,24 @@ function toFront(SharpFormField $field, $value)
      */
     function fromFront(SharpFormField $field, string $attribute, $value)
     {
-        return collect($value)->map(function ($item) use($field) {
-            $itemArray = [
-                $field->itemIdAttribute() => $item[$field->itemIdAttribute()]
-            ];
-
-            foreach($item as $key => $value) {
-                $itemField = $field->findItemFormFieldByKey($key);
-
-                if($itemField) {
-                    $itemArray[$key] = $itemField->formatter()
-                        ->setInstanceId($this->instanceId)
-                        ->fromFront($itemField, $key, $value);
-                }
-            }
+        return collect($value)
+            ->map(function ($item) use($field) {
+                $itemArray = [
+                    $field->itemIdAttribute() => $item[$field->itemIdAttribute()]
+                ];
 
-            return $itemArray;
+                foreach($item as $key => $value) {
+                    $itemField = $field->findItemFormFieldByKey($key);
+
+                    if($itemField) {
+                        $itemArray[$key] = $itemField->formatter()
+                            ->setInstanceId($this->instanceId)
+                            ->fromFront($itemField, $key, $value);
+                    }
+                }
 
-        })->all();
+                return $itemArray;
+            })
+            ->all();
     }
 }
diff --git a/src/Form/Fields/Formatters/SelectFormatter.php b/src/Form/Fields/Formatters/SelectFormatter.php
@@ -3,6 +3,7 @@
 namespace Code16\Sharp\Form\Fields\Formatters;
 
 use Code16\Sharp\Form\Fields\SharpFormField;
+use Code16\Sharp\Utils\Transformers\ArrayConverter;
 
 class SelectFormatter extends SharpFieldFormatter
 {
@@ -14,11 +15,15 @@ class SelectFormatter extends SharpFieldFormatter
     function toFront(SharpFormField $field, $value)
     {
         if($field->multiple()) {
-            return collect((array)$value)->map(function($item) use($field) {
-                return is_array($item) || is_object($item)
-                    ? ((array)$item)[$field->idAttribute()]
-                    : $item;
-            })->all();
+            return collect((array)$value)
+                ->map(function($item) use($field) {
+                    $item = ArrayConverter::modelToArray($item);
+
+                    return is_array($item)
+                        ? $item[$field->idAttribute()]
+                        : $item;
+                })
+                ->all();
 
         } elseif(is_array($value)) {
             // Strip other values is not configured to be multiple
@@ -38,9 +43,11 @@ function fromFront(SharpFormField $field, string $attribute, $value)
     {
         if($field->multiple()) {
             // We must transform items into associative arrays with the "id" key
-            return collect((array)$value)->map(function ($item) {
-                return ["id" => $item];
-            })->all();
+            return collect((array)$value)
+                ->map(function ($item) use($field) {
+                    return [$field->idAttribute() => $item];
+                })
+                ->all();
 
         } elseif(is_array($value)) {
             return $value[0];
diff --git a/src/Form/Fields/Formatters/TagsFormatter.php b/src/Form/Fields/Formatters/TagsFormatter.php
@@ -3,6 +3,7 @@
 namespace Code16\Sharp\Form\Fields\Formatters;
 
 use Code16\Sharp\Form\Fields\SharpFormField;
+use Code16\Sharp\Utils\Transformers\ArrayConverter;
 
 class TagsFormatter extends SharpFieldFormatter
 {
@@ -16,10 +17,11 @@ function toFront(SharpFormField $field, $value)
     {
         return collect((array)$value)
             ->map(function($item) use($field) {
+                $item = ArrayConverter::modelToArray($item);
 
-                if(is_object($item) || is_array($item)) {
+                if(is_array($item)) {
                     return [
-                        "id" => ((array)$item)[$field->idAttribute()],
+                        "id" => $item[$field->idAttribute()],
                     ];
                 }
 
@@ -45,28 +47,28 @@ function fromFront(SharpFormField $field, string $attribute, $value)
                 return is_null($item["id"]) || isset($options[$item["id"]]);
             })
 
-        ->when(! $field->creatable(), function($collection) {
-            // Field isn't creatable, let's just strip all null ids
-            return $collection->filter(function($item) {
-                return !is_null($item["id"]);
-            });
-        })
+            ->when(! $field->creatable(), function($collection) {
+                // Field isn't creatable, let's just strip all null ids
+                return $collection->filter(function($item) {
+                    return !is_null($item["id"]);
+                });
+            })
 
-        ->map(function($item) use($field) {
-            if(is_null($item["id"])) {
-                return array_merge([
-                        $field->idAttribute() => null,
-                        $field->createAttribute() => $item["label"]
-                    ], $field->createAdditionalAttributes()
-                );
-            }
+            ->map(function($item) use($field) {
+                if(is_null($item["id"])) {
+                    return array_merge([
+                            $field->idAttribute() => null,
+                            $field->createAttribute() => $item["label"]
+                        ], $field->createAdditionalAttributes()
+                    );
+                }
 
-            return [
-                $field->idAttribute() => $item["id"]
-            ];
+                return [
+                    $field->idAttribute() => $item["id"]
+                ];
 
-        })
-        ->values()
-        ->all();
+            })
+            ->values()
+            ->all();
     }
 }
diff --git a/src/Form/Fields/Utils/SharpFormFieldWithOptions.php b/src/Form/Fields/Utils/SharpFormFieldWithOptions.php
@@ -2,6 +2,7 @@
 
 namespace Code16\Sharp\Form\Fields\Utils;
 
+use Code16\Sharp\Utils\Transformers\ArrayConverter;
 use Illuminate\Support\Collection;
 
 trait SharpFormFieldWithOptions
@@ -19,9 +20,9 @@ protected static function formatOptions($options, $idAttribute = "id")
         }
 
         $options = collect($options);
+        $firstOption = ArrayConverter::modelToArray($options->first());
 
-        if((is_array($options->first()) || is_object($options->first()))
-            && isset(((array)$options->first())[$idAttribute])) {
+        if(is_array($firstOption) && isset($firstOption[$idAttribute])) {
             // We assume that we already have ["id", "label"] in this case
             return $options->all();
         }
diff --git a/src/Utils/Transformers/ArrayConverter.php b/src/Utils/Transformers/ArrayConverter.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Code16\Sharp\Utils\Transformers;
+
+class ArrayConverter
+{
+
+    /**
+     * Convert a class or Model into an array.
+     * If $model is not an array or model, simply return it.
+     *
+     * @param array|object|mixed $model
+     * @return array|mixed
+     */
+    public static function modelToArray($model)
+    {
+        if(is_array($model)) {
+            return $model;
+        }
+
+        if(is_object($model)) {
+            if(method_exists($model, "toArray")) {
+                return $model->toArray();
+            }
+
+            return (array)$model;
+        }
+
+        // Model is not a structured data. We return it as it is.
+        return $model;
+    }
+}
diff --git a/src/Utils/Transformers/WithCustomTransformers.php b/src/Utils/Transformers/WithCustomTransformers.php
@@ -7,7 +7,6 @@
 use Code16\Sharp\Form\SharpForm;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator as LengthAwarePaginatorContract;
 use Illuminate\Pagination\LengthAwarePaginator;
-use stdClass;
 
 /**
  * This trait allows a class to handle a custom transformers array.
@@ -100,7 +99,7 @@ function apply($value, $instance = null, $attribute = null)
      */
     protected function applyTransformers($model, bool $forceFullObject = true)
     {
-        $attributes = is_array($model) ? $model: ($model instanceof stdClass ? (array)$model: $model->toArray());
+        $attributes = ArrayConverter::modelToArray($model);
 
         if($forceFullObject) {
             // Merge model attribute with form fields to be sure we have
diff --git a/tests/Unit/Form/Fields/Formatters/AutocompleteFormatterTest.php b/tests/Unit/Form/Fields/Formatters/AutocompleteFormatterTest.php
@@ -25,6 +25,28 @@ function we_can_format_local_value_to_front()
             SharpFormAutocompleteField::make("text", "local")->setItemIdAttribute("num"),
             $value
         ));
+
+        $this->assertEquals(["id" => $value], (new AutocompleteFormatter)->toFront(
+            SharpFormAutocompleteField::make("text", "local"),
+            ["id" => $value]
+        ));
+
+        $this->assertEquals(["id" => $value], (new AutocompleteFormatter)->toFront(
+            SharpFormAutocompleteField::make("text", "local"),
+            (object)["id" => $value]
+        ));
+
+        $this->assertEquals(["id" => $value], (new AutocompleteFormatter)->toFront(
+            SharpFormAutocompleteField::make("text", "local"),
+            new class($value) {
+                function __construct($value) {
+                    $this->value = $value;
+                }
+                function toArray() {
+                    return ["id" => $this->value];
+                }
+            }
+        ));
     }
 
     /** @test */
diff --git a/tests/Unit/Form/Fields/Formatters/SelectFormatterTest.php b/tests/Unit/Form/Fields/Formatters/SelectFormatterTest.php

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Code16\Sharp\Form\Fields\Formatters;`
`4`	`4`
`5`	`5`	`use Code16\Sharp\Form\Fields\SharpFormField;`
	`6`	`+use Code16\Sharp\Utils\Transformers\ArrayConverter;`
`6`	`7`
`7`	`8`	`class AutocompleteFormatter extends SharpFieldFormatter`
`8`	`9`	`{`
`@@ -14,6 +15,8 @@ class AutocompleteFormatter extends SharpFieldFormatter`
`14`	`15`	`*/`
`15`	`16`	`function toFront(SharpFormField $field, $value)`
`16`	`17`	`{`
	`18`	`+ $value = ArrayConverter::modelToArray($value);`
	`19`	`+`
`17`	`20`	`return is_null($value) \|\| is_array($value)`
`18`	`21`	`? $value`
`19`	`22`	`: [$field->itemIdAttribute() => $value];`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Code16\Sharp\Form\Fields\Utils;`
`4`	`4`
	`5`	`+use Code16\Sharp\Utils\Transformers\ArrayConverter;`
`5`	`6`	`use Illuminate\Support\Collection;`
`6`	`7`
`7`	`8`	`trait SharpFormFieldWithOptions`
`@@ -19,9 +20,9 @@ protected static function formatOptions($options, $idAttribute = "id")`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`$options = collect($options);`
	`23`	`+ $firstOption = ArrayConverter::modelToArray($options->first());`
`22`	`24`
`23`		`- if((is_array($options->first()) \|\| is_object($options->first()))`
`24`		`- && isset(((array)$options->first())[$idAttribute])) {`
	`25`	`+ if(is_array($firstOption) && isset($firstOption[$idAttribute])) {`
`25`	`26`	`// We assume that we already have ["id", "label"] in this case`
`26`	`27`	`return $options->all();`
`27`	`28`	`}`