Completed the examples & sketchbook scanning

Author: Stefterv

app/src/processing/app/api/Contributions.kt

@@ -3,10 +3,9 @@ package processing.app.api
 import com.github.ajalt.clikt.command.SuspendingCliktCommand
 import com.github.ajalt.clikt.core.Context
 import com.github.ajalt.clikt.core.subcommands
-import kotlinx.serialization.Serializable
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
-import processing.app.Base
+import processing.app.Platform
 import processing.app.api.Sketch.Companion.getSketches
 import java.io.File
 
@@ -37,27 +36,109 @@ class Contributions: SuspendingCliktCommand(){
 
         override fun help(context: Context) = "List all examples"
         override suspend fun run() {
-
-            val examplesFolder = Base.getSketchbookExamplesFolder()
-
+            Platform.init()
             // TODO: Decouple modes listing from `Base` class, defaulting to Java mode for now
+            // TODO: Allow the user to change the sketchbook location
+            // TODO: Currently blocked since `Base.getSketchbookFolder()` is not available in headless mode
+            val sketchbookFolder = Platform.getDefaultSketchbookFolder()
             val resourcesDir = System.getProperty("compose.application.resources.dir")
+
             val javaMode = "$resourcesDir/modes/java"
-            val javaModeExamples = "$javaMode/examples"
 
-            val javaExamples = getSketches(File(javaModeExamples))
+            val javaModeExamples = File("$javaMode/examples")
+                .listFiles()
+                ?.map { getSketches(it)}
+                ?: emptyList()
 
-            val json = serializer.encodeToString(listOf(javaExamples))
-            println(json)
+            val javaModeLibrariesExamples = File("$javaMode/libraries")
+                .listFiles{ it.isDirectory }
+                ?.map { library ->
+                    val properties = library.resolve("library.properties")
+                    val name = findNameInProperties(properties) ?: library.name
+
+                    val libraryExamples = getSketches(library.resolve("examples"))
+                    Sketch.Companion.Folder(
+                        type = "folder",
+                        name = name,
+                        path = library.absolutePath,
+                        mode = "java",
+                        children = libraryExamples?.children ?: emptyList(),
+                        sketches = libraryExamples?.sketches ?: emptyList()
+                    )
+                } ?: emptyList()
+            val javaModeLibraries = Sketch.Companion.Folder(
+                type = "folder",
+                name = "Libraries",
+                path = "$javaMode/libraries",
+                mode = "java",
+                children = javaModeLibrariesExamples,
+                sketches = emptyList()
+            )
 
-            // Build-in examples for each mode
-            // Get examples for core libraries
+            val contributedLibraries = sketchbookFolder.resolve("libraries")
+                .listFiles{ it.isDirectory }
+                ?.map { library ->
+                    val properties = library.resolve("library.properties")
+                    val name = findNameInProperties(properties) ?: library.name
+                    // Get library name from library.properties if it exists
+                    val libraryExamples = getSketches(library.resolve("examples"))
+                    Sketch.Companion.Folder(
+                        type = "folder",
+                        name = name,
+                        path = library.absolutePath,
+                        mode = "java",
+                        children = libraryExamples?.children ?: emptyList(),
+                        sketches = libraryExamples?.sketches ?: emptyList()
+                    )
+                } ?: emptyList()
 
-            // Examples downloaded in the sketchbook
-            // Library contributions
-            // Mode examples
+            val contributedLibrariesFolder = Sketch.Companion.Folder(
+                type = "folder",
+                name = "Contributed Libraries",
+                path = sketchbookFolder.resolve("libraries").absolutePath,
+                mode = "java",
+                children = contributedLibraries,
+                sketches = emptyList()
+            )
+
+            val contributedExamples = sketchbookFolder.resolve("examples")
+                .listFiles{ it.isDirectory }
+                ?.map {
+                    val properties = it.resolve("examples.properties")
+                    val name = findNameInProperties(properties) ?: it.name
+
+                    val sketches = getSketches(it.resolve("examples"))
+                    Sketch.Companion.Folder(
+                        type = "folder",
+                        name,
+                        path = it.absolutePath,
+                        mode = "java",
+                        children = sketches?.children ?: emptyList(),
+                        sketches = sketches?.sketches ?: emptyList(),
+                    )
+                }
+                ?: emptyList()
+            val contributedExamplesFolder = Sketch.Companion.Folder(
+                type = "folder",
+                name = "Contributed Examples",
+                path = sketchbookFolder.resolve("examples").absolutePath,
+                mode = "java",
+                children = contributedExamples,
+                sketches = emptyList()
+            )
+
+            val json = serializer.encodeToString(javaModeExamples + javaModeLibraries + contributedLibrariesFolder + contributedExamplesFolder)
+            println(json)
         }
 
+        private fun findNameInProperties(properties: File): String? {
+            if (!properties.exists()) return null
 
+            return  properties.readLines().firstNotNullOfOrNull { line ->
+                line.split("=", limit = 2)
+                    .takeIf { it.size == 2 && it[0].trim() == "name" }
+                    ?.let { it[1].trim() }
+            }
+        }
     }
 }

app/src/processing/app/api/Sketch.kt

@@ -23,17 +23,19 @@ class Sketch {
             val sketches: List<Sketch> = emptyList()
         )
 
-        fun getSketches(file: File, filter: (File) -> Boolean = { true }): Folder {
+        fun getSketches(file: File, filter: (File) -> Boolean = { true }): Folder? {
             val name = file.name
             val (sketchesFolders, childrenFolders) = file.listFiles()?.filter (File::isDirectory)?.partition { isSketchFolder(it) } ?: return Folder(
                 name = name,
                 path = file.absolutePath,
                 sketches = emptyList(),
                 children = emptyList()
             )
-
-            val children = childrenFolders.filter(filter) .map { getSketches(it) }
+            val children = childrenFolders.filter(filter).mapNotNull { getSketches(it) }
             val sketches = sketchesFolders.map { Sketch(name = it.name, path = it.absolutePath) }
+            if(sketches.isEmpty() && children.isEmpty()) {
+                return null
+            }
             return Folder(
                 name = name,
                 path = file.absolutePath,

app/src/processing/app/api/Sketchbook.kt

@@ -34,7 +34,15 @@ class Sketchbook: SuspendingCliktCommand() {
             // TODO: Currently blocked since `Base.getSketchbookFolder()` is not available in headless mode
             val sketchbookFolder = Platform.getDefaultSketchbookFolder()
 
-            val sketches = getSketches(sketchbookFolder)
+            val sketches = getSketches(sketchbookFolder) {
+                !listOf(
+                    "android",
+                    "modes",
+                    "tools",
+                    "examples",
+                    "libraries"
+                ).contains(it.name)
+            }
             val json = serializer.encodeToString(listOf(sketches))
             println(json)
         }