Added begin of HasResolver concern (building)

Author: toonvandenbos

README.md

@@ -5,16 +5,25 @@ Base library for repeated layout fields, content builders and other collection c
 
 - Installation & base use cases
 - layouts registration
+    - `register($layout, $limit)`
 - get all registered layouts
-- limiting layouts count (global & layout-specific)
-- inserting instances
+    - `layouts()`
+- limiting layouts
+    - `limit($instances)`
+    - `$layout->limit($instances)`
+- building instances
+    - `build($data)`
+    - `buildUsing($callback)`
+    - `insert($key, $attributes, $index, $id)`
 - get all inserted instances, and manipulate the LayoutCollection :
-    - `find($key)`
-    - `whereKey($key)`
-    - `whereKeyNot($key)`
-    - `whereKeyIn($key)`
-    - `whereKeyNotIn($key)`
+    - `instances()`
+    - `$instances->find($key)`
+    - `$instances->whereKey($key)`
+    - `$instances->whereKeyNot($key)`
+    - `$instances->whereKeyIn($key)`
+    - `$instances->whereKeyNotIn($key)`
 - counting instances
+    - `count($key = null)`
 
 ## Testing
 

src/Concerns/HasResolver.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Whitecube\LaravelFlexibleContent\Concerns;
+
+use Illuminate\Support\Collection;
+
+trait HasResolver
+{
+    /**
+     * The callback to be used to setup the Flexible container's value.
+     *
+     * @var null|callable
+     */
+    public $buildCallback;
+
+    /**
+     * The callback to be used to save the Flexible container's value.
+     *
+     * @var null|callable
+     */
+    public $saveCallback;
+
+    /**
+     * Define the callback that should be used to setup the Flexible container's value.
+     *
+     * @param callable $buildCallback
+     * @return $this
+     */
+    public function buildUsing(callable $buildCallback)
+    {
+        $this->buildCallback = $buildCallback;
+
+        return $this;
+    }
+
+    /**
+     * Define the callback that should be used to save the Flexible container's value.
+     *
+     * @param callable $saveCallback
+     * @return $this
+     */
+    public function saveUsing(callable $saveCallback)
+    {
+        $this->saveCallback = $saveCallback;
+
+        return $this;
+    }
+
+    /**
+     * Create the Flexible container's base layout instances.
+     *
+     * @param mixed $data
+     * @return $this
+     */
+    public function build($data = null)
+    {
+        if(! is_null($this->buildCallback)) {
+            call_user_func($this->buildCallback, $this, $data);
+            return $this;
+        }
+
+        return $this->buildFromData($data);
+    }
+
+    /**
+     * Create the Flexible container's base layout instances from given value.
+     *
+     * @param mixed $data
+     * @return $this
+     */
+    public function buildFromData($data = null)
+    {
+        if($data instanceof Collection) {
+            $data = $data->toArray();
+        } else if (is_string($data)) {
+            $data = json_decode($data, true) ?? [];
+        }
+
+        if(! $data || ! is_array($data)) {
+            return $this;
+        }
+
+        foreach ($data as $item) {
+            $this->buildItem($item);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Attempt to insert a single instance from serialized value.
+     *
+     * @param mixed $item
+     * @return $this
+     */
+    public function buildItem($item)
+    {
+        if(! is_array($item) && ! is_object($item)) {
+            return $this;
+        }
+
+        $key = data_get($item, 'key');
+        $id = data_get($item, 'id');
+        $attributes = data_get($item, 'attributes', []);
+
+        $this->insert($key, (array) $attributes, null, $id ? strval($id) : null);
+
+        return $this;
+    }
+
+    /**
+     * Execute what has to be done in order to save the current value for next build.
+     *
+     * @return $this
+     */
+    public function save()
+    {
+        // TODO.
+        return $this;
+    }
+}

src/Flexible.php

@@ -8,4 +8,5 @@ class Flexible implements FlexibleInterface
 {
     use Concerns\HasLayouts;
     use Concerns\HasLayoutInstances;
+    use Concerns\HasResolver;
 }

tests/Unit/InstanceResolvingTest.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Tests\Unit;
+
+use Whitecube\LaravelFlexibleContent\Flexible;
+
+it('can build instances from serialized data (array)', function() {
+    $data = [
+        ['key' => 'bar', 'id' => 'one', 'attributes' => []],
+        ['key' => 'foo', 'id' => 'two', 'attributes' => []],
+        ['key' => 'bar', 'id' => 'three', 'attributes' => []],
+    ];
+
+    $flexible = (new Flexible())
+        ->register(fn ($layout) => $layout->key('foo'))
+        ->register(fn ($layout) => $layout->key('bar'))
+        ->build($data);
+
+    $values = $flexible
+        ->instances()
+        ->map(fn ($layout) => $layout->getId());
+
+    expect($values->implode(','))->toBe('one,two,three');
+});
+
+it('can build instances from serialized data (collection)', function() {
+    $data = collect([
+        (object) ['key' => 'bar', 'id' => 'one', 'attributes' => []],
+        (object) ['key' => 'foo', 'id' => 'two', 'attributes' => []],
+        (object) ['key' => 'bar', 'id' => 'three', 'attributes' => []],
+    ]);
+
+    $flexible = (new Flexible())
+        ->register(fn ($layout) => $layout->key('foo'))
+        ->register(fn ($layout) => $layout->key('bar'))
+        ->build($data);
+
+    $values = $flexible
+        ->instances()
+        ->map(fn ($layout) => $layout->getId());
+
+    expect($values->implode(','))->toBe('one,two,three');
+});
+
+it('can build instances from serialized data (json)', function() {
+    $data = json_encode([
+        ['key' => 'bar', 'id' => 'one', 'attributes' => []],
+        ['key' => 'foo', 'id' => 'two', 'attributes' => []],
+        ['key' => 'bar', 'id' => 'three', 'attributes' => []],
+    ]);
+
+    $flexible = (new Flexible())
+        ->register(fn ($layout) => $layout->key('foo'))
+        ->register(fn ($layout) => $layout->key('bar'))
+        ->build($data);
+
+    $values = $flexible
+        ->instances()
+        ->map(fn ($layout) => $layout->getId());
+
+    expect($values->implode(','))->toBe('one,two,three');
+});
+
+it('can build instances from serialized data using custom callable', function() {
+    $data = [
+        ['key' => 'bar', 'id' => 'one', 'attributes' => []],
+        ['key' => 'foo', 'id' => 'two', 'attributes' => []],
+        ['key' => 'bar', 'id' => 'three', 'attributes' => []],
+    ];
+
+    $flexible = (new Flexible())
+        ->register(fn ($layout) => $layout->key('foo'))
+        ->register(fn ($layout) => $layout->key('bar'))
+        ->buildUsing(function(Flexible $container, $items) {
+            foreach ($items as $item) {
+                $container->insert($item['key'], $item['attributes'], null, $item['id'] . '!');
+            }
+        })
+        ->build($data);
+
+    $values = $flexible
+        ->instances()
+        ->map(fn ($layout) => $layout->getId());
+
+    expect($values->implode(','))->toBe('one!,two!,three!');
+});