LoginSystem/src/test/java/fr/xephi/authme/command/TestCommandsUtil.java

package fr.xephi.authme.command;

import com.google.common.collect.ImmutableList;
import fr.xephi.authme.command.executable.HelpCommand;
import fr.xephi.authme.permission.AdminPermission;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PlayerPermission;
import org.bukkit.command.CommandSender;

import java.util.Collection;
import java.util.List;

import static java.util.Arrays.asList;
import static java.util.Collections.singletonList;

/**
 * Util class for generating and retrieving test commands.
 */
public final class TestCommandsUtil {

    private TestCommandsUtil() {
    }

    /**
     * Generate the collection of test commands.
     *
     * @return The generated commands
     */
    public static List<CommandDescription> generateCommands() {
        // Register /authme
        CommandDescription authMeBase = createCommand(null, null, singletonList("authme"), ExecutableCommand.class);
        // Register /authme login <password>
        createCommand(PlayerPermission.LOGIN, authMeBase, singletonList("login"),
            TestLoginCommand.class, newArgument("password", false));
        // Register /authme register <password> <confirmation>, aliases: /authme reg, /authme r
        createCommand(PlayerPermission.LOGIN, authMeBase, asList("register", "reg", "r"), TestRegisterCommand.class,
            newArgument("password", false), newArgument("confirmation", false));

        // Register /email [player]
        CommandDescription emailBase = createCommand(null, null, singletonList("email"), ExecutableCommand.class,
            newArgument("player", true));
        // Register /email helptest -- use only to test for help command arguments special case
        CommandDescription.builder().parent(emailBase).labels("helptest").executableCommand(HelpCommand.class)
            .description("test").detailedDescription("Test.").withArgument("Query", "", false).register();

        // Register /unregister <player>, alias: /unreg
        CommandDescription unregisterBase = createCommand(AdminPermission.UNREGISTER, null,
            asList("unregister", "unreg"), TestUnregisterCommand.class, newArgument("player", false));

        return ImmutableList.of(authMeBase, emailBase, unregisterBase);
    }

    /**
     * Retrieve the command with the given label from the collection of commands.
     * Example: <code>getCommandWithLabel(commands, "authme", "reg")</code> to find the command description
     * which defines the command /authme reg.
     *
     * @param commands The commands to search in
     * @param parentLabel The parent label to search for
     * @param childLabel The child label to find
     * @return The matched command, or throws an exception if no command could be found
     */
    public static CommandDescription getCommandWithLabel(Collection<CommandDescription> commands, String parentLabel,
                                                         String childLabel) {
        CommandDescription parent = getCommandWithLabel(commands, parentLabel);
        return getCommandWithLabel(parent.getChildren(), childLabel);
    }

    /**
     * Retrieve the command with the given label from the collection of commands.
     *
     * @param commands The commands to search in
     * @param label The label to search for
     * @return The matched command, or throws an exception if no command could be found
     */
    public static CommandDescription getCommandWithLabel(Collection<CommandDescription> commands, String label) {
        for (CommandDescription child : commands) {
            if (child.hasLabel(label)) {
                return child;
            }
        }
        throw new IllegalStateException("Could not find command with label '" + label + "'");
    }

    /* Shortcut command to initialize a new test command. */
    private static CommandDescription createCommand(PermissionNode permission, CommandDescription parent,
                                                    List<String> labels, Class<? extends ExecutableCommand> commandClass,
                                                    CommandArgumentDescription... arguments) {
        CommandDescription.CommandBuilder command = CommandDescription.builder()
            .labels(labels)
            .parent(parent)
            .permission(permission)
            .description(labels.get(0) + " cmd")
            .detailedDescription("'" + labels.get(0) + "' test command")
            .executableCommand(commandClass);

        if (arguments != null && arguments.length > 0) {
            for (CommandArgumentDescription argument : arguments) {
                command.withArgument(argument.getName(), argument.getDescription(), argument.isOptional());
            }
        }

        return command.register();
    }

    /* Shortcut command to initialize a new argument description. */
    private static CommandArgumentDescription newArgument(String label, boolean isOptional) {
        return new CommandArgumentDescription(label, "'" + label + "' argument description", isOptional);
    }

    public static class TestLoginCommand implements ExecutableCommand {
        @Override
        public void executeCommand(CommandSender sender, List<String> arguments) {
            // noop
        }
    }

    public static class TestRegisterCommand implements ExecutableCommand {
        @Override
        public void executeCommand(CommandSender sender, List<String> arguments) {
            // noop
        }
    }

    public static class TestUnregisterCommand implements ExecutableCommand {
        @Override
        public void executeCommand(CommandSender sender, List<String> arguments) {
            // noop
        }
    }

}