Improved: PCVersion Design Pattern

Bram1903 · Jun 22, 2024 · 02d1a8f · 02d1a8f
1 parent 22d5dfd
commit 02d1a8f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 15 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -19,10 +19,6 @@ dependencies {
 tasks {
     jar {
         enabled = false
-
-        manifest {
-            attributes["Implementation-Version"] = rootProject.version
-        }
     }
 
     shadowJar {
@@ -37,6 +33,10 @@ tasks {
             "net.kyori.adventure.text.serializer.legacy",
             "io.github.retrooper.packetevents.adventure.serializer.legacy"
         )
+
+        manifest {
+            attributes["Implementation-Version"] = rootProject.version
+        }
     }
 
     assemble {

diff --git a/common/src/main/java/com/deathmotion/playercrasher/managers/UpdateManager.java b/common/src/main/java/com/deathmotion/playercrasher/managers/UpdateManager.java
@@ -58,7 +58,7 @@ public void checkForUpdate() {
         platform.getScheduler().runAsyncTask((o) -> {
             try {
                 PCVersion localVersion = platform.getVersion();
-                PCVersion newVersion = new PCVersion(getLatestGitHubVersion());
+                PCVersion newVersion = PCVersion.fromString(getLatestGitHubVersion());
 
                 compareVersions(localVersion, newVersion);
             } catch (Exception ex) {

diff --git a/common/src/main/java/com/deathmotion/playercrasher/util/PCVersion.java b/common/src/main/java/com/deathmotion/playercrasher/util/PCVersion.java
@@ -23,13 +23,17 @@
 
 import java.util.Objects;
 import java.util.Optional;
+import java.util.logging.Logger;
 
 /**
- * Represents an PlayerCrasher version using Semantic Versioning.
+ * Represents a PlayerCrasher version using Semantic Versioning.
  * Supports version comparison, cloning, and provides a string representation.
+ * Snapshots will always resolve to a newer version than the non-snapshot version if major, minor, and patch are the same.
  */
 public class PCVersion implements Comparable<PCVersion> {
 
+    public static final PCVersion UNKNOWN = new PCVersion(0, 0, 0);
+
     private final int major;
     private final int minor;
     private final int patch;
@@ -67,18 +71,20 @@ public PCVersion(final int major, final int minor, final int patch) {
      * @param version the version string (e.g., "1.8.9-SNAPSHOT").
      * @throws IllegalArgumentException if the version string format is incorrect.
      */
-    public PCVersion(@NotNull final String version) {
-        this.snapshot = version.endsWith("-SNAPSHOT");
+    public static PCVersion fromString(@NotNull final String version) {
         String versionWithoutSnapshot = version.replace("-SNAPSHOT", "");
         String[] parts = versionWithoutSnapshot.split("\\.");
 
-        if (parts.length != 3) {
-            throw new IllegalArgumentException("Version string must be in the format 'major.minor.patch[-SNAPSHOT]'");
+        if (parts.length < 2 || parts.length > 3) {
+            throw new IllegalArgumentException("Version string must be in the format 'major.minor[.patch][-SNAPSHOT]' found '" + version + "' instead.");
         }
 
-        this.major = Integer.parseInt(parts[0]);
-        this.minor = Integer.parseInt(parts[1]);
-        this.patch = Integer.parseInt(parts[2]);
+        int major = Integer.parseInt(parts[0]);
+        int minor = Integer.parseInt(parts[1]);
+        int patch = parts.length > 2 ? Integer.parseInt(parts[2]) : 0;
+        boolean snapshot = version.contains("-SNAPSHOT");
+
+        return new PCVersion(major, minor, patch, snapshot);
     }
 
     /**
@@ -87,8 +93,13 @@ public PCVersion(@NotNull final String version) {
      * @return a {@link PCVersion} instance.
      */
     public static PCVersion createFromPackageVersion() {
-        String version = Optional.ofNullable(PCPlatform.class.getPackage().getImplementationVersion()).orElse("0.0.0");
-        return new PCVersion(version);
+        Optional<PCVersion> version = Optional.ofNullable(PCPlatform.class.getPackage().getImplementationVersion()).map(PCVersion::fromString);
+        if (!version.isPresent()) {
+            Logger logger = Logger.getLogger(PCPlatform.class.getName());
+            logger.warning("[playercrasher-version] Failed to retrieve the PlayerCrasher version from the package implementation version. Are you using a using a custom build?");
+        }
+
+        return version.orElse(UNKNOWN);
     }
 
     /**