Remove Action events.

Change-Id: I67b558de082c1ce196800d8b0aafa2d6ce87b298
Reviewed-on: http://gerrit.dmdirc.com/3455
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/actions/Action.java

@@ -26,6 +26,9 @@ import com.dmdirc.GlobalWindow;
 import com.dmdirc.commandparser.parsers.GlobalCommandParser;
 import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.PreferencesType;
+import com.dmdirc.events.ActionCreatedEvent;
+import com.dmdirc.events.ActionDeletedEvent;
+import com.dmdirc.events.ActionUpdatedEvent;
 import com.dmdirc.interfaces.ActionController;
 import com.dmdirc.interfaces.actions.ActionComparison;
 import com.dmdirc.interfaces.actions.ActionComponent;
@@ -38,6 +41,8 @@ import com.dmdirc.updater.Version;
 import com.dmdirc.util.io.ConfigFile;
 import com.dmdirc.util.io.InvalidConfigFileException;
 
+import com.google.common.eventbus.EventBus;
+
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -73,6 +78,8 @@ public class Action extends ActionModel implements ConfigChangeListener {
     private final IdentityController identityController;
     /** The controller to use to retrieve components, comparisons, etc. */
     private final ActionController actionController;
+    /** Event bus to post events to. */
+    private final EventBus eventBus;
     /** The config file we're using. */
     protected ConfigFile config;
     /** The location of the file we're reading/saving. */
@@ -82,6 +89,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
      * Creates a new instance of Action. The group and name specified must be the group and name of
      * a valid action already saved to disk.
      *
+     * @param eventBus                    Event bus to post events to
      * @param globalCommandParserProvider Provider of global command parsers for triggering actions.
      * @param globalWindowProvider        Provider of global windows for triggering actions.
      * @param substitutorFactory          Factory to use to create action substitutors.
@@ -92,6 +100,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
      * @param name                        The name of the action
      */
     public Action(
+            final EventBus eventBus,
             final Provider<GlobalCommandParser> globalCommandParserProvider,
             final Provider<GlobalWindow> globalWindowProvider,
             final ActionSubstitutorFactory substitutorFactory,
@@ -102,6 +111,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
             final String name) {
         super(globalCommandParserProvider, globalWindowProvider, substitutorFactory, group, name);
 
+        this.eventBus = eventBus;
         this.actionController = actionController;
         this.identityController = identityController;
         this.actionsDirectory = actionsDirectory;
@@ -126,6 +136,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
     /**
      * Creates a new instance of Action with the specified properties and saves it to disk.
      *
+     * @param eventBus                    Event bus to post events to
      * @param globalCommandParserProvider Provider of global command parsers for triggering actions.
      * @param globalWindowProvider        Provider of global windows for triggering actions.
      * @param substitutorFactory          Factory to use to create action substitutors.
@@ -141,6 +152,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
      * @param newFormat                   The new formatter to use
      */
     public Action(
+            final EventBus eventBus,
             final Provider<GlobalCommandParser> globalCommandParserProvider,
             final Provider<GlobalWindow> globalWindowProvider,
             final ActionSubstitutorFactory substitutorFactory,
@@ -157,6 +169,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
         super(globalCommandParserProvider, globalWindowProvider, substitutorFactory, group, name,
                 triggers, response, conditions, conditionTree, newFormat);
 
+        this.eventBus = eventBus;
         this.actionController = actionController;
         this.identityController = identityController;
         this.actionsDirectory = actionsDirectory;
@@ -165,8 +178,6 @@ public class Action extends ActionModel implements ConfigChangeListener {
 
         new File(actionsDirectory + group).mkdirs();
 
-        actionController.triggerEvent(CoreActionType.ACTION_CREATED, null, this);
-
         save();
 
         identityController.getGlobalConfiguration().addChangeListener("disable_action",
@@ -174,6 +185,8 @@ public class Action extends ActionModel implements ConfigChangeListener {
         checkDisabled();
 
         actionController.addAction(this);
+        //TODO This needs to be done somewhere else, remove eventbus when it is.
+        eventBus.post(new ActionCreatedEvent(this));
     }
 
     /**
@@ -406,7 +419,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
                     + group + "/" + name + ": " + ex.getMessage());
         }
 
-        actionController.triggerEvent(CoreActionType.ACTION_UPDATED, null, this);
+        eventBus.post(new ActionUpdatedEvent(this));
     }
 
     /**
@@ -565,7 +578,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
      * Deletes this action.
      */
     public void delete() {
-        actionController.triggerEvent(CoreActionType.ACTION_DELETED, null, getGroup(), getName());
+        eventBus.post(new ActionDeletedEvent(actionController.getOrCreateGroup(getGroup()), this));
         new File(location).delete();
     }
 
@@ -573,8 +586,7 @@ public class Action extends ActionModel implements ConfigChangeListener {
     public String toString() {
         final String parent = super.toString();
 
-        return parent.substring(0, parent.length() - 1)
-                + ",location=" + location + "]";
+        return parent.substring(0, parent.length() - 1) + ",location=" + location + "]";
     }
 
     @Override

src/com/dmdirc/actions/ActionFactory.java

@@ -30,6 +30,8 @@ import com.dmdirc.interfaces.ActionController;
 import com.dmdirc.interfaces.actions.ActionType;
 import com.dmdirc.interfaces.config.IdentityController;
 
+import com.google.common.eventbus.EventBus;
+
 import java.util.List;
 
 import javax.inject.Inject;
@@ -54,10 +56,13 @@ public class ActionFactory {
     private final ActionSubstitutorFactory substitutorFactory;
     /** The base directory to store actions in. */
     private final String actionsDirectory;
+    /** Event bus to post events on. */
+    private final EventBus eventBus;
 
     /**
      * Creates a new instance of {@link ActionFactory}.
      *
+     * @param eventBus                    The event bus to post events on.
      * @param actionController            The controller that will own actions.
      * @param identityController          The controller to use to retrieve and update settings.
      * @param globalCommandParserProvider The global command parser to use for actions without
@@ -68,12 +73,14 @@ public class ActionFactory {
      */
     @Inject
     public ActionFactory(
+            final EventBus eventBus,
             final Provider<ActionController> actionController,
             final Provider<IdentityController> identityController,
             final Provider<GlobalCommandParser> globalCommandParserProvider,
             final Provider<GlobalWindow> globalWindowProvider,
             final ActionSubstitutorFactory substitutorFactory,
             @Directory(DirectoryType.ACTIONS) final String actionsDirectory) {
+        this.eventBus = eventBus;
         this.actionController = actionController;
         this.identityController = identityController;
         this.globalCommandParserProvider = globalCommandParserProvider;
@@ -93,6 +100,7 @@ public class ActionFactory {
      */
     public Action getAction(final String group, final String name) {
         return new Action(
+                eventBus,
                 globalCommandParserProvider,
                 globalWindowProvider,
                 substitutorFactory,
@@ -121,6 +129,7 @@ public class ActionFactory {
             final List<ActionCondition> conditions,
             final ConditionTree conditionTree, final String newFormat) {
         return new Action(
+                eventBus,
                 globalCommandParserProvider,
                 globalWindowProvider,
                 substitutorFactory,

src/com/dmdirc/actions/CoreActionType.java

@@ -229,10 +229,13 @@ public enum CoreActionType implements ActionType {
     @Deprecated
     PLUGIN_REFRESH(PluginEvents.PLUGIN_EVENT, "Plugins refreshed"),
     /** Action created. */
+    @Deprecated
     ACTION_CREATED(ActionEvents.ACTION_EVENT, "Action created"),
     /** Action updated. */
+    @Deprecated
     ACTION_UPDATED(ActionEvents.ACTION_EVENT, "Action updated"),
     /** Action deleted. */
+    @Deprecated
     ACTION_DELETED(ActionEvents.ACTION_DELETED, "Action deleted"),
     /** Channel clicked. */
     @Deprecated

src/com/dmdirc/actions/metatypes/ActionEvents.java

@@ -23,6 +23,7 @@
 package com.dmdirc.actions.metatypes;
 
 import com.dmdirc.actions.Action;
+import com.dmdirc.actions.ActionGroup;
 import com.dmdirc.interfaces.actions.ActionMetaType;
 
 /**
@@ -33,7 +34,7 @@ public enum ActionEvents implements ActionMetaType {
     /** Action event type. */
     ACTION_EVENT(new String[]{"action"}, Action.class),
     /** Action event type. */
-    ACTION_DELETED(new String[]{"Action group", "Action name"}, Action.class, String.class);
+    ACTION_DELETED(new String[]{"Action group", "Action name"}, ActionGroup.class, String.class);
     /** The names of the arguments for this meta type. */
     private String[] argNames;
     /** The classes of the arguments for this meta type. */

src/com/dmdirc/events/ActionCreatedEvent.java

@@ -0,0 +1,36 @@
+/*
+ * 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.events;
+
+import com.dmdirc.actions.Action;
+
+/**
+ * Fired on the creation of an action.
+ */
+public class ActionCreatedEvent extends ActionEvent {
+
+    public ActionCreatedEvent(final Action action) {
+        super(action);
+    }
+
+}

src/com/dmdirc/events/ActionDeletedEvent.java

@@ -0,0 +1,47 @@
+/*
+ * 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.events;
+
+import com.dmdirc.actions.Action;
+import com.dmdirc.actions.ActionGroup;
+
+/**
+ * Fired when an action is deleted.
+ */
+public class ActionDeletedEvent extends ActionEvent {
+
+    private final ActionGroup group;
+
+    public ActionDeletedEvent(final ActionGroup group, final Action action) {
+        super(action);
+        this.group = group;
+    }
+
+    public ActionGroup getGroup() {
+        return group;
+    }
+
+    public String getName() {
+        return getAction().getName();
+    }
+}

src/com/dmdirc/events/ActionEvent.java

@@ -22,9 +22,21 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.actions.Action;
+
 /**
  * Base class for all action events.
  */
 public abstract class ActionEvent extends DMDircEvent {
 
+    private final Action action;
+
+    public ActionEvent(final Action action) {
+        this.action = action;
+    }
+
+    public Action getAction() {
+        return action;
+    }
+
 }

src/com/dmdirc/events/ActionUpdatedEvent.java

@@ -0,0 +1,36 @@
+/*
+ * 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.events;
+
+import com.dmdirc.actions.Action;
+
+/**
+ * Fired when an action is updated.
+ */
+public class ActionUpdatedEvent extends ActionEvent {
+
+    public ActionUpdatedEvent(final Action action) {
+        super(action);
+    }
+
+}

test/com/dmdirc/actions/ActionTest.java

@@ -36,6 +36,8 @@ import com.dmdirc.logger.Logger;
 import com.dmdirc.util.io.ConfigFile;
 import com.dmdirc.util.io.InvalidConfigFileException;
 
+import com.google.common.eventbus.EventBus;
+
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -68,6 +70,7 @@ public class ActionTest {
 
     @Rule public final TemporaryFolder folder = new TemporaryFolder();
 
+    @Mock private EventBus eventBus;
     @Mock private Provider<GlobalCommandParser> gcpProvider;
     @Mock private Provider<GlobalWindow> gwProvider;
     @Mock private ActionSubstitutorFactory substitutorFactory;
@@ -105,7 +108,7 @@ public class ActionTest {
 
     @Test
     public void testSave() {
-        new Action(gcpProvider, gwProvider, substitutorFactory, actionController,
+        new Action(eventBus, gcpProvider, gwProvider, substitutorFactory, actionController,
                 identityController, getTempDirectory(), "unit-test", "test1", new ActionType[0],
                 new String[0], new ArrayList<ActionCondition>(),
                 ConditionTree.createConjunction(0), null);
@@ -116,7 +119,8 @@ public class ActionTest {
 
     @Test
     public void testSetGroup() {
-        Action action = new Action(gcpProvider, gwProvider, substitutorFactory, actionController,
+        Action action = new Action(eventBus, gcpProvider, gwProvider, substitutorFactory,
+                actionController,
                 identityController, getTempDirectory(),
                 "unit-test", "test1", new ActionType[0],
                 new String[0], new ArrayList<ActionCondition>(),
@@ -124,33 +128,29 @@ public class ActionTest {
         action.setGroup("unit-test-two");
 
         assertFalse("setGroup must remove old file",
-                new File(getTempDirectory(), "unit-test" + File.separator + "test1").
-                isFile());
+                new File(getTempDirectory(), "unit-test" + File.separator + "test1").isFile());
         assertTrue("setGroup must create new file",
-                new File(getTempDirectory(), "unit-test-two" + File.separator + "test1").
-                isFile());
+                new File(getTempDirectory(), "unit-test-two" + File.separator + "test1").isFile());
     }
 
     @Test
     public void testSetName() {
-        Action action = new Action(gcpProvider, gwProvider, substitutorFactory, actionController,
-                identityController, getTempDirectory(),
-                "unit-test", "test1", new ActionType[0],
-                new String[0], new ArrayList<ActionCondition>(),
+        Action action = new Action(eventBus, gcpProvider, gwProvider, substitutorFactory,
+                actionController, identityController, getTempDirectory(), "unit-test",
+                "test1", new ActionType[0], new String[0], new ArrayList<ActionCondition>(),
                 ConditionTree.createConjunction(0), null);
         action.setName("test2");
 
         assertFalse("setName must remove old file",
-                new File(getTempDirectory(), "unit-test" + File.separator + "test1").
-                isFile());
+                new File(getTempDirectory(), "unit-test" + File.separator + "test1").isFile());
         assertTrue("setName must create new file",
-                new File(getTempDirectory(), "unit-test" + File.separator + "test2").
-                isFile());
+                new File(getTempDirectory(), "unit-test" + File.separator + "test2").isFile());
     }
 
     @Test
     public void testDelete() {
-        Action action = new Action(gcpProvider, gwProvider, substitutorFactory, actionController,
+        Action action = new Action(eventBus, gcpProvider, gwProvider, substitutorFactory,
+                actionController,
                 identityController, getTempDirectory(),
                 "unit-test", "test1", new ActionType[0],
                 new String[0], new ArrayList<ActionCondition>(),
@@ -164,9 +164,9 @@ public class ActionTest {
 
     @Test
     public void testRead() throws IOException, InvalidConfigFileException {
-        Action action = new Action(gcpProvider, gwProvider, substitutorFactory, actionController,
-                identityController, getTempDirectory(),
-                "unit-test", "doesn't_exist");
+        Action action = new Action(eventBus, gcpProvider, gwProvider, substitutorFactory,
+                actionController, identityController, getTempDirectory(), "unit-test",
+                "doesn't_exist");
         action.config = new ConfigFile(getClass().getResourceAsStream("action1"));
         action.config.read();
         action.loadActionFromConfig();
@@ -183,9 +183,9 @@ public class ActionTest {
 
     @Test
     public void testMultipleGroups() throws IOException, InvalidConfigFileException {
-        Action action = new Action(gcpProvider, gwProvider, substitutorFactory, actionController,
-                identityController, getTempDirectory(),
-                "unit-test", "doesn't_exist");
+        Action action = new Action(eventBus, gcpProvider, gwProvider, substitutorFactory,
+                actionController, identityController, getTempDirectory(), "unit-test",
+                "doesn't_exist");
         action.config = new ConfigFile(getClass().getResourceAsStream("action_multisettings"));
         action.config.read();
         action.loadActionFromConfig();