PR updates

shweaver-MSFT · shweaver-MSFT · commit 11d1a5e6ca29 · 2021-07-27T17:34:38.000-07:00
diff --git a/Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/ApplicationDataStorageHelper.CacheFolder.cs b/Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/ApplicationDataStorageHelper.CacheFolder.cs
@@ -37,7 +37,7 @@ public Task<T> ReadCacheFileAsync<T>(string filePath, T @default = default)
         /// </summary>
         /// <param name="folderPath">The path to the target folder.</param>
         /// <returns>A list of file types and names in the target folder.</returns>
-        public Task<IEnumerable<(DirectoryItemType, string)>> ReadCacheFolderAsync(string folderPath)
+        public Task<IEnumerable<(DirectoryItemType ItemType, string Name)>> ReadCacheFolderAsync(string folderPath)
         {
             return ReadFolderAsync(CacheFolder, folderPath);
         }
diff --git a/Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/ApplicationDataStorageHelper.cs b/Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/ApplicationDataStorageHelper.cs
@@ -22,7 +22,7 @@ public partial class ApplicationDataStorageHelper : IFileStorageHelper, ISetting
         /// </summary>
         /// <param name="objectSerializer">Serializer for converting stored values. Defaults to <see cref="Toolkit.Helpers.SystemSerializer"/>.</param>
         /// <returns>A new instance of ApplicationDataStorageHelper.</returns>
-        public static ApplicationDataStorageHelper GetCurrent(Toolkit.Helpers.IObjectSerializer objectSerializer = null)
+        public static ApplicationDataStorageHelper GetCurrent(Toolkit.Helpers.IObjectSerializer? objectSerializer = null)
         {
             var appData = ApplicationData.Current;
             return new ApplicationDataStorageHelper(appData, objectSerializer);
@@ -34,7 +34,7 @@ public static ApplicationDataStorageHelper GetCurrent(Toolkit.Helpers.IObjectSer
         /// <param name="user">App data user owner.</param>
         /// <param name="objectSerializer">Serializer for converting stored values. Defaults to <see cref="Toolkit.Helpers.SystemSerializer"/>.</param>
         /// <returns>A new instance of ApplicationDataStorageHelper.</returns>
-        public static async Task<ApplicationDataStorageHelper> GetForUserAsync(User user, Toolkit.Helpers.IObjectSerializer objectSerializer = null)
+        public static async Task<ApplicationDataStorageHelper> GetForUserAsync(User user, Toolkit.Helpers.IObjectSerializer? objectSerializer = null)
         {
             var appData = await ApplicationData.GetForUserAsync(user);
             return new ApplicationDataStorageHelper(appData, objectSerializer);
@@ -65,7 +65,7 @@ public static async Task<ApplicationDataStorageHelper> GetForUserAsync(User user
         /// </summary>
         /// <param name="appData">The data store to interact with.</param>
         /// <param name="objectSerializer">Serializer for converting stored values. Defaults to <see cref="Toolkit.Helpers.SystemSerializer"/>.</param>
-        public ApplicationDataStorageHelper(ApplicationData appData, Toolkit.Helpers.IObjectSerializer objectSerializer = null)
+        public ApplicationDataStorageHelper(ApplicationData appData, Toolkit.Helpers.IObjectSerializer? objectSerializer = null)
         {
             AppData = appData ?? throw new ArgumentNullException(nameof(appData));
             Serializer = objectSerializer ?? new Toolkit.Helpers.SystemSerializer();
@@ -137,15 +137,35 @@ public void Clear()
         /// <returns>True if a value exists.</returns>
         public bool KeyExists(string compositeKey, string key)
         {
-            if (KeyExists(compositeKey))
+            if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))
             {
-                ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];
-                if (composite != null)
+                return composite.ContainsKey(key);
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Attempts to retrieve a single item by its key in composite.
+        /// </summary>
+        /// <typeparam name="T">Type of object retrieved.</typeparam>
+        /// <param name="compositeKey">Key of the composite (that contains settings).</param>
+        /// <param name="key">Key of the object.</param>
+        /// <param name="value">The value of the object retrieved.</param>
+        /// <returns>The T object.</returns>
+        public bool TryRead<T>(string compositeKey, string key, out T value)
+        {
+            if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))
+            {
+                string compositeValue = (string)composite[key];
+                if (compositeValue != null)
                 {
-                    return composite.ContainsKey(key);
+                    value = Serializer.Deserialize<T>(compositeValue);
+                    return true;
                 }
             }
 
+            value = default;
             return false;
         }
 
@@ -159,11 +179,9 @@ public bool KeyExists(string compositeKey, string key)
         /// <returns>The T object.</returns>
         public T Read<T>(string compositeKey, string key, T @default = default)
         {
-            ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];
-            if (composite != null)
+            if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))
             {
-                string value = (string)composite[key];
-                if (value != null)
+                if (composite.TryGetValue(key, out object valueObj) && valueObj is string value)
                 {
                     return Serializer.Deserialize<T>(value);
                 }
@@ -182,10 +200,8 @@ public T Read<T>(string compositeKey, string key, T @default = default)
         /// <param name="values">Objects to save.</param>
         public void Save<T>(string compositeKey, IDictionary<string, T> values)
         {
-            if (KeyExists(compositeKey))
+            if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))
             {
-                ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];
-
                 foreach (KeyValuePair<string, T> setting in values)
                 {
                     if (composite.ContainsKey(setting.Key))
@@ -200,7 +216,7 @@ public void Save<T>(string compositeKey, IDictionary<string, T> values)
             }
             else
             {
-                ApplicationDataCompositeValue composite = new ApplicationDataCompositeValue();
+                composite = new ApplicationDataCompositeValue();
                 foreach (KeyValuePair<string, T> setting in values)
                 {
                     composite.Add(setting.Key, Serializer.Serialize(setting.Value));
@@ -215,20 +231,15 @@ public void Save<T>(string compositeKey, IDictionary<string, T> values)
         /// </summary>
         /// <param name="compositeKey">Key of the composite (that contains settings).</param>
         /// <param name="key">Key of the object.</param>
-        /// <exception cref="KeyNotFoundException">Throws when the specified composite/settings key is not found.</exception>
-        public void Delete(string compositeKey, string key)
+        /// <returns>A boolean indicator of success.</returns>
+        public bool TryDelete(string compositeKey, string key)
         {
-            if (!KeyExists(compositeKey))
+            if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))
             {
-                throw new KeyNotFoundException($"Composite key not found: {compositeKey}");
+                return composite.Remove(key);
             }
 
-            ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];
-
-            if (!composite.Remove(key))
-            {
-                throw new KeyNotFoundException($"Settings key not found: {key}");
-            }
+            return false;
         }
 
         /// <inheritdoc />
@@ -238,7 +249,7 @@ public Task<T> ReadFileAsync<T>(string filePath, T @default = default)
         }
 
         /// <inheritdoc />
-        public Task<IEnumerable<(DirectoryItemType, string)>> ReadFolderAsync(string folderPath)
+        public Task<IEnumerable<(DirectoryItemType ItemType, string Name)>> ReadFolderAsync(string folderPath)
         {
             return ReadFolderAsync(Folder, folderPath);
         }
@@ -290,8 +301,8 @@ private async Task<T> ReadFileAsync<T>(StorageFolder folder, string filePath, T
                     : item.IsOfType(StorageItemTypes.Folder) ? DirectoryItemType.Folder
                     : DirectoryItemType.None;
 
-                return new ValueTuple<DirectoryItemType, string>(itemType, item.Name);
-            }).ToList();
+                return (itemType, item.Name);
+            });
         }
 
         private Task<StorageFile> SaveFileAsync<T>(StorageFolder folder, string filePath, T value)
diff --git a/Microsoft.Toolkit/Extensions/ISettingsStorageHelperExtensions.cs b/Microsoft.Toolkit/Extensions/ISettingsStorageHelperExtensions.cs
@@ -22,21 +22,18 @@ public static class ISettingsStorageHelperExtensions
         /// <typeparam name="TValue">The type of object value expected.</typeparam>
         /// <param name="storageHelper">The storage helper instance fo read from.</param>
         /// <param name="key">The key of the target object.</param>
-        /// <param name="value">The value of the target object, or the fallback value.</param>
         /// <param name="fallback">An alternative value returned if the read fails.</param>
-        /// <returns>A boolean indicator of success.</returns>
-        public static bool TryGetValueOrDefault<TKey, TValue>(this ISettingsStorageHelper<TKey> storageHelper, TKey key, out TValue? value, TValue? fallback = default)
+        /// <returns>The value of the target object, or the fallback value.</returns>
+        public static TValue GetValueOrDefault<TKey, TValue>(this ISettingsStorageHelper<TKey> storageHelper, TKey key, TValue? fallback = default)
             where TKey : notnull
         {
             if (storageHelper.TryRead<TValue>(key, out TValue? storedValue))
             {
-                value = storedValue;
-                return true;
+                return storedValue;
             }
             else
             {
-                value = fallback;
-                return false;
+                return fallback;
             }
         }
 
@@ -58,7 +55,8 @@ public static bool TryGetValueOrDefault<TKey, TValue>(this ISettingsStorageHelpe
             }
             else
             {
-                throw new KeyNotFoundException();
+                ThrowKeyNotFoundException(key);
+                return default;
             }
         }
 
@@ -74,8 +72,13 @@ public static void Delete<TKey>(this ISettingsStorageHelper<TKey> storageHelper,
         {
             if (!storageHelper.TryDelete(key))
             {
-                throw new KeyNotFoundException();
+                ThrowKeyNotFoundException(key);
             }
         }
+
+        private static void ThrowKeyNotFoundException<TKey>(TKey key)
+        {
+            throw new KeyNotFoundException($"The given key '{key}' was not present");
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public Task<T> ReadCacheFileAsync<T>(string filePath, T @default = default)`
`37`	`37`	`/// </summary>`
`38`	`38`	`/// <param name="folderPath">The path to the target folder.</param>`
`39`	`39`	`/// <returns>A list of file types and names in the target folder.</returns>`
`40`		`- public Task<IEnumerable<(DirectoryItemType, string)>> ReadCacheFolderAsync(string folderPath)`
	`40`	`+ public Task<IEnumerable<(DirectoryItemType ItemType, string Name)>> ReadCacheFolderAsync(string folderPath)`
`41`	`41`	`{`
`42`	`42`	`return ReadFolderAsync(CacheFolder, folderPath);`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public partial class ApplicationDataStorageHelper : IFileStorageHelper, ISetting`
`22`	`22`	`/// </summary>`
`23`	`23`	`/// <param name="objectSerializer">Serializer for converting stored values. Defaults to <see cref="Toolkit.Helpers.SystemSerializer"/>.</param>`
`24`	`24`	`/// <returns>A new instance of ApplicationDataStorageHelper.</returns>`
`25`		`- public static ApplicationDataStorageHelper GetCurrent(Toolkit.Helpers.IObjectSerializer objectSerializer = null)`
	`25`	`+ public static ApplicationDataStorageHelper GetCurrent(Toolkit.Helpers.IObjectSerializer? objectSerializer = null)`
`26`	`26`	`{`
`27`	`27`	`var appData = ApplicationData.Current;`
`28`	`28`	`return new ApplicationDataStorageHelper(appData, objectSerializer);`
`@@ -34,7 +34,7 @@ public static ApplicationDataStorageHelper GetCurrent(Toolkit.Helpers.IObjectSer`
`34`	`34`	`/// <param name="user">App data user owner.</param>`
`35`	`35`	`/// <param name="objectSerializer">Serializer for converting stored values. Defaults to <see cref="Toolkit.Helpers.SystemSerializer"/>.</param>`
`36`	`36`	`/// <returns>A new instance of ApplicationDataStorageHelper.</returns>`
`37`		`- public static async Task<ApplicationDataStorageHelper> GetForUserAsync(User user, Toolkit.Helpers.IObjectSerializer objectSerializer = null)`
	`37`	`+ public static async Task<ApplicationDataStorageHelper> GetForUserAsync(User user, Toolkit.Helpers.IObjectSerializer? objectSerializer = null)`
`38`	`38`	`{`
`39`	`39`	`var appData = await ApplicationData.GetForUserAsync(user);`
`40`	`40`	`return new ApplicationDataStorageHelper(appData, objectSerializer);`
`@@ -65,7 +65,7 @@ public static async Task<ApplicationDataStorageHelper> GetForUserAsync(User user`
`65`	`65`	`/// </summary>`
`66`	`66`	`/// <param name="appData">The data store to interact with.</param>`
`67`	`67`	`/// <param name="objectSerializer">Serializer for converting stored values. Defaults to <see cref="Toolkit.Helpers.SystemSerializer"/>.</param>`
`68`		`- public ApplicationDataStorageHelper(ApplicationData appData, Toolkit.Helpers.IObjectSerializer objectSerializer = null)`
	`68`	`+ public ApplicationDataStorageHelper(ApplicationData appData, Toolkit.Helpers.IObjectSerializer? objectSerializer = null)`
`69`	`69`	`{`
`70`	`70`	`AppData = appData ?? throw new ArgumentNullException(nameof(appData));`
`71`	`71`	`Serializer = objectSerializer ?? new Toolkit.Helpers.SystemSerializer();`
`@@ -137,15 +137,35 @@ public void Clear()`
`137`	`137`	`/// <returns>True if a value exists.</returns>`
`138`	`138`	`public bool KeyExists(string compositeKey, string key)`
`139`	`139`	`{`
`140`		`- if (KeyExists(compositeKey))`
	`140`	`+ if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))`
`141`	`141`	`{`
`142`		`- ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];`
`143`		`- if (composite != null)`
	`142`	`+ return composite.ContainsKey(key);`
	`143`	`+ }`
	`144`	`+`
	`145`	`+ return false;`
	`146`	`+ }`
	`147`	`+`
	`148`	`+ /// <summary>`
	`149`	`+ /// Attempts to retrieve a single item by its key in composite.`
	`150`	`+ /// </summary>`
	`151`	`+ /// <typeparam name="T">Type of object retrieved.</typeparam>`
	`152`	`+ /// <param name="compositeKey">Key of the composite (that contains settings).</param>`
	`153`	`+ /// <param name="key">Key of the object.</param>`
	`154`	`+ /// <param name="value">The value of the object retrieved.</param>`
	`155`	`+ /// <returns>The T object.</returns>`
	`156`	`+ public bool TryRead<T>(string compositeKey, string key, out T value)`
	`157`	`+ {`
	`158`	`+ if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))`
	`159`	`+ {`
	`160`	`+ string compositeValue = (string)composite[key];`
	`161`	`+ if (compositeValue != null)`
`144`	`162`	`{`
`145`		`- return composite.ContainsKey(key);`
	`163`	`+ value = Serializer.Deserialize<T>(compositeValue);`
	`164`	`+ return true;`
`146`	`165`	`}`
`147`	`166`	`}`
`148`	`167`
	`168`	`+ value = default;`
`149`	`169`	`return false;`
`150`	`170`	`}`
`151`	`171`
`@@ -159,11 +179,9 @@ public bool KeyExists(string compositeKey, string key)`
`159`	`179`	`/// <returns>The T object.</returns>`
`160`	`180`	`public T Read<T>(string compositeKey, string key, T @default = default)`
`161`	`181`	`{`
`162`		`- ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];`
`163`		`- if (composite != null)`
	`182`	`+ if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))`
`164`	`183`	`{`
`165`		`- string value = (string)composite[key];`
`166`		`- if (value != null)`
	`184`	`+ if (composite.TryGetValue(key, out object valueObj) && valueObj is string value)`
`167`	`185`	`{`
`168`	`186`	`return Serializer.Deserialize<T>(value);`
`169`	`187`	`}`
`@@ -182,10 +200,8 @@ public T Read<T>(string compositeKey, string key, T @default = default)`
`182`	`200`	`/// <param name="values">Objects to save.</param>`
`183`	`201`	`public void Save<T>(string compositeKey, IDictionary<string, T> values)`
`184`	`202`	`{`
`185`		`- if (KeyExists(compositeKey))`
	`203`	`+ if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))`
`186`	`204`	`{`
`187`		`- ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];`
`188`		`-`
`189`	`205`	`foreach (KeyValuePair<string, T> setting in values)`
`190`	`206`	`{`
`191`	`207`	`if (composite.ContainsKey(setting.Key))`
`@@ -200,7 +216,7 @@ public void Save<T>(string compositeKey, IDictionary<string, T> values)`
`200`	`216`	`}`
`201`	`217`	`else`
`202`	`218`	`{`
`203`		`- ApplicationDataCompositeValue composite = new ApplicationDataCompositeValue();`
	`219`	`+ composite = new ApplicationDataCompositeValue();`
`204`	`220`	`foreach (KeyValuePair<string, T> setting in values)`
`205`	`221`	`{`
`206`	`222`	`composite.Add(setting.Key, Serializer.Serialize(setting.Value));`
`@@ -215,20 +231,15 @@ public void Save<T>(string compositeKey, IDictionary<string, T> values)`
`215`	`231`	`/// </summary>`
`216`	`232`	`/// <param name="compositeKey">Key of the composite (that contains settings).</param>`
`217`	`233`	`/// <param name="key">Key of the object.</param>`
`218`		`- /// <exception cref="KeyNotFoundException">Throws when the specified composite/settings key is not found.</exception>`
`219`		`- public void Delete(string compositeKey, string key)`
	`234`	`+ /// <returns>A boolean indicator of success.</returns>`
	`235`	`+ public bool TryDelete(string compositeKey, string key)`
`220`	`236`	`{`
`221`		`- if (!KeyExists(compositeKey))`
	`237`	`+ if (TryRead(compositeKey, out ApplicationDataCompositeValue composite))`
`222`	`238`	`{`
`223`		`- throw new KeyNotFoundException($"Composite key not found: {compositeKey}");`
	`239`	`+ return composite.Remove(key);`
`224`	`240`	`}`
`225`	`241`
`226`		`- ApplicationDataCompositeValue composite = (ApplicationDataCompositeValue)Settings.Values[compositeKey];`
`227`		`-`
`228`		`- if (!composite.Remove(key))`
`229`		`- {`
`230`		`- throw new KeyNotFoundException($"Settings key not found: {key}");`
`231`		`- }`
	`242`	`+ return false;`
`232`	`243`	`}`
`233`	`244`
`234`	`245`	`/// <inheritdoc />`
`@@ -238,7 +249,7 @@ public Task<T> ReadFileAsync<T>(string filePath, T @default = default)`
`238`	`249`	`}`
`239`	`250`
`240`	`251`	`/// <inheritdoc />`
`241`		`- public Task<IEnumerable<(DirectoryItemType, string)>> ReadFolderAsync(string folderPath)`
	`252`	`+ public Task<IEnumerable<(DirectoryItemType ItemType, string Name)>> ReadFolderAsync(string folderPath)`
`242`	`253`	`{`
`243`	`254`	`return ReadFolderAsync(Folder, folderPath);`
`244`	`255`	`}`
`@@ -290,8 +301,8 @@ private async Task<T> ReadFileAsync<T>(StorageFolder folder, string filePath, T`
`290`	`301`	`: item.IsOfType(StorageItemTypes.Folder) ? DirectoryItemType.Folder`
`291`	`302`	`: DirectoryItemType.None;`
`292`	`303`
`293`		`- return new ValueTuple<DirectoryItemType, string>(itemType, item.Name);`
`294`		`- }).ToList();`
	`304`	`+ return (itemType, item.Name);`
	`305`	`+ });`
`295`	`306`	`}`
`296`	`307`
`297`	`308`	`private Task<StorageFile> SaveFileAsync<T>(StorageFolder folder, string filePath, T value)`
Original file line number	Diff line number	Diff line change
`@@ -22,21 +22,18 @@ public static class ISettingsStorageHelperExtensions`
`22`	`22`	`/// <typeparam name="TValue">The type of object value expected.</typeparam>`
`23`	`23`	`/// <param name="storageHelper">The storage helper instance fo read from.</param>`
`24`	`24`	`/// <param name="key">The key of the target object.</param>`
`25`		`- /// <param name="value">The value of the target object, or the fallback value.</param>`
`26`	`25`	`/// <param name="fallback">An alternative value returned if the read fails.</param>`
`27`		`- /// <returns>A boolean indicator of success.</returns>`
`28`		`- public static bool TryGetValueOrDefault<TKey, TValue>(this ISettingsStorageHelper<TKey> storageHelper, TKey key, out TValue? value, TValue? fallback = default)`
	`26`	`+ /// <returns>The value of the target object, or the fallback value.</returns>`
	`27`	`+ public static TValue GetValueOrDefault<TKey, TValue>(this ISettingsStorageHelper<TKey> storageHelper, TKey key, TValue? fallback = default)`
`29`	`28`	`where TKey : notnull`
`30`	`29`	`{`
`31`	`30`	`if (storageHelper.TryRead<TValue>(key, out TValue? storedValue))`
`32`	`31`	`{`
`33`		`- value = storedValue;`
`34`		`- return true;`
	`32`	`+ return storedValue;`
`35`	`33`	`}`
`36`	`34`	`else`
`37`	`35`	`{`
`38`		`- value = fallback;`
`39`		`- return false;`
	`36`	`+ return fallback;`
`40`	`37`	`}`
`41`	`38`	`}`
`42`	`39`
`@@ -58,7 +55,8 @@ public static bool TryGetValueOrDefault<TKey, TValue>(this ISettingsStorageHelpe`
`58`	`55`	`}`
`59`	`56`	`else`
`60`	`57`	`{`
`61`		`- throw new KeyNotFoundException();`
	`58`	`+ ThrowKeyNotFoundException(key);`
	`59`	`+ return default;`
`62`	`60`	`}`
`63`	`61`	`}`
`64`	`62`
`@@ -74,8 +72,13 @@ public static void Delete<TKey>(this ISettingsStorageHelper<TKey> storageHelper,`
`74`	`72`	`{`
`75`	`73`	`if (!storageHelper.TryDelete(key))`
`76`	`74`	`{`
`77`		`- throw new KeyNotFoundException();`
	`75`	`+ ThrowKeyNotFoundException(key);`
`78`	`76`	`}`
`79`	`77`	`}`
	`78`	`+`
	`79`	`+ private static void ThrowKeyNotFoundException<TKey>(TKey key)`
	`80`	`+ {`
	`81`	`+ throw new KeyNotFoundException($"The given key '{key}' was not present");`
	`82`	`+ }`
`80`	`83`	`}`
`81`	`84`	`}`