Change SnapshotMatcher to save ordered to prevent long VCS diffs

Author: Andre Bonna

README.md

@@ -28,7 +28,7 @@ Add to your pom.xml dependencies section:
 <dependency>
     <groupId>io.github.json-snapshot</groupId>
     <artifactId>json-snapshot</artifactId>
-    <version>1.0.7</version>
+    <version>1.0.8</version>
 </dependency>
 ```
 

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>io.github.json-snapshot</groupId>
     <artifactId>json-snapshot</artifactId>
-    <version>1.0.7</version>
+    <version>1.0.8</version>
     <packaging>jar</packaging>
 
     <name>json-snapshot</name>

src/main/java/io/github/jsonSnapshot/Snapshot.java

@@ -7,7 +7,9 @@
 
 import java.lang.reflect.Method;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
+import java.util.Set;
 
 public class Snapshot {
 
@@ -31,7 +33,7 @@ public class Snapshot {
 
     public void toMatchSnapshot() {
 
-        List<String> rawSnapshots = snapshotFile.getRawSnapshots();
+        Set<String> rawSnapshots = snapshotFile.getRawSnapshots();
 
         String rawSnapshot = getRawSnapshot(rawSnapshots);
 
@@ -59,7 +61,7 @@ private SnapshotMatchException generateDiffError(String rawSnapshot, String curr
         return new SnapshotMatchException(error);
     }
 
-    private String getRawSnapshot(List<String> rawSnapshots) {
+    private String getRawSnapshot(Collection<String> rawSnapshots) {
         for (String rawSnapshot : rawSnapshots) {
 
             if (rawSnapshot.contains(getSnapshotName())) {

src/main/java/io/github/jsonSnapshot/SnapshotFile.java

@@ -6,6 +6,9 @@
 import java.io.*;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Set;
+import java.util.TreeSet;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -17,7 +20,7 @@ public class SnapshotFile {
     private String fileName;
 
     @Getter
-    private List<String> rawSnapshots;
+    private Set<String> rawSnapshots;
 
     SnapshotFile(String fileName) throws IOException {
 
@@ -35,14 +38,15 @@ public class SnapshotFile {
 
             String fileText = fileContent.toString();
             if (StringUtils.isNotBlank(fileText)) {
-                rawSnapshots = Stream.of(fileContent.toString().split(SPLIT_STRING)).collect(Collectors.toList());
+                rawSnapshots = Stream.of(fileContent.toString().split(SPLIT_STRING)).map(String::trim).collect(Collectors.toCollection(
+                        TreeSet::new));
             }
             else {
-                rawSnapshots = new ArrayList<>();
+                rawSnapshots = new TreeSet<>();
             }
         } catch (IOException e) {
             createFile(this.fileName);
-            rawSnapshots = new ArrayList<>();
+            rawSnapshots = new TreeSet<>();
         }
     }
 

src/main/java/io/github/jsonSnapshot/SnapshotMatcher.java

@@ -17,6 +17,7 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import static org.mockito.Mockito.atLeastOnce;
@@ -41,7 +42,7 @@ public static void start() {
     }
 
     public static void validateSnapshots() {
-        List<String> rawSnapshots = snapshotFile.getRawSnapshots();
+        Set<String> rawSnapshots = snapshotFile.getRawSnapshots();
         List<String> snapshotNames = calledSnapshots.stream().map(Snapshot::getSnapshotName).collect(Collectors.toList());
         List<String> unusedRawSnapshots = new ArrayList<>();
 

src/test/java/io/github/jsonSnapshot/SnapshotIntegrationTest.snap

@@ -1,35 +1,35 @@
-io.github.jsonSnapshot.SnapshotIntegrationTest.shouldThrowSnapshotMatchException=[
+io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotFour=[
   {
-    "id": "anyId5",
-    "value": 5,
-    "name": "anyName5"
+    "id": "anyId4",
+    "value": 4,
+    "name": "any\n\n\nName4"
   }
 ]
 
 
-io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotThree=[
+io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotInsidePrivateMethod=[
   {
-    "id": "anyId3",
-    "value": 3,
-    "name": "anyName3"
+    "id": "anyPrivate",
+    "value": 5,
+    "name": "anyPrivate"
   }
 ]
 
 
-io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotFour=[
+io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotOne=[
   {
-    "id": "anyId4",
-    "value": 4,
-    "name": "any\n\n\nName4"
+    "id": "anyId1",
+    "value": 1,
+    "name": "anyName1"
   }
 ]
 
 
-io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotOne=[
+io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotThree=[
   {
-    "id": "anyId1",
-    "value": 1,
-    "name": "anyName1"
+    "id": "anyId3",
+    "value": 3,
+    "name": "anyName3"
   }
 ]
 
@@ -43,11 +43,10 @@ io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotTwo=[
 ]
 
 
-
-io.github.jsonSnapshot.SnapshotIntegrationTest.shouldMatchSnapshotInsidePrivateMethod=[
+io.github.jsonSnapshot.SnapshotIntegrationTest.shouldThrowSnapshotMatchException=[
   {
-    "id": "anyPrivate",
+    "id": "anyId5",
     "value": 5,
-    "name": "anyPrivate"
+    "name": "anyName5"
   }
 ]

src/test/java/io/github/jsonSnapshot/SnapshotTest.java

@@ -9,6 +9,7 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Paths;
+import java.util.TreeSet;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -47,7 +48,7 @@ public void shouldGetSnapshotNameSuccessfully() {
     @Test
     public void shouldMatchSnapshotSuccessfully() {
         snapshot.toMatchSnapshot();
-        assertThat(snapshotFile.getRawSnapshots()).isEqualTo(Stream.of(SNAPSHOT).collect(Collectors.toList()));
+        assertThat(snapshotFile.getRawSnapshots()).isEqualTo(Stream.of(SNAPSHOT).collect(Collectors.toCollection(TreeSet::new)));
     }
 
     @Test(expected = SnapshotMatchException.class)

src/test/java/io/github/jsonSnapshot/SnapshotUtilsTest.snap

@@ -1,3 +1,26 @@
+io.github.jsonSnapshot.SnapshotUtilsTest.shouldExtractArgsFromFakeMethod=[
+  {
+    "FakeObject.fakeMethod": [
+      {
+        "arg0": "test1",
+        "arg1": 1,
+        "arg2": [
+          "listTest1"
+        ]
+      },
+      {
+        "arg0": "test2",
+        "arg1": 2,
+        "arg2": [
+          "listTest1",
+          "listTest2"
+        ]
+      }
+    ]
+  }
+]
+
+
 io.github.jsonSnapshot.SnapshotUtilsTest.shouldExtractArgsFromFakeMethodWithComplexFakeObject=[
   {
     "FakeObject.fakeMethodWithComplexObject": [
@@ -41,27 +64,4 @@ io.github.jsonSnapshot.SnapshotUtilsTest.shouldExtractArgsFromFakeMethodWithComp
       }
     ]
   }
-]
-
-
-io.github.jsonSnapshot.SnapshotUtilsTest.shouldExtractArgsFromFakeMethod=[
-  {
-    "FakeObject.fakeMethod": [
-      {
-        "arg0": "test1",
-        "arg1": 1,
-        "arg2": [
-          "listTest1"
-        ]
-      },
-      {
-        "arg0": "test2",
-        "arg1": 2,
-        "arg2": [
-          "listTest1",
-          "listTest2"
-        ]
-      }
-    ]
-  }
 ]