Replace org:immutables with JDK records (#209)

* Replace org:immutables with JDK records

* Preserve libraries order to improve reproducibility

Author: Yeregorix

build.gradle.kts

@@ -12,7 +12,6 @@ plugins {
     alias(libs.plugins.gradlePluginPublish)
     alias(libs.plugins.indra.publishing.gradlePlugin)
     alias(libs.plugins.blossom)
-    alias(libs.plugins.eclipseApt)
 }
 
 group = "org.spongepowered"
@@ -55,9 +54,6 @@ dependencies {
     implementation(libs.gson)
 
     compileOnlyApi(libs.checkerQual)
-    annotationProcessor(libs.immutables.value)
-    compileOnlyApi(variantOf(libs.immutables.value) { classifier("annotations") })
-    api(libs.immutables.gson)
 
     // IDE support
     implementation(libs.ideaExt)

gradle/libs.versions.toml

@@ -7,7 +7,6 @@ asm = "9.9.1"
 checker = "3.52.1"
 vineFlower = "1.11.2"
 ideaExt = "1.3"
-immutables = "2.10.1"
 indra = "4.0.0"
 junit = "5.14.1"
 mergeTool = "1.2.3"
@@ -25,8 +24,6 @@ asm-util = { module = "org.ow2.asm:asm-util", version.ref = "asm" }
 vineFlower = { module = "org.vineflower:vineflower", version.ref = "vineFlower" }
 gson = { module = "com.google.code.gson:gson", version = "2.13.2" }
 ideaExt = { module = "gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext", version.ref = "ideaExt" }
-immutables-value = { module = "org.immutables:value", version.ref = "immutables" }
-immutables-gson = { module = "org.immutables:gson", version.ref = "immutables" }
 junit-api = { module = "org.junit.jupiter:junit-jupiter-api" }
 junit-bom = { module = "org.junit:junit-bom", version.ref = "junit" }
 junit-engine = { module = "org.junit.jupiter:junit-jupiter-engine" }
@@ -37,7 +34,6 @@ mammoth = { module = "net.kyori:mammoth", version.ref = "mammoth" }
 
 [plugins]
 blossom = { id = "net.kyori.blossom", version = "2.2.0" }
-eclipseApt = { id = "com.diffplug.eclipse.apt", version = "4.4.1" }
 gradlePluginPublish = { id = "com.gradle.plugin-publish", version = "2.0.0" }
 ideaExt = { id = "org.jetbrains.gradle.plugin.idea-ext", version.ref = "ideaExt" }
 indra = { id = "net.kyori.indra", version.ref = "indra" }

src/main/java/org/spongepowered/gradle/vanilla/internal/Constants.java

@@ -171,8 +171,8 @@ private Configurations() {
      * Extra dependencies that are injected into the project.
      */
     public static final Set<GroupArtifactVersion> INJECTED_DEPENDENCIES = Set.of(
-        GroupArtifactVersion.of("com.google.code.findbugs", "jsr305", "3.0.2"),
-        GroupArtifactVersion.of("org.jetbrains", "annotations", "23.0.0") // 1.18+ only technically
+        new GroupArtifactVersion("com.google.code.findbugs", "jsr305", "3.0.2"),
+        new GroupArtifactVersion("org.jetbrains", "annotations", "23.0.0") // 1.18+ only technically
     );
 
     private Constants() {

src/main/java/org/spongepowered/gradle/vanilla/internal/bundler/BundleElement.java

@@ -24,51 +24,15 @@
  */
 package org.spongepowered.gradle.vanilla.internal.bundler;
 
-import org.immutables.value.Value;
-
 /**
  * A single entry in a bundle.
  *
  * <p>In bundle format version {@code 1.0}, these elements are declared as
  * rows of tab-separated values.</p>
+ *
+ * @param sha256 The expected SHA-265 hash of the file in the jar.
+ * @param id The maven coordinates corresponding to this artifact.
+ * @param path The path of the index entry in the jar.
  */
-@Value.Immutable
-public interface BundleElement {
-
-    /**
-     * Create a new bundle element.
-     *
-     * @param sha256 the sha-265 hash
-     * @param id the ID of the bundle element
-     * @param path the path in the jar
-     * @return a new element
-     */
-    static BundleElement of(final String sha256, final String id, final String path) {
-        return new BundleElementImpl(sha256, id, path);
-    }
-
-    /**
-     * The expected hash of the file in the jar.
-     *
-     * @return SHA-265 hash string
-     */
-    @Value.Parameter
-    String sha256();
-
-    /**
-     * The maven coordinates corresponding to this artifact.
-     *
-     * @return the maven coordinates
-     */
-    @Value.Parameter
-    String id();
-
-    /**
-     * The path of the index entry in the jar.
-     *
-     * @return the path relative to the jar
-     */
-    @Value.Parameter
-    String path();
-
+public record BundleElement(String sha256, String id, String path) {
 }

src/main/java/org/spongepowered/gradle/vanilla/internal/bundler/BundlerMetadata.java

@@ -25,24 +25,28 @@
 package org.spongepowered.gradle.vanilla.internal.bundler;
 
 import org.checkerframework.checker.nullness.qual.Nullable;
-import org.immutables.value.Value;
 
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
-import java.util.Collections;
+import java.util.List;
 import java.util.Optional;
-import java.util.Set;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 import java.util.jar.Manifest;
-import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-@Value.Immutable
-public abstract class BundlerMetadata {
+/**
+ * The bundler metadata.
+ *
+ * @param version The bundler format used by this jar.
+ * @param libraries Libraries packed in the jar as dependencies for the server.
+ * @param server A bundle element describing the server itself.
+ * @param mainClass The main class to execute.
+ */
+public record BundlerMetadata(FormatVersion version, List<BundleElement> libraries, BundleElement server, @Nullable String mainClass) {
 
     private static final String MAIN_CLASS = "META-INF/main-class";
 
@@ -94,9 +98,9 @@ public static Optional<BundlerMetadata> read(final JarFile file) throws IOExcept
         }
 
         // libraries list
-        final Set<BundleElement> libraries;
+        final List<BundleElement> libraries;
         try (final Stream<BundleElement> elements = BundlerMetadata.readIndex(file, "libraries")) {
-            libraries = Collections.unmodifiableSet(elements.collect(Collectors.toSet()));
+            libraries = elements.toList();
         }
 
         // main class
@@ -110,11 +114,7 @@ public static Optional<BundlerMetadata> read(final JarFile file) throws IOExcept
             mainClass = read.readLine();
         }
 
-        return Optional.of(BundlerMetadata.of(parsed, libraries, serverJar, mainClass));
-    }
-
-    public static BundlerMetadata of(final FormatVersion version, final Set<BundleElement> libraries, final BundleElement server, final @Nullable String mainClass) {
-        return new BundlerMetadataImpl(version, libraries, server, mainClass);
+        return Optional.of(new BundlerMetadata(parsed, libraries, serverJar, mainClass));
     }
 
     private static Stream<BundleElement> readIndex(final JarFile jar, final String index) throws IOException {
@@ -126,7 +126,7 @@ private static Stream<BundleElement> readIndex(final JarFile jar, final String i
         final BufferedReader reader = new BufferedReader(new InputStreamReader(jar.getInputStream(entry), StandardCharsets.UTF_8));
         return reader.lines()
             .map(x -> x.split("\t"))
-            .map(line -> BundleElement.of(line[0], line[1], "META-INF/" + index + "/" + line[2]))
+            .map(line -> new BundleElement(line[0], line[1], "META-INF/" + index + "/" + line[2]))
             .onClose(() -> {
                 try {
                     reader.close();
@@ -135,40 +135,4 @@ private static Stream<BundleElement> readIndex(final JarFile jar, final String i
                 }
             });
     }
-
-    /**
-     * The bundler format used by this jar.
-     *
-     * <p>While VanillaGradle only knows about versions that existed at the time
-     * of its release, we will attempt to read future versions as well.</p>
-     *
-     * @return the format version
-     */
-    @Value.Parameter
-    public abstract FormatVersion version();
-
-    /**
-     * Libraries packed in the jar as dependencies for the server.
-     *
-     * @return the library elements
-     */
-    @Value.Parameter
-    public abstract Set<BundleElement> libraries();
-
-    /**
-     * Get a bundle element describing the server itself.
-     *
-     * @return an index entry describing the server
-     */
-    @Value.Parameter
-    public abstract BundleElement server();
-
-    /**
-     * The main class to execute.
-     *
-     * @return the main class
-     */
-    @Value.Parameter
-    public abstract @Nullable String mainClass();
-
 }

src/main/java/org/spongepowered/gradle/vanilla/internal/bundler/FormatVersion.java

@@ -24,20 +24,20 @@
  */
 package org.spongepowered.gradle.vanilla.internal.bundler;
 
-import org.immutables.value.Value;
-
 /**
  * A version of the Minecraft bundler metadata format.
+ *
+ * @param major Major version. Indicates incompatible changes.
+ * @param minor Minor version. Indicates additions and other compatible changes.
  */
-@Value.Immutable(builder = false)
-public interface FormatVersion extends Comparable<FormatVersion> {
+public record FormatVersion(int major, int minor) implements Comparable<FormatVersion> {
 
     /**
      * An attribute in the manifest of bundler jars containing a format version.
      *
      * @see #parse(String)
      */
-    String MANIFEST_ATTRIBUTE = "Bundler-Format";
+    public static final String MANIFEST_ATTRIBUTE = "Bundler-Format";
 
     /**
      * Parse the manifest attribute version.
@@ -52,52 +52,25 @@ static FormatVersion parse(final String attribute) {
         if (split.length < 2) {
             throw new IllegalArgumentException("Invalid version " + attribute);
         }
-        return FormatVersion.of(
+        return new FormatVersion(
             Integer.parseInt(split[0]),
             Integer.parseInt(split[1])
         );
     }
 
-    /**
-     * Create a format version directly.
-     *
-     * @param major the major version
-     * @param minor the minor version
-     * @return a new format version object
-     */
-    static FormatVersion of(final int major, final int minor) {
-        return new FormatVersionImpl(major, minor);
-    }
-
-    /**
-     * Major version. Indicates incompatible changes.
-     *
-     * @return the major version
-     */
-    @Value.Parameter
-    int major();
-
-    /**
-     * Minor version. Indicates additions and other compatible changes.
-     *
-     * @return the minor version
-     */
-    @Value.Parameter
-    int minor();
-
     /**
      * Whether a version of {@code other} can interpret data in this format version.
      *
      * @param other the compared version
      * @return whether other is compatible with this version's data
      */
-    default boolean compatibleWith(final FormatVersion other) {
+    public boolean compatibleWith(final FormatVersion other) {
         return other.major() == this.major()
             && other.minor() >= this.minor();
     }
 
     @Override
-    default int compareTo(final FormatVersion other) {
+    public int compareTo(final FormatVersion other) {
         if (this.major() != other.major()) {
             return Integer.compare(this.major(), other.major());
         } else {

src/main/java/org/spongepowered/gradle/vanilla/internal/bundler/package-info.java

@@ -32,7 +32,6 @@
 import com.google.gson.stream.JsonReader;
 import com.google.gson.stream.JsonToken;
 import com.google.gson.stream.JsonWriter;
-import org.immutables.value.Value;
 import org.spongepowered.gradle.vanilla.internal.model.rule.RuleDeclaration;
 
 import java.io.IOException;
@@ -42,32 +41,13 @@
 
 import javax.annotation.Nullable;
 
-@Value.Immutable
-public interface Argument {
+public record Argument(List<String> value, RuleDeclaration rules) {
 
-    static Argument of(final List<String> value) {
-        return new ArgumentImpl(value, RuleDeclaration.empty());
+    public Argument(final List<String> value) {
+        this(value, RuleDeclaration.empty());
     }
 
-    static Argument of(final List<String> value, final RuleDeclaration rules) {
-        return new ArgumentImpl(value, rules);
-    }
-
-    /**
-     * The argument value.
-     *
-     * @return the value of the argument
-     */
-    @Value.Parameter
-    List<String> value();
-
-    @Value.Default
-    @Value.Parameter
-    default RuleDeclaration rules() {
-        return RuleDeclaration.empty();
-    }
-
-    final class ArgumentTypeAdapter extends TypeAdapter<Argument> {
+    public static final class ArgumentTypeAdapter extends TypeAdapter<Argument> {
         private static final String VALUE = "value";
         private static final String RULES = "rules";
         private final TypeAdapter<RuleDeclaration> declaration;
@@ -85,7 +65,7 @@ public void write(final JsonWriter out, final Argument value) {
         public Argument read(final JsonReader in) throws IOException {
             switch (in.peek()) {
                 case STRING: // literal argument
-                    return new ArgumentImpl(Collections.singletonList(in.nextString()), RuleDeclaration.empty());
+                    return new Argument(Collections.singletonList(in.nextString()));
                 case BEGIN_OBJECT: // argument with a rule
                     @Nullable List<String> value = null;
                     RuleDeclaration declaration = RuleDeclaration.empty();
@@ -116,7 +96,7 @@ public Argument read(final JsonReader in) throws IOException {
                     if (value == null) {
                         throw new JsonSyntaxException("Exited argument declaration without finding argument values");
                     }
-                    return new ArgumentImpl(value, declaration);
+                    return new Argument(value, declaration);
                 default:
                     throw new JsonSyntaxException("Expected either a literal argument or a rule, but got " + in.peek() + " at " + in.getPath());