Merge pull request #718 from refinedmods/feat/GH-102/autocrafting-mon…

…itor

Autocrafting monitor

CHANGELOG.md

@@ -7,6 +7,14 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+
+-   Autocrafting Monitor
+
+### Changed
+
+-   The Autocrafting Monitor now has a sidebar with all tasks instead of using tabs.
+
 ## [2.0.0-milestone.4.9] - 2024-11-01
 
 ### Added

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/TaskId.java

@@ -0,0 +1,9 @@
+package com.refinedmods.refinedstorage.api.autocrafting;
+
+import java.util.UUID;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.10")
+public record TaskId(UUID id) {
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/Preview.java

@@ -0,0 +1,9 @@
+package com.refinedmods.refinedstorage.api.autocrafting.preview;
+
+import java.util.List;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.9")
+public record Preview(PreviewType type, List<PreviewItem> items) {
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/PreviewItem.java

@@ -0,0 +1,9 @@
+package com.refinedmods.refinedstorage.api.autocrafting.preview;
+
+import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.9")
+public record PreviewItem(ResourceKey resource, long available, long missing, long toCraft) {
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/PreviewProvider.java

@@ -0,0 +1,14 @@
+package com.refinedmods.refinedstorage.api.autocrafting.preview;
+
+import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+
+import java.util.Optional;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.9")
+public interface PreviewProvider {
+    Optional<Preview> getPreview(ResourceKey resource, long amount);
+
+    boolean startTask(ResourceKey resource, long amount);
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/PreviewType.java

@@ -0,0 +1,10 @@
+package com.refinedmods.refinedstorage.api.autocrafting.preview;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.9")
+public enum PreviewType {
+    SUCCESS,
+    MISSING_RESOURCES
+}
+

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/package-info.java

@@ -0,0 +1,7 @@
+@ParametersAreNonnullByDefault
+@FieldsAndMethodsAreNonnullByDefault
+package com.refinedmods.refinedstorage.api.autocrafting.preview;
+
+import com.refinedmods.refinedstorage.api.core.FieldsAndMethodsAreNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/status/TaskStatus.java

@@ -0,0 +1,32 @@
+package com.refinedmods.refinedstorage.api.autocrafting.status;
+
+import com.refinedmods.refinedstorage.api.autocrafting.TaskId;
+import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+
+import java.util.List;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.10")
+public record TaskStatus(TaskInfo info, float percentageCompleted, List<Item> items) {
+    public record TaskInfo(TaskId id, ResourceKey resource, long amount, long startTime) {
+    }
+
+    public record Item(
+        ItemType type,
+        ResourceKey resource,
+        long stored,
+        long missing,
+        long processing,
+        long scheduled,
+        long crafting
+    ) {
+    }
+
+    public enum ItemType {
+        NORMAL,
+        MACHINE_DOES_NOT_ACCEPT_RESOURCE,
+        NO_MACHINE_FOUND,
+        AUTOCRAFTER_IS_LOCKED
+    }
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/status/TaskStatusListener.java

@@ -0,0 +1,14 @@
+package com.refinedmods.refinedstorage.api.autocrafting.status;
+
+import com.refinedmods.refinedstorage.api.autocrafting.TaskId;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.10")
+public interface TaskStatusListener {
+    void taskStatusChanged(TaskStatus status);
+
+    void taskRemoved(TaskId id);
+
+    void taskAdded(TaskStatus status);
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/status/TaskStatusProvider.java

@@ -0,0 +1,20 @@
+package com.refinedmods.refinedstorage.api.autocrafting.status;
+
+import com.refinedmods.refinedstorage.api.autocrafting.TaskId;
+
+import java.util.List;
+
+import org.apiguardian.api.API;
+
+@API(status = API.Status.STABLE, since = "2.0.0-milestone.4.10")
+public interface TaskStatusProvider {
+    List<TaskStatus> getStatuses();
+
+    void addListener(TaskStatusListener listener);
+
+    void removeListener(TaskStatusListener listener);
+
+    void cancel(TaskId taskId);
+
+    void cancelAll();
+}

refinedstorage-autocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/status/package-info.java

@@ -0,0 +1,7 @@
+@ParametersAreNonnullByDefault
+@FieldsAndMethodsAreNonnullByDefault
+package com.refinedmods.refinedstorage.api.autocrafting.status;
+
+import com.refinedmods.refinedstorage.api.core.FieldsAndMethodsAreNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;

refinedstorage-autocrafting-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/ResourceFixtures.java

@@ -2,7 +2,7 @@
 
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
 
-enum ResourceFixtures implements ResourceKey {
+public enum ResourceFixtures implements ResourceKey {
     A,
     B,
     C

refinedstorage-autocrafting-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/status/TaskStatusTest.java

@@ -0,0 +1,35 @@
+package com.refinedmods.refinedstorage.api.autocrafting.status;
+
+import com.refinedmods.refinedstorage.api.autocrafting.ResourceFixtures;
+import com.refinedmods.refinedstorage.api.autocrafting.TaskId;
+
+import java.util.List;
+import java.util.UUID;
+
+import org.junit.jupiter.api.Test;
+
+public class TaskStatusTest {
+    @Test
+    void dummyTest() {
+        new TaskStatus(
+            new TaskStatus.TaskInfo(
+                new TaskId(UUID.randomUUID()),
+                ResourceFixtures.A,
+                0,
+                0
+            ),
+            0.69F,
+            List.of(
+                new TaskStatus.Item(
+                    TaskStatus.ItemType.NORMAL,
+                    ResourceFixtures.A,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0
+                )
+            )
+        );
+    }
+}

refinedstorage-autocrafting-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/status/package-info.java

@@ -0,0 +1,7 @@
+@ParametersAreNonnullByDefault
+@FieldsAndMethodsAreNonnullByDefault
+package com.refinedmods.refinedstorage.api.autocrafting.status;
+
+import com.refinedmods.refinedstorage.api.core.FieldsAndMethodsAreNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;

refinedstorage-common-api/src/main/java/com/refinedmods/refinedstorage/common/api/grid/Grid.java

@@ -1,6 +1,6 @@
 package com.refinedmods.refinedstorage.common.api.grid;
 
-import com.refinedmods.refinedstorage.api.autocrafting.AutocraftingPreviewProvider;
+import com.refinedmods.refinedstorage.api.autocrafting.preview.PreviewProvider;
 import com.refinedmods.refinedstorage.api.grid.operations.GridOperations;
 import com.refinedmods.refinedstorage.api.grid.watcher.GridWatcher;
 import com.refinedmods.refinedstorage.api.storage.Actor;
@@ -16,7 +16,7 @@
 import org.apiguardian.api.API;
 
 @API(status = API.Status.STABLE, since = "2.0.0-milestone.3.0")
-public interface Grid extends AutocraftingPreviewProvider {
+public interface Grid extends PreviewProvider {
     void addWatcher(GridWatcher watcher, Class<? extends Actor> actorType);
 
     void removeWatcher(GridWatcher watcher);

refinedstorage-common/src/generated/resources/assets/refinedstorage/blockstates/autocrafting_monitor.json

@@ -0,0 +1,110 @@
+{
+  "variants": {
+    "active=false,direction=down_east": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": 90,
+      "y": -90
+    },
+    "active=false,direction=down_north": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": 90
+    },
+    "active=false,direction=down_south": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": 90,
+      "y": 180
+    },
+    "active=false,direction=down_west": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": 90,
+      "y": 90
+    },
+    "active=false,direction=east": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "y": 90
+    },
+    "active=false,direction=north": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive"
+    },
+    "active=false,direction=south": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "y": 180
+    },
+    "active=false,direction=up_east": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": -90,
+      "y": -90
+    },
+    "active=false,direction=up_north": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": -90,
+      "y": 180
+    },
+    "active=false,direction=up_south": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": -90
+    },
+    "active=false,direction=up_west": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "x": -90,
+      "y": 90
+    },
+    "active=false,direction=west": {
+      "model": "refinedstorage:block/autocrafting_monitor/inactive",
+      "y": 270
+    },
+    "active=true,direction=down_east": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": 90,
+      "y": -90
+    },
+    "active=true,direction=down_north": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": 90
+    },
+    "active=true,direction=down_south": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": 90,
+      "y": 180
+    },
+    "active=true,direction=down_west": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": 90,
+      "y": 90
+    },
+    "active=true,direction=east": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "y": 90
+    },
+    "active=true,direction=north": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue"
+    },
+    "active=true,direction=south": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "y": 180
+    },
+    "active=true,direction=up_east": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": -90,
+      "y": -90
+    },
+    "active=true,direction=up_north": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": -90,
+      "y": 180
+    },
+    "active=true,direction=up_south": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": -90
+    },
+    "active=true,direction=up_west": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "x": -90,
+      "y": 90
+    },
+    "active=true,direction=west": {
+      "model": "refinedstorage:block/autocrafting_monitor/light_blue",
+      "y": 270
+    }
+  }
+}