Change settings to override defaults

CHANGELOG.md

@@ -2,6 +2,9 @@ Changelog
 -------------
 
 ### Unreleased
+* Fill missing configuration with default values [#204](https://github.com/televator-apps/vimari/pull/204). This allows users to reduce the size of their configuration when using the default values. It allows us to introduce new settings without breaking user configurations because they miss this setting in their configuration.
+
+### 2.1.0 (2020-09-10)
 * Add `transparentBindings` setting that allows the use of non-bound keys in normal mode ([#188](https://github.com/televator-apps/vimari/issues/188)).
 * Remove eager link hint triggering [#190](https://github.com/televator-apps/vimari/issues/190)
 * Use `window.open` for `openNewTab` action [#189](https://github.com/televator-apps/vimari/issues/189)

Vimari Extension/ConfigurationModel.swift

@@ -10,7 +10,8 @@ protocol ConfigurationModelProtocol {
     func editConfigFile() throws
     func resetConfigFile() throws
     func getDefaultSettings() throws -> [String: Any]
-    func getUserSettings() throws -> [String : Any]
+    func getUserSettings() throws -> [String: Any]
+    func getMergedSettings() throws -> [String: Any]
 }
 
 import Foundation
@@ -54,7 +55,13 @@ class ConfigurationModel: ConfigurationModelProtocol {
         let settingsData = try Data(contentsOf: urlSettingsFile)
         return try settingsData.toJSONObject()
     }
-
+
+    func getMergedSettings() throws -> [String: Any] {
+        let userSettings = try getUserSettings()
+        let defaults = try getDefaultSettings()
+        return SettingsMerger.mergeWithDefaults(userSettings, defaults: defaults)
+    }
+
     private func loadSettings(fromFile file: String) throws -> [String : Any] {
         let settingsData = try Bundle.main.getJSONData(from: file)
         return try settingsData.toJSONObject()

Vimari Extension/SafariExtensionHandler.swift

@@ -150,7 +150,7 @@ class SafariExtensionHandler: SFSafariExtensionHandler {
     private func updateSettings(page: SFSafariPage) {
         do {
             let settings: [String: Any]
-            if let userSettings = try? configuration.getUserSettings() {
+            if let userSettings = try? configuration.getMergedSettings() {
                 settings = userSettings
             } else {
                 settings = try configuration.getDefaultSettings()
@@ -160,15 +160,6 @@ class SafariExtensionHandler: SFSafariExtensionHandler {
             NSLog(error.localizedDescription)
         }
     }
-
-    private func fallbackSettings(page: SFSafariPage) {
-        do {
-            let settings = try configuration.getUserSettings()
-            page.dispatch(settings: settings)
-        } catch {
-            NSLog(error.localizedDescription)
-        }
-    }
 }
 
 // MARK: Helpers

Vimari Extension/SettingsMerger.swift

@@ -0,0 +1,25 @@
+//
+//  SettingsMerger.swift
+//  Vimari Extension
+//
+//  Created by Nick Belzer on 20/09/2020.
+//  Copyright © 2020 net.televator. All rights reserved.
+//
+
+import Foundation
+
+class SettingsMerger {
+    /** This function merges the user settings with the default values when they are not provided by the user settings.  */
+    static func mergeWithDefaults(_ settings: [String: Any], defaults: [String: Any]) -> [String: Any] {
+        return settings.merging(defaults, uniquingKeysWith: solveSettingsMergeConflict)
+    }
+
+    /** Helper method for conflicts during settings merging. Recursively merges dictionaries with the preference for the first value.*/
+    static private func solveSettingsMergeConflict(val: Any, defaultVal: Any) -> Any {
+        if let subDictUser = val as? [String: Any], let subDictDefault = defaultVal as? [String: Any] {
+            // Allow for recursive merging of nested dictionaries.
+            return subDictUser.merging(subDictDefault, uniquingKeysWith: self.solveSettingsMergeConflict)
+        }
+        return val;
+    }
+}

Vimari.xcodeproj/project.pbxproj

@@ -7,6 +7,8 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		654AAF3E2517A37D00AB44D9 /* SettingsMerger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 654AAF3D2517A37D00AB44D9 /* SettingsMerger.swift */; };
+		654AAF4B2517A81200AB44D9 /* SettingsMerger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 654AAF3D2517A37D00AB44D9 /* SettingsMerger.swift */; };
 		659033F124E2B77400432D0E /* svim-scripts.js in Resources */ = {isa = PBXBuildFile; fileRef = 659033F024E2B77400432D0E /* svim-scripts.js */; };
 		65E444F324CC3A1B008EA1DC /* SafariExtensionCommunicator.js in Resources */ = {isa = PBXBuildFile; fileRef = 65E444F224CC3A1B008EA1DC /* SafariExtensionCommunicator.js */; };
 		B1E3C17023A65ED400A56807 /* ConfigurationModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1E3C16F23A65ED400A56807 /* ConfigurationModel.swift */; };
@@ -58,6 +60,7 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		654AAF3D2517A37D00AB44D9 /* SettingsMerger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsMerger.swift; sourceTree = "<group>"; };
 		659033F024E2B77400432D0E /* svim-scripts.js */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.javascript; path = "svim-scripts.js"; sourceTree = "<group>"; };
 		65E444F224CC3A1B008EA1DC /* SafariExtensionCommunicator.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = SafariExtensionCommunicator.js; sourceTree = "<group>"; };
 		B1E3C16F23A65ED400A56807 /* ConfigurationModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConfigurationModel.swift; sourceTree = "<group>"; };
@@ -163,6 +166,7 @@
 				E380F2612331806500640547 /* SafariExtensionHandler.swift */,
 				B1E3C16F23A65ED400A56807 /* ConfigurationModel.swift */,
 				E380F2632331806500640547 /* SafariExtensionViewController.swift */,
+				654AAF3D2517A37D00AB44D9 /* SettingsMerger.swift */,
 				E380F2652331806500640547 /* SafariExtensionViewController.xib */,
 				B1FD3B9723A588DE00677A52 /* json */,
 				E380F281233183EE00640547 /* css */,
@@ -322,6 +326,7 @@
 			files = (
 				E380F2512331806400640547 /* ViewController.swift in Sources */,
 				E380F24C2331806400640547 /* AppDelegate.swift in Sources */,
+				654AAF4B2517A81200AB44D9 /* SettingsMerger.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -331,6 +336,7 @@
 			files = (
 				E380F2642331806500640547 /* SafariExtensionViewController.swift in Sources */,
 				E380F2622331806500640547 /* SafariExtensionHandler.swift in Sources */,
+				654AAF3E2517A37D00AB44D9 /* SettingsMerger.swift in Sources */,
 				B1E3C17023A65ED400A56807 /* ConfigurationModel.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;