Refactor the work with default settings (flatten arrays) (#78)

* Refactor the work with default settings (flatten arrays)

Author: glorand

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `glorand/laravel-model-settings` will be documented in this file
 
+## 4.2.0 - 2020-12-14
+### Added
+- Refactor the work with default settings (flatten arrays)
+
 ## 4.1.0 - 2020-12-03
 ### Added
 - Refactor unit tests

src/Managers/AbstractSettingsManager.php

@@ -34,16 +34,59 @@ public function __construct(Model $model)
     }
 
     /**
+     * Check if array is associative and not sequential
+     * @param array $arr
+     * @return bool
+     */
+    private static function isAssoc(array $arr): bool
+    {
+        if ([] === $arr) {
+            return false;
+        }
+
+        return array_keys($arr) !== range(0, count($arr) - 1);
+    }
+
+    /**
+     * Flatten array with dots for settings package
+     * @param $array
+     * @param string $prepend
      * @return array
      */
-    public function all(): array
+    public static function dotFlatten($array, $prepend = ''): array
     {
-        $array = [];
-        foreach (array_merge($this->model->getDefaultSettings(), $this->model->getSettingsValue()) as $key => $value) {
-            Arr::set($array, $key, $value);
+        $results = [];
+        foreach ($array as $key => $value) {
+            // only re-run if nested array is associative (key-based)
+            if (is_array($value) && static::isAssoc($value) && !empty($value)) {
+                $results = array_merge($results, static::dotFlatten($value, $prepend . $key . '.'));
+            } else {
+                $results[$prepend . $key] = $value;
+            }
         }
 
-        return $array;
+        return $results;
+    }
+
+    /**
+     * Get nested merged array with all available keys
+     * @return array
+     */
+    public function all(): array
+    {
+        return $this->getMultiple();
+    }
+
+    /**
+     * Get flat merged array with dot-notation keys
+     * @return array
+     */
+    public function allFlattened(): array
+    {
+        $flattenedDefaultSettings = static::dotFlatten($this->model->getDefaultSettings());
+        $flattenedSettingsValue = static::dotFlatten($this->model->getSettingsValue());
+
+        return array_merge($flattenedDefaultSettings, $flattenedSettingsValue);
     }
 
     /**
@@ -74,7 +117,7 @@ public function has(string $path): bool
     /**
      * @param string|null $path
      * @param null $default
-     * @return array|mixed
+     * @return array|\ArrayAccess|mixed
      */
     public function get(string $path = null, $default = null)
     {
@@ -84,16 +127,25 @@ public function get(string $path = null, $default = null)
     /**
      * @param iterable|null $paths
      * @param null $default
-     * @return iterable
+     * @return array
      */
-    public function getMultiple(iterable $paths = null, $default = null): iterable
+    public function getMultiple(iterable $paths = null, $default = null): array
     {
-        $values = [];
+        $array = [];
+        $allFlattened = $this->allFlattened();
+        $settingsArray = [];
+        foreach ($allFlattened as $key => $value) {
+            Arr::set($settingsArray, $key, $value);
+        }
+        if (is_null($paths)) {
+            return $settingsArray;
+        }
+
         foreach ($paths as $path) {
-            $values[$path] = $this->get($path, $default);
+            Arr::set($array, $path, Arr::get($settingsArray, $path, $default));
         }
 
-        return $values;
+        return $array;
     }
 
     /**

tests/CommonFunctionalityTest.php

@@ -151,8 +151,10 @@ public function testGetMultiple(string $modelType)
         $values = $model->settings()->getMultiple(['user.first_name', 'user.last_name'], 'def_val');
         $this->assertEquals(
             [
-                'user.first_name' => 'def_val',
-                'user.last_name'  => 'def_val',
+                'user' => [
+                    'first_name' => 'def_val',
+                    'last_name'  => 'def_val',
+                ],
             ],
             $values
         );
@@ -169,7 +171,9 @@ public function testGetMultiple(string $modelType)
                     'last_name'  => 'Doe',
                     'email'      => '[email protected]',
                 ],
-                'project.name' => 'Project One',
+                'project' => [
+                    'name' => 'Project One',
+                ],
                 'date'    => 'def_val',
             ],
             $values
@@ -303,6 +307,38 @@ public function testDefaultValue(string $modelType)
             array_merge($this->defaultSettingsTestArray, $this->testArray),
             $model->settings()->all()
         );
+
+        $model->settings()->clear();
+
+        $default = [
+            'a' => [
+                'val_a_1' => 1,
+                'val_a_2' => 2,
+            ],
+        ];
+        $applyData = [
+            'a' => [
+                'val_a_2' => '2-updated',
+                'val_a_3' => 3,
+            ],
+            'b' => 'b-val',
+        ];
+
+        $model->defaultSettings = $default;
+        $this->assertEquals($default, $model->settings()->all());
+
+        $model->settings()->apply($applyData);
+        $this->assertEquals(
+            [
+                'a' => [
+                    'val_a_1' => 1,
+                    'val_a_2' => '2-updated',
+                    'val_a_3' => 3,
+                ],
+                'b' => 'b-val',
+            ],
+            $model->settings()->all()
+        );
     }
 
     /**

tests/TestCase.php

@@ -30,11 +30,7 @@ public function setUp(): void
 
     protected function checkRequirements()
     {
-        collect($this->getAnnotations())->filter(function ($location) {
-            return in_array('!Travis', Arr::get($location, 'requires', []));
-        })->each(function ($location) {
-            $this->markTestSkipped('Travis will not run this test.');
-        });
+        //
     }
 
     protected function getPackageProviders($app)