Refactor BCInfo to load from a file

Still cheap and helps gradle stop unnecessary recompiles

Author: freya022

BotCommands-core/build.gradle.kts

@@ -131,22 +131,16 @@ val generateInfo by tasks.registering(GenerateBCInfoTask::class) {
     outputs.upToDateWhen { false }
 }
 
-ksp {
-    excludedSources.from(generateInfo)
-}
-
 sourceSets {
     main {
-        java {
+        resources {
             srcDir(generateInfo)
-            exclude("**/\$BCInfo.java")
         }
     }
 }
 
 dokka {
     dokkaSourceSets.configureEach {
-        suppressedFiles.from("src/main/java/io/github/freya022/botcommands/api/\$BCInfo.java")
         suppressGeneratedFiles = false
     }
 }

BotCommands-core/src/main/java/io/github/freya022/botcommands/api/$BCInfo.java

@@ -0,0 +1,58 @@
+package io.github.freya022.botcommands.api;
+
+import io.github.freya022.botcommands.api.core.Logging;
+
+import javax.annotation.Nonnull;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.time.Instant;
+import java.util.Properties;
+
+public class BCInfo {
+
+    public static final Instant BUILD_TIME;
+    public static final String VERSION_MAJOR;
+    public static final String VERSION_MINOR;
+    public static final String VERSION_REVISION;
+    public static final String VERSION_CLASSIFIER;
+    public static final String GITHUB = "https://github.com/freya022/BotCommands";
+    /** May be "null", may also be a full commit hash in Jitpack builds */
+    public static final String BRANCH_NAME;
+    /** May be "null" */
+    public static final String COMMIT_HASH;
+    public static final String BUILD_JDA_VERSION;
+
+    @SuppressWarnings("ConstantConditions")
+    public static final String VERSION;
+
+    static {
+        final Properties properties = loadProperties();
+
+        BUILD_TIME = Instant.ofEpochSecond(Long.parseLong(properties.getProperty("BUILD_TIME", "0")));
+        VERSION_MAJOR = properties.getProperty("VERSION_MAJOR", "<major>");
+        VERSION_MINOR = properties.getProperty("VERSION_MINOR", "<minor>");
+        VERSION_REVISION = properties.getProperty("VERSION_REVISION", "<revision>");
+        VERSION_CLASSIFIER = properties.getProperty("VERSION_CLASSIFIER", "<classifier>");
+        BRANCH_NAME = properties.getProperty("BRANCH_NAME", "<branch>");
+        COMMIT_HASH = properties.getProperty("COMMIT_HASH", "<commit>");
+        BUILD_JDA_VERSION = properties.getProperty("BUILD_JDA_VERSION", "<JDA_version>");
+        VERSION = "%s.%s.%s%s%s".formatted(VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION,
+                VERSION_CLASSIFIER.equals("null") ? "" : "-" + VERSION_CLASSIFIER,
+                COMMIT_HASH.equals("null") ? "" : "_" + COMMIT_HASH);
+    }
+
+    @Nonnull
+    private static Properties loadProperties() {
+        final Properties properties = new Properties(8);
+        try (InputStream stream = BCInfo.class.getResourceAsStream("/BCInfo.properties")) {
+            if (stream == null) throw new IOException("Unable to find BCInfo.properties");
+            try (InputStreamReader reader = new InputStreamReader(stream)) {
+                properties.load(reader);
+            }
+        } catch (Exception e) {
+            Logging.getLogger().error("Could not load properties file!", e);
+        }
+        return properties;
+    }
+}

BotCommands-core/src/main/java/io/github/freya022/botcommands/api/BCInfo.java

@@ -1,7 +1,6 @@
 import org.gradle.api.DefaultTask
 import org.gradle.api.provider.ProviderFactory
 import org.gradle.api.tasks.Input
-import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
 import org.gradle.work.DisableCachingByDefault
@@ -11,11 +10,8 @@ import javax.inject.Inject
 @DisableCachingByDefault
 abstract class GenerateBCInfoTask : DefaultTask() {
 
-    @get:InputFile
-    val inputFile = project.layout.projectDirectory.file($$"src/main/java/io/github/freya022/botcommands/api/$BCInfo.java")
-
     @get:OutputDirectory
-    val outputDir = project.layout.buildDirectory.dir("generated/sources/BotCommands/main/java")
+    val outputDir = project.layout.buildDirectory.dir("generated/sources/BotCommands/main/resources")
 
     @get:Input
     val projectDir: String = project.projectDir.absolutePath
@@ -32,26 +28,19 @@ abstract class GenerateBCInfoTask : DefaultTask() {
 
     @TaskAction
     fun run() {
-        val attributes = mapOf(
-            "version-major" to version.major,
-            "version-minor" to version.minor,
-            "version-revision" to version.revision,
-            "version-classifier" to (version.classifier ?: "null"),
-            "branch-name" to (GitUtils.getCommitBranch(logger, providers, projectDir) ?: "null"),
-            "commit-hash" to (GitUtils.getCommitHash(logger, providers, projectDir)?.take(10) ?: "null"),
-            "build-jda-version" to jdaVersion,
-            "build-time" to Instant.now().toEpochMilli().toString(),
-        )
-
-        val initialContent = inputFile.asFile.readText()
-        val filteredContent = initialContent.replaceTokens(attributes).replace($$"$BCInfo", "BCInfo")
-
-        val bcInfoFile = outputDir.get().file("io/github/freya022/botcommands/api/BCInfo.java").asFile
+        val content = """
+            BUILD_TIME = ${Instant.now().toEpochMilli()}
+            VERSION_MAJOR = ${version.major}
+            VERSION_MINOR = ${version.minor}
+            VERSION_REVISION = ${version.revision}
+            VERSION_CLASSIFIER = ${version.classifier ?: "null"}
+            BRANCH_NAME = ${GitUtils.getCommitBranch(logger, providers, projectDir) ?: "null"}
+            COMMIT_HASH = ${GitUtils.getCommitHash(logger, providers, projectDir)?.take(10) ?: "null"}
+            BUILD_JDA_VERSION = $jdaVersion
+        """.trimIndent()
+
+        val bcInfoFile = outputDir.get().file("BCInfo.properties").asFile
         bcInfoFile.parentFile.mkdirs()
-        bcInfoFile.writeText(filteredContent)
-    }
-
-    private fun String.replaceTokens(map: Map<String, String>): String {
-        return map.entries.fold(this) { current, (key, value) -> current.replace("@$key@", value) }
+        bcInfoFile.writeText(content)
     }
 }