feat(quests): show custom reward item names
This commit is contained in:
@@ -2,10 +2,17 @@ package games.dmg.spigotquestboard;
|
||||
|
||||
import java.util.Base64;
|
||||
import java.util.Objects;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
|
||||
import org.bukkit.Material;
|
||||
import org.bukkit.inventory.ItemStack;
|
||||
import org.bukkit.inventory.meta.ItemMeta;
|
||||
|
||||
record EscrowItem(String material, int amount, String serializedItem, String customName) {
|
||||
EscrowItem(String material, int amount, String serializedItem) {
|
||||
this(material, amount, serializedItem, null);
|
||||
}
|
||||
|
||||
record EscrowItem(String material, int amount, String serializedItem) {
|
||||
EscrowItem {
|
||||
Objects.requireNonNull(material, "material");
|
||||
material = material.trim().toUpperCase(java.util.Locale.ROOT);
|
||||
@@ -18,24 +25,43 @@ record EscrowItem(String material, int amount, String serializedItem) {
|
||||
if (serializedItem != null && serializedItem.isBlank()) {
|
||||
throw new IllegalArgumentException("Serialized item must not be blank");
|
||||
}
|
||||
customName = normalizeReadableName(customName);
|
||||
}
|
||||
|
||||
static EscrowItem fromItemStack(ItemStack stack) {
|
||||
Objects.requireNonNull(stack, "stack");
|
||||
if (stack.getType().isAir() || stack.getAmount() <= 0) {
|
||||
if (isAir(stack.getType()) || stack.getAmount() <= 0) {
|
||||
throw new IllegalArgumentException("Reward stack must not be empty");
|
||||
}
|
||||
ItemStack snapshot = stack.clone();
|
||||
return new EscrowItem(
|
||||
snapshot.getType().name(), snapshot.getAmount(),
|
||||
Base64.getEncoder().encodeToString(snapshot.serializeAsBytes())
|
||||
Base64.getEncoder().encodeToString(snapshot.serializeAsBytes()),
|
||||
readableCustomName(snapshot)
|
||||
);
|
||||
}
|
||||
|
||||
EscrowItem inferCustomName() {
|
||||
if (customName != null || serializedItem == null) {
|
||||
return this;
|
||||
}
|
||||
try {
|
||||
String inferredName = readableCustomName(deserializeExactItem());
|
||||
return inferredName == null
|
||||
? this : new EscrowItem(material, amount, serializedItem, inferredName);
|
||||
} catch (RuntimeException | LinkageError exception) {
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
ItemStack toItemStack() {
|
||||
if (serializedItem == null) {
|
||||
return new ItemStack(Objects.requireNonNull(Material.matchMaterial(material)), amount);
|
||||
}
|
||||
return deserializeExactItem();
|
||||
}
|
||||
|
||||
private ItemStack deserializeExactItem() {
|
||||
final ItemStack stack;
|
||||
try {
|
||||
stack = ItemStack.deserializeBytes(Base64.getDecoder().decode(serializedItem));
|
||||
@@ -47,4 +73,34 @@ record EscrowItem(String material, int amount, String serializedItem) {
|
||||
}
|
||||
return stack;
|
||||
}
|
||||
|
||||
private static boolean isAir(Material material) {
|
||||
return material == Material.AIR || material == Material.CAVE_AIR
|
||||
|| material == Material.VOID_AIR;
|
||||
}
|
||||
|
||||
private static String readableCustomName(ItemStack stack) {
|
||||
if (!stack.hasItemMeta()) {
|
||||
return null;
|
||||
}
|
||||
ItemMeta metadata = stack.getItemMeta();
|
||||
if (!metadata.hasCustomName()) {
|
||||
return null;
|
||||
}
|
||||
Component name = metadata.customName();
|
||||
if (name == null) {
|
||||
return null;
|
||||
}
|
||||
return normalizeReadableName(
|
||||
PlainTextComponentSerializer.plainText().serialize(name)
|
||||
);
|
||||
}
|
||||
|
||||
private static String normalizeReadableName(String name) {
|
||||
if (name == null) {
|
||||
return null;
|
||||
}
|
||||
String normalized = name.replaceAll("[\\p{Cntrl}\\s]+", " ").trim();
|
||||
return normalized.isEmpty() ? null : normalized;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -37,6 +37,9 @@ final class QuestListingFormatter {
|
||||
}
|
||||
|
||||
private static String formatReward(EscrowItem item) {
|
||||
if (item.customName() != null) {
|
||||
return item.amount() + " × " + item.customName() + " (" + item.material() + ")";
|
||||
}
|
||||
return item.amount() + " × " + item.material()
|
||||
+ (item.serializedItem() == null ? "" : " (with exact item data)");
|
||||
}
|
||||
|
||||
@@ -165,9 +165,14 @@ final class YamlQuestRepository implements QuestRepository {
|
||||
if (data != null && !(data instanceof String)) {
|
||||
throw new IllegalArgumentException("Invalid item-data");
|
||||
}
|
||||
Object customName = entry.get("custom-name");
|
||||
if (customName != null && !(customName instanceof String)) {
|
||||
throw new IllegalArgumentException("Invalid custom-name");
|
||||
}
|
||||
items.add(new EscrowItem(
|
||||
requiredString(entry, "material"), requiredInteger(entry, "amount"), (String) data
|
||||
));
|
||||
requiredString(entry, "material"), requiredInteger(entry, "amount"),
|
||||
(String) data, (String) customName
|
||||
).inferCustomName());
|
||||
}
|
||||
return items;
|
||||
}
|
||||
@@ -181,6 +186,9 @@ final class YamlQuestRepository implements QuestRepository {
|
||||
if (item.serializedItem() != null) {
|
||||
serialized.put("item-data", item.serializedItem());
|
||||
}
|
||||
if (item.customName() != null) {
|
||||
serialized.put("custom-name", item.customName());
|
||||
}
|
||||
serializedItems.add(serialized);
|
||||
}
|
||||
return serializedItems;
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
package games.dmg.spigotquestboard;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import java.util.Base64;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
import net.kyori.adventure.text.format.TextDecoration;
|
||||
import org.bukkit.Material;
|
||||
import org.bukkit.inventory.ItemStack;
|
||||
import org.bukkit.inventory.meta.ItemMeta;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.mockito.MockedStatic;
|
||||
import org.mockito.Mockito;
|
||||
|
||||
final class EscrowItemTest {
|
||||
@Test
|
||||
void capturesStyledCustomNameAsSafePlainTextWithoutChangingSerializedBytes() {
|
||||
byte[] exactBytes = new byte[] {1, 2, 3, 4};
|
||||
ItemStack original = mock(ItemStack.class);
|
||||
ItemStack snapshot = mock(ItemStack.class);
|
||||
ItemMeta metadata = mock(ItemMeta.class);
|
||||
when(original.getType()).thenReturn(Material.PAPER);
|
||||
when(original.getAmount()).thenReturn(2);
|
||||
when(original.clone()).thenReturn(snapshot);
|
||||
when(snapshot.getType()).thenReturn(Material.PAPER);
|
||||
when(snapshot.getAmount()).thenReturn(2);
|
||||
when(snapshot.serializeAsBytes()).thenReturn(exactBytes);
|
||||
when(snapshot.hasItemMeta()).thenReturn(true);
|
||||
when(snapshot.getItemMeta()).thenReturn(metadata);
|
||||
when(metadata.hasCustomName()).thenReturn(true);
|
||||
when(metadata.customName()).thenReturn(
|
||||
Component.text(" Shopping", NamedTextColor.GOLD, TextDecoration.BOLD)
|
||||
.append(Component.text("\nList ", NamedTextColor.BLUE))
|
||||
);
|
||||
|
||||
EscrowItem escrow = EscrowItem.fromItemStack(original);
|
||||
|
||||
assertEquals("Shopping List", escrow.customName());
|
||||
assertArrayEquals(exactBytes, Base64.getDecoder().decode(escrow.serializedItem()));
|
||||
}
|
||||
|
||||
@Test
|
||||
void ignoresVanillaDisplayNameWhenNoTrueCustomNameExists() {
|
||||
ItemStack original = mock(ItemStack.class);
|
||||
ItemStack snapshot = mock(ItemStack.class);
|
||||
ItemMeta metadata = mock(ItemMeta.class);
|
||||
when(original.getType()).thenReturn(Material.DIAMOND);
|
||||
when(original.getAmount()).thenReturn(3);
|
||||
when(original.clone()).thenReturn(snapshot);
|
||||
when(snapshot.getType()).thenReturn(Material.DIAMOND);
|
||||
when(snapshot.getAmount()).thenReturn(3);
|
||||
when(snapshot.serializeAsBytes()).thenReturn(new byte[] {9});
|
||||
when(snapshot.hasItemMeta()).thenReturn(true);
|
||||
when(snapshot.getItemMeta()).thenReturn(metadata);
|
||||
when(metadata.hasCustomName()).thenReturn(false);
|
||||
|
||||
assertNull(EscrowItem.fromItemStack(original).customName());
|
||||
}
|
||||
|
||||
@Test
|
||||
void historicalInferenceDoesNotWeakenExactEnvelopeValidation() {
|
||||
String data = Base64.getEncoder().encodeToString(new byte[] {7});
|
||||
EscrowItem escrow = new EscrowItem("PAPER", 1, data);
|
||||
ItemStack mismatched = mock(ItemStack.class);
|
||||
when(mismatched.getType()).thenReturn(Material.BOOK);
|
||||
when(mismatched.getAmount()).thenReturn(1);
|
||||
|
||||
try (MockedStatic<ItemStack> itemStacks = Mockito.mockStatic(ItemStack.class)) {
|
||||
itemStacks.when(() -> ItemStack.deserializeBytes(Mockito.any(byte[].class)))
|
||||
.thenReturn(mismatched);
|
||||
|
||||
assertEquals(escrow, escrow.inferCustomName());
|
||||
assertThrows(IllegalStateException.class, escrow::toItemStack);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -32,6 +32,19 @@ final class QuestListingFormatterTest {
|
||||
assertTrue(listing.contains("Time remaining: 1d 1h 1m 1s"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void showsCustomRewardNameTogetherWithMaterialType() {
|
||||
Quest quest = quest(
|
||||
NOW.plusSeconds(60),
|
||||
List.of(new EscrowItem("PAPER", 1, "opaque-exact-data", "Shopping List"))
|
||||
);
|
||||
|
||||
String listing = QuestListingFormatter.format(quest, NOW);
|
||||
|
||||
assertTrue(listing.contains("1 × Shopping List (PAPER)"));
|
||||
assertFalse(listing.contains("PAPER (with exact item data)"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void roundsAnActiveSubsecondBoundaryUpToOneSecond() {
|
||||
Quest quest = quest(NOW.plusNanos(1), List.of(new EscrowItem("DIAMOND", 1, null)));
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
package games.dmg.spigotquestboard;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.file.Files;
|
||||
@@ -12,8 +15,14 @@ import java.util.Base64;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import org.bukkit.Material;
|
||||
import org.bukkit.inventory.ItemStack;
|
||||
import org.bukkit.inventory.meta.ItemMeta;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.io.TempDir;
|
||||
import org.mockito.MockedStatic;
|
||||
import org.mockito.Mockito;
|
||||
|
||||
final class YamlQuestRepositoryTest {
|
||||
@TempDir Path temporaryDirectory;
|
||||
@@ -53,6 +62,90 @@ final class YamlQuestRepositoryTest {
|
||||
assertTrue(yaml.contains(itemData));
|
||||
}
|
||||
|
||||
@Test
|
||||
void persistsCustomNamesForRewardAndClaimItems() throws Exception {
|
||||
Path path = temporaryDirectory.resolve("quests.yml");
|
||||
YamlQuestRepository repository = new YamlQuestRepository(path);
|
||||
UUID ownerId = UUID.randomUUID();
|
||||
UUID questId = UUID.randomUUID();
|
||||
Quest quest = new Quest(
|
||||
questId, ownerId, "Issuer", "STONE", 1,
|
||||
List.of(new EscrowItem("PAPER", 1, "reward-data", "Shopping List")),
|
||||
Instant.parse("2026-09-05T03:00:00Z"),
|
||||
Instant.parse("2026-09-12T03:00:00Z"), QuestStatus.COMPLETED
|
||||
);
|
||||
QuestClaim claim = new QuestClaim(
|
||||
UUID.randomUUID(), questId, ownerId,
|
||||
List.of(new EscrowItem("BOOK", 1, "claim-data", "Field Notes")),
|
||||
Instant.parse("2026-09-05T03:01:00Z")
|
||||
);
|
||||
QuestState state = new QuestState(
|
||||
Map.of(questId, quest), Map.of(ownerId, List.of(claim)), Map.of()
|
||||
);
|
||||
|
||||
repository.save(state);
|
||||
|
||||
assertEquals(state, repository.load());
|
||||
String yaml = Files.readString(path);
|
||||
assertTrue(yaml.contains("custom-name: Shopping List"));
|
||||
assertTrue(yaml.contains("custom-name: Field Notes"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void infersHistoricalCustomNameFromExactDataAndPersistsItOnNextSave() throws Exception {
|
||||
Path path = temporaryDirectory.resolve("quests.yml");
|
||||
String itemData = Base64.getEncoder().encodeToString(new byte[] {7});
|
||||
writeHistoricalQuest(path, itemData);
|
||||
ItemStack stack = mock(ItemStack.class);
|
||||
ItemMeta metadata = mock(ItemMeta.class);
|
||||
when(stack.getType()).thenReturn(Material.PAPER);
|
||||
when(stack.getAmount()).thenReturn(1);
|
||||
when(stack.hasItemMeta()).thenReturn(true);
|
||||
when(stack.getItemMeta()).thenReturn(metadata);
|
||||
when(metadata.hasCustomName()).thenReturn(true);
|
||||
when(metadata.customName()).thenReturn(Component.text("Archived List"));
|
||||
YamlQuestRepository repository = new YamlQuestRepository(path);
|
||||
|
||||
QuestState loaded;
|
||||
try (MockedStatic<ItemStack> itemStacks = Mockito.mockStatic(ItemStack.class)) {
|
||||
itemStacks.when(() -> ItemStack.deserializeBytes(Mockito.any(byte[].class)))
|
||||
.thenReturn(stack);
|
||||
loaded = repository.load();
|
||||
}
|
||||
|
||||
assertEquals("Archived List", loaded.quests().values().iterator().next()
|
||||
.reward().getFirst().customName());
|
||||
assertEquals("Archived List", loaded.claims().values().iterator().next()
|
||||
.getFirst().items().getFirst().customName());
|
||||
repository.save(loaded);
|
||||
assertTrue(Files.readString(path).contains("custom-name: Archived List"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void malformedOrUnavailableHistoricalItemDataFallsBackWithoutFailingLoad() throws Exception {
|
||||
Path malformedPath = temporaryDirectory.resolve("malformed.yml");
|
||||
writeHistoricalQuest(malformedPath, "not-base64%%% ");
|
||||
|
||||
Quest malformedQuest = new YamlQuestRepository(malformedPath).load()
|
||||
.quests().values().iterator().next();
|
||||
|
||||
assertNull(malformedQuest.reward().getFirst().customName());
|
||||
assertTrue(QuestListingFormatter.format(
|
||||
malformedQuest, Instant.parse("2026-09-06T03:00:00Z")
|
||||
).contains("1 × PAPER (with exact item data)"));
|
||||
|
||||
Path unavailablePath = temporaryDirectory.resolve("unavailable.yml");
|
||||
writeHistoricalQuest(unavailablePath, Base64.getEncoder().encodeToString(new byte[] {8}));
|
||||
Quest unavailableQuest;
|
||||
try (MockedStatic<ItemStack> itemStacks = Mockito.mockStatic(ItemStack.class)) {
|
||||
itemStacks.when(() -> ItemStack.deserializeBytes(Mockito.any(byte[].class)))
|
||||
.thenThrow(new IllegalStateException("server item codec unavailable"));
|
||||
unavailableQuest = new YamlQuestRepository(unavailablePath).load()
|
||||
.quests().values().iterator().next();
|
||||
}
|
||||
assertNull(unavailableQuest.reward().getFirst().customName());
|
||||
}
|
||||
|
||||
@Test
|
||||
void missingLifecycleStatusDefaultsToActiveForExistingYaml() throws Exception {
|
||||
Path path = temporaryDirectory.resolve("quests.yml");
|
||||
@@ -161,6 +254,32 @@ final class YamlQuestRepositoryTest {
|
||||
assertEquals(QuestClaimType.RETURNED_REWARD, claim.type());
|
||||
}
|
||||
|
||||
private static void writeHistoricalQuest(Path path, String itemData) throws IOException {
|
||||
Files.writeString(path, """
|
||||
quests:
|
||||
- id: 00000000-0000-0000-0000-000000000010
|
||||
issuer-id: 00000000-0000-0000-0000-000000000001
|
||||
issuer-name: Issuer
|
||||
requested-material: STONE
|
||||
requested-amount: 1
|
||||
created-at: '2026-09-05T03:00:00Z'
|
||||
expires-at: '2026-09-12T03:00:00Z'
|
||||
reward:
|
||||
- material: PAPER
|
||||
amount: 1
|
||||
item-data: '%s'
|
||||
claims:
|
||||
- id: 00000000-0000-0000-0000-000000000020
|
||||
quest-id: 00000000-0000-0000-0000-000000000010
|
||||
owner-id: 00000000-0000-0000-0000-000000000001
|
||||
created-at: '2026-09-05T04:00:00Z'
|
||||
items:
|
||||
- material: PAPER
|
||||
amount: 1
|
||||
item-data: '%s'
|
||||
""".formatted(itemData, itemData));
|
||||
}
|
||||
|
||||
@Test
|
||||
void malformedStateIsRejectedRatherThanPartiallyLoaded() throws Exception {
|
||||
Path path = temporaryDirectory.resolve("quests.yml");
|
||||
|
||||
Reference in New Issue
Block a user