Upgrade Spotless, and provide File to Cleanthat for better error logging

Author: blacelle

CHANGES.md

@@ -28,6 +28,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Bump default `shfmt` version to latest `3.7.0` -> `3.8.0`. ([#2050](https://github.com/diffplug/spotless/pull/2050))
 * Bump default `sortpom` version to latest `3.2.1` -> `4.0.0`. ([#2049](https://github.com/diffplug/spotless/pull/2049), [#2078](https://github.com/diffplug/spotless/pull/2078), [#2115](https://github.com/diffplug/spotless/pull/2115))
 * Bump default `zjsonpatch` version to latest `0.4.14` -> `0.4.16`. ([#1969](https://github.com/diffplug/spotless/pull/1969))
+* Bump default `cleanthat` version to latest `2.17` -> `2.20`. ([#1725](https://github.com/diffplug/spotless/pull/1725))
 ### Removed
 * **BREAKING** Remove `JarState.getMavenCoordinate(String prefix)`. ([#1945](https://github.com/diffplug/spotless/pull/1945))
 * **BREAKING** Replace `PipeStepPair` with `FenceStep`. ([#1954](https://github.com/diffplug/spotless/pull/1954))

lib/build.gradle

@@ -80,7 +80,7 @@ dependencies {
 
 	// GLUE CODE (alphabetic order please)
 	// cleanthat
-	String VER_CLEANTHAT='2.17'
+	String VER_CLEANTHAT='2.20'
 	cleanthatCompileOnly "io.github.solven-eu.cleanthat:java:$VER_CLEANTHAT"
 	compatCleanthat2Dot1CompileAndTestOnly "io.github.solven-eu.cleanthat:java:$VER_CLEANTHAT"
 	// diktat old supported version 1.x

lib/src/cleanthat/java/com/diffplug/spotless/glue/java/JavaCleanthatRefactorerFunc.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-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,6 +15,7 @@
  */
 package com.diffplug.spotless.glue.java;
 
+import java.io.File;
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.Collections;
@@ -31,12 +32,13 @@
 import eu.solven.cleanthat.engine.java.refactorer.JavaRefactorer;
 import eu.solven.cleanthat.engine.java.refactorer.JavaRefactorerProperties;
 import eu.solven.cleanthat.formatter.LineEnding;
+import eu.solven.cleanthat.formatter.PathAndContent;
 
 /**
  * The glue for CleanThat: it is build over the version in build.gradle, but at runtime it will be executed over
  * the version loaded in JarState, which is by default defined in com.diffplug.spotless.java.CleanthatJavaStep#JVM_SUPPORT
  */
-public class JavaCleanthatRefactorerFunc implements FormatterFunc {
+public class JavaCleanthatRefactorerFunc implements FormatterFunc.NeedsFile {
 	private static final Logger LOGGER = LoggerFactory.getLogger(JavaCleanthatRefactorerFunc.class);
 
 	private String jdkVersion;
@@ -56,20 +58,20 @@ public JavaCleanthatRefactorerFunc() {
 	}
 
 	@Override
-	public String apply(String input) throws Exception {
+	public String applyWithFile(String unix, File file) throws Exception {
 		// https://stackoverflow.com/questions/1771679/difference-between-threads-context-class-loader-and-normal-classloader
 		ClassLoader originalClassLoader = Thread.currentThread().getContextClassLoader();
 		try {
 			// Ensure CleanThat main Thread has its custom classLoader while executing its refactoring
 			Thread.currentThread().setContextClassLoader(getClass().getClassLoader());
-			return doApply(input);
+			return doApply(unix, file);
 		} finally {
 			// Restore the originalClassLoader
 			Thread.currentThread().setContextClassLoader(originalClassLoader);
 		}
 	}
 
-	private String doApply(String input) throws InterruptedException, IOException {
+	private String doApply(String input, File file) throws IOException {
 		// call some API that uses reflection without taking ClassLoader param
 		CleanthatEngineProperties engineProperties = CleanthatEngineProperties.builder().engineVersion(jdkVersion).build();
 
@@ -88,7 +90,9 @@ private String doApply(String input) throws InterruptedException, IOException {
 		LOGGER.debug("Processing sourceJdk={} included={} excluded={}", jdkVersion, included, excluded, includeDraft);
 		LOGGER.debug("Available mutators: {}", JavaRefactorer.getAllIncluded());
 
-		return refactorer.doFormat(input);
+		PathAndContent pathAndContent = new PathAndContent(file.toPath(), input);
+
+		return refactorer.doFormat(pathAndContent);
 	}
 
 }

lib/src/main/java/com/diffplug/spotless/java/CleanthatJavaStep.java

@@ -40,7 +40,7 @@ public final class CleanthatJavaStep implements java.io.Serializable {
 	/**
 	 * CleanThat changelog is available at <a href="https://github.com/solven-eu/cleanthat/blob/master/CHANGES.MD">here</a>.
 	 */
-	private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(11, "2.16");
+	private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(11, "2.20");
 
 	private final JarState.Promised jarState;
 	private final String version;