Add Command implementation for aliases.

Change-Id: Id9e68a94dc0b42b3fc4450154e2e2e71807a88c1
Reviewed-on: http://gerrit.dmdirc.com/3516
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/commandparser/aliases/AliasCommandHandler.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser.aliases;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.interfaces.CommandController;
+
+/**
+ * {@link Command} implementation that handles an alias.
+ */
+public class AliasCommandHandler extends Command {
+
+    private final Alias alias;
+
+    public AliasCommandHandler(final CommandController controller, final Alias alias) {
+        super(controller);
+        this.alias = alias;
+    }
+
+    @Override
+    public void execute(final FrameContainer origin, final CommandArguments args,
+            final CommandContext context) {
+        if (args.getArguments().length >= alias.getMinArguments()) {
+            origin.getCommandParser().parseCommand(origin, getSubstituteCommand(args));
+        } else {
+            sendLine(origin, args.isSilent(), FORMAT_ERROR, alias.getName() + " requires at least "
+                    + alias.getMinArguments() + " argument"
+                    + (alias.getMinArguments() == 1 ? "" : "s") + ".");
+        }
+    }
+
+    /**
+     * Gets the command that should be executed, with the appropriate substitutions made.
+     *
+     * <p>
+     * The returned command will have arguments substituted (replacing "$1-", "$2", etc), and will
+     * be silenced if the given args are silent.
+     *
+     * @param args The arguments entered by the user.
+     *
+     * @return The substituted command to execute.
+     */
+    private String getSubstituteCommand(final CommandArguments args) {
+        final StringBuilder builder = new StringBuilder(alias.getSubstitution());
+
+        final String[] arguments = args.getArguments();
+        for (int i = 0; i < arguments.length; i++) {
+            replaceAll(builder, "$" + (i + 1) + "-", args.getArgumentsAsString(i));
+            replaceAll(builder, "$" + (i + 1), arguments[i]);
+        }
+
+        if (args.isSilent()) {
+            builder.insert(0, getController().getSilenceChar());
+        }
+        builder.insert(0, getController().getCommandChar());
+
+        return builder.toString();
+    }
+
+    /**
+     * Replaces all instances of the specified substring in the builder.
+     *
+     * @param builder     The builder to modify.
+     * @param substr      The substring to replace.
+     * @param replacement The string to use as a replacement.
+     */
+    private static void replaceAll(final StringBuilder builder,
+            final String substr, final String replacement) {
+        int index = builder.indexOf(substr);
+        while (index > -1) {
+            builder.replace(index, index + substr.length(), replacement);
+            index = builder.indexOf(substr);
+        }
+    }
+
+}

test/com/dmdirc/commandparser/aliases/AliasCommandHandlerTest.java

@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser.aliases;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandType;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.commandparser.parsers.CommandParser;
+import com.dmdirc.interfaces.CommandController;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class AliasCommandHandlerTest {
+
+    @Mock private FrameContainer container;
+    @Mock private CommandController commandController;
+    @Mock private CommandParser commandParser;
+    @Mock private CommandContext context;
+    @Mock private CommandInfo commandInfo;
+
+    @Before
+    public void setup() {
+        when(container.getCommandParser()).thenReturn(commandParser);
+        when(commandController.getCommandChar()).thenReturn('#');
+        when(commandController.getSilenceChar()).thenReturn('/');
+        when(context.getSource()).thenReturn(container);
+        when(context.getCommandInfo()).thenReturn(commandInfo);
+    }
+
+    @Test
+    public void testBasicAlias() {
+        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 0, "test2");
+        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
+        final CommandArguments arguments = new CommandArguments(commandController, "#test");
+        handler.execute(container, arguments, context);
+        verify(commandParser).parseCommand(container, "#test2");
+    }
+
+    @Test
+    public void testSubstitutions() {
+        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 0, "test2 $1- $2 $1 $2- $2");
+        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
+        final CommandArguments arguments
+                = new CommandArguments(commandController, "#test agadoo do");
+        handler.execute(container, arguments, context);
+        verify(commandParser).parseCommand(container, "#test2 agadoo do do agadoo do do");
+    }
+
+    @Test
+    public void testInsufficientArgsSingular() {
+        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 1, "blah");
+        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
+        final CommandArguments arguments = new CommandArguments(commandController, "#test");
+        handler.execute(container, arguments, context);
+        verify(container).addLine("commandError", "test requires at least 1 argument.");
+    }
+
+    @Test
+    public void testInsufficientArgsPlural() {
+        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 2, "blah");
+        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
+        final CommandArguments arguments = new CommandArguments(commandController, "#test agadoo");
+        handler.execute(container, arguments, context);
+        verify(container).addLine("commandError", "test requires at least 2 arguments.");
+    }
+
+    @Test
+    public void testCarriesForwardSilence() {
+        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 0, "blah");
+        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
+        final CommandArguments arguments = new CommandArguments(commandController, "#/test agadoo");
+        handler.execute(container, arguments, context);
+        verify(commandParser).parseCommand(container, "#/blah");
+    }
+
+}