More detailed commandStack events

lib/command/CommandStack.js

@@ -1,6 +1,7 @@
 import {
   uniqueBy,
-  isArray
+  isArray,
+  assign,
 } from 'min-dash';
 
 
@@ -107,10 +108,16 @@ export default function CommandStack(eventBus, injector) {
    * Current active commandStack execution
    *
    * @type {Object}
+   * @property {Array} actions
+   * @property {Array} dirty
+   * @property {boolean|undefined} atomic
+   * @property {string|undefined} method Is this an execution, undo, or redo?
+   * @property {Array} executed List of actions who finished executing
    */
   this._currentExecution = {
     actions: [],
-    dirty: []
+    dirty: [],
+    executed: [],
   };
 
 
@@ -141,6 +148,8 @@ CommandStack.prototype.execute = function(command, context) {
     throw new Error('command required');
   }
 
+  var execution = this._currentExecution;
+  execution.method || (execution.method = 'execute');
   var action = { command: command, context: context };
 
   this._pushAction(action);
@@ -201,7 +210,8 @@ CommandStack.prototype.clear = function(emit) {
   this._stackIdx = -1;
 
   if (emit !== false) {
-    this._fire('changed');
+    this._fire('changed', { method: 'clear', actions: [] });
+    delete this._currentExecution.method;
   }
 };
 
@@ -211,8 +221,10 @@ CommandStack.prototype.clear = function(emit) {
  */
 CommandStack.prototype.undo = function() {
   var action = this._getUndoAction(),
+      execution = this._currentExecution,
       next;
 
+  execution.method = 'undo';
   if (action) {
     this._pushAction(action);
 
@@ -237,11 +249,14 @@ CommandStack.prototype.undo = function() {
  */
 CommandStack.prototype.redo = function() {
   var action = this._getRedoAction(),
+      execution = this._currentExecution,
       next;
 
   if (action) {
     this._pushAction(action);
 
+    execution.method = 'redo';
+
     while (action) {
       this._internalExecute(action, true);
       next = this._getRedoAction();
@@ -446,17 +461,21 @@ CommandStack.prototype._pushAction = function(action) {
 
 CommandStack.prototype._popAction = function() {
   var execution = this._currentExecution,
+      method = execution.method,
       actions = execution.actions,
       dirty = execution.dirty;
 
   actions.pop();
 
   if (!actions.length) {
-    this._eventBus.fire('elements.changed', { elements: uniqueBy('id', dirty.reverse()) });
+    var context = { elements: uniqueBy('id', dirty.reverse()) };
+    this._eventBus.fire('elements.changed', assign({}, context));
 
     dirty.length = 0;
 
-    this._fire('changed');
+    this._fire('changed', assign({ method: method, actions: execution.executed.concat() }, { context: context }));
+    delete execution.method;
+    execution.executed.length = 0;
   }
 };
 
@@ -479,12 +498,14 @@ CommandStack.prototype._executedAction = function(action, redo) {
 
   if (!redo) {
     this._stack.splice(stackIdx, this._stack.length, action);
+    this._currentExecution.executed.push(action);
   }
 };
 
 
 CommandStack.prototype._revertedAction = function(action) {
   this._stackIdx--;
+  this._currentExecution.executed.push(action);
 };
 
 

test/spec/command/CommandStackSpec.js

@@ -5,6 +5,7 @@ import {
 
 
 import cmdModule from 'lib/command';
+import { expect } from 'chai';
 
 // example commands
 
@@ -876,4 +877,99 @@ describe('command/CommandStack', function() {
 
   });
 
+  describe('change-event', function() {
+
+    var testSetup = function(eventBus, commandStack) {
+      var eventData = {};
+
+      commandStack.registerHandler('complex-command', ComplexCommand);
+      commandStack.registerHandler('pre-command', PreCommand);
+      commandStack.registerHandler('post-command', PostCommand);
+      eventBus.on('commandStack.changed', function(event) {
+        eventData.changeEvent = event.method;
+        eventData.actions = event.actions.map(function(action) {return action.command;});
+      });
+
+      return eventData;
+    };
+
+    describe('should indicate details about a change', function() {
+
+      it('with method <execute>', inject(function(eventBus, commandStack) {
+
+        // given
+        var eventData = testSetup(eventBus, commandStack);
+
+        // when
+        commandStack.execute('complex-command', { element: { trace: [] } });
+
+        // then
+        var changeEvent = eventData.changeEvent,
+            actions = eventData.actions;
+
+        expect(changeEvent).to.equal('execute');
+        expect(actions).to.eql(['pre-command', 'complex-command', 'post-command']);
+
+      }));
+
+      it('with method <undo>', inject(function(eventBus, commandStack) {
+
+        // given
+        var eventData = testSetup(eventBus, commandStack);
+
+        // when
+        commandStack.execute('complex-command', { element: { trace: [] } });
+        commandStack.undo();
+
+        // then
+        var changeEvent = eventData.changeEvent,
+            actions = eventData.actions;
+
+        expect(changeEvent).to.equal('undo');
+        expect(actions).to.eql(['post-command', 'complex-command', 'pre-command']);
+
+      }));
+
+      it.skip('with method <redo>', inject(function(eventBus, commandStack) {
+
+        // given
+        var eventData = testSetup(eventBus, commandStack);
+
+        // when
+        commandStack.execute('complex-command', { element: { trace: [] } });
+        commandStack.undo();
+        commandStack.redo();
+
+        // then
+        var changeEvent = eventData.changeEvent,
+            actions = eventData.actions;
+
+        expect(changeEvent).to.equal('redo');
+
+        // Need to figure out a way to indicate the executed actions
+        expect(actions).to.eql(['pre-command', 'complex-command', 'post-command']);
+
+      }));
+
+      it('with method <clear>', inject(function(eventBus, commandStack) {
+
+        // given
+        var eventData = testSetup(eventBus, commandStack);
+
+        // when
+        commandStack.clear();
+
+        // then
+        var changeEvent = eventData.changeEvent,
+            actions = eventData.actions;
+
+        expect(changeEvent).to.equal('clear');
+        expect(actions).to.eql([]);
+
+      }));
+
+    });
+
+  });
+
 });