Made the methods private in auditcommand and extracted them into moderationutils

Author: modwodmm

application/src/main/java/org/togetherjava/tjbot/features/moderation/ModerationUtils.java

@@ -1,6 +1,7 @@
 package org.togetherjava.tjbot.features.moderation;
 
 import net.dv8tion.jda.api.EmbedBuilder;
+import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.IPermissionHolder;
@@ -25,11 +26,17 @@
 
 import java.awt.Color;
 import java.time.Instant;
+import java.time.ZoneOffset;
 import java.time.temporal.ChronoUnit;
 import java.time.temporal.TemporalUnit;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.function.Predicate;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 
 /**
  * Utility class offering helpers revolving around user moderation, such as banning or kicking.
@@ -273,7 +280,7 @@ static boolean handleHasAuthorPermissions(String actionVerb, Permission permissi
      * Creates a message to be displayed as response to a moderation action.
      * <p>
      * Essentially, it informs others about the action, such as "John banned Bob for playing with
-     * the fire.".
+     * the fire".
      *
      * @param author the author executing the action
      * @param action the action that is executed
@@ -442,4 +449,84 @@ static RestAction<Boolean> sendModActionDm(RestAction<EmbedBuilder> embedBuilder
      */
     record TemporaryData(Instant expiresAt, String duration) {
     }
+
+    /**
+     * Splits a list of moderation records into discrete pages capped at 10 items each.
+     *
+     * @param actions the list of chronological actions against a target
+     * @return a list of sub-lists where each sub-list contains a maximum of 10 items
+     */
+    public static List<List<ActionRecord>> groupActionsByPages(List<ActionRecord> actions) {
+        List<List<ActionRecord>> groupedActions = new ArrayList<>();
+        final int maxPageLength = 10;
+
+        for (int i = 0; i < actions.size(); i++) {
+            if (i % maxPageLength == 0) {
+                groupedActions.add(new ArrayList<>(maxPageLength));
+            }
+            groupedActions.getLast().add(actions.get(i));
+        }
+
+        return groupedActions;
+    }
+
+    /**
+     * Generates a structural text overview outlining the count total of each action type.
+     *
+     * @param actions a collection of history records
+     * @return a formatted markdown description summary
+     */
+    public static String createSummaryMessageDescription(Collection<ActionRecord> actions) {
+        int actionAmount = actions.size();
+
+        String shortSummary = "There are **%s actions** against the user."
+            .formatted(actionAmount == 0 ? "no" : actionAmount);
+
+        if (actionAmount == 0) {
+            return shortSummary;
+        }
+
+        Map<ModerationAction, Long> actionTypeToCount = actions.stream()
+            .collect(Collectors.groupingBy(ActionRecord::actionType, Collectors.counting()));
+
+        String typeCountSummary = actionTypeToCount.entrySet()
+            .stream()
+            .filter(typeAndCount -> typeAndCount.getValue() > 0)
+            .sorted(Map.Entry.<ModerationAction, Long>comparingByValue().reversed())
+            .map(typeAndCount -> "- **%s**: %d".formatted(typeAndCount.getKey(),
+                    typeAndCount.getValue()))
+            .collect(Collectors.joining("\n"));
+
+        return shortSummary + "\n" + typeCountSummary;
+    }
+
+    /**
+     * Converts an action record item asynchronously into a formatted embed data field.
+     *
+     * @param action the record data item
+     * @param jda the active JDA instance used to resolve the moderator's handle
+     * @return a field representation task mapping out the execution card detail
+     */
+    public static RestAction<MessageEmbed.Field> actionToField(ActionRecord action, JDA jda) {
+        return jda.retrieveUserById(action.authorId())
+            .map(author -> author == null ? "(unknown user)" : author.getName())
+            .map(authorText -> {
+                String expiresAtFormatted = action.actionExpiresAt() == null ? ""
+                        : "\nTemporary action, expires at: " + net.dv8tion.jda.api.utils.TimeUtil
+                            .getDateTimeString(action.actionExpiresAt().atOffset(ZoneOffset.UTC));
+
+                String fieldName = "%s by %s".formatted(action.actionType().name(), authorText);
+                String fieldDescription =
+                        """
+                                %s
+                                Issued at: %s%s
+                                """.formatted(action.reason(),
+                                net.dv8tion.jda.api.utils.TimeUtil
+                                    .getDateTimeString(action.issuedAt().atOffset(ZoneOffset.UTC)),
+                                expiresAtFormatted);
+
+                return new MessageEmbed.Field(fieldName, fieldDescription, false);
+            });
+    }
+
 }

application/src/main/java/org/togetherjava/tjbot/features/moderation/ReportCommand.java

@@ -27,7 +27,6 @@
 import org.togetherjava.tjbot.features.CommandVisibility;
 import org.togetherjava.tjbot.features.MessageContextCommand;
 import org.togetherjava.tjbot.features.componentids.Lifespan;
-import org.togetherjava.tjbot.features.moderation.audit.AuditCommand;
 import org.togetherjava.tjbot.features.utils.MessageUtils;
 
 import java.awt.Color;
@@ -263,9 +262,9 @@ public void onButtonClick(ButtonInteractionEvent event, List<String> args) {
                     new EmbedBuilder().setTitle("Audit log of **%s**".formatted(user.getName()))
                         .setAuthor(user.getName(), null, user.getEffectiveAvatarUrl())
                         .setColor(Color.BLACK)
-                        .setDescription(AuditCommand.createSummaryMessageDescription(actions));
+                        .setDescription(ModerationUtils.createSummaryMessageDescription(actions));
 
-            List<List<ActionRecord>> pages = AuditCommand.groupActionsByPages(actions);
+            List<List<ActionRecord>> pages = ModerationUtils.groupActionsByPages(actions);
 
             if (pages.isEmpty()) {
                 event.getHook().sendMessageEmbeds(auditEmbed.build()).queue();
@@ -275,7 +274,7 @@ public void onButtonClick(ButtonInteractionEvent event, List<String> args) {
             List<net.dv8tion.jda.api.requests.RestAction<MessageEmbed.Field>> fieldTasks =
                     pages.getLast()
                         .stream()
-                        .map(action -> AuditCommand.actionToField(action, event.getJDA()))
+                        .map(action -> ModerationUtils.actionToField(action, event.getJDA()))
                         .toList();
 
             net.dv8tion.jda.api.requests.RestAction.allOf(fieldTasks).queue(fields -> {

application/src/main/java/org/togetherjava/tjbot/features/moderation/audit/AuditCommand.java

@@ -13,7 +13,6 @@
 import net.dv8tion.jda.api.interactions.commands.OptionType;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
 import net.dv8tion.jda.api.requests.RestAction;
-import net.dv8tion.jda.api.utils.TimeUtil;
 import net.dv8tion.jda.api.utils.messages.MessageCreateBuilder;
 import net.dv8tion.jda.api.utils.messages.MessageEditBuilder;
 import net.dv8tion.jda.api.utils.messages.MessageRequest;
@@ -22,21 +21,16 @@
 import org.togetherjava.tjbot.features.CommandVisibility;
 import org.togetherjava.tjbot.features.SlashCommandAdapter;
 import org.togetherjava.tjbot.features.moderation.ActionRecord;
-import org.togetherjava.tjbot.features.moderation.ModerationAction;
 import org.togetherjava.tjbot.features.moderation.ModerationActionsStore;
 import org.togetherjava.tjbot.features.moderation.ModerationUtils;
 
 import javax.annotation.Nullable;
 
-import java.time.Instant;
-import java.time.ZoneOffset;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
-import java.util.Map;
 import java.util.Objects;
 import java.util.function.Supplier;
-import java.util.stream.Collectors;
 
 /**
  * This command lists all moderation actions that have been taken against a given user, for example
@@ -49,7 +43,6 @@ public final class AuditCommand extends SlashCommandAdapter {
     private static final String TARGET_OPTION = "user";
     private static final String COMMAND_NAME = "audit";
     private static final String ACTION_VERB = "audit";
-    private static final int MAX_PAGE_LENGTH = 10;
     private static final String PREVIOUS_BUTTON_LABEL = "⬅";
     private static final String NEXT_BUTTON_LABEL = "➡";
     private final ModerationActionsStore actionsStore;
@@ -101,8 +94,8 @@ private boolean handleChecks(Member bot, Member author, @Nullable Member target,
 
     /**
      * @param pageNumber page number to display when actions are divided into pages and each page
-     *        can contain {@link AuditCommand#MAX_PAGE_LENGTH} actions, {@code -1} encodes the last
-     *        page
+     *        can contain {@link ModerationUtils#groupActionsByPages(List)} actions, {@code -1}
+     *        encodes the last page
      */
     private <R extends MessageRequest<R>> RestAction<R> auditUser(
             Supplier<R> messageBuilderSupplier, long guildId, long targetId, long callerId,
@@ -126,53 +119,20 @@ private <R extends MessageRequest<R>> RestAction<R> auditUser(
                     pageNumberInLimits, totalPages, guildId, targetId, callerId));
     }
 
-    public static List<List<ActionRecord>> groupActionsByPages(List<ActionRecord> actions) {
-        List<List<ActionRecord>> groupedActions = new ArrayList<>();
-        for (int i = 0; i < actions.size(); i++) {
-            if (i % AuditCommand.MAX_PAGE_LENGTH == 0) {
-                groupedActions.add(new ArrayList<>(AuditCommand.MAX_PAGE_LENGTH));
-            }
-
-            groupedActions.getLast().add(actions.get(i));
-        }
-
-        return groupedActions;
+    private static List<List<ActionRecord>> groupActionsByPages(List<ActionRecord> actions) {
+        return ModerationUtils.groupActionsByPages(actions);
     }
 
     private static EmbedBuilder createSummaryEmbed(User user, Collection<ActionRecord> actions) {
         String avatarOrDefaultUrl = user.getEffectiveAvatarUrl();
 
         return new EmbedBuilder().setTitle("Audit log of **%s**".formatted(user.getName()))
             .setAuthor(user.getName(), null, avatarOrDefaultUrl)
-            .setDescription(createSummaryMessageDescription(actions))
+            .setDescription(ModerationUtils.createSummaryMessageDescription(actions)) // Redirected
+                                                                                      // here
             .setColor(ModerationUtils.AMBIENT_COLOR);
     }
 
-    public static String createSummaryMessageDescription(Collection<ActionRecord> actions) {
-        int actionAmount = actions.size();
-
-        String shortSummary = "There are **%s actions** against the user."
-            .formatted(actionAmount == 0 ? "no" : actionAmount);
-
-        if (actionAmount == 0) {
-            return shortSummary;
-        }
-
-        // Summary of all actions with their count, like "- Warn: 5", descending
-        Map<ModerationAction, Long> actionTypeToCount = actions.stream()
-            .collect(Collectors.groupingBy(ActionRecord::actionType, Collectors.counting()));
-
-        String typeCountSummary = actionTypeToCount.entrySet()
-            .stream()
-            .filter(typeAndCount -> typeAndCount.getValue() > 0)
-            .sorted(Map.Entry.<ModerationAction, Long>comparingByValue().reversed())
-            .map(typeAndCount -> "- **%s**: %d".formatted(typeAndCount.getKey(),
-                    typeAndCount.getValue()))
-            .collect(Collectors.joining("\n"));
-
-        return shortSummary + "\n" + typeCountSummary;
-    }
-
     private RestAction<EmbedBuilder> attachEmbedFields(EmbedBuilder auditEmbed,
             List<? extends List<ActionRecord>> groupedActions, int pageNumber, int totalPages,
             JDA jda) {
@@ -192,26 +152,8 @@ private RestAction<EmbedBuilder> attachEmbedFields(EmbedBuilder auditEmbed,
         });
     }
 
-    public static RestAction<MessageEmbed.Field> actionToField(ActionRecord action, JDA jda) {
-        return jda.retrieveUserById(action.authorId())
-            .map(author -> author == null ? "(unknown user)" : author.getName())
-            .map(authorText -> {
-                String expiresAtFormatted = action.actionExpiresAt() == null ? ""
-                        : "\nTemporary action, expires at: " + formatTime(action.actionExpiresAt());
-
-                String fieldName = "%s by %s".formatted(action.actionType().name(), authorText);
-                String fieldDescription = """
-                        %s
-                        Issued at: %s%s
-                        """.formatted(action.reason(), formatTime(action.issuedAt()),
-                        expiresAtFormatted);
-
-                return new MessageEmbed.Field(fieldName, fieldDescription, false);
-            });
-    }
-
-    private static String formatTime(Instant when) {
-        return TimeUtil.getDateTimeString(when.atOffset(ZoneOffset.UTC));
+    private static RestAction<MessageEmbed.Field> actionToField(ActionRecord action, JDA jda) {
+        return ModerationUtils.actionToField(action, jda);
     }
 
     private <R extends MessageRequest<R>> R attachPageTurnButtons(