Skip to content

Refactor/rewrite string templating in kotlin #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SuperRicky14 merged 9 commits into from
Jan 25, 2026
Merged

Refactor/rewrite string templating in kotlin #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
646abb6
Rename .java to .kt
SuperRicky14 Jan 25, 2026
7d305d7
Do rewrite.
SuperRicky14 Jan 25, 2026
334ef0d
Makes the templating function work for any object. This is important …
SuperRicky14 Jan 25, 2026
87259b6
Refactor callers to use the rewritten String.template function.
SuperRicky14 Jan 25, 2026
384b8d0
Fix logging, prevent potential NullPointerException if Supplier or La…
SuperRicky14 Jan 25, 2026
4fc8274
Fix MsgFmtTest.java's tests, as the function contract changed.
SuperRicky14 Jan 25, 2026
306d400
Make MsgFmt.kt consume backslash when escaping
SuperRicky14 Jan 25, 2026
6b3089d
Update MsgFmtTest.java with new tests for updated function contract.
SuperRicky14 Jan 25, 2026
932be06
Refactor MsgFmt.kt to be less nested
SuperRicky14 Jan 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions common/src/main/java/net/superricky/tpaplusplus/commands/accept/AcceptTPA.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import net.superricky.tpaplusplus.requests.Request;
import net.superricky.tpaplusplus.requests.RequestGrabUtil;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.time.Duration;
import java.util.Map;
Expand All @@ -37,8 +37,8 @@ public static void acceptFunctionality(Request request, ServerPlayer receiver) {
}

public static void absoluteAcceptFunctionality(Request request, ServerPlayer receiver) {
receiver.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.RECEIVER_ACCEPTS_TPA.get(), Map.of("senders_name", request.getSender().getName().getString()))));
request.getSender().sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_GOT_ACCEPTED_TPA.get(), Map.of("receivers_name", request.getReceiver().getName().getString()))));
receiver.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.RECEIVER_ACCEPTS_TPA.get(), Map.of("senders_name", request.getSender().getName().getString()))));
request.getSender().sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_GOT_ACCEPTED_TPA.get(), Map.of("receivers_name", request.getReceiver().getName().getString()))));

RequestHelper.teleport(request);

Expand Down
8 changes: 4 additions & 4 deletions common/src/main/java/net/superricky/tpaplusplus/commands/block/BlockPlayer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import net.superricky.tpaplusplus.io.PlayerData;
import net.superricky.tpaplusplus.io.SaveDataManager;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.time.Duration;
import java.util.Map;
Expand All @@ -27,7 +27,7 @@ public static void blockPlayer(ServerPlayer executor, ServerPlayer blockedPlayer

if (executorData.hasBlockedPlayer(blockedPlayer.getUUID())) {
// Executor has already blocked the other player
executor.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.ALREADY_BLOCKED_PLAYER.get(),
executor.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.ALREADY_BLOCKED_PLAYER.get(),
Map.of("blocked_player", blockedPlayer.getName().getString()))));
return;
}
Expand All @@ -47,12 +47,12 @@ public static void blockPlayer(ServerPlayer executor, ServerPlayer blockedPlayer
public static void absoluteBlockPlayer(ServerPlayer executor, ServerPlayer blockedPlayer) {
SaveDataManager.INSTANCE.addBlockedPlayer(executor.getUUID(), blockedPlayer.getUUID());

executor.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_BLOCKED_PLAYER.get(),
executor.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_BLOCKED_PLAYER.get(),
Map.of("blocked_player", blockedPlayer.getName().getString()))));

if (Boolean.TRUE.equals(Config.SEND_BLOCKED_MESSAGES_TO_BOTH_PLAYERS.get())) {
// Sending Blocked / Unblocked Messages has been enabled in the config
blockedPlayer.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.PLAYER_BLOCKED_BY_SENDER.get(),
blockedPlayer.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.PLAYER_BLOCKED_BY_SENDER.get(),
Map.of("sender_name", executor.getName().getString()))));
}
}
Expand Down
6 changes: 3 additions & 3 deletions common/src/main/java/net/superricky/tpaplusplus/commands/cancel/CancelTPA.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import net.superricky.tpaplusplus.requests.Request;
import net.superricky.tpaplusplus.requests.RequestGrabUtil;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.time.Duration;
import java.util.Map;
Expand All @@ -37,8 +37,8 @@ private static void cancelFunctionality(Request request, ServerPlayer sender) {
}

public static void absoluteCancel(Request request) {
request.getSender().sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_CANCELS_TPA.get(), Map.of("cancelled_tpa_recipient", request.getReceiver().getName().getString()))));
request.getReceiver().sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.RECEIVER_GOT_CANCELLED_TPA.get(), Map.of("cancelling_sender_of_tpa", request.getSender().getName().getString()))));
request.getSender().sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_CANCELS_TPA.get(), Map.of("cancelled_tpa_recipient", request.getReceiver().getName().getString()))));
request.getReceiver().sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.RECEIVER_GOT_CANCELLED_TPA.get(), Map.of("cancelling_sender_of_tpa", request.getSender().getName().getString()))));

RequestHelper.getRequestSet().remove(request);
}
Expand Down
6 changes: 3 additions & 3 deletions common/src/main/java/net/superricky/tpaplusplus/commands/deny/DenyTPA.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import net.superricky.tpaplusplus.requests.Request;
import net.superricky.tpaplusplus.requests.RequestGrabUtil;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.time.Duration;
import java.util.Map;
Expand All @@ -37,8 +37,8 @@ private static void denyFunctionality(Request request, ServerPlayer receiver) {
}

public static void absoluteDeny(Request request) {
request.getReceiver().sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.RECEIVER_DENIES_TPA.get(), Map.of("denied_sender_name", request.getSender().getName().getString()))));
request.getSender().sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_GOT_DENIED_TPA.get(), Map.of("receiver_who_denied", request.getReceiver().getName().getString()))));
request.getReceiver().sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.RECEIVER_DENIES_TPA.get(), Map.of("denied_sender_name", request.getSender().getName().getString()))));
request.getSender().sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_GOT_DENIED_TPA.get(), Map.of("receiver_who_denied", request.getReceiver().getName().getString()))));

RequestHelper.getRequestSet().remove(request);
}
Expand Down
18 changes: 9 additions & 9 deletions common/src/main/java/net/superricky/tpaplusplus/commands/send/SendTPA.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import net.superricky.tpaplusplus.requests.Request;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.timeout.TimeoutManager;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.time.Duration;
import java.util.Map;
Expand All @@ -23,14 +23,14 @@ public class SendTPA {
private static boolean isEitherBlocked(ServerPlayer sender, ServerPlayer receiver) {
PlayerData senderData = SaveDataManager.INSTANCE.getPlayerData(sender.getUUID());
if (senderData.hasBlockedPlayer(receiver.getUUID())) {
sender.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_BLOCKED_RECEIVER.get(),
sender.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_BLOCKED_RECEIVER.get(),
Map.of("blocked_player", receiver.getName().getString()))));
return true;
}

PlayerData receiverData = SaveDataManager.INSTANCE.getPlayerData(receiver.getUUID());
if (receiverData.hasBlockedPlayer(sender.getUUID())) {
sender.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.RECEIVER_BLOCKED_SENDER.get(),
sender.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.RECEIVER_BLOCKED_SENDER.get(),
Map.of("blocking_player", receiver.getName().getString()))));
return true;
}
Expand All @@ -45,15 +45,15 @@ public static void sendTeleportRequest(ServerPlayer sender, ServerPlayer receive
}

if (RequestHelper.alreadySentTeleportRequest(sender, receiver)) {
sender.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.ERR_ALREADY_SENT_TELEPORT_REQUEST.get(), Map.of("receiver_name", receiver.getName().getString()))));
sender.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.ERR_ALREADY_SENT_TELEPORT_REQUEST.get(), Map.of("receiver_name", receiver.getName().getString()))));
return;
}

if (isEitherBlocked(sender, receiver)) return;

PlayerData receiverData = SaveDataManager.INSTANCE.getPlayerData(receiver.getUUID());
if (receiverData.getTpToggle()) { // receiverData is not null && receiver TP toggle is enabled.
sender.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.ERR_RECEIVER_TP_DISABLED.get(),
sender.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.ERR_RECEIVER_TP_DISABLED.get(),
Map.of("receiverName", receiver.getName().getString()))));
return;
}
Expand Down Expand Up @@ -111,11 +111,11 @@ public static void absoluteSendTeleportRequest(ServerPlayer sender, ServerPlayer


if (isHereRequest) {
sender.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_SENT_TPAHERE.get(), Map.of("receivers_name", receiver.getName().getString()))));
receiver.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.RECEIVER_GOT_TPAHERE.get(), Map.of("senders_name", sender.getName().getString()))));
sender.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_SENT_TPAHERE.get(), Map.of("receivers_name", receiver.getName().getString()))));
receiver.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.RECEIVER_GOT_TPAHERE.get(), Map.of("senders_name", sender.getName().getString()))));
} else {
sender.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_SENT_TPA.get(), Map.of("receivers_name", receiver.getName().getString()))));
receiver.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.RECEIVER_GOT_TPA.get(), Map.of("senders_name", sender.getName().getString()))));
sender.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_SENT_TPA.get(), Map.of("receivers_name", receiver.getName().getString()))));
receiver.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.RECEIVER_GOT_TPA.get(), Map.of("senders_name", sender.getName().getString()))));
}
}

Expand Down
8 changes: 4 additions & 4 deletions common/src/main/java/net/superricky/tpaplusplus/commands/tpaplusplus/TPAPlusPlusCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import net.superricky.tpaplusplus.config.Messages;
import net.superricky.tpaplusplus.network.UpdateCheckKt;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.util.Map;
import java.util.Objects;
Expand Down Expand Up @@ -78,8 +78,8 @@ private static int refactorColorSet(CommandSourceStack source, String... colorLi

for (String color : colorList) {
if (!ConfigReformatter.isValidColor(color)) {
source.sendFailure(Component.literal(MsgFmt.fmt(Messages.ERR_TPAPLUSPLUS_COLORS_INVALID_COLORS.get(), Map.of("invalid_color_code", color))));
source.sendFailure(Component.literal(MsgFmt.fmt(Messages.ERR_TPAPLUSPLUS_COLORS_INVALID_COLORS_EXAMPLES.get(), Map.of("random_color_code", (Supplier<String>) ConfigReformatter::getRandomColorCode))));
source.sendFailure(Component.literal(MsgFmtKt.template(Messages.ERR_TPAPLUSPLUS_COLORS_INVALID_COLORS.get(), Map.of("invalid_color_code", color))));
source.sendFailure(Component.literal(MsgFmtKt.template(Messages.ERR_TPAPLUSPLUS_COLORS_INVALID_COLORS_EXAMPLES.get(), Map.of("random_color_code", (Supplier<String>) ConfigReformatter::getRandomColorCode))));
return 0;
}
}
Expand Down Expand Up @@ -110,7 +110,7 @@ private static int refactorColorSet(CommandSourceStack source, String... colorLi
}

private static int version(CommandSourceStack source) {
source.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.TPAPLUSPLUS_VERSION.get(), Map.of("mod_version", TPAPlusPlus.MOD_VERSION)))); // send the mod's version to the command executor
source.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.TPAPLUSPLUS_VERSION.get(), Map.of("mod_version", TPAPlusPlus.MOD_VERSION)))); // send the mod's version to the command executor
source.sendSystemMessage(Component.literal("§6Checking for updates..."));

final Entity executor = source.getEntity();
Expand Down
8 changes: 4 additions & 4 deletions common/src/main/java/net/superricky/tpaplusplus/commands/unblock/UnBlockPlayer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import net.superricky.tpaplusplus.io.PlayerData;
import net.superricky.tpaplusplus.io.SaveDataManager;
import net.superricky.tpaplusplus.requests.RequestHelper;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.time.Duration;
import java.util.Map;
Expand All @@ -27,7 +27,7 @@ public static void unBlockPlayer(ServerPlayer executor, ServerPlayer blockedPlay

if (!executorData.hasBlockedPlayer(blockedPlayer.getUUID())) {
// Executor has not blocked the other player
executor.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.HAVENT_BLOCKED_PLAYER.get(),
executor.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.HAVENT_BLOCKED_PLAYER.get(),
Map.of("blocked_player", blockedPlayer.getName().getString()))));
return;
}
Expand All @@ -47,12 +47,12 @@ public static void unBlockPlayer(ServerPlayer executor, ServerPlayer blockedPlay
public static void absoluteUnBlockPlayer(ServerPlayer executor, ServerPlayer blockedPlayer) {
SaveDataManager.INSTANCE.removeBlockedPlayer(executor.getUUID(), blockedPlayer.getUUID());

executor.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.SENDER_UNBLOCKED_PLAYER.get(),
executor.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.SENDER_UNBLOCKED_PLAYER.get(),
Map.of("unblocked_player", blockedPlayer.getName().getString()))));

if (Boolean.TRUE.equals(Config.SEND_BLOCKED_MESSAGES_TO_BOTH_PLAYERS.get())) {
// Sending Blocked / Unblocked Messages has been enabled in the config
blockedPlayer.sendSystemMessage(Component.literal(MsgFmt.fmt(Messages.PLAYER_UNBLOCKED_BY_SENDER.get(),
blockedPlayer.sendSystemMessage(Component.literal(MsgFmtKt.template(Messages.PLAYER_UNBLOCKED_BY_SENDER.get(),
Map.of("sender_name", executor.getName().getString()))));
}
}
Expand Down
6 changes: 3 additions & 3 deletions common/src/main/java/net/superricky/tpaplusplus/cooldown/CooldownManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import net.minecraft.network.chat.Component
import net.minecraft.server.MinecraftServer
import net.minecraft.server.level.ServerPlayer
import net.superricky.tpaplusplus.config.Messages
import net.superricky.tpaplusplus.util.MsgFmt
import net.superricky.tpaplusplus.util.template
import java.time.Duration
import java.time.Instant
import java.util.*
Expand Down Expand Up @@ -47,8 +47,8 @@ object CooldownManager {
}
}

playerToNotify.sendSystemMessage(Component.literal(MsgFmt.fmt(
Messages.COMMAND_ON_COOLDOWN_MESSAGE.get(), mapOf(
playerToNotify.sendSystemMessage(Component.literal(Messages.COMMAND_ON_COOLDOWN_MESSAGE.get().template(
mapOf(
"command_used" to cooldownData.commandOnCooldown.getCommandNameFromType(),
"time_remaining" to formattedDurationText
)
Expand Down
14 changes: 7 additions & 7 deletions common/src/main/java/net/superricky/tpaplusplus/limitations/impl/DistanceLimitation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import net.superricky.tpaplusplus.config.Config;
import net.superricky.tpaplusplus.config.Messages;
import net.superricky.tpaplusplus.limitations.Limitation;
import net.superricky.tpaplusplus.util.MsgFmt;
import net.superricky.tpaplusplus.util.MsgFmtKt;

import java.util.Map;

Expand All @@ -30,13 +30,13 @@ public String getViolationMessage(ServerPlayer sender, ServerPlayer receiver) {
receiver.getX(), receiver.getY(), receiver.getZ());

if (distance > Config.FURTHEST_ALLOWED_DISTANCE.get()) {
return MsgFmt.fmt(Messages.ERR_TOO_FAR_EXECUTOR.get(),
Map.of(DISTANCE_IDENTIFIER, Math.round(distance),
EXPECTED_DISTANCE_IDENTIFIER, Math.round(Config.FURTHEST_ALLOWED_DISTANCE.get())));
return MsgFmtKt.template(Messages.ERR_TOO_FAR_EXECUTOR.get(),
Map.of(DISTANCE_IDENTIFIER, Double.toString(Math.round(distance)),
EXPECTED_DISTANCE_IDENTIFIER, Double.toString(Math.round(Config.FURTHEST_ALLOWED_DISTANCE.get()))));
} else {
return MsgFmt.fmt(Messages.ERR_TOO_CLOSE_EXECUTOR.get(),
Map.of(DISTANCE_IDENTIFIER, Math.round(distance),
EXPECTED_DISTANCE_IDENTIFIER, Math.round(Config.CLOSEST_ALLOWED_DISTANCE.get())));
return MsgFmtKt.template(Messages.ERR_TOO_CLOSE_EXECUTOR.get(),
Map.of(DISTANCE_IDENTIFIER, Double.toString(Math.round(distance)),
EXPECTED_DISTANCE_IDENTIFIER, Double.toString(Math.round(Config.CLOSEST_ALLOWED_DISTANCE.get()))));
}
}
}
17 changes: 5 additions & 12 deletions common/src/main/java/net/superricky/tpaplusplus/timeout/TimeoutManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import net.minecraft.server.MinecraftServer
import net.superricky.tpaplusplus.config.Messages
import net.superricky.tpaplusplus.requests.Request
import net.superricky.tpaplusplus.requests.RequestHelper
import net.superricky.tpaplusplus.util.MsgFmt
import net.superricky.tpaplusplus.util.template
import java.time.Duration
import java.time.Instant

Expand Down Expand Up @@ -39,18 +39,15 @@ object TimeoutManager {

if (timeout.request.isHereRequest) {
sender.sendSystemMessage(
Component.literal(
MsgFmt.fmt(
Messages.SENDER_TPAHERE_TIMEOUT.get(),
Component.literal(Messages.SENDER_TPAHERE_TIMEOUT.get().template(
mapOf("receivers_name" to receiver.displayName.string)
)
)
)

receiver.sendSystemMessage(
Component.literal(
MsgFmt.fmt(
Messages.RECEIVER_TPAHERE_TIMEOUT.get(),
Messages.RECEIVER_TPAHERE_TIMEOUT.get().template(
mapOf("senders_name" to sender.displayName.string)
)
)
Expand All @@ -61,18 +58,14 @@ object TimeoutManager {
}

sender.sendSystemMessage(
Component.literal(
MsgFmt.fmt(
Messages.SENDER_TPA_TIMEOUT.get(),
Component.literal(Messages.SENDER_TPA_TIMEOUT.get().template(
mapOf("receivers_name" to receiver.displayName.string)
)
)
)

receiver.sendSystemMessage(
Component.literal(
MsgFmt.fmt(
Messages.RECEIVER_TPA_TIMEOUT.get(),
Component.literal(Messages.RECEIVER_TPA_TIMEOUT.get().template(
mapOf("senders_name" to sender.displayName.string)
)
)
Expand Down
Loading
Loading