refactor: adapt creation pipeline to allow createLazy to work with function pointers

Author: simschla

lib/src/main/java/com/diffplug/spotless/generic/IdeaStep.java

@@ -48,27 +48,34 @@
 
 public final class IdeaStep {
 
+	private static final Logger LOGGER = LoggerFactory.getLogger(IdeaStep.class);
+
 	public static final String NAME = "IDEA";
 
 	public static final String IDEA_EXECUTABLE_DEFAULT = "idea";
 
-	private static final Logger LOGGER = LoggerFactory.getLogger(IdeaStep.class);
 	public static final String IDEA_CONFIG_PATH_PROPERTY = "idea.config.path";
 	public static final String IDEA_SYSTEM_PATH_PROPERTY = "idea.system.path";
+	@Nonnull
+	private final IdeaStepBuilder builder;
 
-	private IdeaStep() {}
+	private IdeaStep(@Nonnull IdeaStepBuilder builder) {
+		this.builder = builder;
+	}
 
-	public static IdeaStepBuilder create(@Nonnull File buildDir) {
+	public static IdeaStepBuilder newBuilder(@Nonnull File buildDir) {
 		return new IdeaStepBuilder(Objects.requireNonNull(buildDir));
 	}
 
-	private static FormatterStep create(@Nonnull IdeaStepBuilder builder) {
-		Objects.requireNonNull(builder);
-		return FormatterStep.createLazy(NAME,
-				() -> createState(builder), State::toFunc);
+	private static FormatterStep create(IdeaStepBuilder builder) {
+		return new IdeaStep(builder).createFormatterStep();
 	}
 
-	private static State createState(@Nonnull IdeaStepBuilder builder) {
+	private FormatterStep createFormatterStep() {
+		return FormatterStep.createLazy(NAME, this::createState, State::toFunc);
+	}
+
+	private State createState() {
 		return new State(Objects.requireNonNull(builder));
 	}
 
@@ -114,6 +121,17 @@ public IdeaStepBuilder setIdeaProperties(@Nonnull Map<String, String> ideaProper
 		public FormatterStep build() {
 			return create(this);
 		}
+
+		@Override
+		public String toString() {
+			return String.format(
+					"IdeaStepBuilder[useDefaults=%s, binaryPath=%s, codeStyleSettingsPath=%s, ideaProperties=%s, buildDir=%s]",
+					this.useDefaults,
+					this.binaryPath,
+					this.codeStyleSettingsPath,
+					this.ideaProperties,
+					this.buildDir);
+		}
 	}
 
 	private static class State implements Serializable {
@@ -128,6 +146,7 @@ private static class State implements Serializable {
 		private final TreeMap<String, String> ideaProperties;
 
 		private State(@Nonnull IdeaStepBuilder builder) {
+			LOGGER.debug("Creating {} state with configuration {}", NAME, builder);
 			this.uniqueBuildFolder = new File(builder.buildDir, UUID.randomUUID().toString());
 			this.withDefaults = builder.useDefaults;
 			this.codeStyleSettingsPath = builder.codeStyleSettingsPath;
@@ -203,7 +222,9 @@ private String format(IdeaStepFormatterCleanupResources ideaStepFormatterCleanup
 				List<String> params = getParams(tempFile);
 
 				Map<String, String> env = createEnv();
+				LOGGER.info("Launching IDEA formatter for orig file {} with params: {} and env: {}", file, params, env);
 				var result = ideaStepFormatterCleanupResources.runner.exec(null, env, null, params);
+				LOGGER.debug("command finished with exit code: {}", result.exitCode());
 				LOGGER.debug("command finished with stdout: {}",
 						result.assertExitZero(StandardCharsets.UTF_8));
 				return Files.readString(tempFile.toPath(), StandardCharsets.UTF_8);
@@ -236,6 +257,7 @@ private File createIdeaPropertiesFile() {
 			properties.put(IDEA_CONFIG_PATH_PROPERTY, ThrowingEx.get(configPath.toFile()::getCanonicalPath));
 			properties.put(IDEA_SYSTEM_PATH_PROPERTY, ThrowingEx.get(systemPath.toFile()::getCanonicalPath));
 
+			LOGGER.debug("Creating IDEA properties file at {} with content: {}", ideaProps, properties);
 			try (FileOutputStream out = new FileOutputStream(ideaProps.toFile())) {
 				properties.store(out, "Generated by spotless");
 			} catch (IOException e) {

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

@@ -969,7 +969,7 @@ public class IdeaConfig {
 		private final IdeaStep.IdeaStepBuilder builder;
 
 		IdeaConfig() {
-			this.builder = IdeaStep.create(getProject().getLayout().getBuildDirectory().getAsFile().get());
+			this.builder = IdeaStep.newBuilder(getProject().getLayout().getBuildDirectory().getAsFile().get());
 			addStep(createStep());
 		}
 

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Idea.java

@@ -35,7 +35,7 @@ public class Idea implements FormatterStepFactory {
 
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig config) {
-		return IdeaStep.create(config.getFileLocator().getBuildDir())
+		return IdeaStep.newBuilder(config.getFileLocator().getBuildDir())
 				.setUseDefaults(withDefaults)
 				.setCodeStyleSettingsPath(configPath)
 				.setBinaryPath(binaryPath)

testlib/src/test/java/com/diffplug/spotless/generic/IdeaStepTest.java

@@ -32,7 +32,7 @@ class IdeaStepTest extends ResourceHarness {
 
 	@Test
 	void name() throws Exception {
-		FormatterStep step = IdeaStep.create(buildDir()).setUseDefaults(true).build();
+		FormatterStep step = IdeaStep.newBuilder(buildDir()).setUseDefaults(true).build();
 
 		String name = step.getName();
 
@@ -44,7 +44,7 @@ void notFormattings() throws Exception {
 		File cleanFile = newFile("clean.java");
 		String cleanJava = ResourceHarness.getTestResource("java/idea/full.clean.java");
 		Files.write(cleanJava, cleanFile, StandardCharsets.UTF_8);
-		FormatterStep step = IdeaStep.create(buildDir()).setUseDefaults(true).build();
+		FormatterStep step = IdeaStep.newBuilder(buildDir()).setUseDefaults(true).build();
 
 		var result = step.format(cleanJava, cleanFile);
 
@@ -57,7 +57,7 @@ void formattings() throws Exception {
 		File dirtyFile = newFile("dirty.java");
 		String dirtyJava = ResourceHarness.getTestResource("java/idea/full.dirty.java");
 		Files.write(dirtyJava, dirtyFile, StandardCharsets.UTF_8);
-		FormatterStep step = IdeaStep.create(buildDir()).setUseDefaults(true).build();
+		FormatterStep step = IdeaStep.newBuilder(buildDir()).setUseDefaults(true).build();
 
 		var result = step.format(dirtyJava, dirtyFile);
 
@@ -70,7 +70,7 @@ void formattingsWorkWithDefaultParameters() throws Exception {
 		File dirtyFile = newFile("dirty.java");
 		String dirtyJava = ResourceHarness.getTestResource("java/idea/full.dirty.java");
 		Files.write(dirtyJava, dirtyFile, StandardCharsets.UTF_8);
-		FormatterStep step = IdeaStep.create(buildDir()).build();
+		FormatterStep step = IdeaStep.newBuilder(buildDir()).build();
 
 		var result = step.format(dirtyJava, dirtyFile);
 
@@ -83,7 +83,7 @@ void formattingsWithOutDefaultDoesNothing() throws Exception {
 		File dirtyFile = newFile("dirty.java");
 		String dirtyJava = ResourceHarness.getTestResource("java/idea/full.dirty.java");
 		Files.write(dirtyJava, dirtyFile, StandardCharsets.UTF_8);
-		FormatterStep step = IdeaStep.create(buildDir()).setUseDefaults(false).build();
+		FormatterStep step = IdeaStep.newBuilder(buildDir()).setUseDefaults(false).build();
 
 		var result = step.format(dirtyJava, dirtyFile);
 
@@ -96,7 +96,7 @@ void configureFile() throws Exception {
 		File cleanFile = newFile("clean.java");
 		String cleanJava = ResourceHarness.getTestResource("java/idea/full.clean.java");
 		Files.write(cleanJava, cleanFile, StandardCharsets.UTF_8);
-		FormatterStep step = IdeaStep.create(buildDir()).setUseDefaults(true).build();
+		FormatterStep step = IdeaStep.newBuilder(buildDir()).setUseDefaults(true).build();
 
 		var result = step.format(cleanJava, cleanFile);