! B json array now odered when using JsonApprovals

Resolves issue #667

Author: LarsEckart

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

@@ -2,7 +2,6 @@
 
 import com.google.gson.GsonBuilder;
 import org.junit.jupiter.api.Test;
-import org.lambda.functions.Function1;
 
 import java.time.LocalDateTime;
 
@@ -37,4 +36,52 @@ public void setLocalDate(LocalDateTime localDate)
     }
     private LocalDateTime localDate;
   }
+  @Test
+  void verifyJsonReorderWithoutArray()
+  {
+    Approvals.settings().allowMultipleVerifyCallsForThisMethod();
+    String variant1 = """
+        	{
+        		"a" = 1,
+        		"b" = 2
+        	}
+        """;
+    String variant2 = """
+        	{
+        		"b" = 2,
+        		"a" = 1
+        	}
+        """;
+    // It does not matter on which we call the verifyJson
+    JsonApprovals.verifyJson(variant1, true);
+    JsonApprovals.verifyJson(variant2, true);
+  }
+  @Test
+  void verifyJsonReorderWithArray()
+  {
+    Approvals.settings().allowMultipleVerifyCallsForThisMethod();
+    String variant1 = """
+        	{
+        		"array" = [
+        			{
+        				"a" = 1,
+        				"b" = 2
+        			}
+        		]
+        	}
+        """;
+    String variant2 = """
+        	{
+        		"array" = [
+        			{
+        				"b" = 2,
+        				"a" = 1
+        			}
+        		]
+        	}
+        """;
+    // Now both variants should work since objects within arrays get reordered
+    JsonApprovals.verifyJson(variant1, true);
+    JsonApprovals.verifyJson(variant2, true);
+  }
 }

approvaltests-tests/src/test/java/org/approvaltests/JsonApprovalsTest.verifyJsonReorderWithArray.approved.json

@@ -0,0 +1,8 @@
+{
+  "array": [
+    {
+      "a": 1,
+      "b": 2
+    }
+  ]
+}

approvaltests-tests/src/test/java/org/approvaltests/JsonApprovalsTest.verifyJsonReorderWithoutArray.approved.json

@@ -0,0 +1,4 @@
+{
+  "a": 1,
+  "b": 2
+}

approvaltests-tests/src/test/java/org/approvaltests/JsonAprovalsTest.verifyJsonReorderWithArray.approved.json

@@ -0,0 +1,8 @@
+{
+  "array": [
+    {
+      "a": 1,
+      "b": 2
+    }
+  ]
+}

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

@@ -2,6 +2,7 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
@@ -100,13 +101,37 @@ public static JsonObject sortJsonObjectFields(JsonObject jsonObject)
       {
         sortedJsonObject.add(entry.getKey(), sortJsonObjectFields(element.getAsJsonObject()));
       }
+      else if (element.isJsonArray())
+      {
+        sortedJsonObject.add(entry.getKey(), sortJsonArrayFields(element.getAsJsonArray()));
+      }
       else
       {
         sortedJsonObject.add(entry.getKey(), element);
       }
     }
     return sortedJsonObject;
   }
+  public static JsonArray sortJsonArrayFields(JsonArray jsonArray)
+  {
+    JsonArray sortedJsonArray = new JsonArray();
+    for (JsonElement element : jsonArray)
+    {
+      if (element.isJsonObject())
+      {
+        sortedJsonArray.add(sortJsonObjectFields(element.getAsJsonObject()));
+      }
+      else if (element.isJsonArray())
+      {
+        sortedJsonArray.add(sortJsonArrayFields(element.getAsJsonArray()));
+      }
+      else
+      {
+        sortedJsonArray.add(element);
+      }
+    }
+    return sortedJsonArray;
+  }
   public static class InstantAdapter extends TypeAdapter<Instant>
   {
     @Override