Add task preprocessVersion (#26)

- Add preprocessVersion
- Add disableAnsi
- Fix errors
- Improved messages

Author: ScribbleTAS

.github/workflows/test.yml

@@ -11,16 +11,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Set up JDK 22 for x64
+    - name: Set up JDK 23 for x64
       uses: actions/setup-java@v4
       with:
-        java-version: '22'
+        java-version: '23'
         distribution: 'temurin'
         architecture: x64
     - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v3
+      uses: gradle/actions/setup-gradle@v4
       with:
-        gradle-version: 8.10.2
+        gradle-version: 8.12.1
     - name: Build
       run: gradle build
     - name: Upload Test Report

Test/build.gradle

@@ -9,4 +9,6 @@ discombobulator {
 	]
 
 	ignoredFileFormats = ["*.png"]
+	
+	disableAnsi = false
 }

build.gradle

@@ -4,8 +4,8 @@ plugins {
 	id 'maven-publish'
 }
 
-// Change java compatibility level to 22
-sourceCompatibility = targetCompatibility = 22
+// Change java compatibility level to 23
+sourceCompatibility = targetCompatibility = 23
 
 // Name, version and group for the project
 version = "1.3-SNAPSHOT"

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

@@ -32,6 +32,7 @@
 import com.minecrafttas.discombobulator.tasks.TaskCollectBuilds;
 import com.minecrafttas.discombobulator.tasks.TaskPreprocessBase;
 import com.minecrafttas.discombobulator.tasks.TaskPreprocessVersion;
+import com.minecrafttas.discombobulator.tasks.TaskPreprocessVersionError;
 import com.minecrafttas.discombobulator.tasks.TaskPreprocessWatch;
 import com.minecrafttas.discombobulator.utils.Colors;
 import com.minecrafttas.discombobulator.utils.PathLock;
@@ -47,6 +48,8 @@ public class Discombobulator implements Plugin<Project> {
 
 	public static PreprocessingConfiguration config;
 
+	public static boolean DISABLE_ANSI = false;
+
 	public static FilePreprocessor fileProcessor;
 
 	public static PathLock pathLock;
@@ -79,16 +82,22 @@ public void apply(Project project) {
 		List<Task> compileTasks = new ArrayList<>();
 		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.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();
+		versionTaskRoot.setGroup("discombobulator");
+		versionTaskRoot.setDescription("Do not use this task! Use it in subprojects!");
+
 		project.afterEvaluate(_project -> {
 			boolean inverted = config.getInverted().getOrElse(false);
 			PORT_LOCK = config.getPort().getOrElse(8762);
+			DISABLE_ANSI = config.getDisableAnsi().getOrElse(false);
 
 			Map<String, Path> versionPairs = null;
 			Path projectDir = _project.getProjectDir().toPath();

src/main/java/com/minecrafttas/discombobulator/extensions/PreprocessingConfiguration.java

@@ -48,6 +48,12 @@ public abstract class PreprocessingConfiguration {
 	 */
 	public abstract Property<Boolean> getInverted();
 
+	/**
+	 * If true, disables ANSI colors
+	 * @return
+	 */
+	public abstract Property<Boolean> getDisableAnsi();
+
 	/**
 	 * The port for the port lock
 	 * @return The port number

src/main/java/com/minecrafttas/discombobulator/processor/FilePreprocessor.java

@@ -18,10 +18,10 @@
 import org.apache.commons.io.filefilter.WildcardFileFilter;
 
 import com.minecrafttas.discombobulator.Discombobulator;
+import com.minecrafttas.discombobulator.tasks.TaskPreprocessWatch.CurrentFilePreprocessAction;
 import com.minecrafttas.discombobulator.utils.BetterFileWalker;
 import com.minecrafttas.discombobulator.utils.LineFeedHelper;
 import com.minecrafttas.discombobulator.utils.SafeFileOperations;
-import com.minecrafttas.discombobulator.utils.Triple;
 
 public class FilePreprocessor {
 
@@ -33,6 +33,15 @@ public FilePreprocessor(LinePreprocessor processor, WildcardFileFilter fileFilte
 		this.fileFilter = fileFilter;
 	}
 
+	/**
+	 * Preprocesses a single file into the target version
+	 * 
+	 * @param inFile The path to the file that will be preprocessed  
+	 * @param outFile The path to the file where the preprocessed file will be stored stored
+	 * @param version The target version to preprocess to. null if the target is the base source
+	 * @param extension The file extension (e.g. ".java") of the file
+	 * @throws Exception If the preprocessing fails
+	 */
 	public void preprocessFile(Path inFile, Path outFile, String version, String extension) throws Exception {
 
 //		System.out.println(inFile);
@@ -58,6 +67,13 @@ public void preprocessFile(Path inFile, Path outFile, String version, String ext
 			return;
 		}
 
+		String targetVersion = version;
+		if (targetVersion == null) {
+			targetVersion = "Base";
+		}
+
+		System.out.println(String.format("into version %s%s%s", CYAN, targetVersion, WHITE));
+
 		if (fileFilter != null && fileFilter.accept(inFile.toFile())) {
 			System.out.println(String.format("Ignoring %s%s%s", YELLOW, inFile.getFileName().toString(), WHITE));
 			Files.copy(inFile, outFile, StandardCopyOption.REPLACE_EXISTING);
@@ -69,20 +85,30 @@ public void preprocessFile(Path inFile, Path outFile, String version, String ext
 		preprocessLines(linesToProcess, outFile, version, extension);
 	}
 
-	public Triple<List<String>, Path, Path> /*<- TODO Change to it's own class*/ preprocessVersions(Path inFile, Map<String, Path> versions, String extension, Path currentDir, boolean verbose) throws Exception {
+	/**
+	 * Preprocess a file into multiple target versions
+	 * 
+	 * @param inFile The file to preprocess
+	 * @param versions The mapped versions to preprocess to.
+	 * @param extension The file extension (e.g. ".java") of the file
+	 * @param currentVersionDir The current version directory that where the file that is being worked on lies.<br>
+	 * Used for checking if you are trying to preprocess into the current directory, which can lead to issues otherwise.
+	 * @param verbose If more info should be printed to the console
+	 * @return The {@link CurrentFilePreprocessAction}
+	 * @throws Exception If the preprocessing fails
+	 */
+	public CurrentFilePreprocessAction preprocessVersions(Path inFile, Map<String, Path> versions, String extension, Path currentVersionDir, boolean verbose) throws Exception {
 
-		Path relativeInFile = currentDir.relativize(inFile);
+		Path relativeInFile = currentVersionDir.relativize(inFile);
 		System.out.println(String.format("Preprocessing %s%s%s%s%s", relativeInFile.getParent(), File.separator, PURPLE, relativeInFile.getFileName().toString(), WHITE));
 
 		boolean ignored = fileFilter != null && fileFilter.accept(inFile.toFile());
 
 		List<String> linesToProcess = null;
 		if (!ignored)
 			linesToProcess = Files.readAllLines(inFile);
-		else
-			System.out.println(String.format("Ignoring %s%s%s", YELLOW, inFile.getFileName().toString(), WHITE));
 
-		Triple<List<String>, Path, Path> out = null;
+		CurrentFilePreprocessAction out = null;
 
 		// Iterate through all versions
 		for (Entry<String, Path> versionPair : versions.entrySet()) {
@@ -91,10 +117,15 @@ public void preprocessFile(Path inFile, Path outFile, String version, String ext
 			Path targetSubSourceDir = targetProject.resolve("src");
 			Path outFile = targetSubSourceDir.resolve(relativeInFile);
 
+			// Stop certain file types to be preprocessed (e.g. ".png")
 			if (ignored) {
+				if (targetSubSourceDir.equals(currentVersionDir)) {
+					continue;
+				}
 				if (verbose) {
 					System.out.println(String.format("into version %s%s%s", CYAN, versionName, WHITE));
 				}
+				System.out.println(String.format("Ignoring %s%s%s", YELLOW, inFile.getFileName().toString(), WHITE));
 				Files.copy(inFile, outFile, StandardCopyOption.REPLACE_EXISTING);
 				continue;
 			}
@@ -103,8 +134,8 @@ public void preprocessFile(Path inFile, Path outFile, String version, String ext
 			List<String> outLines = processor.preprocess(versionName, linesToProcess, extension);
 
 			// If the version equals the original version, then skip it
-			if (targetSubSourceDir.equals(currentDir)) {
-				out = Triple.of(outLines, inFile, outFile);
+			if (targetSubSourceDir.equals(currentVersionDir)) {
+				out = new CurrentFilePreprocessAction(outLines, inFile, outFile);
 				continue;
 			}
 
@@ -127,22 +158,32 @@ public void preprocessFile(Path inFile, Path outFile, String version, String ext
 	 */
 	public List<String> preprocessLines(List<String> inLines, Path outFile, String version, String extension) throws Exception {
 		List<String> lines = processor.preprocess(version, inLines, extension);
+		writeLines(lines, outFile);
+		return lines;
+	}
 
+	///
+	/// 1. Locks the file to stop the filewatcher from detecting it
+	/// 2. Creates any missing directories
+	/// 3. Writes the lines with the line feed specified by the `line.seperator` system property
+	///
+	/// @param inLines
+	/// @param outFile
+	/// @throws Exception
+	///
+	private void writeLines(List<String> inLines, Path outFile) throws Exception {
 		// Lock the file
 		Discombobulator.pathLock.scheduleAndLock(outFile);
-
 		// Write file and update last modified date
 		Files.createDirectories(outFile.getParent());
 
 		StringBuilder stringBuilder = new StringBuilder();
 		String linefeed = LineFeedHelper.newLine();
-		for (String line : lines) {
+		for (String line : inLines) {
 			stringBuilder.append(line);
 			stringBuilder.append(linefeed);
 		}
 		Files.write(outFile, stringBuilder.toString().getBytes());
-
-		return lines;
 	}
 
 	/**
@@ -183,4 +224,5 @@ public LinePreprocessor getLineProcessor() {
 	public WildcardFileFilter getFileFilter() {
 		return fileFilter;
 	}
+
 }

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

@@ -1,11 +1,96 @@
 package com.minecrafttas.discombobulator.tasks;
 
+import java.nio.charset.MalformedInputException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import org.apache.commons.io.FilenameUtils;
 import org.gradle.api.DefaultTask;
 import org.gradle.api.tasks.TaskAction;
 
+import com.minecrafttas.discombobulator.Discombobulator;
+import com.minecrafttas.discombobulator.tasks.TaskPreprocessWatch.CurrentFilePreprocessAction;
+import com.minecrafttas.discombobulator.utils.BetterFileWalker;
+import com.minecrafttas.discombobulator.utils.LineFeedHelper;
+import com.minecrafttas.discombobulator.utils.Pair;
+import com.minecrafttas.discombobulator.utils.SocketLock;
+
+/**
+ * Task for preprocessing one version into all other versions including the base source
+ * 
+ * @author Scribble
+ */
 public class TaskPreprocessVersion extends DefaultTask {
 
 	@TaskAction
-	public void preprocessVersion() {
+	public void preprocessVersion() throws Exception {
+		System.out.println(Discombobulator.getSplash());
+
+		// Lock port
+		SocketLock lock = new SocketLock(Discombobulator.PORT_LOCK);
+		lock.tryLock();
+
+		// Prepare list of physical version folders
+		Path baseProjectDir = this.getProject().getParent().getProjectDir().toPath();
+		Path baseSourceDir = baseProjectDir.resolve("src");
+
+		Map<String, Path> versionsConfig;
+		try {
+			versionsConfig = Discombobulator.getVersionPairs(baseProjectDir);
+		} catch (Exception e) {
+			if (e.getMessage() != null && !e.getMessage().isEmpty()) {
+				Discombobulator.printError(e.getMessage());
+			} else {
+				e.printStackTrace();
+			}
+			return;
+		}
+
+		Path versionProjectDir = this.getProject().getProjectDir().toPath();
+		Pair<String, Path> masterVersion = null;
+		// Find current version in version config
+
+		for (Entry<String, Path> entry : versionsConfig.entrySet()) {
+			if (entry.getValue().equals(versionProjectDir)) {
+				masterVersion = Pair.of(entry.getKey(), entry.getValue());
+			}
+		}
+
+		if (masterVersion == null) {
+			throw new Exception("Version could not be found in build.gradle");
+		}
+
+		LineFeedHelper.printMessage();
+
+		System.out.println(String.format("Preprocessing version %s...", masterVersion.left()));
+
+		Path versionSourceDir = versionProjectDir.resolve("src");
+		if (!Files.exists(versionSourceDir))
+			throw new RuntimeException("Base source folder not found");
+
+		BetterFileWalker.walk(versionSourceDir, path -> {
+			Path inFile = versionSourceDir.resolve(path);
+			String extension = FilenameUtils.getExtension(path.getFileName().toString());
+
+			try {
+				// Preprocess version dir
+				CurrentFilePreprocessAction action = Discombobulator.fileProcessor.preprocessVersions(inFile, versionsConfig, extension, versionSourceDir, true);
+				TaskPreprocessWatch.runFileAction(action);
+
+				// Preprocess in base dir
+				Path outFile = baseSourceDir.resolve(path);
+				Discombobulator.fileProcessor.preprocessFile(inFile, outFile, null, extension);
+			} catch (MalformedInputException e) {
+				Discombobulator.printError(String.format("Can't process file, probably not a text file...\n Maybe add ignoredFileFormats = [\"*.%s\"] to the build.gradle?", extension), path.getFileName().toString());
+				e.printStackTrace();
+				return;
+			} catch (Exception e) {
+				Discombobulator.printError(e.getMessage(), path.getFileName().toString());
+				e.printStackTrace();
+				return;
+			}
+		});
 	}
 }

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

@@ -0,0 +1,23 @@
+package com.minecrafttas.discombobulator.tasks;
+
+import org.gradle.api.DefaultTask;
+import org.gradle.api.tasks.TaskAction;
+
+/**
+ * <p>Task class for stopping a task.
+ * <p>{@link TaskPreprocessVersion} is intended for <strong>subprojects only!</strong><br>
+ * And since gradle is such a cool program, it automatically creates a task in the root project as well,<br>
+ * that you can not disable apparently.
+ * <p>But you can register separate tasks to the root project, that will execute before everything else, so to stop it,<br>
+ * we just need to throw an exception and it will stop all following tasks. Thanks Gradle! 
+ */
+public class TaskPreprocessVersionError extends DefaultTask {
+
+	@TaskAction
+	public void preprocessVersion() throws Exception {
+		throw new Exception("\n\n!!!!!!!!!! Do not use this task on the root project !!!!!!!!!!\n\n"
+				+ "This task is intended for subprojects only,\n"
+				+ "so this exception will stop it from running on all subprojects.\n"
+				+ "This was the only way I could find to disable the task for the root project, thanks Gradle!\n");
+	}
+}