Update tasks to support gradle config cache

Author: ScribbleTAS

src/main/java/com/minecrafttas/discombobulator/Discombobulator.java

@@ -3,6 +3,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -33,21 +34,50 @@
  */
 public class Discombobulator implements Plugin<Project> {
 
-	/**
-	 * Which port to lock
-	 */
+	///
+	/// Which port to lock
+	/// 
 	public static int PORT_LOCK = 8762;
 
+	///
+	/// The config set in the build.gradle file of the discombobulator
+	/// 
 	public static PreprocessingConfiguration config;
 
+	///
+	/// If true: Disables color output in the console
+	/// 
 	public static boolean DISABLE_ANSI = false;
 
+	///
+	/// Whether to use Windows or Unix style line feeds
+	/// 
 	public static String DEFAULT_LINE_FEED = System.lineSeparator();
 
+	///
+	/// The base dir of the project
+	/// 
+	public static Path BASE_PROJECT_DIR;
+
+	///
+	/// The base build directory, usually {@link #BASE_PROJECT_DIR}/build
+	/// 
+	public static Path BUILD_DIR;
+
+	///
+	/// The {@link FilePreprocessor}
+	/// 
 	public static FilePreprocessor fileProcessor;
 
+	///
+	/// The {@link PathLock}
+	/// 
 	public static PathLock pathLock;
 
+	///
+	/// The version of Discombobulator,
+	/// used for the splash in the console
+	/// 
 	private static String discoVersion;
 
 	/**
@@ -61,27 +91,42 @@ public void apply(Project project) {
 		pathLock = new PathLock();
 
 		// Register tasks
+
+		/// preprocessBase	///
 		TaskPreprocessBase baseTask = project.getTasks().register("preprocessBase", TaskPreprocessBase.class).get();
 		baseTask.setGroup("discombobulator");
 		baseTask.setDescription("Split base source into seperate version folders");
 
+		/// preprocessWatch	///
 		TaskPreprocessWatch watchTask = project.getTasks().register("preprocessWatch", TaskPreprocessWatch.class).get();
 		watchTask.setGroup("discombobulator");
 		watchTask.setDescription("Starts a watch session. Preprocesses files into other versions on file change.");
+		watchTask.setProperty("projectName", project.getName());
 
+		/// collectBuilds	///
 		TaskCollectBuilds collectBuilds = project.getTasks().register("collectBuilds", TaskCollectBuilds.class).get();
 		collectBuilds.setGroup("discombobulator");
 		collectBuilds.setDescription("Builds, then collects all versions in root/build");
 
-		List<Task> compileTasks = new ArrayList<>();
+		List<Task> compileTaskList = new ArrayList<>();
+		Map<String, Path> buildDirs = new HashMap<>();
+		for (Project subProject : project.getSubprojects()) {
+			Task compileTask = subProject.getTasksByName("remapJar", false).iterator().next();
+			compileTaskList.add(compileTask);
+
+			buildDirs.put(subProject.getName(), getBuildDir(subProject).resolve("libs"));
+		}
+		collectBuilds.setDependsOn(compileTaskList);
+		collectBuilds.setProperty("buildDirectories", buildDirs);
+
+		/// preprocessVersion ///
 		for (Project subProject : project.getSubprojects()) {
-			compileTasks.add(subProject.getTasksByName("remapJar", false).iterator().next());
 			// Register preprocessVersion task in subProjects
 			TaskPreprocessVersion versionTask = subProject.getTasks().register("preprocessVersion", TaskPreprocessVersion.class).get();
+			versionTask.setProperty("versionDirectory", subProject.getProjectDir());
 			versionTask.setGroup("discombobulator");
 			versionTask.setDescription("Preprocesses this version back to the base folder and to versions other than this one");
 		}
-		collectBuilds.updateCompileTasks(compileTasks);
 
 		// Register preprocessVersion task in root
 		TaskPreprocessVersionError versionTaskRoot = project.getTasks().register("preprocessVersion", TaskPreprocessVersionError.class).get();
@@ -93,11 +138,12 @@ public void apply(Project project) {
 			PORT_LOCK = config.getPort().getOrElse(8762);
 			DISABLE_ANSI = config.getDisableAnsi().getOrElse(false);
 			DEFAULT_LINE_FEED = config.getDefaultLineFeed().getOrElse(System.lineSeparator());
+			BASE_PROJECT_DIR = _project.getProjectDir().toPath();
+			BUILD_DIR = getBuildDir(_project);
 
 			Map<String, Path> versionPairs = null;
-			Path projectDir = _project.getProjectDir().toPath();
 			try {
-				versionPairs = getVersionPairs(projectDir);
+				versionPairs = getVersionPairs(BASE_PROJECT_DIR);
 			} catch (Exception e) {
 				if (e.getMessage() != null && !e.getMessage().isEmpty()) {
 					printError(e.getMessage());
@@ -126,8 +172,9 @@ public void apply(Project project) {
 
 	public static String getSplash() {
 		return "\n" + (DISABLE_ANSI ? getColorLessSplash() : getColoredSplash()) + "\n\n"
-				+ getCenterText(String.format("Now using %sGradle 9", Colors.PURPLE), 9) + "\n"
-				+ "		Created by Pancake and Scribble\n" + getCenterText(discoVersion) + "\n\n";
+				+ getCenterText(String.format("Enable configuration cache today!")) + "\n"
+				+ getCenterText("Created by Pancake and Scribble") + "\n"
+				+ getCenterText(discoVersion) + "\n\n";
 
 	}
 
@@ -162,6 +209,14 @@ private static String getCenterText(String text) {
 		return getCenterText(text, length);
 	}
 
+	/**
+	 * @param project The project to use
+	 * @return The build directory from the project
+	 */
+	public static Path getBuildDir(Project project) {
+		return project.getLayout().getBuildDirectory().get().getAsFile().toPath();
+	}
+
 	/**
 	 * Centers any given text
 	 * 

src/main/java/com/minecrafttas/discombobulator/tasks/TaskCollectBuilds.java

@@ -4,35 +4,35 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
 import java.util.Map.Entry;
 import java.util.stream.Stream;
 
 import org.gradle.api.DefaultTask;
-import org.gradle.api.Project;
-import org.gradle.api.Task;
+import org.gradle.api.provider.MapProperty;
+import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.TaskAction;
 
+import com.minecrafttas.discombobulator.Discombobulator;
+
 /**
  * Builds and moves all built versions into one directory for easier access
  * 
  * @author Pancake
  */
-public class TaskCollectBuilds extends DefaultTask {
+public abstract class TaskCollectBuilds extends DefaultTask {
 
 	/**
 	 * List of all build dirs
 	 */
-	private Map<String, Path> buildDirs = new HashMap<>();
+	@Input
+	abstract MapProperty<String, Path> getBuildDirectories();
 
 	/**
 	 * The main task component
 	 */
 	@TaskAction
 	public void collectBuilds() {
-		Path collectDir = getBuildDir(getProject());
+		Path collectDir = Discombobulator.BUILD_DIR;
 
 		try {
 			if (!Files.exists(collectDir))
@@ -42,7 +42,7 @@ public void collectBuilds() {
 			return;
 		}
 
-		for (Entry<String, Path> entry : buildDirs.entrySet()) {
+		for (Entry<String, Path> entry : getBuildDirectories().get().entrySet()) {
 			Path buildDir = entry.getValue();
 			Stream<Path> stream;
 
@@ -67,25 +67,4 @@ public void collectBuilds() {
 			stream.close();
 		}
 	}
-
-	/**
-	 * Updates this task with all compile tasks
-	 * 
-	 * @param compileTasks List of compile tasks
-	 */
-	public void updateCompileTasks(List<Task> compileTasks) {
-		for (Task task : compileTasks) {
-			Project project = task.getProject();
-			this.buildDirs.put(project.getName(), getBuildDir(project).resolve("libs"));
-		}
-		this.setDependsOn(compileTasks);
-	}
-
-	/**
-	 * @param project The project to use
-	 * @return The build directory from the project
-	 */
-	private Path getBuildDir(Project project) {
-		return project.getLayout().getBuildDirectory().get().getAsFile().toPath();
-	}
 }

src/main/java/com/minecrafttas/discombobulator/tasks/TaskPreprocessBase.java

@@ -42,7 +42,7 @@ public void preprocessBase() throws Exception {
 		lock.tryLock();
 
 		// Prepare list of physical version folders
-		Path baseProjectDir = this.getProject().getProjectDir().toPath();
+		Path baseProjectDir = Discombobulator.BASE_PROJECT_DIR;
 		Map<String, Path> versionsConfig;
 		try {
 			versionsConfig = Discombobulator.getVersionPairs(baseProjectDir);

src/main/java/com/minecrafttas/discombobulator/tasks/TaskPreprocessVersion.java

@@ -11,6 +11,8 @@
 
 import org.apache.commons.io.FilenameUtils;
 import org.gradle.api.DefaultTask;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.tasks.InputDirectory;
 import org.gradle.api.tasks.TaskAction;
 
 import com.minecrafttas.discombobulator.Discombobulator;
@@ -33,7 +35,10 @@
  * 
  * @author Scribble
  */
-public class TaskPreprocessVersion extends DefaultTask {
+public abstract class TaskPreprocessVersion extends DefaultTask {
+
+	@InputDirectory
+	abstract DirectoryProperty getVersionDirectory();
 
 	@TaskAction
 	public void preprocessVersion() throws Exception {
@@ -44,7 +49,7 @@ public void preprocessVersion() throws Exception {
 		lock.tryLock();
 
 		// Prepare list of physical version folders
-		Path baseProjectDir = this.getProject().getParent().getProjectDir().toPath();
+		Path baseProjectDir = Discombobulator.BASE_PROJECT_DIR;
 		Path baseSourceDir = baseProjectDir.resolve("src");
 
 		Map<String, Path> versionsConfig;
@@ -59,7 +64,7 @@ public void preprocessVersion() throws Exception {
 			return;
 		}
 
-		Path versionProjectDir = this.getProject().getProjectDir().toPath();
+		Path versionProjectDir = getVersionDirectory().get().getAsFile().toPath();
 		Pair<String, Path> masterVersion = null;
 		// Find current version in version config
 

src/main/java/com/minecrafttas/discombobulator/tasks/TaskPreprocessWatch.java

@@ -24,6 +24,8 @@
 
 import org.apache.commons.io.FilenameUtils;
 import org.gradle.api.DefaultTask;
+import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.TaskAction;
 
 import com.minecrafttas.discombobulator.Discombobulator;
@@ -40,14 +42,17 @@
  * 
  * @author Pancake, Scribble
  */
-public class TaskPreprocessWatch extends DefaultTask {
+public abstract class TaskPreprocessWatch extends DefaultTask {
 
 	private List<FileWatcherThread> threads = new ArrayList<>();
 
 	private CurrentFilePreprocessAction currentFileAction = null;
 
 	private boolean msgSeen = false;
 
+	@Input
+	abstract Property<String> getProjectName();
+
 	@TaskAction
 	public void preprocessWatch() throws Exception {
 		System.out.println(Discombobulator.getSplash());
@@ -56,7 +61,7 @@ public void preprocessWatch() throws Exception {
 		lock.tryLock();
 
 		// Prepare list of physical version folders
-		Path baseProjectDir = this.getProject().getProjectDir().toPath();
+		Path baseProjectDir = Discombobulator.BASE_PROJECT_DIR;
 
 		LineFeedHelper.printMessage();
 
@@ -122,7 +127,7 @@ private void watchVersion(Path subSourceDir, Map<String, Path> targetSet) {
 			e.printStackTrace();
 		}
 
-		if (version.equals(this.getProject().getName())) {
+		if (version.equals(getProjectName().get())) {
 			version = "Base";
 		}
 
@@ -259,25 +264,22 @@ public void close() {
 		}
 	}
 
-	/// 
 	/// Stores data used for preprocessing the file that was edited most recently.
 	///
-	/// This fixes an issue where the IDE will behave weirdly, when trying to preprocess and replace a file,  
-	/// that is currently being worked on. So when saving a file,  
-	/// The file watcher would also replace the file that you just saved, leading to discrepancies and annoyances.
+	/// This fixes an issue where the IDE will behave weirdly, when trying to
+	/// preprocess and replace a file, that is currently being worked on. So when
+	/// saving a file, The file watcher would also replace the file that you just
+	/// saved, leading to discrepancies and annoyances.
 	///
 	/// With this, you can execute the preprocessing at a later time.
 	///
-	/// @author Scribble
-	///
+	/// @author Scribble ///
 	public static record CurrentFilePreprocessAction(List<String> outLines, Path inFile, Path outFile) {
 	}
 
-	///
 	/// Runs the {@link CurrentFilePreprocessAction}
 	///
-	/// @param currentFileAction The {@link CurrentFilePreprocessAction} to run
-	///
+	/// @param currentFileAction The {@link CurrentFilePreprocessAction} to run ///
 	public static void runFileAction(CurrentFilePreprocessAction currentFileAction) throws IOException {
 		Path outFile = currentFileAction.outFile();
 		List<String> outLines = currentFileAction.outLines();