Feature Add OverrideSettingsCachePath and overrideDatabaseName (#99)

* Feature Add OverrideSettingsCachePath and overrideDatabaseName

fix for #98
Allow manual configuration of the Directory and FileName for the db.

* Add missing  overrideDatabaseName

Author: ChrisPulman

README.md

@@ -127,6 +127,12 @@ public class ViewSettings : SettingsBase
 }
 ```
 
+## OPTIONAL: Override Settings Cache Path
+
+```c#
+AppInfo.OverrideSettingsCachePath(path);
+```
+
 ## Create an instance or get existing Settings SettingsCache
 
 Install ReactiveMarbles.CacheDatabase.Settings

src/ReactiveMarbles.CacheDatabase.EncryptedSettings.Tests/SettingsCacheTests.cs

@@ -14,6 +14,7 @@ public class SettingsCacheTests
         /// <summary>
         /// Test1s this instance.
         /// </summary>
+        /// <param name="overrideDatabaseName">Name of the override database.</param>
         [Fact]
         public async void TestCreateAndInsert()
         {
@@ -43,5 +44,16 @@ public async void TestUpdateAndRead()
             Assert.Equal(EnumTestValue.Option2, viewSettings.EnumTest);
             await viewSettings.DisposeAsync();
         }
+
+        /// <summary>
+        /// Tests the override settings cache path.
+        /// </summary>
+        [Fact]
+        public void TestOverrideSettingsCachePath()
+        {
+            const string path = "c:\\SettingsStoreage\\ApplicationSettings\\";
+            AppInfo.OverrideSettingsCachePath(path);
+            Assert.Equal(path, AppInfo.SettingsCachePath);
+        }
     }
 }

src/ReactiveMarbles.CacheDatabase.Settings.Tests/SettingsCacheTests.cs

@@ -41,5 +41,16 @@ public async void TestUpdateAndRead()
             Assert.Equal(EnumTestValue.Option2, viewSettings.EnumTest);
             await viewSettings.DisposeAsync();
         }
+
+        /// <summary>
+        /// Tests the override settings cache path.
+        /// </summary>
+        [Fact]
+        public void TestOverrideSettingsCachePath()
+        {
+            const string path = "c:\\SettingsStoreage\\ApplicationSettings\\";
+            AppInfo.OverrideSettingsCachePath(path);
+            Assert.Equal(path, AppInfo.SettingsCachePath);
+        }
     }
 }

src/ReactiveMarbles.CacheDatabase.Settings/Core/AppInfo.cs

@@ -4,14 +4,19 @@
 
 using ReactiveMarbles.CacheDatabase.Core;
 using ReactiveMarbles.CacheDatabase.Settings.Core;
+
 #if ENCRYPTED
+
 using ReactiveMarbles.CacheDatabase.EncryptedSqlite3;
+
 #else
 using ReactiveMarbles.CacheDatabase.Sqlite3;
 #endif
+
 using System.Reflection;
 
 #if ENCRYPTED
+
 namespace ReactiveMarbles.CacheDatabase.EncryptedSettings
 #else
 namespace ReactiveMarbles.CacheDatabase.Settings
@@ -46,7 +51,7 @@ static AppInfo()
         /// <value>
         /// The settings cache path.
         /// </value>
-        public static string? SettingsCachePath { get; }
+        public static string? SettingsCachePath { get; private set; }
 
         /// <summary>
         /// Gets the executing assembly.
@@ -76,49 +81,71 @@ static AppInfo()
 
         internal static Dictionary<string, ISettingsStorage?> SettingsStores { get; }
 
+        /// <summary>
+        /// Overrides the settings cache path.
+        /// </summary>
+        /// <param name="path">The path.</param>
+        public static void OverrideSettingsCachePath(string path)
+        {
+            SettingsCachePath = path;
+        }
+
         /// <summary>
         /// Deletes the settings store.
         /// </summary>
         /// <typeparam name="T">The type of store to delete.</typeparam>
-        /// <returns>A Task.</returns>
-        public static async Task DeleteSettingsStore<T>()
+        /// <param name="overrideDatabaseName">Name of the override database.</param>
+        /// <returns>
+        /// A Task.
+        /// </returns>
+        public static async Task DeleteSettingsStore<T>(string? overrideDatabaseName = null)
         {
             await DisposeSettingsStore<T>().ConfigureAwait(false);
-            File.Delete(Path.Combine(SettingsCachePath!, $"{typeof(T).Name}.db"));
+            File.Delete(Path.Combine(SettingsCachePath!, $"{overrideDatabaseName ?? typeof(T).Name}.db"));
         }
 
         /// <summary>
         /// Gets the settings store.
         /// </summary>
         /// <typeparam name="T">The store to get.</typeparam>
-        /// <returns>A Settings Store.</returns>
-        public static ISettingsStorage? GetSettingsStore<T>() =>
-            SettingsStores[typeof(T).Name];
+        /// <param name="overrideDatabaseName">Name of the override database.</param>
+        /// <returns>
+        /// A Settings Store.
+        /// </returns>
+        public static ISettingsStorage? GetSettingsStore<T>(string? overrideDatabaseName = null) =>
+            SettingsStores[overrideDatabaseName ?? typeof(T).Name];
 
         /// <summary>
         /// Disposes the settings store.
         /// </summary>
         /// <typeparam name="T">The type of store.</typeparam>
-        /// <returns>A Task.</returns>
-        public static async Task DisposeSettingsStore<T>()
+        /// <param name="overrideDatabaseName">Name of the override database.</param>
+        /// <returns>
+        /// A Task.
+        /// </returns>
+        public static async Task DisposeSettingsStore<T>(string? overrideDatabaseName = null)
         {
-            await GetSettingsStore<T>()!.DisposeAsync().ConfigureAwait(false);
-            await BlobCaches[typeof(T).Name]!.DisposeAsync().ConfigureAwait(false);
+            await GetSettingsStore<T>(overrideDatabaseName)!.DisposeAsync().ConfigureAwait(false);
+            await BlobCaches[overrideDatabaseName ?? typeof(T).Name]!.DisposeAsync().ConfigureAwait(false);
         }
 
 #if ENCRYPTED
+
         /// <summary>
         /// Setup the secure settings store.
         /// </summary>
         /// <typeparam name="T">The Type of settings store.</typeparam>
         /// <param name="password">Secure password.</param>
         /// <param name="initialise">Initialise the Settings values.</param>
-        /// <returns>The Settings store.</returns>
-        public static async Task<T?> SetupSettingsStore<T>(string password, bool initialise = true)
+        /// <param name="overrideDatabaseName">Name of the override database.</param>
+        /// <returns>
+        /// The Settings store.
+        /// </returns>
+        public static async Task<T?> SetupSettingsStore<T>(string password, bool initialise = true, string? overrideDatabaseName = null)
             where T : ISettingsStorage?, new()
         {
             Directory.CreateDirectory(SettingsCachePath!);
-            BlobCaches[typeof(T).Name] = new EncryptedSqliteBlobCache(Path.Combine(SettingsCachePath!, $"{typeof(T).Name}.db"), password);
+            BlobCaches[typeof(T).Name] = new EncryptedSqliteBlobCache(Path.Combine(SettingsCachePath!, $"{overrideDatabaseName ?? typeof(T).Name}.db"), password);
 
             var viewSettings = new T();
             SettingsStores[typeof(T).Name] = viewSettings;
@@ -129,19 +156,23 @@ public static async Task DisposeSettingsStore<T>()
 
             return viewSettings;
         }
+
 #else
 
         /// <summary>
         /// Setup the settings store.
         /// </summary>
         /// <typeparam name="T">The Type of settings store.</typeparam>
         /// <param name="initialise">Initialise the Settings values.</param>
-        /// <returns>The Settings store.</returns>
-        public static async Task<T?> SetupSettingsStore<T>(bool initialise = true)
+        /// <param name="overrideDatabaseName">Name of the override database.</param>
+        /// <returns>
+        /// The Settings store.
+        /// </returns>
+        public static async Task<T?> SetupSettingsStore<T>(bool initialise = true, string? overrideDatabaseName = null)
             where T : ISettingsStorage?, new()
         {
             Directory.CreateDirectory(SettingsCachePath!);
-            BlobCaches[typeof(T).Name] = new SqliteBlobCache(Path.Combine(SettingsCachePath!, $"{typeof(T).Name}.db"));
+            BlobCaches[typeof(T).Name] = new SqliteBlobCache(Path.Combine(SettingsCachePath!, $"{overrideDatabaseName ?? typeof(T).Name}.db"));
 
             var viewSettings = new T();
             SettingsStores[typeof(T).Name] = viewSettings;