Processing Plugin tests & Refactor

Stefterv · Stefterv · commit 7379166bc482 · 2025-07-08T10:26:16.000+02:00
diff --git a/app/src/processing/app/gradle/GradleJob.kt b/app/src/processing/app/gradle/GradleJob.kt
@@ -33,7 +33,9 @@ import java.nio.file.Path
 import kotlin.io.path.deleteIfExists
 import kotlin.io.path.writeText
 
-// Starts a gradle job to run the sketch
+/*
+* The gradle job runs the gradle tasks and manages the gradle connection
+ */
 class GradleJob(
     vararg val tasks: String,
     val workingDir: Path,
@@ -231,16 +233,18 @@ class GradleJob(
         }
     }
 
-    fun launchJob(block: suspend CoroutineScope.() -> Unit){
-        val job = scope.launch { block() }
-        jobs.add(job)
-    }
+
 
     fun cancel(){
         cancel.cancel()
         jobs.forEach(Job::cancel)
     }
 
+    private fun launchJob(block: suspend CoroutineScope.() -> Unit){
+        val job = scope.launch { block() }
+        jobs.add(job)
+    }
+
     // Handle exception thrown by Gradle
     private fun handleExceptions(action: () -> Unit){
         try{
@@ -278,6 +282,7 @@ class GradleJob(
         }
     }
 
+    // TODO: Move to separate file
     private fun BuildLauncher.addStateListener(){
         addProgressListener(ProgressListener { event ->
             if(event is TaskStartEvent) {
diff --git a/java/gradle/build.gradle.kts b/java/gradle/build.gradle.kts
@@ -7,6 +7,7 @@ plugins{
 
 repositories {
     mavenCentral()
+    maven("https://jogamp.org/deployment/maven")
 }
 
 dependencies{
@@ -16,9 +17,11 @@ dependencies{
     implementation(libs.kotlinGradlePlugin)
     implementation(libs.kotlinComposePlugin)
 
+    testImplementation(project(":core"))
     testImplementation(libs.junit)
 }
 
+// TODO: CI/CD for publishing the plugin to the Gradle Plugin Portal
 gradlePlugin{
     plugins{
         create("processing"){
diff --git a/java/gradle/src/main/kotlin/LibrariesTask.kt b/java/gradle/src/main/kotlin/LibrariesTask.kt
@@ -17,6 +17,7 @@ This task stores the resulting information in a file that can be used later to r
  */
 abstract class LibrariesTask : DefaultTask() {
 
+    // TODO: Allow multiple directories
     @InputDirectory
     @Optional
     val librariesDirectory: DirectoryProperty = project.objects.directoryProperty()
@@ -41,6 +42,9 @@ abstract class LibrariesTask : DefaultTask() {
     fun execute() {
         if (!librariesDirectory.isPresent) {
             logger.error("Libraries directory is not set. Libraries will not be imported.")
+            val meta = ObjectOutputStream(librariesMetaData.get().asFile.outputStream())
+            meta.writeObject(arrayListOf<Library>())
+            meta.close()
             return
         }
         val libraries = librariesDirectory.get().asFile
diff --git a/java/gradle/src/main/kotlin/PDETask.kt b/java/gradle/src/main/kotlin/PDETask.kt
@@ -7,14 +7,15 @@ import org.gradle.work.InputChanges
 import processing.mode.java.preproc.PdePreprocessor
 import java.io.File
 import java.io.ObjectOutputStream
+import java.io.Serializable
 import java.util.concurrent.Callable
 import java.util.jar.JarFile
 import javax.inject.Inject
 
 
 // TODO: Generate sourcemaps
 /*
-* The PDETask is the main task that processes the .pde files and generates the Java source code
+* The PDETask is the main task that processes the .pde files and generates the Java source code through the PdePreprocessor.
  */
 abstract class PDETask : SourceTask() {
     @get:InputFiles
@@ -24,21 +25,13 @@ abstract class PDETask : SourceTask() {
     open val stableSources: FileCollection = project.files(Callable<Any> { this.source })
 
     @OutputDirectory
-    val outputDirectory = project.objects.directoryProperty()
-
-    @get:Input
-    @get:Optional
-    var workingDir: String? = null
+    val outputDirectory: DirectoryProperty = project.objects.directoryProperty()
 
     @get:Input
     var sketchName: String = "processing"
 
-    @get:Input
-    @get:Optional
-    var sketchBook: String? = null
-
     @OutputFile
-    val sketchMetaData = project.objects.fileProperty()
+    val sketchMetaData: RegularFileProperty = project.objects.fileProperty()
 
     init{
         outputDirectory.convention(project.layout.buildDirectory.dir("generated/pde"))
@@ -49,18 +42,16 @@ abstract class PDETask : SourceTask() {
         val sketchName: String,
         val sketchRenderer: String?,
         val importStatements: List<String>
-    ) : java.io.Serializable
+    ) : Serializable
 
     @TaskAction
     fun execute() {
-        // TODO: Allow pre-processor to run on individual files (future)
-        // TODO: Only compare file names from both defined roots (e.g. sketch.pde and folder/sketch.pde should both be included)
-
         // Using stableSources since we can only run the pre-processor on the full set of sources
         val combined = stableSources
             .files
             .groupBy { it.name }
             .map { entry ->
+                // TODO: Select by which one is in the unsaved folder
                 entry.value.maxByOrNull { it.lastModified() }!!
             }
             .joinToString("\n"){
@@ -74,6 +65,8 @@ abstract class PDETask : SourceTask() {
             .build()
             .write(javaFile, combined)
 
+        // TODO: Save the edits to meta files
+
         javaFile.flush()
         javaFile.close()
 
@@ -87,10 +80,4 @@ abstract class PDETask : SourceTask() {
         metaFile.writeObject(sketchMeta)
         metaFile.close()
     }
-
-    @get:Inject
-    open val deleter: Deleter
-        get() {
-            throw UnsupportedOperationException("Decorator takes care of injection")
-        }
 }
diff --git a/java/gradle/src/main/kotlin/ProcessingPlugin.kt b/java/gradle/src/main/kotlin/ProcessingPlugin.kt
@@ -17,7 +17,6 @@ import java.net.Socket
 import java.util.*
 import javax.inject.Inject
 
-// TODO: CI/CD for publishing the plugin
 class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFactory) : Plugin<Project> {
     override fun apply(project: Project) {
         val sketchName = project.layout.projectDirectory.asFile.name.replace(Regex("[^a-zA-Z0-9_]"), "_")
@@ -32,6 +31,7 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
 
         // TODO: Setup sketchbook when using as a standalone plugin, use the Java Preferences
         val sketchbook = project.findProperty("processing.sketchbook") as String?
+        val settings = project.findProperty("processing.settings") as String?
 
         // Apply the Java plugin to the Project
         project.plugins.apply(JavaPlugin::class.java)
@@ -46,13 +46,12 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
             project.tasks.findByName("wrapper")?.enabled = false
         }
 
-        // Add the compose plugin to wrap the sketch in an executable
-        project.plugins.apply("org.jetbrains.compose")
-
         // Add kotlin support
         project.plugins.apply("org.jetbrains.kotlin.jvm")
         // Add jetpack compose support
         project.plugins.apply("org.jetbrains.kotlin.plugin.compose")
+        // Add the compose plugin to wrap the sketch in an executable
+        project.plugins.apply("org.jetbrains.compose")
 
         // Add the Processing core library (within Processing from the internal maven repo and outside from the internet)
         project.dependencies.add("implementation", "$processingGroup:core:${processingVersion}")
@@ -129,8 +128,7 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
 
         }
 
-        project.extensions.getByType(JavaPluginExtension::class.java).sourceSets.all { sourceSet ->
-            // For each java source set (mostly main) add a new source set for the PDE files
+        project.extensions.getByType(JavaPluginExtension::class.java).sourceSets.first().let{ sourceSet ->
             val pdeSourceSet = objectFactory.newInstance(
                 DefaultPDESourceDirectorySet::class.java,
                 objectFactory.sourceDirectorySet("${sourceSet.name}.pde", "${sourceSet.name} Processing Source")
@@ -142,43 +140,37 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
                 srcDir("$workingDir/unsaved")
             }
             sourceSet.allSource.source(pdeSourceSet)
+            sourceSet.java.srcDir(project.layout.projectDirectory).apply {
+                include("**/*.java")
+                exclude("${project.layout.buildDirectory.asFile.get()}/**/*")
+            }
 
             val librariesTaskName = sourceSet.getTaskName("scanLibraries", "PDE")
             val librariesScan = project.tasks.register(librariesTaskName, LibrariesTask::class.java) { task ->
                 task.description = "Scans the libraries in the sketchbook"
                 task.librariesDirectory.set(sketchbook?.let { File(it, "libraries") })
+                // TODO: Save the libraries metadata to settings folder to share between sketches
             }
 
             val pdeTaskName = sourceSet.getTaskName("preprocess", "PDE")
             val pdeTask = project.tasks.register(pdeTaskName, PDETask::class.java) { task ->
                 task.description = "Processes the ${sourceSet.name} PDE"
                 task.source = pdeSourceSet
                 task.sketchName = sketchName
-                task.workingDir = workingDir
-                task.sketchBook = sketchbook
 
                 // Set the output of the pre-processor as the input for the java compiler
                 sourceSet.java.srcDir(task.outputDirectory)
-
-                task.doLast {
-                    // Copy java files from the root to the generated directory
-                    project.copy { copyTask ->
-                        copyTask.from(project.layout.projectDirectory){ from ->
-                            from.include("*.java")
-                        }
-                        copyTask.into(task.outputDirectory)
-                    }
-                }
             }
 
             val depsTaskName = sourceSet.getTaskName("addLegacyDependencies", "PDE")
             project.tasks.register(depsTaskName, DependenciesTask::class.java){ task ->
+                task.librariesMetaData
                 task.dependsOn(pdeTask, librariesScan)
+                // TODO: Save the libraries metadata to settings folder to share between sketches
             }
 
-            project.tasks.named(
-                sourceSet.compileJavaTaskName
-            ) { task ->
+            // Make sure that the PDE task runs before the java compilation task
+            project.tasks.named(sourceSet.compileJavaTaskName) { task ->
                 task.dependsOn(pdeTaskName, depsTaskName)
             }
         }
diff --git a/java/gradle/src/test/kotlin/ProcessingPluginTest.kt b/java/gradle/src/test/kotlin/ProcessingPluginTest.kt
