Improved: Design Pattern of AHIVersion

Bram1903 · Jun 22, 2024 · 69ab165 · 69ab165
1 parent 5ebf2df
commit 69ab165
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 11 deletions.
diff --git a/common/src/main/java/com/deathmotion/antihealthindicator/managers/UpdateManager.java b/common/src/main/java/com/deathmotion/antihealthindicator/managers/UpdateManager.java
@@ -58,7 +58,7 @@ public void checkForUpdate() {
         platform.getScheduler().runAsyncTask((o) -> {
             try {
                 AHIVersion localVersion = platform.getVersion();
-                AHIVersion newVersion = new AHIVersion(getLatestGitHubVersion());
+                AHIVersion newVersion = AHIVersion.fromString(getLatestGitHubVersion());
 
                 compareVersions(localVersion, newVersion);
             } catch (Exception ex) {

diff --git a/common/src/main/java/com/deathmotion/antihealthindicator/util/AHIVersion.java b/common/src/main/java/com/deathmotion/antihealthindicator/util/AHIVersion.java
@@ -23,13 +23,17 @@
 
 import java.util.Objects;
 import java.util.Optional;
+import java.util.logging.Logger;
 
 /**
  * Represents an AntiHealthIndicator 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 AHIVersion implements Comparable<AHIVersion> {
 
+    public static final AHIVersion UNKNOWN = new AHIVersion(0, 0, 0);
+
     private final int major;
     private final int minor;
     private final int patch;
@@ -67,18 +71,20 @@ public AHIVersion(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 AHIVersion(@NotNull final String version) {
-        this.snapshot = version.endsWith("-SNAPSHOT");
+    public static AHIVersion 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 AHIVersion(major, minor, patch, snapshot);
     }
 
     /**
@@ -87,8 +93,13 @@ public AHIVersion(@NotNull final String version) {
      * @return a {@link AHIVersion} instance.
      */
     public static AHIVersion createFromPackageVersion() {
-        String version = Optional.ofNullable(AHIPlatform.class.getPackage().getImplementationVersion()).orElse("0.0.0");
-        return new AHIVersion(version);
+        Optional<AHIVersion> version = Optional.ofNullable(AHIPlatform.class.getPackage().getImplementationVersion()).map(AHIVersion::fromString);
+        if (!version.isPresent()) {
+            Logger logger = Logger.getLogger(AHIPlatform.class.getName());
+            logger.warning("[antihealthindicator-version] Failed to retrieve the AntiHealthIndicator version from the package implementation version. Are you using a using a custom build?");
+        }
+
+        return version.orElse(UNKNOWN);
     }
 
     /**
@@ -145,7 +156,7 @@ public int compareTo(@NotNull final AHIVersion other) {
         int patchCompare = Integer.compare(this.patch, other.patch);
         if (patchCompare != 0) return patchCompare;
 
-        return Boolean.compare(other.snapshot, this.snapshot);
+        return Boolean.compare(this.snapshot, other.snapshot);
     }
 
     /**