Default Settings (#20)

* Default Settings

Author: glorand

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `glorand/laravel-model-settings` will be documented in this file
 
+## 3.3.0 - 2019-08-29
+### Added
+- Default settings on Model
+
 ## 3.2.0 - 2019-08-07
 ### Added
 - Compatibility with PSR-16, CacheInterface

README.md

@@ -9,6 +9,9 @@
 <p align="center">
 <a href="https://packagist.org/packages/glorand/laravel-model-settings">
  <img src="https://poser.pugx.org/glorand/laravel-model-settings/v/stable" alt="Latest Stable Version">
+</a>
+<a href="https://packagist.org/packages/glorand/laravel-model-settings">
+  <img src="https://poser.pugx.org/glorand/laravel-model-settings/downloads" alt="Total Downloads">
 </a>
  <a href="https://travis-ci.com/glorand/laravel-model-settings">
  <img src="https://travis-ci.com/glorand/laravel-model-settings.svg?branch=master" alt="Build Status">
@@ -37,6 +40,7 @@ Bug reports, feature requests, and pull requests can be submitted by following o
 - [Updating your Eloquent Models](#update_models)
     - [Option 1 - `HasSettingsField` trait](#update_models_1)
     - [Option 2 - `HasSettingsTable` trait](#update_models_2)
+- [Default Settings](#default_settings)
 - [Usage](#usage)
     - [Get all model's settings](#get_all)
     - [Get a specific setting](#get)
@@ -109,6 +113,19 @@ class User extends Model
 }
 ```
 
+##Default settings <a name="default_settings"></a>
+
+```php
+use Glorand\Model\Settings\Traits\HasSettingsTable;
+
+class User extends Model
+{
+    public $defaultSettings = [
+        'key_1' => 'val_1',
+    ];
+}
+```
+
 ## Usage <a name="usage"></a>
 
 ```php

src/Managers/AbstractSettingsManager.php

@@ -16,9 +16,12 @@ abstract class AbstractSettingsManager implements SettingsManagerContract
     /** @var \Illuminate\Database\Eloquent\Model */
     protected $model;
 
+    /** @var array */
+    protected $defaultSettings = [];
+
     /**
      * AbstractSettingsManager constructor.
-     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param \Illuminate\Database\Eloquent\Model|HasSettings $model
      * @throws \Glorand\Model\Settings\Exceptions\ModelSettingsException
      */
     public function __construct(Model $model)
@@ -34,7 +37,7 @@ public function __construct(Model $model)
      */
     public function all(): array
     {
-        return $this->model->getSettingsValue();
+        return array_merge($this->model->getDefaultSettings(), $this->model->getSettingsValue());
     }
 
     /**

src/Traits/HasSettings.php

@@ -2,8 +2,19 @@
 
 namespace Glorand\Model\Settings\Traits;
 
+use Illuminate\Support\Arr;
+
 trait HasSettings
 {
+    public function getDefaultSettings(): array
+    {
+        if (property_exists($this, 'defaultSettings')) {
+            return Arr::wrap($this->defaultSettings);
+        }
+
+        return [];
+    }
+
     /**
      * @return array
      */

tests/FieldSettingsManagerTest.php

@@ -17,6 +17,10 @@ class FieldSettingsManagerTest extends TestCase
             'email'      => "[email protected]",
         ],
     ];
+    /** @var array  */
+    protected $defaultSettingsTestArray = [
+        'project' => 'Main Project',
+    ];
 
     public function setUp(): void
     {
@@ -31,13 +35,25 @@ public function testInit()
     }
 
     /**
-     * @throws \Exception
+     * @throws \Glorand\Model\Settings\Exceptions\ModelSettingsException
      */
     public function testAll()
     {
         $this->assertEquals($this->model->settings()->all(), []);
     }
 
+    /**
+     * @throws \Glorand\Model\Settings\Exceptions\ModelSettingsException
+     */
+    public function testDefaultValue()
+    {
+        $this->model->defaultSettings = $this->defaultSettingsTestArray;
+        $this->assertEquals($this->defaultSettingsTestArray, $this->model->settings()->all());
+
+        $this->model->settings()->apply($this->testArray);
+        $this->assertEquals($this->model->settings()->all(), array_merge($this->defaultSettingsTestArray, $this->testArray));
+    }
+
     /**
      * @expectedException \Glorand\Model\Settings\Exceptions\ModelSettingsException
      * @expectedExceptionMessage Unknown field

tests/Models/UserWithField.php

@@ -16,4 +16,6 @@ class UserWithField extends Model
     protected $guarded = [];
 
     protected $fillable = ['id', 'name'];
+
+    public $defaultSettings = [];
 }

tests/Models/UsersWithTable.php

@@ -17,4 +17,6 @@ class UsersWithTable extends Model
     protected $guarded = [];
 
     protected $fillable = ['id', 'name'];
+
+    public $defaultSettings = [];
 }

tests/TableSettingsManagerTest.php

@@ -3,13 +3,16 @@
 namespace Glorand\Model\Settings\Tests;
 
 use Glorand\Model\Settings\Models\ModelSettings;
+use Glorand\Model\Settings\Tests\Models\UsersWithDefaultSettingsTable;
 use Glorand\Model\Settings\Tests\Models\UsersWithTable as User;
 use Glorand\Model\Settings\Traits\HasSettingsTable;
 use Illuminate\Database\Eloquent\Relations\MorphOne;
 use Illuminate\Support\Facades\DB;
 
 class TableSettingsManagerTest extends TestCase
 {
+    /** @var \Glorand\Model\Settings\Tests\Models\UsersWithTable */
+    private $model;
     /** @var array */
     protected $testArray = [
         'user' => [
@@ -18,8 +21,10 @@ class TableSettingsManagerTest extends TestCase
             'email'      => "[email protected]",
         ],
     ];
-    /** @var \Glorand\Model\Settings\Tests\Models\UsersWithTable */
-    private $model;
+    /** @var array  */
+    protected $defaultSettingsTestArray = [
+        'project' => 'Main Project',
+    ];
 
     public function setUp(): void
     {
@@ -41,6 +46,18 @@ public function testAll()
         $this->assertEquals($this->model->settings()->all(), []);
     }
 
+    /**
+     * @throws \Glorand\Model\Settings\Exceptions\ModelSettingsException
+     */
+    public function testDefaultValue()
+    {
+        $this->model->defaultSettings = $this->defaultSettingsTestArray;
+        $this->assertEquals($this->defaultSettingsTestArray, $this->model->settings()->all());
+
+        $this->model->settings()->apply($this->testArray);
+        $this->assertEquals($this->model->settings()->all(), array_merge($this->defaultSettingsTestArray, $this->testArray));
+    }
+
     /**
      * @throws \Exception
      */