Make FreshMarkStep round-trippable

Author: Goooler

lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,12 +35,11 @@
 import com.diffplug.spotless.JarState;
 import com.diffplug.spotless.Jvm;
 import com.diffplug.spotless.Provisioner;
-import com.diffplug.spotless.ThrowingEx.Supplier;
+import com.diffplug.spotless.RoundedStep;
 
 /** A step for <a href="https://github.com/diffplug/freshmark">FreshMark</a>. */
-public class FreshMarkStep {
-	// prevent direct instantiation
-	private FreshMarkStep() {}
+public class FreshMarkStep implements RoundedStep {
+	private static final long serialVersionUID = 1L;
 
 	private static final String DEFAULT_VERSION = "1.3.1";
 	private static final String NAME = "freshmark";
@@ -52,13 +51,21 @@ private FreshMarkStep() {}
 	private static final String FORMATTER_CLASS = "com.diffplug.freshmark.FreshMark";
 	private static final String FORMATTER_METHOD = "compile";
 
+	private final JarState.Promised jarState;
+	private final Map<String, ?> properties;
+
+	private FreshMarkStep(JarState.Promised jarState, Map<String, ?> properties) {
+		this.jarState = jarState;
+		this.properties = properties;
+	}
+
 	/** Creates a formatter step for the given version and settings file. */
-	public static FormatterStep create(Supplier<Map<String, ?>> properties, Provisioner provisioner) {
+	public static FormatterStep create(Map<String, ?> properties, Provisioner provisioner) {
 		return create(defaultVersion(), properties, provisioner);
 	}
 
 	/** Creates a formatter step for the given version and settings file. */
-	public static FormatterStep create(String version, Supplier<Map<String, ?>> properties, Provisioner provisioner) {
+	public static FormatterStep create(String version, Map<String, ?> properties, Provisioner provisioner) {
 		Objects.requireNonNull(version, "version");
 		Objects.requireNonNull(properties, "properties");
 		Objects.requireNonNull(provisioner, "provisioner");
@@ -70,21 +77,25 @@ public static FormatterStep create(String version, Supplier<Map<String, ?>> prop
 			mavenCoordinates.add(NASHORN_MAVEN_COORDINATE + NASHORN_VERSION);
 		}
 
-		return FormatterStep.createLazy(NAME,
-				() -> new State(JarState.from(mavenCoordinates, provisioner), properties.get()),
+		return FormatterStep.create(NAME,
+				new FreshMarkStep(JarState.promise(() -> JarState.from(mavenCoordinates, provisioner)), properties),
+				FreshMarkStep::equalityState,
 				State::createFormat);
 	}
 
 	public static String defaultVersion() {
 		return DEFAULT_VERSION;
 	}
 
+	private State equalityState() throws Exception {
+		return new State(jarState.get(), properties);
+	}
+
 	private static class State implements Serializable {
 		private static final long serialVersionUID = 1L;
 
-		/** The jar that contains the formatter. */
-		final JarState jarState;
-		final NavigableMap<String, ?> properties;
+		private final JarState jarState;
+		private final NavigableMap<String, ?> properties;
 
 		State(JarState jarState, Map<String, ?> properties) {
 			this.jarState = jarState;

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/FreshMarkExtension.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,13 +38,11 @@ public class FreshMarkExtension extends FormatExtension {
 	@Inject
 	public FreshMarkExtension(SpotlessExtension spotless) {
 		super(spotless);
-		addStep(FreshMarkStep.create(() -> {
-			Map<String, Object> map = new HashMap<>();
-			for (Action<Map<String, Object>> action : propertyActions) {
-				action.execute(map);
-			}
-			return map;
-		}, provisioner()));
+		Map<String, Object> map = new HashMap<>();
+		for (Action<Map<String, Object>> action : propertyActions) {
+			action.execute(map);
+		}
+		addStep(FreshMarkStep.create(map, provisioner()));
 	}
 
 	public void properties(Action<Map<String, Object>> action) {

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

@@ -52,7 +52,7 @@ protected StepHarnessBase(Formatter formatter) {
 			} 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", "antlr4Formatter",
 					"gson", "jacksonJson", "apply-json-patch", "jsonSimple", "sortPom", "jacksonYaml", "gherkinUtils",
-					"flexmark-java",
+					"flexmark-java", "freshmark",
 					"importOrder", "Remove unnecessary semicolons").contains(onlyStepName)) {
 				supportsRoundTrip = true;
 			}

testlib/src/test/java/com/diffplug/spotless/markdown/FreshMarkStepTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,19 +27,19 @@
 
 class FreshMarkStepTest {
 	@Test
-	void behavior() throws Exception {
+	void behavior() {
 		HashMap<String, String> map = new HashMap<>();
 		map.put("lib", "MyLib");
 		map.put("author", "Me");
-		StepHarness.forStep(FreshMarkStep.create(() -> map, TestProvisioner.mavenCentral()))
+		StepHarness.forStep(FreshMarkStep.create(map, TestProvisioner.mavenCentral()))
 				.testResource("freshmark/FreshMarkUnformatted.test", "freshmark/FreshMarkFormatted.test");
 	}
 
 	@Test
-	void equality() throws Exception {
+	void equality() {
 		new SerializableEqualityTester() {
 			String version = "1.3.1";
-			Map<String, Object> props = new HashMap<>();
+			final Map<String, Object> props = new HashMap<>();
 
 			@Override
 			protected void setupTest(API api) {
@@ -57,7 +57,7 @@ protected void setupTest(API api) {
 			protected FormatterStep create() {
 				String finalVersion = this.version;
 				Map<String, ?> finalProps = new HashMap<>(props);
-				return FreshMarkStep.create(finalVersion, () -> finalProps, TestProvisioner.mavenCentral());
+				return FreshMarkStep.create(finalVersion, finalProps, TestProvisioner.mavenCentral());
 			}
 		}.testEquals();
 	}