Persistence for settings field (#5)

* Use Facade instead of Helper
* Persistence for settings field

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `glorand/laravel-model-settings` will be documented in this file
 
+## 3.1.0 - 2019-06-28
+### Added
+- Configure persistence for settings in case of Field Type (HasSettingsField)
+
 ## 3.0.0 - 2019-03-21
 ### Added
 - Command to create the table for settings

README.md

@@ -43,6 +43,7 @@ Bug reports, feature requests, and pull requests can be submitted by following o
     - [Add / Update setting](#add_update)
     - [Check if the model has a specific setting](#check)
     - [Remove a setting from a model](#remove)
+    - [Persistence](#persistence)
  - [Changelog](#changelog)
  - [Contributing](#contributing)
 - [License](#license)
@@ -143,6 +144,23 @@ $user->settings()->has('some.setting');
 $user->settings()->delete('some.setting');
 ```
 
+#### Persistence for settings field <a name="persistence"></a>
+In case of field settings the auto-save is configurable
+
+ - Use an attribute on model
+```php
+protected $persistSettings = true; //boolean
+```
+ - Environment (.env) variable
+ ```dotenv
+MODEL_SETTINGS_PERSISTENT=true
+```
+- Config value - model settings config file
+ ```php
+'settings_persistent' => env('MODEL_SETTINGS_PERSISTENT', false),
+```
+If the persistence is `false` you have to save the model after the operation.
+
 ## Changelog <a name="changelog"></a>
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
 

config/model_settings.php

@@ -3,4 +3,5 @@
 return [
     'settings_field_name' => env('MODEL_SETTINGS_FIELD_NAME', 'settings'),
     'settings_table_name' => env('MODEL_SETTINGS_TABLE_NAME', 'model_settings'),
+    'settings_persistent' => env('MODEL_SETTINGS_PERSISTENT', true),
 ];

src/Console/CreateSettingsFieldForModel.php

@@ -5,7 +5,7 @@
 use Illuminate\Console\Command;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Str;
-use Schema;
+use Illuminate\Support\Facades\Schema;
 
 class CreateSettingsFieldForModel extends Command
 {

src/Console/CreateSettingsTable.php

@@ -5,7 +5,7 @@
 use Illuminate\Console\Command;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Str;
-use Schema;
+use Illuminate\Support\Facades\Schema;
 
 class CreateSettingsTable extends Command
 {

src/Managers/FieldSettingsManager.php

@@ -18,7 +18,9 @@ class FieldSettingsManager extends AbstractSettingsManager
     public function apply(array $settings = []): SettingsManagerContract
     {
         $this->model->{$this->model->getSettingsFieldName()} = json_encode($settings);
-        $this->model->save();
+        if ($this->model->isPersistSettings()) {
+            $this->model->save();
+        }
 
         return $this;
     }

src/Traits/HasSettingsField.php

@@ -11,11 +11,14 @@
  * @package Glorand\Model\Settings\Traits
  * @property array $settings
  * @property string $settingsFieldName
+ * @property boolean $persistSettings
  */
 trait HasSettingsField
 {
     use HasSettings;
 
+    private $persistSettings = null;
+
     /**
      * @return \Glorand\Model\Settings\Contracts\SettingsManagerContract
      * @throws ModelSettingsException
@@ -36,6 +39,7 @@ public function getSettingsValue(): array
         if (!array_has($attributes, $settingsFieldName)) {
             throw new ModelSettingsException("Unknown field ($settingsFieldName) on table {$this->getTable()}");
         }
+
         return json_decode($this->getAttributeValue($settingsFieldName) ?? '[]', true);
     }
 
@@ -47,7 +51,25 @@ public function getSettingsFieldName(): string
         return $this->settingsFieldName ?? config('model_settings.settings_field_name');
     }
 
+    /**
+     * @return bool
+     */
+    public function isPersistSettings(): bool
+    {
+        return boolval($this->persistSettings ?? config('model_settings.settings_persistent'));
+    }
+
+    /**
+     * @param bool $val
+     */
+    public function setPersistSettings(bool $val = true)
+    {
+        $this->persistSettings = $val;
+    }
+
     abstract public function getTable();
+
     abstract public function getAttributes();
+
     abstract public function getAttributeValue($key);
 }

tests/FieldSettingsManagerTest.php

@@ -76,7 +76,18 @@ public function testGet()
     public function testApply()
     {
         $this->model->settings()->apply($this->testArray);
-        $this->assertEquals($this->model->settings()->all(), $this->testArray);
+        $this->assertEquals($this->model->fresh()->settings()->all(), $this->testArray);
+
+        $this->model->settings()->delete();
+
+        $this->model->setPersistSettings(false);
+        $this->model->settings()->apply($this->testArray);
+        $this->assertEquals($this->model->fresh()->settings()->all(), []);
+
+        $this->model->fresh();
+        $this->model->setPersistSettings(true);
+        $this->model->settings()->apply($this->testArray);
+        $this->assertEquals($this->model->fresh()->settings()->all(), $this->testArray);
     }
 
     /**

tests/Models/UserWithField.php

@@ -9,6 +9,8 @@ class UserWithField extends Model
 {
     use HasSettingsField;
 
+    //protected $persistSettings = true;
+
     protected $table = 'users_with_field';
 
     protected $guarded = [];