feat(paper): add a provided sender mapper

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/ConsoleSource.java

@@ -0,0 +1,42 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.paper.sender;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import org.bukkit.command.ConsoleCommandSender;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+@SuppressWarnings("UnstableApiUsage")
+public final class ConsoleSource extends GenericSource {
+
+    ConsoleSource(final CommandSourceStack commandSourceStack) {
+        super(commandSourceStack);
+    }
+
+    @Override
+    public @NonNull ConsoleCommandSender source() {
+        return (ConsoleCommandSender) super.source();
+    }
+
+}

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/EntitySource.java

@@ -0,0 +1,41 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.paper.sender;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import org.bukkit.entity.Entity;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+@SuppressWarnings("UnstableApiUsage")
+public final class EntitySource extends GenericSource {
+
+    EntitySource(final CommandSourceStack commandSourceStack) {
+        super(commandSourceStack);
+    }
+
+    @Override
+    public @NonNull Entity source() {
+        return (Entity) super.source();
+    }
+}

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/GenericSource.java

@@ -0,0 +1,59 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.paper.sender;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import net.kyori.adventure.audience.Audience;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Entity;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+@SuppressWarnings("UnstableApiUsage")
+public class GenericSource implements Source {
+
+    private final CommandSourceStack commandSourceStack;
+
+    GenericSource(final @NonNull CommandSourceStack commandSourceStack) {
+        this.commandSourceStack = commandSourceStack;
+    }
+
+    @Override
+    public final @NonNull CommandSourceStack stack() {
+        return this.commandSourceStack;
+    }
+
+    /**
+     * @see Source#source()
+     */
+    @Override
+    public @NonNull CommandSender source() {
+        return this.commandSourceStack.getSender();
+    }
+
+    @Override
+    public final @NonNull Audience audience() {
+        Entity executor = this.commandSourceStack.getExecutor();
+        return executor == null ? this.commandSourceStack.getSender() : executor;
+    }
+}

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/PaperSimpleSenderMapper.java

@@ -0,0 +1,72 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.paper.sender;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import org.bukkit.command.CommandSender;
+import org.bukkit.command.ConsoleCommandSender;
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.Player;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.incendo.cloud.SenderMapper;
+
+@SuppressWarnings("UnstableApiUsage")
+public final class PaperSimpleSenderMapper implements SenderMapper<CommandSourceStack, Source> {
+
+    /**
+     * Create a new instance of {@link PaperSimpleSenderMapper}.
+     *
+     * @return a new instance of {@link PaperSimpleSenderMapper}
+     */
+    public static @NonNull PaperSimpleSenderMapper simpleSenderMapper() {
+        return new PaperSimpleSenderMapper();
+    }
+
+    PaperSimpleSenderMapper() {
+    }
+
+    @Override
+    public @NonNull Source map(final @NonNull CommandSourceStack base) {
+        CommandSender commandSender = base.getSender();
+
+        if (commandSender instanceof ConsoleCommandSender) {
+            return new ConsoleSource(base);
+        }
+
+        if (commandSender instanceof Player) {
+            return new PlayerSource(base);
+        }
+
+        if (commandSender instanceof Entity) {
+            return new EntitySource(base);
+        }
+
+        return new GenericSource(base);
+    }
+
+    @Override
+    public @NonNull CommandSourceStack reverse(final @NonNull Source mapped) {
+        return mapped.stack();
+    }
+}

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/PlayerSource.java

@@ -0,0 +1,41 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.paper.sender;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import org.bukkit.entity.Player;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+@SuppressWarnings("UnstableApiUsage")
+public final class PlayerSource extends GenericSource {
+
+    PlayerSource(final CommandSourceStack commandSourceStack) {
+        super(commandSourceStack);
+    }
+
+    @Override
+    public @NonNull Player source() {
+        return (Player) super.source();
+    }
+}

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/Source.java

@@ -0,0 +1,54 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.paper.sender;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import net.kyori.adventure.audience.Audience;
+import org.bukkit.command.CommandSender;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+@SuppressWarnings("UnstableApiUsage")
+public interface Source {
+
+    /**
+     * Gets the command source stack.
+     *
+     * @return the command source stack
+     */
+    @NonNull CommandSourceStack stack();
+
+    /**
+     * Gets the underlying command sender from the command source stack.
+     *
+     * @return the sender.
+     */
+    @NonNull CommandSender source();
+
+    /**
+     * Gets the audience of the source.
+     *
+     * @return the audience
+     */
+    @NonNull Audience audience();
+}

cloud-paper/src/main/java/org/incendo/cloud/paper/sender/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Built in CommandSender mappings for Modern Paper.
+ */
+package org.incendo.cloud.paper.sender;

examples/example-paper/src/main/java/org/incendo/cloud/examples/paper/PaperPlugin.java

@@ -23,18 +23,17 @@
 //
 package org.incendo.cloud.examples.paper;
 
-import io.papermc.paper.command.brigadier.CommandSourceStack;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.framework.qual.DefaultQualifier;
 import org.incendo.cloud.paper.PaperCommandManager;
+import org.incendo.cloud.paper.sender.Source;
 
-@SuppressWarnings("UnstableApiUsage")
 @DefaultQualifier(NonNull.class)
 public final class PaperPlugin extends JavaPlugin {
-    private final PaperCommandManager.Bootstrapped<CommandSourceStack> commandManager;
+    private final PaperCommandManager.Bootstrapped<Source> commandManager;
 
-    public PaperPlugin(final PaperCommandManager.Bootstrapped<CommandSourceStack> commandManager) {
+    public PaperPlugin(final PaperCommandManager.Bootstrapped<Source> commandManager) {
         this.commandManager = commandManager;
     }