refactor isApplied to isResolved to better reflect its role

This commit is contained in:
Piotr W. committed 2026-04-25 13:33:49 +01:00
1 parent b7b0e0614a
commit 7aca149ddf
6 files changed
+15 -13

No files matched your search

@@ -138,7 +138,7 @@ public final class AdvisorModule extends AbstractModule {
}
public boolean isResolved(String id) {
return advisories.get(id).isApplied();
return advisories.get(id).isResolved();
}
public Set<String> getDismissedAdvisories() {
@@ -224,8 +224,8 @@ public final class AdvisorModule extends AbstractModule {
audience.sendMessage(
text(advisory.getName(), NamedTextColor.GOLD)
.decorate(TextDecoration.BOLD)
.append(text(" [" + (advisory.isApplied() ? "✔" : "✘") + "]",
advisory.isApplied() ? NamedTextColor.GREEN : NamedTextColor.RED))
.append(text(" [" + (advisory.isResolved() ? "✔" : "✘") + "]",
advisory.isResolved() ? NamedTextColor.GREEN : NamedTextColor.RED))
);
audience.sendMessage(advisory.getDescription().asComponent().color(NamedTextColor.YELLOW));
audience.sendMessage(Component.empty());
@@ -234,7 +234,7 @@ public final class AdvisorModule extends AbstractModule {
// dynamically generate actions based on advisory state
//noinspection ExtractMethodRecommender
boolean isApplied = advisory.isApplied();
boolean isApplied = advisory.isResolved();
boolean isDismissed = getDismissedAdvisories().contains(id);
Component actions = Component.empty();
@@ -278,7 +278,7 @@ public final class AdvisorModule extends AbstractModule {
TextColor colour;
if (dismissedAdvisories.contains(id)) { // dismissed
colour = NamedTextColor.GRAY;
} else if (!advisory.isApplied()) { // needs applied
} else if (!advisory.isResolved()) { // needs applied
colour = NamedTextColor.RED;
} else {
colour = NamedTextColor.GREEN;
@@ -42,17 +42,17 @@ public abstract class AbstractAdvisory implements Advisory {
return severity;
}
public abstract boolean isApplied();
public abstract boolean isResolved();
/**
* Called when the advisory is being resolved.
* @implNote {@link AbstractAdvisory#resolve()} already checks if the advisory is applied, so
* {@link AbstractAdvisory#isApplied()} is always {@code false} in this function.
* {@link AbstractAdvisory#isResolved()} is always {@code false} in this function.
*/
protected abstract void onResolve();
public final void resolve() {
if (isApplied()) return;
if (isResolved()) return;
onResolve();
}
}
@@ -25,5 +25,5 @@ public interface Advisory {
* Check if the advisory applies
* @return whether the advisory is not implemented
*/
boolean isApplied();
boolean isResolved();
}
@@ -30,7 +30,7 @@ public class ConfigAdvisory<T> extends AbstractAdvisory {
}
@Override
public boolean isApplied() {
public boolean isResolved() {
return Objects.equals(config.getValue(path), recommendedValue);
}
@@ -30,7 +30,7 @@ public class LambdaAdvisory extends AbstractAdvisory{
}
@Override
public boolean isApplied() {
public boolean isResolved() {
return isApplied.getAsBoolean();
}
@@ -8,6 +8,7 @@ import dev.piotr_weychan.szlaban.behaviour.AbstractBehaviour;
import dev.piotr_weychan.szlaban.behaviour.BehaviourContext;
import dev.piotr_weychan.szlaban.behaviour.Capability;
import org.bukkit.plugin.java.JavaPlugin;
import org.junit.jupiter.api.BeforeEach;
import org.slf4j.Logger;
import java.util.EnumSet;
@@ -19,7 +20,7 @@ import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
class AbstractModuleTest {
protected static final JavaPlugin mockPlugin = mock(JavaPlugin.class);
private static final JavaPlugin mockPlugin = mock(JavaPlugin.class);
private static class TestBehaviour extends AbstractBehaviour {
public int started = 0;
@@ -46,7 +47,8 @@ class AbstractModuleTest {
}
}
AbstractModuleTest() {
@BeforeEach
void setup() {
Logger logger = mock(Logger.class);
when(mockPlugin.getSLF4JLogger()).thenReturn(logger);
}