Merge pull request #77 from OakLoaf/v2.0

Resolves #74

Author: OakLoaf

api/src/main/java/org/lushplugins/pluginupdater/api/exception/InvalidVersionFormatException.java

@@ -0,0 +1,12 @@
+package org.lushplugins.pluginupdater.api.exception;
+
+public class InvalidVersionFormatException extends RuntimeException {
+
+    public InvalidVersionFormatException(String message) {
+        super(message);
+    }
+
+    public InvalidVersionFormatException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

api/src/main/java/org/lushplugins/pluginupdater/api/platform/Platform.java

@@ -5,15 +5,14 @@
 import java.util.concurrent.Callable;
 
 /**
- * @param rateLimit The endpoint's rate limit per second. Set to {@code -1} to remove limit.
- * @param updater
- * @param platformDataConstructor
+ * @param rateLimit The endpoint's rate limit per second, set to {@code -1} to remove limit
  */
 public record Platform(
     int rateLimit,
     Callable<VersionChecker> updater,
     PlatformRegistry.PlatformDataConstructor platformDataConstructor
 ) {
+
     public boolean hasRateLimit() {
         return this.rateLimit > 0;
     }

api/src/main/java/org/lushplugins/pluginupdater/api/platform/PlatformData.java

@@ -1,13 +1,26 @@
 package org.lushplugins.pluginupdater.api.platform;
 
+import org.lushplugins.pluginupdater.api.version.comparator.SemVerComparator;
+import org.lushplugins.pluginupdater.api.version.comparator.VersionComparator;
+
 public abstract class PlatformData {
     private final String name;
+    private final VersionComparator defaultComparator;
 
-    public PlatformData(String name) {
+    public PlatformData(String name, VersionComparator defaultComparator) {
         this.name = name;
+        this.defaultComparator = defaultComparator;
+    }
+
+    public PlatformData(String name) {
+        this(name, SemVerComparator.INSTANCE);
     }
 
     public String getName() {
         return name;
     }
+
+    public VersionComparator getDefaultComparator() {
+        return defaultComparator;
+    }
 }

api/src/main/java/org/lushplugins/pluginupdater/api/platform/github/GithubData.java

@@ -6,19 +6,19 @@
 public class GithubData extends PlatformData {
     private static final String NAME = "github";
 
-    private final String githubRepo;
+    private final String repo;
 
-    public GithubData(ConfigurationSection configurationSection) {
+    public GithubData(ConfigurationSection config) {
         super(NAME);
-        this.githubRepo = configurationSection.getString("github-repo");
+        this.repo = config.getString("github-repo");
     }
 
-    public GithubData(String githubRepo) {
+    public GithubData(String repo) {
         super(NAME);
-        this.githubRepo = githubRepo;
+        this.repo = repo;
     }
 
-    public String getGithubRepo() {
-        return githubRepo;
+    public String getRepo() {
+        return repo;
     }
 }

api/src/main/java/org/lushplugins/pluginupdater/api/platform/github/GithubVersionChecker.java

@@ -36,7 +36,7 @@ public String getDownloadUrl(PluginData pluginData, PlatformData platformData) t
     }
 
     private JsonObject getLatestRelease(PluginData pluginData, GithubData githubData) throws IOException, InterruptedException {
-        HttpResponse<String> response = HttpUtil.sendRequest(String.format("%s/repos/%s/releases/latest", UpdaterConstants.Endpoint.GITHUB, githubData.getGithubRepo()));
+        HttpResponse<String> response = HttpUtil.sendRequest(String.format("%s/repos/%s/releases/latest", UpdaterConstants.Endpoint.GITHUB, githubData.getRepo()));
 
         if (response.statusCode() != 200) {
             throw new IllegalStateException("Received invalid response code (%s) whilst checking '%s' for updates.".formatted(response.statusCode(), pluginData.getPluginName()));

api/src/main/java/org/lushplugins/pluginupdater/api/platform/hangar/HangarData.java

@@ -6,22 +6,22 @@
 public class HangarData extends PlatformData {
     private static final String NAME = "hangar";
 
-    private final String hangarProjectSlug;
+    private final String projectSlug;
 
-    public HangarData(ConfigurationSection configurationSection) {
+    public HangarData(ConfigurationSection config) {
         super(NAME);
-        this.hangarProjectSlug = configurationSection.getString("hangar-project-slug");
+        this.projectSlug = config.getString("hangar-project-slug");
     }
 
     /**
-     * @param hangarProjectSlug Your Modrinth Project Slug
+     * @param projectSlug The Hangar Project Slug
      */
-    public HangarData(String hangarProjectSlug) {
+    public HangarData(String projectSlug) {
         super(NAME);
-        this.hangarProjectSlug = hangarProjectSlug;
+        this.projectSlug = projectSlug;
     }
 
-    public String getHangarProjectSlug() {
-        return hangarProjectSlug;
+    public String getProjectSlug() {
+        return projectSlug;
     }
 }

api/src/main/java/org/lushplugins/pluginupdater/api/platform/hangar/HangarVersionChecker.java

@@ -17,7 +17,7 @@ public String getLatestVersion(PluginData pluginData, PlatformData platformData)
             return null;
         }
 
-        HttpResponse<String> response = HttpUtil.sendRequest(String.format("%s/projects/%s/latestrelease", UpdaterConstants.Endpoint.HANGAR, hangarData.getHangarProjectSlug()));
+        HttpResponse<String> response = HttpUtil.sendRequest(String.format("%s/projects/%s/latestrelease", UpdaterConstants.Endpoint.HANGAR, hangarData.getProjectSlug()));
 
         if (response.statusCode() != 200) {
             throw new IllegalStateException("Received invalid response code (" + response.statusCode() + ") whilst checking '" + pluginData.getPluginName() + "' for updates.");
@@ -29,7 +29,7 @@ public String getLatestVersion(PluginData pluginData, PlatformData platformData)
     @Override
     public String getDownloadUrl(PluginData pluginData, PlatformData platformData) {
         return platformData instanceof HangarData hangarData ?
-            String.format("%s/projects/%s/versions/%s/PAPER/download", UpdaterConstants.Endpoint.HANGAR, hangarData.getHangarProjectSlug(), pluginData.getLatestVersion()) :
+            String.format("%s/projects/%s/versions/%s/PAPER/download", UpdaterConstants.Endpoint.HANGAR, hangarData.getProjectSlug(), pluginData.getLatestVersion()) :
             null;
     }
 }

api/src/main/java/org/lushplugins/pluginupdater/api/platform/modrinth/ModrinthData.java

@@ -11,78 +11,67 @@
 public class ModrinthData extends PlatformData {
     private static final String NAME = "modrinth";
 
-    private final String modrinthProjectId;
-    private final @Nullable List<String> versionTypes;
-    private final boolean featuredOnly;
+    private final String projectId;
+    private final @Nullable List<String> releaseChannels;
 
-    public ModrinthData(ConfigurationSection configurationSection) {
+    public ModrinthData(ConfigurationSection config) {
         super(NAME);
-        this.modrinthProjectId = configurationSection.getString("modrinth-project-id");
+        this.projectId = config.getString("modrinth-project-id");
 
-        if (configurationSection.isString("channels")) {
-            this.versionTypes = Collections.singletonList(configurationSection.getString("channels", "release").toLowerCase());
-        } else if (configurationSection.isList("channels")) {
-            this.versionTypes = configurationSection.getStringList("channels").stream()
+        if (config.isString("channels")) {
+            this.releaseChannels = Collections.singletonList(config.getString("channels", ReleaseChannel.RELEASE).toLowerCase());
+        } else if (config.isList("channels")) {
+            this.releaseChannels = config.getStringList("channels").stream()
                 .map(String::toLowerCase)
                 .toList();
         } else {
-            this.versionTypes = null;
+            this.releaseChannels = ReleaseChannel.ALL;
         }
-
-        this.featuredOnly = configurationSection.getBoolean("featured-only");
     }
 
     /**
-     * @param modrinthProjectId The Modrinth project id
-     * @param versionTypes Which version types to filter (Set to 'null' to not filter)
-     * @param featuredOnly Whether to filter updates by Featured only
+     * @param projectId The Modrinth project id
+     * @param releaseChannels Which release channels to filter, {@code null} will include all release channels
      */
-    public ModrinthData(String modrinthProjectId, @Nullable List<String> versionTypes, boolean featuredOnly) {
+    public ModrinthData(String projectId, @Nullable List<String> releaseChannels) {
         super(NAME);
-        this.modrinthProjectId = modrinthProjectId;
-        this.versionTypes = versionTypes;
-        this.featuredOnly = featuredOnly;
+        this.projectId = projectId;
+        this.releaseChannels = releaseChannels;
     }
 
     /**
-     * @param modrinthProjectId The Modrinth project id
-     * @param versionType Which version type to filter (Set to 'null' to not filter)
-     * @param featuredOnly Whether to filter updates by Featured only
+     * @param projectId The Modrinth project id
+     * @param releaseChannel Which release channel to filter, {@code null} will include all release channels
      */
-    public ModrinthData(String modrinthProjectId, @Nullable String versionType, boolean featuredOnly) {
-        this(modrinthProjectId, Collections.singletonList(versionType), featuredOnly);
+    public ModrinthData(String projectId, @Nullable String releaseChannel) {
+        this(projectId, Collections.singletonList(releaseChannel));
     }
 
     /**
-     * @param modrinthProjectId The Modrinth project id
-     * @param featuredOnly Whether to filter updates by Featured only
+     * @param projectId The Modrinth project id
      */
-    public ModrinthData(String modrinthProjectId, boolean featuredOnly) {
-        this(modrinthProjectId, VersionType.ALL, featuredOnly);
+    public ModrinthData(String projectId) {
+        this(projectId, ReleaseChannel.ALL);
     }
 
-    public String getModrinthProjectId() {
-        return modrinthProjectId;
+    public String getProjectId() {
+        return projectId;
     }
 
     public boolean specifiesVersionType() {
-        return this.versionTypes != null;
+        return this.releaseChannels != null;
     }
 
     @ApiStatus.Internal
     public @Nullable String getVersionType() {
-        return this.versionTypes != null ? this.versionTypes.get(0) : null;
-    }
-
-    public @Nullable List<String> getVersionTypes() {
-        return versionTypes;
+        return this.releaseChannels != null ? this.releaseChannels.get(0) : null;
     }
 
-    public boolean includeFeaturedOnly() {
-        return featuredOnly;
+    public @Nullable List<String> getReleaseChannels() {
+        return releaseChannels;
     }
 
-    public static class VersionType {
+    public static class ReleaseChannel {
         public static final List<String> ALL = null;
         public static final String RELEASE = "release";
         public static final String BETA = "beta";

api/src/main/java/org/lushplugins/pluginupdater/api/platform/modrinth/ModrinthVersionChecker.java

@@ -35,17 +35,14 @@ public String getDownloadUrl(PluginData pluginData, PlatformData platformData) t
     }
 
     private JsonArray getVersions(PluginData pluginData, ModrinthData modrinthData) throws IOException, InterruptedException {
-        StringBuilder uriBuilder = new StringBuilder(String.format("%s/project/%s/version", UpdaterConstants.Endpoint.MODRINTH, modrinthData.getModrinthProjectId()))
-            .append("?loaders=[%22bukkit%22,%22spigot%22,%22paper%22,%22purpur%22,%22folia%22]");
+        StringBuilder uriBuilder = new StringBuilder(String.format("%s/project/%s/version", UpdaterConstants.Endpoint.MODRINTH, modrinthData.getProjectId()))
+            .append("?loaders=[%22bukkit%22,%22spigot%22,%22paper%22,%22purpur%22,%22folia%22]")
+            .append("&include_changelog=false");
 
         if (modrinthData.specifiesVersionType()) {
             uriBuilder.append("&version_type=").append(modrinthData.getVersionType());
         }
 
-        if (modrinthData.includeFeaturedOnly()) {
-            uriBuilder.append("&featured=true");
-        }
-
         HttpResponse<String> response = HttpUtil.sendRequest(uriBuilder.toString());
 
         if (response.statusCode() != 200) {

api/src/main/java/org/lushplugins/pluginupdater/api/platform/spigot/SpigotData.java

@@ -6,22 +6,22 @@
 public class SpigotData extends PlatformData {
     private static final String NAME = "spigot";
 
-    private final String spigotResourceId;
+    private final String resourceId;
 
-    public SpigotData(ConfigurationSection configurationSection) {
+    public SpigotData(ConfigurationSection config) {
         super(NAME);
-        spigotResourceId = configurationSection.getString("spigot-resource-id");
+        resourceId = config.getString("spigot-resource-id");
     }
 
     /**
-     * @param spigotResourceId Your Spigot Resource Id
+     * @param resourceId The Spigot Resource Id
      */
-    public SpigotData(String spigotResourceId) {
+    public SpigotData(String resourceId) {
         super(NAME);
-        this.spigotResourceId = spigotResourceId;
+        this.resourceId = resourceId;
     }
 
-    public String getSpigotResourceId() {
-        return spigotResourceId;
+    public String getResourceId() {
+        return resourceId;
     }
 }