! F JsonUtils.reorderFields

Author: ScottBob

approvaltests-tests/src/test/java/org/approvaltests/JsonFormattingTest.java

@@ -1,6 +1,7 @@
 package org.approvaltests;
 
 import com.google.gson.GsonBuilder;
+import com.spun.util.JsonUtils;
 import org.junit.jupiter.api.Test;
 
 import java.time.Instant;
@@ -57,4 +58,22 @@ private static class DateStuff
   {
     public Instant instant;
   }
+  @Test
+  public void testJsonFieldOrdering()
+  {
+    Approvals.settings().allowMultipleVerifyCallsForThisMethod();
+    String json1 = "{\"infos\":{\"address\":\"my address\",\"phone\":\"my phone\"},\"insurance\":{\"forks\":[14,53,123],\"prices\":[5,8,\"3%\"]}}";
+    String json2 = "{\"insurance\":{\"forks\":[14,53,123],\"prices\":[5,8,\"3%\"]},\"infos\":{\"phone\":\"my phone\",\"address\":\"my address\"}}";
+//    JsonApprovals.verifyJson(json1);
+//    JsonApprovals.verifyJson(json2);
+//
+//    JsonApprovals.verifyOrderedJson(json1);
+//    JsonApprovals.verifyOrderedJson(json2);
+//
+//    JsonApprovals.verifyJson(json1, true);
+//    JsonApprovals.verifyJson(json2, true);
+
+    JsonApprovals.verifyJson(JsonUtils.reorderFields(json1));
+    JsonApprovals.verifyJson(JsonUtils.reorderFields(json2));
+  }
 }

approvaltests-tests/src/test/java/org/approvaltests/JsonFormattingTest.testJsonFieldOrdering.approved.json

@@ -0,0 +1,18 @@
+{
+  "infos": {
+    "address": "my address",
+    "phone": "my phone"
+  },
+  "insurance": {
+    "forks": [
+      14,
+      53,
+      123
+    ],
+    "prices": [
+      5,
+      8,
+      "3%"
+    ]
+  }
+}

approvaltests-util/src/main/java/com/spun/util/JsonUtils.java

@@ -6,8 +6,12 @@
 import org.lambda.functions.Function1;
 
 import java.io.IOException;
+import java.lang.reflect.Field;
 import java.time.Instant;
 import java.time.LocalDateTime;
+import java.util.Map;
+import java.util.TreeMap;
+import java.util.stream.Collectors;
 
 public class JsonUtils
 {
@@ -61,6 +65,34 @@ private static GsonBuilder addHandlingForDateObjects(GsonBuilder builder)
     builder = builder.registerTypeAdapter(LocalDateTime.class, new LocalDateTimeAdapter());
     return builder;
   }
+
+  public static String reorderFields(String json) {
+    JsonObject sortedJsonObject = sortJsonObject(json);
+    return asJson(sortedJsonObject);
+  }
+
+  public static JsonObject sortJsonObject(String json) {
+    JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
+    return sortJsonObjectFields(jsonObject);
+  }
+
+  public static JsonObject sortJsonObjectFields(JsonObject jsonObject) {
+    JsonObject sortedJsonObject = new JsonObject();
+    Map<String, JsonElement> sortedFirstLevelFields = jsonObject.entrySet().stream()
+            .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> b, TreeMap::new));
+
+    for (Map.Entry<String, JsonElement> entry : sortedFirstLevelFields.entrySet()) {
+      JsonElement element = entry.getValue();
+      if (element.isJsonObject()) {
+        sortedJsonObject.add(entry.getKey(), sortJsonObjectFields(element.getAsJsonObject()));
+      } else {
+        sortedJsonObject.add(entry.getKey(), element);
+      }
+    }
+
+    return sortedJsonObject;
+  }
+
   public static class InstantAdapter extends TypeAdapter<Instant>
   {
     @Override