#none: Code formatting via spotless (#119)

Author: jackmatt2

build.gradle

@@ -2,10 +2,10 @@ plugins {
     id 'net.researchgate.release' version '2.6.0' apply false
     id 'com.github.johnrengelman.shadow' version '5.2.0' apply false
     id 'io.codearte.nexus-staging' version '0.22.0'
+    id "com.diffplug.spotless" version "6.11.0" apply false
 }
 
 subprojects { subproject ->
-
     // FIXME this plugin is currently not working for multi-module projects even when defined at the top level only
     // Will need to release and TAG manually for now
     subproject.apply plugin: 'net.researchgate.release'
@@ -38,7 +38,7 @@ subprojects { subproject ->
         compileOnly 'org.slf4j:slf4j-api:2.0.0-alpha0'
     }
 
-    // Adds verbose logging for TravisCI
+    // Add verbose logging for Github Actions
     test {
         testLogging {
             events "passed", "skipped", "failed"

gradle/spotless-groovy.gradle

@@ -0,0 +1,10 @@
+apply plugin: 'com.diffplug.spotless'
+
+// Code formatting
+spotless {
+    groovy {
+        importOrder()
+        excludeJava()
+        greclipse()
+    }
+}

gradle/spotless.gradle

@@ -0,0 +1,11 @@
+apply plugin: 'com.diffplug.spotless'
+
+// Code formatting
+spotless {
+    java {
+        importOrder()
+        removeUnusedImports()
+        googleJavaFormat()
+        formatAnnotations()
+    }
+}

java-snapshot-testing-core/build.gradle

@@ -1,4 +1,5 @@
 apply from: "../gradle/publishing.gradle"
+apply from: "../gradle/spotless.gradle"
 
 dependencies {
 

java-snapshot-testing-core/src/main/java/au/com/origin/snapshots/Expect.java

@@ -3,14 +3,13 @@
 import au.com.origin.snapshots.comparators.SnapshotComparator;
 import au.com.origin.snapshots.reporters.SnapshotReporter;
 import au.com.origin.snapshots.serializers.SnapshotSerializer;
-import lombok.RequiredArgsConstructor;
-import lombok.SneakyThrows;
-
 import java.lang.reflect.Method;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import lombok.RequiredArgsConstructor;
+import lombok.SneakyThrows;
 
 @RequiredArgsConstructor
 public class Expect {
@@ -31,9 +30,9 @@ public static Expect of(SnapshotVerifier snapshotVerifier, Method method) {
   /**
    * Make an assertion on the given input parameters against what already exists
    *
-   * If you were previously using varargs and see an error - you can fix the error using
-   * "toMatchSnapshotLegacy", however, a better approach is to use the ".scenario()"
-   * feature as future versions of this library will most likely remove the legacy implementation completely.
+   * <p>If you were previously using varargs and see an error - you can fix the error using
+   * "toMatchSnapshotLegacy", however, a better approach is to use the ".scenario()" feature as
+   * future versions of this library will most likely remove the legacy implementation completely.
    *
    * @param object snapshot object
    */
@@ -58,9 +57,9 @@ public void toMatchSnapshot(Object object) {
 
   /**
    * Normally a snapshot can be applied only once to a test method.
-   * <p>
-   * For Parameterized tests where the same method is executed multiple times you can supply
-   * the scenario() to overcome this restriction.  Ensure each scenario is unique.
+   *
+   * <p>For Parameterized tests where the same method is executed multiple times you can supply the
+   * scenario() to overcome this restriction. Ensure each scenario is unique.
    *
    * @param scenario - unique scenario description
    * @return Snapshot
@@ -115,8 +114,8 @@ public Expect comparator(String name) {
   }
 
   /**
-   * Apply a list of custom reporters for this snapshot
-   * This will replace the default reporters defined in the config
+   * Apply a list of custom reporters for this snapshot This will replace the default reporters
+   * defined in the config
    *
    * @param reporters your custom reporters
    * @return Snapshot
@@ -127,8 +126,8 @@ public Expect reporters(SnapshotReporter... reporters) {
   }
 
   /**
-   * Apply a list of custom reporters for this snapshot
-   * This will replace the default reporters defined in the config
+   * Apply a list of custom reporters for this snapshot This will replace the default reporters
+   * defined in the config
    *
    * @param name the {name} attribute reporters.{name} from snapshot.properties
    * @return Snapshot
@@ -144,8 +143,7 @@ public Expect reporters(String name) {
    * @param serializer your custom serializer
    * @return this
    * @see au.com.origin.snapshots.serializers.SnapshotSerializer
-   * <p>
-   * Example implementations
+   *     <p>Example implementations
    * @see au.com.origin.snapshots.serializers.ToStringSnapshotSerializer
    * @see au.com.origin.snapshots.serializers.Base64SnapshotSerializer
    */
@@ -158,8 +156,8 @@ public Expect serializer(Class<? extends SnapshotSerializer> serializer) {
   /**
    * Add anything you like to the snapshot header.
    *
-   * These custom headers can be used in serializers, comparators or reporters to change
-   * how they behave.
+   * <p>These custom headers can be used in serializers, comparators or reporters to change how they
+   * behave.
    *
    * @param key key
    * @param value value
@@ -169,5 +167,4 @@ public Expect header(String key, String value) {
     headers.put(key, value);
     return this;
   }
-
 }

java-snapshot-testing-core/src/main/java/au/com/origin/snapshots/Snapshot.java

@@ -1,82 +1,79 @@
 package au.com.origin.snapshots;
 
 import au.com.origin.snapshots.exceptions.LogGithubIssueException;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
 @EqualsAndHashCode
 @Builder
 @Getter
 @RequiredArgsConstructor
 public class Snapshot implements Comparable<Snapshot> {
 
-    private final String name;
-    private final String scenario;
-    private final SnapshotHeader header;
-    private final String body;
-
-    @Override
-    public int compareTo(Snapshot other) {
-        return (name + scenario).compareTo(other.name + other.scenario);
-    }
+  private final String name;
+  private final String scenario;
+  private final SnapshotHeader header;
+  private final String body;
 
-    public String getIdentifier() {
-        return scenario == null ? name : String.format("%s[%s]", name, scenario);
-    }
+  @Override
+  public int compareTo(Snapshot other) {
+    return (name + scenario).compareTo(other.name + other.scenario);
+  }
 
-    public static Snapshot parse(String rawText) {
-        String regex = "^(?<name>.*?)(\\[(?<scenario>.*)\\])?=(?<header>\\{.*\\})?(?<snapshot>(.*)$)";
-        Pattern p = Pattern.compile(regex, Pattern.DOTALL);
-        Matcher m = p.matcher(rawText);
-        boolean found = m.find();
-        if (!found) {
-            throw new LogGithubIssueException(
-                    "Corrupt Snapshot (REGEX matches = 0): possibly due to manual editing or our REGEX failing\n" +
-                    "Possible Solutions\n" +
-                    "1. Ensure you have not accidentally manually edited the snapshot file!\n" +
-                    "2. Compare the snapshot with GIT history"
-            );
-        }
+  public String getIdentifier() {
+    return scenario == null ? name : String.format("%s[%s]", name, scenario);
+  }
 
-        String name = m.group("name");
-        String scenario = m.group("scenario");
-        String header = m.group("header");
-        String snapshot = m.group("snapshot");
+  public static Snapshot parse(String rawText) {
+    String regex = "^(?<name>.*?)(\\[(?<scenario>.*)\\])?=(?<header>\\{.*\\})?(?<snapshot>(.*)$)";
+    Pattern p = Pattern.compile(regex, Pattern.DOTALL);
+    Matcher m = p.matcher(rawText);
+    boolean found = m.find();
+    if (!found) {
+      throw new LogGithubIssueException(
+          "Corrupt Snapshot (REGEX matches = 0): possibly due to manual editing or our REGEX failing\n"
+              + "Possible Solutions\n"
+              + "1. Ensure you have not accidentally manually edited the snapshot file!\n"
+              + "2. Compare the snapshot with GIT history");
+    }
 
-        if (name == null || snapshot == null) {
-            throw new LogGithubIssueException(
-                    "Corrupt Snapshot (REGEX name or snapshot group missing): possibly due to manual editing or our REGEX failing\n" +
-                            "Possible Solutions\n" +
-                            "1. Ensure you have not accidentally manually edited the snapshot file\n" +
-                            "2. Compare the snapshot with your version control history"
-            );
-        }
+    String name = m.group("name");
+    String scenario = m.group("scenario");
+    String header = m.group("header");
+    String snapshot = m.group("snapshot");
 
-        return Snapshot.builder()
-                .name(name)
-                .scenario(scenario)
-                .header(SnapshotHeader.fromJson(header))
-                .body(snapshot)
-                .build();
+    if (name == null || snapshot == null) {
+      throw new LogGithubIssueException(
+          "Corrupt Snapshot (REGEX name or snapshot group missing): possibly due to manual editing or our REGEX failing\n"
+              + "Possible Solutions\n"
+              + "1. Ensure you have not accidentally manually edited the snapshot file\n"
+              + "2. Compare the snapshot with your version control history");
     }
 
-    /**
-     * The raw string representation of the snapshot as it would appear in the *.snap file.
-     *
-     * @return raw snapshot
-     */
-    public String raw() {
-        String headerJson = (header == null) || (header.size() == 0) ? "" : header.toJson();
-        return getIdentifier() + "=" + headerJson + body;
-    }
+    return Snapshot.builder()
+        .name(name)
+        .scenario(scenario)
+        .header(SnapshotHeader.fromJson(header))
+        .body(snapshot)
+        .build();
+  }
 
-    @Override
-    public String toString() {
-        return raw();
-    }
+  /**
+   * The raw string representation of the snapshot as it would appear in the *.snap file.
+   *
+   * @return raw snapshot
+   */
+  public String raw() {
+    String headerJson = (header == null) || (header.size() == 0) ? "" : header.toJson();
+    return getIdentifier() + "=" + headerJson + body;
+  }
+
+  @Override
+  public String toString() {
+    return raw();
+  }
 }