Add away colours plugin.

awaycolours/plugin.config

@@ -0,0 +1,22 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+  version
+
+metadata:
+  author=Greboid <greg@dmdirc.com>
+  mainclass=com.dmdirc.addons.awaycolours.AwayColours
+  description=Provides away colours to theclient
+  name=awaycolours
+  nicename=Away Colours Plugin
+
+updates:
+  id=75
+
+version:
+  friendly=0.1

awaycolours/src/com/dmdirc/addons/awaycolours/AwayColoursManager.java

@@ -0,0 +1,104 @@
+/*
+ * 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.addons.awaycolours;
+
+import com.dmdirc.ChannelClientProperty;
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.config.ConfigBinder;
+import com.dmdirc.config.ConfigBinding;
+import com.dmdirc.events.ChannelUserAwayEvent;
+import com.dmdirc.events.ChannelUserBackEvent;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.util.colours.Colour;
+
+import javax.inject.Inject;
+
+import net.engio.mbassy.listener.Handler;
+
+/**
+ * Adds away colours to DMDirc.
+ */
+public class AwayColoursManager {
+
+    private final DMDircMBassador eventBus;
+    private final ConfigBinder binder;
+    private Colour colour;
+    private boolean nicklist = true;
+    private boolean text = true;
+
+    @Inject
+    public AwayColoursManager(final DMDircMBassador eventBus,
+            @GlobalConfig final AggregateConfigProvider config,
+            @PluginDomain(AwayColoursPlugin.class) final String domain) {
+        this.eventBus = eventBus;
+        binder = new ConfigBinder(config, domain);
+
+    }
+
+    public void load() {
+        eventBus.subscribe(this);
+        binder.bind(this, AwayColoursManager.class);
+    }
+
+    public void unload() {
+        eventBus.unsubscribe(this);
+        binder.unbind(this);
+    }
+
+    @ConfigBinding(key = "colour")
+    public void handleColourChange(final Colour colour) {
+        this.colour = colour;
+    }
+
+    @ConfigBinding(key = "nicklist")
+    public void handleNicklistChange(final boolean nicklist) {
+        this.nicklist = nicklist;
+    }
+
+    @ConfigBinding(key = "text")
+    public void handleTextChange(final boolean text) {
+        this.text = text;
+    }
+
+    @Handler
+    public void handleAwayEvent(final ChannelUserAwayEvent event) {
+        if (nicklist) {
+            event.getUser().getMap().put(ChannelClientProperty.NICKLIST_FOREGROUND, colour);
+        }
+        if (text) {
+            event.getUser().getMap().put(ChannelClientProperty.TEXT_FOREGROUND, colour);
+        }
+    }
+
+    @Handler
+    public void handleBackEvent(final ChannelUserBackEvent event) {
+        if (nicklist) {
+            event.getUser().getMap().remove(ChannelClientProperty.NICKLIST_FOREGROUND);
+        }
+        if (text) {
+            event.getUser().getMap().remove(ChannelClientProperty.TEXT_FOREGROUND);
+        }
+    }
+}

awaycolours/src/com/dmdirc/addons/awaycolours/AwayColoursModule.java

@@ -0,0 +1,34 @@
+/*
+ * 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.addons.awaycolours;
+
+import com.dmdirc.ClientModule;
+
+import dagger.Module;
+
+/**
+ * Dagger injection module for the Away Colours plugin.
+ */
+@Module(injects = AwayColoursManager.class, addsTo = ClientModule.class)
+public class AwayColoursModule {
+}

awaycolours/src/com/dmdirc/addons/awaycolours/AwayColoursPlugin.java

@@ -0,0 +1,54 @@
+/*
+ * 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.addons.awaycolours;
+
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.implementations.BaseCommandPlugin;
+
+import dagger.ObjectGraph;
+
+/**
+ * Away Colours Plugin.
+ */
+public final class AwayColoursPlugin extends BaseCommandPlugin {
+
+    private AwayColoursManager manager;
+
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+
+        setObjectGraph(graph.plus(new AwayColoursModule()));
+        manager = getObjectGraph().get(AwayColoursManager.class);
+    }
+
+    @Override
+    public void onLoad() {
+        manager.load();
+    }
+
+    @Override
+    public void onUnload() {
+        manager.unload();
+    }
+}

awaycolours/test/com/dmdirc/addons/awaycolours/AwayColoursManagerTest.java

@@ -0,0 +1,146 @@
+/*
+ * 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.addons.awaycolours;
+
+import com.dmdirc.ChannelClientProperty;
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.config.ConfigBinder;
+import com.dmdirc.events.ChannelUserAwayEvent;
+import com.dmdirc.events.ChannelUserBackEvent;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.parser.interfaces.ChannelClientInfo;
+import com.dmdirc.util.colours.Colour;
+
+import java.util.Map;
+
+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.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class AwayColoursManagerTest {
+
+    @Mock private DMDircMBassador eventBus;
+    @Mock private AggregateConfigProvider config;
+    @Mock private ConfigBinder binder;
+    @Mock private ChannelUserAwayEvent awayEvent;
+    @Mock private ChannelUserBackEvent backEvent;
+    @Mock private ChannelClientInfo user;
+    @Mock private Map<Object, Object> map;
+    private AwayColoursManager instance;
+    private Colour colour;
+
+    @Before
+    public void setUp() throws Exception {
+        colour = Colour.RED;
+        instance = new AwayColoursManager(eventBus, config, "test");
+        when(awayEvent.getUser()).thenReturn(user);
+        when(backEvent.getUser()).thenReturn(user);
+        when(user.getMap()).thenReturn(map);
+    }
+
+    @Test
+    public void testLoad() throws Exception {
+        instance.load();
+        verify(eventBus).subscribe(instance);
+    }
+
+    @Test
+    public void testUnload() throws Exception {
+        instance.unload();
+        verify(eventBus).unsubscribe(instance);
+    }
+
+    @Test
+    public void testHandleColourChange() throws Exception {
+        instance.handleColourChange(colour);
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(true);
+        instance.handleAwayEvent(awayEvent);
+        verify(map).put(ChannelClientProperty.NICKLIST_FOREGROUND, colour);
+        verify(map).put(ChannelClientProperty.TEXT_FOREGROUND, colour);
+        instance.handleColourChange(Colour.BLACK);
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(true);
+        instance.handleAwayEvent(awayEvent);
+        verify(map).put(ChannelClientProperty.NICKLIST_FOREGROUND, Colour.BLACK);
+        verify(map).put(ChannelClientProperty.TEXT_FOREGROUND, Colour.BLACK);
+    }
+
+    @Test
+    public void testHandleNicklistChange() throws Exception {
+        instance.handleColourChange(colour);
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(true);
+        instance.handleAwayEvent(awayEvent);
+        verify(map).put(ChannelClientProperty.NICKLIST_FOREGROUND, colour);
+        verify(map).put(ChannelClientProperty.TEXT_FOREGROUND, colour);
+        instance.handleColourChange(Colour.BLACK);
+        instance.handleNicklistChange(false);
+        instance.handleTextChange(true);
+        instance.handleAwayEvent(awayEvent);
+        verify(map, never()).put(ChannelClientProperty.NICKLIST_FOREGROUND, Colour.BLACK);
+        verify(map).put(ChannelClientProperty.TEXT_FOREGROUND, Colour.BLACK);
+    }
+
+    @Test
+    public void testHandleTextChange() throws Exception {
+        instance.handleColourChange(colour);
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(true);
+        instance.handleAwayEvent(awayEvent);
+        verify(map).put(ChannelClientProperty.NICKLIST_FOREGROUND, colour);
+        verify(map).put(ChannelClientProperty.TEXT_FOREGROUND, colour);
+        instance.handleColourChange(Colour.BLACK);
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(false);
+        instance.handleAwayEvent(awayEvent);
+        verify(map).put(ChannelClientProperty.NICKLIST_FOREGROUND, Colour.BLACK);
+        verify(map, never()).put(ChannelClientProperty.TEXT_FOREGROUND, Colour.BLACK);
+    }
+
+    @Test
+    public void testHandleAwayEvent() throws Exception {
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(true);
+        instance.handleBackEvent(backEvent);
+        verify(map).remove(ChannelClientProperty.NICKLIST_FOREGROUND);
+        verify(map).remove(ChannelClientProperty.TEXT_FOREGROUND);
+    }
+
+    @Test
+    public void testHandleBackEvent() throws Exception {
+        instance.handleColourChange(colour);
+        instance.handleNicklistChange(true);
+        instance.handleTextChange(true);
+        instance.handleAwayEvent(awayEvent);
+        verify(map).put(ChannelClientProperty.NICKLIST_FOREGROUND, colour);
+        verify(map).put(ChannelClientProperty.TEXT_FOREGROUND, colour);
+    }
+}