feat: add platform-api module (fix #287)

CONTRIBUTING.md

@@ -142,6 +142,7 @@ Additionally, commit message lines should not exceed 100 characters.
 - `extensions`, when modifying a file that is related to extensions.
 - `folia`, when modifying a file inside the `platform-folia` module.
 - `nukkit`, when modifying a file inside the `platform-nukkit` module.
+- `platform`, when modifying a file inside the `platform-api` module.
 - `scheduling`, when modifying a file that is related to scheduling.
 - `scripts`, when modifying a file inside the `scripts` directory.
 - `sponge`, when modifying a file inside the `platform-sponge` module.

api/src/test/java/dev/hypera/chameleon/TestChameleon.java

@@ -31,7 +31,6 @@
 import dev.hypera.chameleon.logger.ChameleonLogger;
 import dev.hypera.chameleon.logger.DummyChameleonLogger;
 import dev.hypera.chameleon.platform.Platform;
-import dev.hypera.chameleon.platform.PlatformChameleon;
 import dev.hypera.chameleon.platform.PluginManager;
 import dev.hypera.chameleon.scheduler.Scheduler;
 import dev.hypera.chameleon.user.UserManager;
@@ -41,7 +40,7 @@
 /**
  * Dummy Chameleon implementation.
  */
-public final class TestChameleon extends PlatformChameleon<Object> {
+public final class TestChameleon extends Chameleon {
 
     public static final @NotNull String PLATFORM_ID = "Test";
     private final @NotNull Platform platform = new TestChameleonPlatform();
@@ -53,51 +52,30 @@ public TestChameleon() {
         this(new DummyChameleonLogger());
     }
 
-    /**
-     * Dummy Chameleon implementation constructor.
-     *
-     * @param platformPlugin Platform plugin instance.
-     */
-    public TestChameleon(@NotNull Object platformPlugin) {
-        this(new DummyChameleonLogger(), platformPlugin);
-    }
-
-    /**
-     * Dummy Chameleon implementation constructor.
-     *
-     * @param logger Logger.
-     * @param platformPlugin Platform plugin instance.
-     */
-    public TestChameleon(@NotNull ChameleonLogger logger, @NotNull Object platformPlugin) {
-        this(TestChameleonPlugin::new, logger, platformPlugin, new EventBusImpl(logger), new ExtensionMap());
-    }
-
     /**
      * Dummy Chameleon implementation constructor.
      *
      * @param logger Logger.
      */
     public TestChameleon(@NotNull ChameleonLogger logger) {
-        this(TestChameleonPlugin::new, logger, 0, new EventBusImpl(logger), new ExtensionMap());
+        this(TestChameleonPlugin::new, logger, new EventBusImpl(logger), new ExtensionMap());
     }
 
     /**
      * Dummy Chameleon implementation constructor.
      *
      * @param pluginBootstrap Chameleon plugin bootstrap.
      * @param logger          Logger.
-     * @param platformPlugin  Platform plugin.
      * @param eventBus        Event bus.
      * @param extensions      Extensions.
      */
     public TestChameleon(
         @NotNull ChameleonPluginBootstrap pluginBootstrap,
         @NotNull ChameleonLogger logger,
-        @NotNull Object platformPlugin,
         @NotNull EventBus eventBus,
         @NotNull ExtensionMap extensions
     ) {
-        super(pluginBootstrap, platformPlugin, eventBus, logger, extensions);
+        super(pluginBootstrap, eventBus, logger, extensions);
     }
 
     public static @NotNull ChameleonBootstrap<TestChameleon> create() {

api/src/test/java/dev/hypera/chameleon/TestChameleonBootstrap.java

@@ -34,7 +34,7 @@ final class TestChameleonBootstrap extends ChameleonBootstrap<TestChameleon> {
 
     @Override
     protected @NotNull TestChameleon loadPlatform() {
-        return new TestChameleon(this.pluginBootstrap, this.logger, 0, this.eventBus, this.extensions);
+        return new TestChameleon(this.pluginBootstrap, this.logger, this.eventBus, this.extensions);
     }
 
 }

api/src/test/java/dev/hypera/chameleon/platform/PlatformChameleonTests.java → platform-api/build.gradle.kts

@@ -21,20 +21,11 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package dev.hypera.chameleon.platform;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
-import dev.hypera.chameleon.TestChameleon;
-import org.junit.jupiter.api.Test;
-
-final class PlatformChameleonTests {
-
-    @Test
-    void testPlatformPlugin() {
-        // Make sure PlatformChameleon stores and returns the platform plugin correctly.
-        TestChameleon chameleon = new TestChameleon(123);
-        assertEquals(123, chameleon.getPlatformPlugin());
-    }
+plugins {
+    id("chameleon.common")
+    id("java-library")
+}
 
+dependencies {
+    compileOnlyApi(projects.chameleonApi)
 }

platform-bukkit/build.gradle.kts

@@ -32,6 +32,7 @@ repositories {
 
 dependencies {
     compileOnlyApi(projects.chameleonApi)
+    compileOnlyApi(projects.chameleonPlatformApi)
     compileOnlyApi(libs.platform.bukkit)
     implementation(libs.adventure.platform.bukkit)
 }

platform-bungeecord/build.gradle.kts

@@ -32,6 +32,7 @@ repositories {
 
 dependencies {
     compileOnlyApi(projects.chameleonApi)
+    compileOnlyApi(projects.chameleonPlatformApi)
     compileOnlyApi(libs.platform.bungeecord)
     implementation(libs.adventure.platform.bungeecord)
 }

platform-nukkit/build.gradle.kts

@@ -32,5 +32,6 @@ repositories {
 
 dependencies {
     compileOnlyApi(projects.chameleonApi)
+    compileOnlyApi(projects.chameleonPlatformApi)
     compileOnlyApi(libs.platform.nukkit)
 }

platform-sponge/build.gradle.kts

@@ -32,6 +32,7 @@ repositories {
 
 dependencies {
     compileOnlyApi(projects.chameleonApi)
+    compileOnlyApi(projects.chameleonPlatformApi)
     compileOnlyApi(libs.platform.sponge) {
         exclude(module = "configurate-*")
     }

platform-velocity/build.gradle.kts

@@ -32,5 +32,6 @@ repositories {
 
 dependencies {
     compileOnlyApi(projects.chameleonApi)
+    compileOnlyApi(projects.chameleonPlatformApi)
     compileOnlyApi(libs.platform.velocity)
 }

settings.gradle.kts

@@ -41,6 +41,7 @@ sequenceOf(
     "bom",
     "annotations",
     "example",
+    "platform-api",
     "platform-bukkit",
     "platform-bungeecord",
     "platform-folia",