feat: Remove checking ratchetFrom from IDE hook

Author: Dimitrii Lipiridi

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

@@ -124,7 +124,7 @@ public void setEncoding(String name) {
 
 	/** @see #setRatchetFrom(String) */
 	public String getRatchetFrom() {
-		return ratchetFrom.equals(RATCHETFROM_NOT_SET_AT_FORMAT_LEVEL) ? spotless.getRatchetFrom() : ratchetFrom;
+		return ratchetFrom == RATCHETFROM_NOT_SET_AT_FORMAT_LEVEL ? spotless.getRatchetFrom() : ratchetFrom;
 	}
 
 	/**

plugin-maven/src/main/java/com/diffplug/spotless/maven/AbstractSpotlessMojo.java

@@ -264,16 +264,16 @@ private List<File> collectFiles(FormatterFactory formatterFactory, FormatterConf
 			}
 			final String[] includePatterns = this.filePatterns.split(",");
 			final List<Pattern> compiledIncludePatterns = Arrays.stream(includePatterns)
-				.map(Pattern::compile)
-				.collect(Collectors.toList());
+					.map(Pattern::compile)
+					.collect(Collectors.toList());
 			final Predicate<File> shouldInclude = file -> compiledIncludePatterns
-				.stream()
-				.anyMatch(filePattern -> filePattern.matcher(file.getAbsolutePath())
-					.matches());
+					.stream()
+					.anyMatch(filePattern -> filePattern.matcher(file.getAbsolutePath())
+							.matches());
 			return files
-				.stream()
-				.filter(shouldInclude)
-				.collect(toList());
+					.stream()
+					.filter(shouldInclude)
+					.collect(toList());
 		} catch (IOException e) {
 			throw new PluginException("Unable to scan file tree rooted at " + baseDir, e);
 		}
@@ -384,8 +384,4 @@ private UpToDateChecker createUpToDateChecker(Iterable<Formatter> formatters) {
 		}
 		return UpToDateChecker.wrapWithBuildContext(checker, buildContext);
 	}
-
-	protected File getBaseDir() {
-		return baseDir;
-	}
 }

plugin-maven/src/main/java/com/diffplug/spotless/maven/IdeHook.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,64 +15,60 @@
  */
 package com.diffplug.spotless.maven;
 
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+
 import com.diffplug.common.base.Errors;
 import com.diffplug.common.io.ByteStreams;
 import com.diffplug.spotless.Formatter;
 import com.diffplug.spotless.PaddedCell;
 
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.Files;
-import java.util.List;
-
 class IdeHook {
 
 	private static void dumpIsClean() {
 		System.err.println("IS CLEAN");
 	}
 
-	static void performHook(Iterable<File> projectFiles, String path, Formatter formatter, File projectDir, String ratchetFrom, boolean spotlessIdeHookUseStdIn, boolean spotlessIdeHookUseStdOut) {
+	//No need to check ratchet (using isClean()) as it is performed in Gradle's IDE hook, since we have already gathered the available git files from ratchet.
+	static void performHook(Iterable<File> projectFiles, Formatter formatter, String path, boolean spotlessIdeHookUseStdIn, boolean spotlessIdeHookUseStdOut) {
 		File file = new File(path);
 		if (!file.isAbsolute()) {
 			System.err.println("Argument passed to spotlessIdeHook must be an absolute path");
 			return;
 		}
-		if (projectContainsFile(projectFiles, file)) {
-			try {
-				if (ratchetFrom != null) {
-					GitRatchetMaven ratchet = GitRatchetMaven.instance();
-					if (ratchet.isClean(projectDir, ratchet.rootTreeShaOf(projectDir, ratchetFrom), file)) {
-						dumpIsClean();
-						return;
-					}
-				}
-				byte[] bytes;
-				if (spotlessIdeHookUseStdIn) {
-					bytes = ByteStreams.toByteArray(System.in);
-				} else {
-					bytes = Files.readAllBytes(file.toPath());
-				}
-				PaddedCell.DirtyState dirty = PaddedCell.calculateDirtyState(formatter, file, bytes);
-				if (dirty.isClean()) {
-					dumpIsClean();
-				} else if (dirty.didNotConverge()) {
-					System.err.println("DID NOT CONVERGE");
-					System.err.println("Run 'spotlessDiagnose' for details https://github.com/diffplug/spotless/blob/main/PADDEDCELL.md");
+
+		if (!projectContainsFile(projectFiles, file)) {
+			return;
+		}
+
+		try {
+			byte[] bytes;
+			if (spotlessIdeHookUseStdIn) {
+				bytes = ByteStreams.toByteArray(System.in);
+			} else {
+				bytes = Files.readAllBytes(file.toPath());
+			}
+			PaddedCell.DirtyState dirty = PaddedCell.calculateDirtyState(formatter, file, bytes);
+			if (dirty.isClean()) {
+				dumpIsClean();
+			} else if (dirty.didNotConverge()) {
+				System.err.println("DID NOT CONVERGE");
+				System.err.println("See details https://github.com/diffplug/spotless/blob/main/PADDEDCELL.md");
+			} else {
+				System.err.println("IS DIRTY");
+				if (spotlessIdeHookUseStdOut) {
+					dirty.writeCanonicalTo(System.out);
 				} else {
-					System.err.println("IS DIRTY");
-					if (spotlessIdeHookUseStdOut) {
-						dirty.writeCanonicalTo(System.out);
-					} else {
-						dirty.writeCanonicalTo(file);
-					}
+					dirty.writeCanonicalTo(file);
 				}
-			} catch (IOException e) {
-				e.printStackTrace(System.err);
-				throw Errors.asRuntime(e);
-			} finally {
-				System.err.close();
-				System.out.close();
 			}
+		} catch (IOException e) {
+			e.printStackTrace(System.err);
+			throw Errors.asRuntime(e);
+		} finally {
+			System.err.close();
+			System.out.close();
 		}
 	}
 

plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessApplyMojo.java

@@ -18,17 +18,14 @@
 import java.io.File;
 import java.io.IOException;
 
-import java.util.List;
-
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
 
 import com.diffplug.spotless.Formatter;
 import com.diffplug.spotless.PaddedCell;
 import com.diffplug.spotless.maven.incremental.UpToDateChecker;
 
-import org.apache.maven.plugins.annotations.Parameter;
-
 /**
  * Performs formatting of all source files according to configured formatters.
  */
@@ -46,8 +43,8 @@ public class SpotlessApplyMojo extends AbstractSpotlessMojo {
 
 	@Override
 	protected void process(Iterable<File> files, Formatter formatter, UpToDateChecker upToDateChecker) throws MojoExecutionException {
-		if(isIdeHook()) {
-			IdeHook.performHook(files, spotlessIdeHook, formatter, getBaseDir(), null, spotlessIdeHookUseStdIn, spotlessIdeHookUseStdOut);
+		if (isIdeHook()) {
+			IdeHook.performHook(files, formatter, spotlessIdeHook, spotlessIdeHookUseStdIn, spotlessIdeHookUseStdOut);
 			return;
 		}
 
@@ -91,13 +88,4 @@ protected void process(Iterable<File> files, Formatter formatter, UpToDateChecke
 	private boolean isIdeHook() {
 		return !(spotlessIdeHook == null || spotlessIdeHook.isEmpty());
 	}
-
-	private List<File> fetchFileFromIdeHook() {
-		File file = new File(spotlessIdeHook);
-		if (!file.isAbsolute()) {
-			throw new PluginException("Argument passed to spotlessIdeHook must be an absolute path");
-		}
-
-		return List.of(file);
-	}
 }