Convert GitRatchetGradle to be File-based, which allows us to remove all getProject() except IdeHook.

nedtwigg · nedtwigg · commit 998f188a2cbf · 2021-11-06T18:15:31.000-07:00
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GitRatchetGradle.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GitRatchetGradle.java
@@ -19,7 +19,6 @@
 
 import javax.annotation.Nullable;
 
-import org.gradle.api.Project;
 import org.gradle.api.services.BuildService;
 import org.gradle.api.services.BuildServiceParameters;
 import org.gradle.tooling.events.FinishEvent;
@@ -28,15 +27,15 @@
 import com.diffplug.spotless.extra.GitRatchet;
 
 /** Gradle implementation of GitRatchet. */
-public abstract class GitRatchetGradle extends GitRatchet<Project> implements BuildService<BuildServiceParameters.None>, OperationCompletionListener {
+public abstract class GitRatchetGradle extends GitRatchet<File> implements BuildService<BuildServiceParameters.None>, OperationCompletionListener {
 	@Override
-	protected File getDir(Project project) {
-		return project.getProjectDir();
+	protected File getDir(File project) {
+		return project;
 	}
 
 	@Override
-	protected @Nullable Project getParent(Project project) {
-		return project.getParent();
+	protected @Nullable File getParent(File project) {
+		return project.getParentFile();
 	}
 
 	@Override
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/IdeHook.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/IdeHook.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2021 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@ private static void dumpIsClean() {
 		System.err.println("IS CLEAN");
 	}
 
-	static void performHook(SpotlessTask spotlessTask) {
+	static void performHook(SpotlessTaskImpl spotlessTask) {
 		String path = (String) spotlessTask.getProject().property(PROPERTY);
 		File file = new File(path);
 		if (!file.isAbsolute()) {
@@ -43,7 +43,7 @@ static void performHook(SpotlessTask spotlessTask) {
 		if (spotlessTask.getTarget().contains(file)) {
 			try (Formatter formatter = spotlessTask.buildFormatter()) {
 				if (spotlessTask.ratchet != null) {
-					if (spotlessTask.ratchet.isClean(spotlessTask.getProject(), spotlessTask.rootTreeSha, file)) {
+					if (spotlessTask.ratchet.isClean(spotlessTask.getProjectDir().get().getAsFile(), spotlessTask.rootTreeSha, file)) {
 						dumpIsClean();
 						return;
 					}
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessApply.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessApply.java
@@ -42,7 +42,7 @@ public void visitDir(FileVisitDetails fileVisitDetails) {
 				@Override
 				public void visitFile(FileVisitDetails fileVisitDetails) {
 					String path = fileVisitDetails.getPath();
-					File originalSource = new File(getProject().getProjectDir(), path);
+					File originalSource = new File(getProjectDir().get().getAsFile(), path);
 					try {
 						getLogger().debug("Copying " + fileVisitDetails.getFile() + " to " + originalSource);
 						Files.copy(fileVisitDetails.getFile().toPath(), originalSource.toPath(), StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.COPY_ATTRIBUTES);
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessCheck.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessCheck.java
@@ -67,7 +67,7 @@ public void visitDir(FileVisitDetails fileVisitDetails) {
 				@Override
 				public void visitFile(FileVisitDetails fileVisitDetails) {
 					String path = fileVisitDetails.getPath();
-					File originalSource = new File(getProject().getProjectDir(), path);
+					File originalSource = new File(getProjectDir().get().getAsFile(), path);
 					try {
 						// read the file on disk
 						byte[] userFile = Files.readAllBytes(originalSource.toPath());
@@ -100,7 +100,7 @@ public void visitFile(FileVisitDetails fileVisitDetails) {
 				throw new GradleException(DiffMessageFormatter.builder()
 						.runToFix("Run '" + calculateGradleCommand() + " " + getTaskPathPrefix() + "spotlessApply' to fix these violations.")
 						.formatterFolder(
-								getProject().getRootDir().toPath(),
+								getProjectDir().get().getAsFile().toPath(),
 								getSpotlessOutDirectory().get().toPath(),
 								getEncoding().get())
 						.problemFiles(problemFiles)
@@ -109,10 +109,18 @@ public void visitFile(FileVisitDetails fileVisitDetails) {
 		}
 	}
 
+	@Internal
+	abstract Property<String> getProjectPath();
+
+	@Override
+	void init(SpotlessTaskImpl impl) {
+		super.init(impl);
+		getProjectPath().set(getProject().getPath());
+	}
+
 	private String getTaskPathPrefix() {
-		return getProject().getPath().equals(":")
-				? ":"
-				: getProject().getPath() + ":";
+		String path = getProjectPath().get();
+		return path.equals(":") ? ":" : path + ":";
 	}
 
 	private static String calculateGradleCommand() {
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTask.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTask.java
@@ -27,6 +27,7 @@
 
 import org.eclipse.jgit.lib.ObjectId;
 import org.gradle.api.DefaultTask;
+import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.InputFiles;
@@ -80,10 +81,14 @@ public void setLineEndingsPolicy(LineEnding.Policy lineEndingsPolicy) {
 
 	public void setupRatchet(GitRatchetGradle gitRatchet, String ratchetFrom) {
 		ratchet = gitRatchet;
-		rootTreeSha = gitRatchet.rootTreeShaOf(getProject(), ratchetFrom);
-		subtreeSha = gitRatchet.subtreeShaOf(getProject(), rootTreeSha);
+		File projectDir = getProjectDir().get().getAsFile();
+		rootTreeSha = gitRatchet.rootTreeShaOf(projectDir, ratchetFrom);
+		subtreeSha = gitRatchet.subtreeShaOf(projectDir, rootTreeSha);
 	}
 
+	@Internal
+	abstract DirectoryProperty getProjectDir();
+
 	@Internal
 	GitRatchetGradle getRatchet() {
 		return ratchet;
@@ -163,7 +168,7 @@ Formatter buildFormatter() {
 		return Formatter.builder()
 				.lineEndingsPolicy(lineEndingsPolicy)
 				.encoding(Charset.forName(encoding))
-				.rootDir(getProject().getRootDir().toPath())
+				.rootDir(getProjectDir().get().getAsFile().toPath())
 				.steps(steps)
 				.exceptionPolicy(exceptionPolicy)
 				.build();
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTaskImpl.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTaskImpl.java
@@ -86,7 +86,7 @@ private void processInputFile(Formatter formatter, File input) throws IOExceptio
 		File output = getOutputFile(input);
 		getLogger().debug("Applying format to " + input + " and writing to " + output);
 		PaddedCell.DirtyState dirtyState;
-		if (ratchet != null && ratchet.isClean(getProject(), rootTreeSha, input)) {
+		if (ratchet != null && ratchet.isClean(getProjectDir().get().getAsFile(), rootTreeSha, input)) {
 			dirtyState = PaddedCell.isClean();
 		} else {
 			dirtyState = PaddedCell.calculateDirtyState(formatter, input);
@@ -118,12 +118,13 @@ private void deletePreviousResult(File input) throws IOException {
 	}
 
 	private File getOutputFile(File input) {
-		String outputFileName = FormatExtension.relativize(getProject().getProjectDir(), input);
+		File projectDir = getProjectDir().get().getAsFile();
+		String outputFileName = FormatExtension.relativize(projectDir, input);
 		if (outputFileName == null) {
 			throw new IllegalArgumentException(StringPrinter.buildString(printer -> {
-				printer.println("Spotless error! All target files must be within the project root. In project " + getProject().getPath());
-				printer.println("  root dir: " + getProject().getProjectDir().getAbsolutePath());
-				printer.println("    target: " + input.getAbsolutePath());
+				printer.println("Spotless error! All target files must be within the project root.");
+				printer.println("  project dir: " + projectDir.getAbsolutePath());
+				printer.println("       target: " + input.getAbsolutePath());
 			}));
 		}
 		return new File(outputDirectory, outputFileName);
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTaskService.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTaskService.java
@@ -23,6 +23,7 @@
 import javax.inject.Inject;
 
 import org.gradle.api.DefaultTask;
+import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.provider.Property;
 import org.gradle.api.services.BuildService;
@@ -59,12 +60,16 @@ static abstract class ClientTask extends DefaultTask {
 		@Internal
 		abstract Property<SpotlessTaskService> getTaskService();
 
+		@Internal
+		abstract DirectoryProperty getProjectDir();
+
 		@Inject
 		protected abstract ObjectFactory getConfigCacheWorkaround();
 
 		void init(SpotlessTaskImpl impl) {
 			getSpotlessOutDirectory().set(impl.getOutputDirectory());
-			getTaskService().set(impl.getTaskService());
+			getTaskService().set(impl.getTakService());
+			getProjectDir().set(impl.getProjectDir());
 		}
 
 		String sourceTaskPath() {
