tags refactor

.editorconfig

@@ -6,7 +6,7 @@ indent_style = space
 insert_final_newline = true
 max_line_length = 130
 tab_width = 4
-ij_continuation_indent_size = 8
+ij_continuation_indent_size = 4
 ij_formatter_off_tag = @formatter:off
 ij_formatter_on_tag = @formatter:on
 ij_formatter_tags_enabled = false
@@ -137,7 +137,7 @@ ij_java_for_statement_wrap = off
 ij_java_generate_final_locals = true
 ij_java_generate_final_parameters = true
 ij_java_if_brace_force = always
-ij_java_imports_layout = *, |, javax.**, java.**, |, $*
+ij_java_imports_layout = *, |, $*
 ij_java_indent_case_from_switch = true
 ij_java_insert_inner_class_imports = false
 ij_java_insert_override_annotation = true

.github/workflows/build.yml

@@ -0,0 +1,16 @@
+name: "build"
+
+on:
+    push:
+        branches: [ "**" ]
+        tags-ignore: [ "**" ]
+    pull_request:
+    release:
+        types: [ released ]
+
+jobs:
+    call-build:
+        uses: "broccolai/actions/.github/workflows/shared-ci.yml@master"
+        secrets: inherit
+        with:
+            artifacts-path: 'paper/build/libs/tags-paper.jar'

.gitignore

@@ -155,5 +155,4 @@ gradle-app.setting
 # Custom Ignores
 build.sh
 .env
-
-bukkit/run
+paper/run

api/build.gradle.kts

@@ -2,4 +2,5 @@ dependencies {
     api(libs.guice.core)
     api(libs.minimessage)
     api(libs.event.api)
+    api(libs.configurate)
 }

api/src/main/java/broccolai/tags/api/TagsApi.java

@@ -16,7 +16,7 @@ public static void register(final @NonNull Injector injector) {
         INJECTOR = injector;
     }
 
-    public static <T extends Service> T getService(final @NonNull Class<T> clazz) {
+    public static <T extends Service> T service(final @NonNull Class<T> clazz) {
         return INJECTOR.getInstance(clazz);
     }
 

api/src/main/java/broccolai/tags/api/events/event/TagChangeEvent.java

@@ -1,7 +1,7 @@
 package broccolai.tags.api.events.event;
 
 import broccolai.tags.api.events.Event;
-import broccolai.tags.api.model.tag.Tag;
+import broccolai.tags.api.model.tag.ConstructedTag;
 import broccolai.tags.api.model.user.TagsUser;
 import net.kyori.event.Cancellable;
 import org.checkerframework.checker.nullness.qual.NonNull;
@@ -10,9 +10,9 @@
 public final class TagChangeEvent extends Cancellable.Impl implements Event {
 
     private final @NonNull TagsUser user;
-    private final @NonNull Tag tag;
+    private final @NonNull ConstructedTag tag;
 
-    public TagChangeEvent(final @NonNull TagsUser user, final @NonNull Tag tag) {
+    public TagChangeEvent(final @NonNull TagsUser user, final @NonNull ConstructedTag tag) {
         this.user = user;
         this.tag = tag;
     }
@@ -23,7 +23,7 @@ public TagChangeEvent(final @NonNull TagsUser user, final @NonNull Tag tag) {
     }
 
     @Pure
-    public @NonNull Tag tag() {
+    public @NonNull ConstructedTag tag() {
         return this.tag;
     }
 

api/src/main/java/broccolai/tags/api/model/tag/ConstructedTag.java

@@ -0,0 +1,21 @@
+package broccolai.tags.api.model.tag;
+
+import broccolai.tags.api.model.Permissible;
+import net.kyori.adventure.text.Component;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public record ConstructedTag(
+        int id,
+        @NonNull String name,
+        boolean secret,
+        @NonNull Component component,
+        @NonNull String reason,
+        @NonNull TagDisplayInformation displayInformation
+) implements Permissible {
+
+    @Override
+    public @NonNull String permission() {
+        return "tags.tag." + this.id();
+    }
+
+}

api/src/main/java/broccolai/tags/api/model/tag/TagDisplayInformation.java

@@ -0,0 +1,14 @@
+package broccolai.tags.api.model.tag;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.configurate.objectmapping.ConfigSerializable;
+
+//todo(josh): split tag into an interface and hide this in the implementation
+//            and remove configurate as a dependency in for api project
+@ConfigSerializable
+public record TagDisplayInformation(
+        @NonNull String material,
+        @Nullable Integer customModelData
+) {
+}

api/src/main/java/broccolai/tags/api/model/user/TagsUser.java

@@ -1,20 +1,19 @@
 package broccolai.tags.api.model.user;
 
-import broccolai.tags.api.model.tag.Tag;
+import broccolai.tags.api.model.tag.ConstructedTag;
 import broccolai.tags.api.model.user.impl.ConsoleTagsUser;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
 import java.util.Optional;
 import java.util.UUID;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 
 public interface TagsUser {
 
     TagsUser CONSOLE = new ConsoleTagsUser();
 
     @NonNull UUID uuid();
 
-    void setCurrent(@Nullable Tag tag);
+    void current(@Nullable ConstructedTag tag);
 
     @NonNull Optional<Integer> current();
 

api/src/main/java/broccolai/tags/api/model/user/impl/ConsoleTagsUser.java

@@ -1,12 +1,11 @@
 package broccolai.tags.api.model.user.impl;
 
-import broccolai.tags.api.model.tag.Tag;
+import broccolai.tags.api.model.tag.ConstructedTag;
 import broccolai.tags.api.model.user.TagsUser;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
 import java.util.Optional;
 import java.util.UUID;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 
 public final class ConsoleTagsUser implements TagsUser {
 
@@ -20,7 +19,7 @@ public final class ConsoleTagsUser implements TagsUser {
     }
 
     @Override
-    public void setCurrent(final @Nullable Tag tag) {
+    public void current(final @Nullable ConstructedTag tag) {
         this.currentTag = tag != null ? tag.id() : null;
     }
 

api/src/main/java/broccolai/tags/api/model/user/impl/PlayerTagsUser.java

@@ -1,12 +1,11 @@
 package broccolai.tags.api.model.user.impl;
 
-import broccolai.tags.api.model.tag.Tag;
+import broccolai.tags.api.model.tag.ConstructedTag;
 import broccolai.tags.api.model.user.TagsUser;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
 import java.util.Optional;
 import java.util.UUID;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 
 public final class PlayerTagsUser implements TagsUser {
 
@@ -27,7 +26,7 @@ public PlayerTagsUser(
     }
 
     @Override
-    public void setCurrent(final @Nullable Tag tag) {
+    public void current(final @Nullable ConstructedTag tag) {
         this.current = tag != null ? tag.id() : null;
     }
 

api/src/main/java/broccolai/tags/api/service/ActionService.java

@@ -0,0 +1,13 @@
+package broccolai.tags.api.service;
+
+import broccolai.tags.api.model.tag.ConstructedTag;
+import broccolai.tags.api.model.user.TagsUser;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public interface ActionService {
+
+    boolean select(@NonNull TagsUser user, @NonNull ConstructedTag tag);
+
+    void remove(@NonNull TagsUser user);
+
+}

api/src/main/java/broccolai/tags/api/service/DataService.java

@@ -2,10 +2,9 @@
 
 import broccolai.tags.api.model.Service;
 import broccolai.tags.api.model.user.TagsUser;
-import org.checkerframework.checker.nullness.qual.NonNull;
-
 import java.util.Optional;
 import java.util.UUID;
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 public interface DataService extends Service {
 

api/src/main/java/broccolai/tags/api/service/MessageService.java

@@ -1,31 +1,30 @@
 package broccolai.tags.api.service;
 
 import broccolai.tags.api.model.Service;
-import broccolai.tags.api.model.tag.Tag;
+import broccolai.tags.api.model.tag.ConstructedTag;
 import broccolai.tags.api.model.user.TagsUser;
+import java.util.Collection;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
 import org.checkerframework.checker.nullness.qual.NonNull;
 
-import java.util.Collection;
-
 public interface MessageService extends Service {
 
     TagResolver prefix();
 
-    Component commandSelect(@NonNull Tag tag);
+    Component commandSelect(@NonNull ConstructedTag tag);
 
-    Component commandList(@NonNull Collection<Tag> tags);
+    Component commandList(@NonNull Collection<ConstructedTag> tags);
 
-    Component commandInfo(@NonNull Tag tag);
+    Component commandInfo(@NonNull ConstructedTag tag);
 
-    Component commandAdminGive(@NonNull Tag tag, @NonNull TagsUser target);
+    Component commandAdminGive(@NonNull ConstructedTag tag, @NonNull TagsUser target);
 
-    Component commandAdminRemove(@NonNull Tag tag, @NonNull TagsUser target);
+    Component commandAdminRemove(@NonNull ConstructedTag tag, @NonNull TagsUser target);
 
-    Component commandAdminList(@NonNull Collection<Tag> tags);
+    Component commandAdminList(@NonNull Collection<ConstructedTag> tags);
 
-    Component commandAdminSet(@NonNull Tag tag, @NonNull TagsUser target);
+    Component commandAdminSet(@NonNull ConstructedTag tag, @NonNull TagsUser target);
 
     Component commandErrorUserNotFound(@NonNull String input);