Merge branch 'Slimefun:master' into master

WalshyDev · web-flow · commit 644ca62b105d · 2024-01-18T14:07:31.000Z
diff --git a/.github/workflows/discord-webhook.yml b/.github/workflows/discord-webhook.yml
@@ -32,7 +32,7 @@ jobs:
         architecture: x64
 
     - name: Cache Maven packages
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
diff --git a/.github/workflows/maven-compiler.yml b/.github/workflows/maven-compiler.yml
@@ -36,7 +36,7 @@ jobs:
         architecture: x64
 
     - name: Cache Maven packages
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -30,7 +30,7 @@ jobs:
         architecture: x64
 
     - name: Cache Maven packages
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
diff --git a/.github/workflows/sonarcloud.yml b/.github/workflows/sonarcloud.yml
@@ -32,14 +32,14 @@ jobs:
           architecture: x64
 
       - name: Cache SonarCloud packages
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
 
       - name: Cache Maven packages
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/api/events/SlimefunItemRegistryFinalizedEvent.java b/src/main/java/io/github/thebusybiscuit/slimefun4/api/events/SlimefunItemRegistryFinalizedEvent.java
@@ -0,0 +1,35 @@
+package io.github.thebusybiscuit.slimefun4.api.events;
+
+import javax.annotation.Nonnull;
+
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+
+import io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem;
+import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
+
+
+/**
+ * This {@link Event} is fired after {@link Slimefun} finishes loading the
+ * {@link SlimefunItem} registry. We recommend listening to this event if you
+ * want to register recipes using items from other addons.
+ *
+ * @author ProfElements
+ */
+public class SlimefunItemRegistryFinalizedEvent extends Event {
+    
+    private static final HandlerList handlers = new HandlerList();
+
+    public SlimefunItemRegistryFinalizedEvent() {}
+
+    @Nonnull
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    @Nonnull
+    @Override
+    public HandlerList getHandlers() {
+        return getHandlerList(); 
+    }
+}
diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/implementation/setup/PostSetup.java b/src/main/java/io/github/thebusybiscuit/slimefun4/implementation/setup/PostSetup.java
@@ -24,6 +24,7 @@
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 
+import io.github.thebusybiscuit.slimefun4.api.events.SlimefunItemRegistryFinalizedEvent;
 import io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.implementation.SlimefunItems;
@@ -77,6 +78,8 @@ public static void loadItems() {
             }
         }
 
+        Bukkit.getPluginManager().callEvent(new SlimefunItemRegistryFinalizedEvent());
+        
         loadOreGrinderRecipes();
         loadSmelteryRecipes();
 
diff --git a/src/test/java/io/github/thebusybiscuit/slimefun4/api/events/TestSlimefunRegistryFinalizedEvent.java b/src/test/java/io/github/thebusybiscuit/slimefun4/api/events/TestSlimefunRegistryFinalizedEvent.java
@@ -0,0 +1,42 @@
+package io.github.thebusybiscuit.slimefun4.api.events;
+
+import org.junit.jupiter.api.Assertions;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+import be.seeseemelk.mockbukkit.MockBukkit;
+import be.seeseemelk.mockbukkit.ServerMock;
+import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
+import io.github.thebusybiscuit.slimefun4.implementation.setup.PostSetup;
+
+class TestSlimefunRegistryFinalizedEvent {
+
+    private static ServerMock server;
+    private static Slimefun plugin;
+
+    @BeforeAll
+    public static void load() {
+        server = MockBukkit.mock();
+        plugin = MockBukkit.load(Slimefun.class);
+    }
+
+    @AfterAll
+    public static void unload() {
+        MockBukkit.unmock();
+    }
+
+    @Test
+    @DisplayName("Test that SlimefunRegistryFinalizedEvent is fired")
+    void testEventIsFired() {
+        // Make sure post setup does not throw
+        Assertions.assertDoesNotThrow(() -> PostSetup.loadItems());
+        
+        // Make sure post setup sent the event
+        server.getPluginManager().assertEventFired(SlimefunItemRegistryFinalizedEvent.class, ignored -> true);
+ 
+        server.getPluginManager().clearEvents();
+    }
+} 

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`import com.google.gson.JsonElement;`
`25`	`25`	`import com.google.gson.JsonObject;`
`26`	`26`
	`27`	`+import io.github.thebusybiscuit.slimefun4.api.events.SlimefunItemRegistryFinalizedEvent;`
`27`	`28`	`import io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem;`
`28`	`29`	`import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;`
`29`	`30`	`import io.github.thebusybiscuit.slimefun4.implementation.SlimefunItems;`
`@@ -77,6 +78,8 @@ public static void loadItems() {`
`77`	`78`	`}`
`78`	`79`	`}`
`79`	`80`
	`81`	`+ Bukkit.getPluginManager().callEvent(new SlimefunItemRegistryFinalizedEvent());`
	`82`	`+`
`80`	`83`	`loadOreGrinderRecipes();`
`81`	`84`	`loadSmelteryRecipes();`
`82`	`85`