Add support for json keys that include a colon character

sleeuwen · sleeuwen · commit ff4e7af806cc · 2022-02-11T20:18:29.000+01:00
diff --git a/dotnet-json.Tests/Commands/MergeCommandTests.cs b/dotnet-json.Tests/Commands/MergeCommandTests.cs
@@ -55,6 +55,132 @@ await File.WriteAllTextAsync(Path.Join(_tmpDir, "a.json"), @"{
 }");
         }
 
+        [Fact]
+        public async Task CorrectlyMergesKeysWithColons()
+        {
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "a.json"), @"{
+    ""Parent:Child"": ""value""
+}");
+
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "b.json"), @"{
+    ""Parent:Child"": ""other""
+}");
+
+            var (exitCode, console) = await RunCommand(
+                Path.Join(_tmpDir, "a.json"),
+                Path.Join(_tmpDir, "b.json"));
+
+            exitCode.Should().Be(0);
+
+            var content = await File.ReadAllTextAsync(Path.Join(_tmpDir, "a.json"));
+            content.Should().Be(@"{
+  ""Parent:Child"": ""other""
+}");
+        }
+
+        [Fact]
+        public async Task KeepsTheFormattingPerKey()
+        {
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "a.json"), @"{
+    ""Parent:Child"": ""value""
+}");
+
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "b.json"), @"{
+    ""Parent"": {
+        ""Child"": ""other""
+    }
+}");
+
+            var (exitCode, console) = await RunCommand(
+                Path.Join(_tmpDir, "a.json"),
+                Path.Join(_tmpDir, "b.json"));
+
+            exitCode.Should().Be(0);
+
+            var content = await File.ReadAllTextAsync(Path.Join(_tmpDir, "a.json"));
+            content.Should().Be(@"{
+  ""Parent:Child"": ""other""
+}");
+        }
+
+        [Fact]
+        public async Task AddsKeyInObject()
+        {
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "a.json"), @"{
+    ""Parent"": {
+        ""Other"": ""value""
+    },
+    ""Parent:Another"": ""value""
+}");
+
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "b.json"), @"{
+    ""Parent"": {
+        ""Child"": ""other""
+    }
+}");
+
+            var (exitCode, console) = await RunCommand(
+                Path.Join(_tmpDir, "a.json"),
+                Path.Join(_tmpDir, "b.json"));
+
+            exitCode.Should().Be(0);
+
+            var content = await File.ReadAllTextAsync(Path.Join(_tmpDir, "a.json"));
+            content.Should().Be(@"{
+  ""Parent"": {
+    ""Other"": ""value"",
+    ""Child"": ""other""
+  },
+  ""Parent:Another"": ""value""
+}");
+        }
+
+        [Fact]
+        public async Task AddsKeyInMostSpecificObject()
+        {
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "a.json"), @"{
+    ""Parent:Nested"": {
+        ""Key"": ""value""
+    },
+    ""Parent"": {
+        ""Nested"": {
+            ""Another"": ""value""
+        }
+    }
+}");
+
+            await File.WriteAllTextAsync(Path.Join(_tmpDir, "b.json"), @"{
+    ""Parent"": {
+        ""Nested"": {
+            ""Child"": ""other""
+        },
+        ""Another:Child"": ""value""
+    }
+}");
+
+            var (exitCode, console) = await RunCommand(
+                Path.Join(_tmpDir, "a.json"),
+                Path.Join(_tmpDir, "b.json"));
+
+            exitCode.Should().Be(0);
+
+            var content = await File.ReadAllTextAsync(Path.Join(_tmpDir, "a.json"));
+            content.Should().Be(@"{
+  ""Parent:Nested"": {
+    ""Key"": ""value"",
+    ""Child"": ""other""
+  },
+  ""Parent"": {
+    ""Nested"": {
+      ""Another"": ""value""
+    },
+    ""Another"": {
+      ""Child"": ""value""
+    }
+  }
+}");
+        }
+
         private async Task<(int exitCode, IConsole console)> RunCommand(params string[] args)
         {
             var command = new MergeCommand();
diff --git a/dotnet-json/Core/JsonDocument.cs b/dotnet-json/Core/JsonDocument.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Text;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
@@ -53,23 +54,34 @@ public void Remove(string key)
                 jValue?.Remove();
         }
 
-        internal static IEnumerable<KeyValuePair<string, JValue>> AllValues(JToken token, string prefix = "")
+        internal static IEnumerable<KeyValuePair<string, JValue>> AllValues(JToken token)
         {
+            return AllTokens(token)
+                .Where(kv => kv.Value is JValue)
+                .Select(kv => KeyValuePair.Create(kv.Key, (kv.Value as JValue)!));
+        }
+
+        internal static IEnumerable<KeyValuePair<string, JToken>> AllTokens(JToken token, string prefix = "")
+        {
+            yield return KeyValuePair.Create(prefix, token);
+
             switch (token)
             {
-                case JValue jValue:
-                    yield return KeyValuePair.Create(prefix, jValue);
+                case JValue:
                     break;
 
                 case JProperty jProperty:
-                    foreach (var kv in AllValues(jProperty.Value, CreatePrefix(prefix, jProperty.Name)))
+                    foreach (var kv in AllTokens(jProperty.Value, CreatePrefix(prefix, jProperty.Name)))
                         yield return kv;
                     break;
 
                 case JArray jArray:
                     for (var i = 0; i < jArray.Count; i++)
-                        foreach (var kv in AllValues(jArray[i], CreatePrefix(prefix, i.ToString())))
+                    {
+                        foreach (var kv in AllTokens(jArray[i], CreatePrefix(prefix, i.ToString())))
                             yield return kv;
+                    }
+
                     break;
 
                 case JObject jObject:
@@ -78,7 +90,7 @@ internal static IEnumerable<KeyValuePair<string, JValue>> AllValues(JToken token
                         if (value == null)
                             continue;
 
-                        foreach (var kv in AllValues(value, CreatePrefix(prefix, key)))
+                        foreach (var kv in AllTokens(value, CreatePrefix(prefix, key)))
                             yield return kv;
                     }
 
@@ -101,62 +113,69 @@ internal static IEnumerable<KeyValuePair<string, JValue>> AllValues(JToken token
 
         internal JToken? FindToken(string key, bool createNew = false)
         {
-            var subKeys = string.IsNullOrWhiteSpace(key) ? new string[0] : key.Split(':');
+            var parentKey = "";
+            var bestParent = (JToken?)(_json as JObject) ?? (_json as JArray);
 
-            var current = _json;
-            for (var i = 0; i < subKeys.Length; i++)
+            foreach (var kv in AllTokens(_json))
             {
-                var subkey = subKeys[i];
-                var isLastKey = i == subKeys.Length - 1;
-
-                if (current is JValue && !createNew)
-                    return null;
+                if (kv.Key == key)
+                    return kv.Value;
 
-                if (int.TryParse(subkey, out _) && current is JObject && ((JObject)current).Count == 0 && current.Parent != null)
+                if (key.StartsWith(kv.Key) && kv.Value is JObject jObject && kv.Key.Length > parentKey.Length)
                 {
-                    if (current.Parent is JProperty jProperty)
-                        jProperty.Value = current = new JArray();
-                    else if (current.Parent is JArray parentArray)
-                        parentArray[parentArray.IndexOf(current)] = current = new JArray();
+                    parentKey = kv.Key;
+                    bestParent = jObject;
                 }
+            }
 
-                if (current is JArray jArray)
-                {
-                    current = FindTokenInArray(jArray, subkey, createNew, isLastKey);
-                    continue;
-                }
+            if (bestParent == null || !createNew)
+                return null;
 
-                if (current is JValue)
-                    return null;
+            var restKeys = key.Substring(parentKey.Length).TrimStart(':').Split(':');
+            for (var i = 0; i < restKeys.Length - 1; i++)
+            {
+                JToken newValue;
 
-                var jObject = (JObject)current!; // At this point current can only be a JObject.
-                current = jObject[subkey];
+                if (restKeys.Length > i + 1 && int.TryParse(restKeys[i + 1], out _))
+                    newValue = new JArray();
+                else
+                    newValue = new JObject();
 
-                if (createNew && (current is null || (current is JValue && !isLastKey)))
+                if (bestParent is JArray jArray)
                 {
-                    current = jObject[subkey] = isLastKey ? (JToken)new JValue((object?)null) : new JObject();
+                    if (!int.TryParse(restKeys[i], out var idx))
+                        throw new Exception($"Cannot index into array with key '{restKeys[^1]}'");
+
+                    while (jArray.Count <= idx)
+                        jArray.Add(new JValue((object?)null));
+                    jArray[idx] = newValue;
+                }
+                else
+                {
+                    bestParent[restKeys[i]] = newValue;
                 }
+
+                bestParent = newValue;
             }
 
-            return current; // If current is no JValue here, throw an exception
-        }
+            var value = (JToken)new JValue((object?)null);
 
-        internal static JToken FindTokenInArray(JArray jArray, string subkey, bool createNew, bool isLastKey)
-        {
-            if (!int.TryParse(subkey, out var index))
-                throw new Exception($"Cannot index into array at {GetPosition(jArray)} with index {subkey}.");
+            if (bestParent is JArray array)
+            {
+                if (!int.TryParse(restKeys[^1], out var idx))
+                    throw new Exception($"Cannot index into array with key '{restKeys[^1]}'");
 
-            if (createNew && index >= jArray.Count)
+                while (array.Count <= idx)
+                    array.Add(new JValue((object?)null));
+                array[idx] = value;
+                value = array[idx];
+            }
+            else
             {
-                for (var j = jArray.Count; j < index; j++)
-                    jArray.Add(new JValue((object?)null));
-                jArray.Add(isLastKey ? (JToken)new JValue((object?)null) : new JObject());
+                bestParent[restKeys[^1]] = value;
             }
 
-            if (index >= jArray.Count)
-                throw new IndexOutOfRangeException($"Index {index} does not exist for array at {GetPosition(jArray)}");
-
-            return jArray[index];
+            return value;
         }
 
         internal void SetValue(string key, object? value)
@@ -168,8 +187,5 @@ internal void SetValue(string key, object? value)
 
             jValue.Value = value;
         }
-
-        internal static string GetPosition(JToken token)
-            => token.Path.Replace(".", ":").Replace("[", ".").Replace("]", "");
     }
 }
diff --git a/dotnet-json/dotnet-json.csproj b/dotnet-json/dotnet-json.csproj
@@ -14,7 +14,7 @@
     <ToolCommandName>dotnet-json</ToolCommandName>
     <PackageOutputPath>./nupkg</PackageOutputPath>
 
-    <Version>1.0.0</Version>
+    <Version>1.0.1</Version>
     <PackageId>dotnet-json</PackageId>
     <Authors>sleeuwen</Authors>
     <RepositoryUrl>https://github.com/sleeuwen/dotnet-json</RepositoryUrl>
@@ -31,9 +31,9 @@
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta2.21617.1" />
   </ItemGroup>
-  
+
   <ItemGroup>
-    <None Include="..\README.md" Pack="true" PackagePath="\"/>
+    <None Include="..\README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
 </Project>
