Merge pull request #8 from OneLiteFeatherNET/develop

The pull request adds the latest changes from develop to master. So we can create our first release

Author: theEvilReaper

.github/workflows/main-build.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v3
+        uses: gradle/actions/wrapper-validation@v4
       - name: Setup Java
         uses: actions/setup-java@v4
         with:

README.md

@@ -0,0 +1,43 @@
+# Guira
+
+Guira is a lightweight Java library designed to help you implement flexible and robust setup processes for games, minigames, or any other custom features on a [Minestom](https://github.com/Minestom/Minestom) server. Rather than enforcing a fixed setup structure, Guira empowers you to define exactly what your setup should contain—such as maps, teams, rules, or any other configuration—by letting you design your own setup data types and logic. The library provides a solid and extensible foundation for storing, tracking, and managing this setup data, making it easy to build tailored setup flows for a wide range of server scenarios.
+
+## Installation
+
+Add the following to your `build.gradle.kts`:
+
+```kotlin
+dependencies {
+    compileOnly("net.onelitefeather.guira:guira:<version>>")
+}
+```
+
+## Usage Example
+
+```java
+// Create a new SetupDataService instance
+SetupDataService<MySetupData> service = SetupDataService.create();
+
+// Add setup data
+UUID uuid = UUID.randomUUID();
+MySetupData data = new MySetupData(uuid, ...);
+service.add(uuid, data);
+
+// Retrieve setup data
+Optional<MySetupData> retrieved = service.get(uuid);
+
+// Remove setup data
+service.remove(uuid);
+```
+
+### Event Handling
+
+Guira provides events such as `SetupCreateEvent` and `SetupFinishEvent` for managing the setup process lifecycle.
+
+> [!NOTE]
+> **Guira does NOT automatically fire any of the provided events (`SetupCreateEvent`, `SetupFinishEvent`, etc).**
+> You are responsible for triggering and handling these events in your own code/context (e.g., your Minestom server plugin or application).
+
+## License
+
+This project is licensed under the [Apache License 2.0](LICENSE).

build.gradle.kts

@@ -1,19 +1,81 @@
 plugins {
     java
+    jacoco
+    `java-library`
+    `maven-publish`
+    alias(libs.plugins.publishdata)
 }
 
 group = "net.onelitefeather.guira"
-version = "1.0-SNAPSHOT"
+version = "0.1.0"
 
-repositories {
-    mavenCentral()
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(21))
+    }
 }
 
 dependencies {
-    testImplementation(platform("org.junit:junit-bom:5.10.0"))
-    testImplementation("org.junit.jupiter:junit-jupiter")
+    compileOnly(libs.minestom)
+    compileOnly(libs.jetbrains.annotation)
+    compileOnly(libs.aves)
+
+    testImplementation(libs.minestom)
+    testImplementation(libs.minestom.test)
+    testImplementation(libs.aves)
+    testImplementation(libs.junit.api)
+    testRuntimeOnly(libs.junit.engine)
+}
+
+publishData {
+    addMainRepo("https://repo.onelitefeather.dev/onelitefeather-releases")
+    addMasterRepo("https://repo.onelitefeather.dev/onelitefeather-releases")
+    addSnapshotRepo("https://repo.onelitefeather.dev/onelitefeather-snapshots")
+    publishTask("jar")
+}
+
+tasks {
+    compileJava {
+        options.encoding = "UTF-8"
+        options.release.set(21)
+    }
+
+    compileTestJava {
+        options.encoding = "UTF-8"
+        options.release.set(21)
+    }
+
+    test {
+        finalizedBy(jacocoTestReport)
+        useJUnitPlatform()
+        jvmArgs("-Dminestom.inside-test=true")
+        testLogging {
+            events("passed", "skipped", "failed")
+        }
+    }
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            // configure the publication as defined previously.
+            publishData.configurePublication(this)
+            version = publishData.getVersion(false)
+        }
+    }
+    repositories {
+        maven {
+            authentication {
+                credentials(PasswordCredentials::class) {
+                    username = System.getenv("ONELITEFEATHER_MAVEN_USERNAME")
+                    password = System.getenv("ONELITEFEATHER_MAVEN_PASSWORD")
+                }
+            }
+
+            name = "OneLiteFeatherRepository"
+            // Get the detected repository from the publish data
+            url = uri(publishData.getRepository())
+        }
+    }
 }
 
-tasks.test {
-    useJUnitPlatform()
-}

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -114,7 +114,7 @@ case "$( uname )" in                #(
   NONSTOP* )        nonstop=true ;;
 esac
 
-CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+CLASSPATH="\\\"\\\""
 
 
 # Determine the Java command to use to start the JVM.
@@ -213,7 +213,7 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
-        org.gradle.wrapper.GradleWrapperMain \
+        -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
         "$@"
 
 # Stop when "xargs" is not available.

gradlew

@@ -70,11 +70,11 @@ goto fail
 :execute
 @rem Setup the command line
 
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+set CLASSPATH=
 
 
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
 
 :end
 @rem End local scope for the variables with windows NT shell

gradlew.bat

@@ -4,7 +4,7 @@
     "config:recommended"
   ],
   "rebaseWhen": "conflicted",
-  "label": [
+  "labels": [
     "renovate"
   ]
 }

renovate.json

@@ -1,2 +1,50 @@
-rootProject.name = "Guira"
+rootProject.name = "guira"
+
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+        maven("https://eldonexus.de/repository/maven-public/")
+    }
+}
+
+dependencyResolutionManagement {
+    repositories {
+        mavenCentral()
+        maven {
+            name = "OneLiteFeatherRepository"
+            url = uri("https://repo.onelitefeather.dev/onelitefeather")
+            if (System.getenv("CI") != null) {
+                credentials {
+                    username = System.getenv("ONELITEFEATHER_MAVEN_USERNAME")
+                    password = System.getenv("ONELITEFEATHER_MAVEN_PASSWORD")
+                }
+            } else {
+                credentials(PasswordCredentials::class)
+                authentication {
+                    create<BasicAuthentication>("basic")
+                }
+            }
+        }
+    }
+    versionCatalogs {
+        create("libs") {
+            version("minestom", "1.5.1")
+            version("aves", "1.6.1")
+            version("junit", "5.12.2")
+            version("publishdata", "1.4.0")
+            version("jetbrains.annotation", "26.0.2")
+
+            library("minestom", "net.onelitefeather.microtus", "Microtus").versionRef("minestom")
+            library("minestom.test", "net.onelitefeather.microtus.testing", "testing").versionRef("minestom")
+
+            library("aves", "de.icevizion.lib", "aves").versionRef("aves")
+
+            library("junit.api", "org.junit.jupiter", "junit-jupiter-api").versionRef("junit")
+            library("junit.engine", "org.junit.jupiter", "junit-jupiter-engine").versionRef("junit")
+            library("jetbrains.annotation", "org.jetbrains", "annotations").versionRef("jetbrains.annotation")
+
+            plugin("publishdata", "de.chojo.publishdata").versionRef("publishdata")
+        }
+    }
+}
 

settings.gradle.kts

@@ -0,0 +1,68 @@
+package net.onelitefeather.guira;
+
+import de.icevizion.aves.map.BaseMap;
+import net.onelitefeather.guira.data.SetupData;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.UnmodifiableView;
+
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+
+/**
+ * The (@link SetupDataService} is responsible for managing setup data during a runtime session.
+ * It allows adding, removing, and retrieving setup data associated with a unique identifier (UUID).
+ *
+ * @param <T> the type of setup data
+ * @author thEvilReaper
+ * @version 1.0.0
+ * @since 0.1.0
+ */
+public interface SetupDataService<T extends SetupData<? extends BaseMap>> {
+
+    /**
+     * Creates a new instance of SetupDataService.
+     *
+     * @param <T> the type of setup data
+     * @return a new instance of SetupDataService
+     */
+    @Contract(pure = true)
+    static @NotNull <T extends SetupData<? extends BaseMap>> SetupDataService<T> create() {
+        return new SetupDataServiceImpl<>();
+    }
+
+    /**
+     * Adds a new setup data to the service.
+     *
+     * @param uuid the unique identifier for the setup data
+     * @param data the setup data to add
+     */
+    void add(@NotNull UUID uuid, @NotNull T data);
+
+    /**
+     * Removes the setup data associated with the given UUID.
+     *
+     * @param uuid the unique identifier for the setup data
+     * @return an optional containing the removed setup data, or empty if not found
+     */
+    @NotNull Optional<@Nullable T> remove(@NotNull UUID uuid);
+
+    /**
+     * Retrieves the setup data associated with the given UUID.
+     *
+     * @param uuid the unique identifier for the setup data
+     * @return an optional containing the setup data, or empty if not found
+     */
+    @NotNull Optional<@Nullable T> get(@NotNull UUID uuid);
+
+    /**
+     * Returns an unmodifiable view of the setup data map.
+     *
+     * @return an unmodifiable view
+     */
+    @NotNull
+    @UnmodifiableView
+    Map<UUID, T> getView();
+}