Make GherkinUtilsStep round-trippable

Author: Goooler

lib/src/main/java/com/diffplug/spotless/gherkin/GherkinUtilsStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 DiffPlug
+ * Copyright 2021-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
  */
 package com.diffplug.spotless.gherkin;
 
-import java.io.IOException;
 import java.io.Serializable;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
@@ -25,10 +24,21 @@
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.JarState;
 import com.diffplug.spotless.Provisioner;
+import com.diffplug.spotless.RoundedStep;
 
-public class GherkinUtilsStep {
+public class GherkinUtilsStep implements RoundedStep {
+	private static final long serialVersionUID = 1L;
 	private static final String MAVEN_COORDINATE = "io.cucumber:gherkin-utils:";
 	private static final String DEFAULT_VERSION = "8.0.2";
+	public static final String NAME = "gherkinUtils";
+
+	private final JarState.Promised jarState;
+	private final GherkinUtilsConfig gherkinSimpleConfig;
+
+	private GherkinUtilsStep(JarState.Promised jarState, GherkinUtilsConfig gherkinSimpleConfig) {
+		this.jarState = jarState;
+		this.gherkinSimpleConfig = gherkinSimpleConfig;
+	}
 
 	public static String defaultVersion() {
 		return DEFAULT_VERSION;
@@ -37,7 +47,14 @@ public static String defaultVersion() {
 	public static FormatterStep create(GherkinUtilsConfig gherkinSimpleConfig,
 			String formatterVersion, Provisioner provisioner) {
 		Objects.requireNonNull(provisioner, "provisioner cannot be null");
-		return FormatterStep.createLazy("gherkin", () -> new GherkinUtilsStep.State(gherkinSimpleConfig, formatterVersion, provisioner), GherkinUtilsStep.State::toFormatter);
+		return FormatterStep.create(NAME,
+				new GherkinUtilsStep(JarState.promise(() -> JarState.from(MAVEN_COORDINATE + formatterVersion, provisioner)), gherkinSimpleConfig),
+				GherkinUtilsStep::equalityState,
+				GherkinUtilsStep.State::toFormatter);
+	}
+
+	private State equalityState() {
+		return new State(jarState.get(), gherkinSimpleConfig);
 	}
 
 	private static final class State implements Serializable {
@@ -46,9 +63,9 @@ private static final class State implements Serializable {
 		private final GherkinUtilsConfig gherkinSimpleConfig;
 		private final JarState jarState;
 
-		private State(GherkinUtilsConfig gherkinSimpleConfig, String formatterVersion, Provisioner provisioner) throws IOException {
+		State(JarState jarState, GherkinUtilsConfig gherkinSimpleConfig) {
+			this.jarState = jarState;
 			this.gherkinSimpleConfig = gherkinSimpleConfig;
-			this.jarState = JarState.from(MAVEN_COORDINATE + formatterVersion, provisioner);
 		}
 
 		FormatterFunc toFormatter() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException,
@@ -58,8 +75,4 @@ FormatterFunc toFormatter() throws ClassNotFoundException, NoSuchMethodException
 			return (FormatterFunc) constructor.newInstance(gherkinSimpleConfig);
 		}
 	}
-
-	private GherkinUtilsStep() {
-		// cannot be directly instantiated
-	}
 }

testlib/src/main/java/com/diffplug/spotless/StepHarnessBase.java

@@ -51,7 +51,7 @@ protected StepHarnessBase(Formatter formatter) {
 				supportsRoundTrip = true;
 			} else if (Set.of("black", "buf", "clang", "ktlint", "ktfmt", "scalafmt", "palantir-java-format", "google-java-format",
 					"removeUnusedImports", "cleanthat", "No line break between type annotation and type",
-					"gson", "jacksonJson", "apply-json-patch", "jsonSimple", "sortPom", "jacksonYaml",
+					"gson", "jacksonJson", "apply-json-patch", "jsonSimple", "sortPom", "jacksonYaml", "gherkinUtils",
 					"importOrder", "Remove unnecessary semicolons").contains(onlyStepName)) {
 				supportsRoundTrip = true;
 			}