refactor RichMultiString to not extend Dictionary, rework proxies to match

Author: hahn-kev

backend/FwLite/FwDataMiniLcmBridge/Api/FwDataMiniLcmApi.cs

@@ -655,11 +655,7 @@ private ExampleSentence FromLexExampleSentence(Guid senseGuid, ILexExampleSenten
             Id = sentence.Guid,
             SenseId = senseGuid,
             Sentence = FromLcmMultiString(sentence.Example),
-            Reference =
-                sentence.Reference.Length == 0
-                    ? null
-                    : RichTextMapping.FromTsString(sentence.Reference,
-                        h => h is null ? null : (WritingSystemId?)GetWritingSystemId(h.Value)),
+            Reference = ToRichString(sentence.Reference),
             Translation = translation is null ? new() : FromLcmMultiString(translation),
         };
     }
@@ -684,16 +680,25 @@ private RichMultiString FromLcmMultiString(IMultiString multiString)
         {
             var tsString = multiString.GetStringFromIndex(i, out var ws);
 
-            result.Add(GetWritingSystemId(ws), RichTextMapping.FromTsString(tsString, h =>
-            {
-                if (h is null) return null;
-                return GetWritingSystemId(h.Value);
-            }));
+            var richString = ToRichString(tsString);
+            if (richString is null) continue;
+            result.Add(GetWritingSystemId(ws), richString);
         }
 
         return result;
     }
 
+    internal RichString? ToRichString(ITsString? tsString)
+    {
+        if (tsString is null or {Length: 0}) return null;
+        return RichTextMapping.FromTsString(tsString,
+            h =>
+            {
+                if (h is null) return null;
+                return GetWritingSystemId(h.Value);
+            });
+    }
+
     public IAsyncEnumerable<Entry> GetEntries(QueryOptions? options = null)
     {
         return GetEntries(null, options);

backend/FwLite/FwDataMiniLcmBridge/Api/UpdateProxy/UpdateDictionaryProxy.cs

@@ -1,4 +1,5 @@
 using System.Collections;
+using System.Diagnostics.CodeAnalysis;
 using MiniLcm.Models;
 using SIL.LCModel.Core.KernelInterfaces;
 using SIL.LCModel.Core.Text;
@@ -19,12 +20,6 @@ public void Add(WritingSystemId key, string value)
         multiString.set_String(writingSystemHandle, TsStringUtils.MakeString(value, writingSystemHandle));
     }
 
-    public void Add(WritingSystemId key, RichString value)
-    {
-        var writingSystemHandle = lexboxLcmApi.GetWritingSystemHandle(key);
-        multiString.set_String(writingSystemHandle, RichTextMapping.ToTsString(value, ws => lexboxLcmApi.GetWritingSystemHandle(ws)));
-    }
-
     public bool ContainsKey(WritingSystemId key)
     {
         if (multiString.StringCount == 0) return false;
@@ -52,13 +47,9 @@ public void Add(object key, object? value)
         {
             Add(keyWs, valueStr);
         }
-        else if (value is RichString valueRich)
-        {
-            Add(keyWs, valueRich);
-        }
         else
         {
-            throw new ArgumentException("unable to convert value to string", nameof(value));
+            throw new ArgumentException($"unable to convert value {value} to string", nameof(value));
         }
     }
 
@@ -185,9 +176,15 @@ public void CopyTo(Array array, int index)
     public bool IsReadOnly => false;
 
 
-    public bool TryGetValue(WritingSystemId key, out string value)
+    public bool TryGetValue(WritingSystemId key, [MaybeNullWhen(false)] out string value)
     {
-        throw new NotSupportedException();
+        if (!ContainsKey(key))
+        {
+            value = null;
+            return false;
+        }
+        value = this[key];
+        return true;
     }
 
     public ICollection<WritingSystemId> Keys => [];
@@ -198,3 +195,194 @@ public bool TryGetValue(WritingSystemId key, out string value)
 
     public ICollection<string> Values => [];
 }
+
+public class UpdateRichMultiStringDictionaryProxy(ITsMultiString multiString, FwDataMiniLcmApi lexboxLcmApi)
+    : IDictionary<WritingSystemId, RichString>, IDictionary
+{
+    public void Add(KeyValuePair<WritingSystemId, RichString> item)
+    {
+        Add(item.Key, item.Value);
+    }
+
+    public void Add(WritingSystemId key, RichString value)
+    {
+        var writingSystemHandle = lexboxLcmApi.GetWritingSystemHandle(key);
+        multiString.set_String(writingSystemHandle,
+            RichTextMapping.ToTsString(value, ws => lexboxLcmApi.GetWritingSystemHandle(ws)));
+    }
+
+    public bool ContainsKey(WritingSystemId key)
+    {
+        if (multiString.StringCount == 0) return false;
+        var tsString = multiString.get_String(lexboxLcmApi.GetWritingSystemHandle(key));
+        return tsString.Length > 0;
+    }
+
+    public void Add(object key, object? value)
+    {
+        WritingSystemId keyWs;
+        if (key is WritingSystemId typed)
+        {
+            keyWs = typed;
+        }
+        else if (key is string keyStr)
+        {
+            keyWs = keyStr;
+        }
+        else
+        {
+            throw new ArgumentException("unable to convert key to writing system id", nameof(key));
+        }
+
+        if (value is RichString valueRich)
+        {
+            Add(keyWs, valueRich);
+        }
+        else
+        {
+            throw new ArgumentException("unable to convert value to string", nameof(value));
+        }
+    }
+
+    public bool Contains(object key)
+    {
+        return ContainsKey(key as WritingSystemId? ?? key as string ??
+            throw new ArgumentException("unable to convert key to writing system id", nameof(key)));
+    }
+
+
+    public RichString this[WritingSystemId key]
+    {
+        get
+        {
+            var tsString = multiString.get_String(lexboxLcmApi.GetWritingSystemHandle(key));
+            return lexboxLcmApi.ToRichString(tsString) ?? throw new ArgumentException($"unable to find rich string for writing system {key}");
+        }
+        set
+        {
+            var writingSystemHandle = lexboxLcmApi.GetWritingSystemHandle(key);
+            multiString.set_String(writingSystemHandle, RichTextMapping.ToTsString(value, id => lexboxLcmApi.GetWritingSystemHandle(id)));
+        }
+    }
+
+    public object? this[object key]
+    {
+        get =>
+            key switch
+            {
+                WritingSystemId keyWs => this[keyWs],
+                string keyStr => this[keyStr],
+                _ => throw new ArgumentException("unable to convert key to writing system id", nameof(key))
+            };
+        set
+        {
+            var valStr = value as RichString ??
+                         throw new ArgumentException("unable to convert value to string", nameof(value));
+            if (key is WritingSystemId keyWs)
+            {
+                this[keyWs] = valStr;
+            }
+            else if (key is string keyStr)
+            {
+                this[keyStr] = valStr;
+            }
+            else
+            {
+                throw new ArgumentException("unable to convert key to writing system id", nameof(key));
+            }
+        }
+    }
+
+    IDictionaryEnumerator IDictionary.GetEnumerator()
+    {
+        throw new NotSupportedException();
+    }
+
+    public void Remove(object key)
+    {
+        if (key is WritingSystemId keyWs)
+        {
+            Remove(keyWs);
+        }
+        else if (key is string keyStr)
+        {
+            Remove(keyStr);
+        }
+        else
+        {
+            throw new ArgumentException($"unable to convert key {key} to writing system id", nameof(key));
+        }
+    }
+
+    public bool Remove(WritingSystemId key)
+    {
+        var containedKey = ContainsKey(key);
+        var writingSystemHandle = lexboxLcmApi.GetWritingSystemHandle(key);
+        multiString.set_String(writingSystemHandle, null);
+        return containedKey;
+    }
+
+    public bool IsFixedSize => false;
+
+    public IEnumerator<KeyValuePair<WritingSystemId, RichString>> GetEnumerator()
+    {
+        throw new NotSupportedException();
+    }
+
+    IEnumerator IEnumerable.GetEnumerator()
+    {
+        return GetEnumerator();
+    }
+
+    public void Clear()
+    {
+        throw new NotSupportedException();
+    }
+
+    public bool Contains(KeyValuePair<WritingSystemId, RichString> item)
+    {
+        throw new NotSupportedException();
+    }
+
+    public void CopyTo(KeyValuePair<WritingSystemId, RichString>[] array, int arrayIndex)
+    {
+        throw new NotSupportedException();
+    }
+
+    public bool Remove(KeyValuePair<WritingSystemId, RichString> item)
+    {
+        throw new NotSupportedException();
+    }
+
+    public void CopyTo(Array array, int index)
+    {
+    }
+
+    public int Count => throw new NotSupportedException();
+
+    public bool IsSynchronized => false;
+
+    public object SyncRoot => this;
+
+    public bool IsReadOnly => false;
+
+
+    public bool TryGetValue(WritingSystemId key, [MaybeNullWhen(false)] out RichString value)
+    {
+        if (!ContainsKey(key))
+        {
+            value = null;
+            return false;
+        }
+        value = this[key];
+        return true;
+    }
+
+    public ICollection<WritingSystemId> Keys => [];
+
+    ICollection IDictionary.Values => Array.Empty<object>();
+
+    ICollection IDictionary.Keys => Array.Empty<object>();
+
+    public ICollection<RichString> Values => [];
+}

backend/FwLite/FwDataMiniLcmBridge/Api/UpdateProxy/UpdateEntryProxy.cs

@@ -82,23 +82,7 @@ public override MultiString Copy()
 }
 
 
-public class UpdateRichMultiStringProxy(ITsMultiString multiString, FwDataMiniLcmApi lexboxLcmApi) : RichMultiString, IDictionary
+public class UpdateRichMultiStringProxy(ITsMultiString multiString, FwDataMiniLcmApi lexboxLcmApi) : RichMultiString(new
+    UpdateRichMultiStringDictionaryProxy(multiString, lexboxLcmApi))
 {
-    private UpdateDictionaryProxy proxy = new(multiString, lexboxLcmApi);
-
-    void IDictionary.Add(object key, object? value)
-    {
-        ((IDictionary)proxy).Add(key, value);
-    }
-
-    void IDictionary.Remove(object key)
-    {
-        ((IDictionary)proxy).Remove(key);
-    }
-
-    object? IDictionary.this[object key]
-    {
-        get => ((IDictionary)proxy)[key];
-        set => ((IDictionary)proxy)[key] = value;
-    }
 }

backend/FwLite/MiniLcm.Tests/RichMultiStringTests.cs

@@ -208,7 +208,7 @@ public void JsonPatchCanUpdateRichMultiString()
         patch.Replace(ms => ms["en"], new RichString("updated"));
         patch.ApplyTo(ms);
         ms.Should().ContainKey("en");
-        ms["en"].Should().BeEquivalentTo(new RichString("updated"));
+        ms["en"].Should().BeEquivalentTo(new RichString("updated", "en"));
     }
 
     //this test emulates any existing data that was stored as a string
@@ -220,7 +220,7 @@ public void JsonPatchCanUpdateRichMultiStringWhenValueIsString()
         patch.Operations.Add(new Operation<RichMultiString>("replace", "/en", null, "updated"));
         patch.ApplyTo(ms);
         ms.Should().ContainKey("en");
-        ms["en"].Should().BeEquivalentTo(new RichString("updated"));
+        ms["en"].Should().BeEquivalentTo(new RichString("updated", "en"));
     }
 
     [Fact]