added function (fsm.states) returning list of all available states to help automated testing (issue jakesgordon#54)

jakesgordon · jakesgordon · commit d4037581fa41 · 2016-11-19T13:36:09.000-08:00
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -23,6 +23,7 @@ Version 2.4.0 (ETA - December 2016)
  * exclude build files from bower install (pull request #75)
  * ensure WILDCARD events are included in list of available transitions() (issue #93)
  * fix FSM getting stuck into "*" state when using double wildcard (issue #64)
+ * function (fsm.states) returning list of all available states in the machine would help automated testing (issue #54)
 
 Version 2.3.5 (January 20 2014)
 -------------------------------
diff --git a/state-machine.js b/state-machine.js
@@ -54,6 +54,8 @@
 
           map[e.name][from[n]] = e.to || from[n]; // allow no-op transition if 'to' is not specified
         }
+        if (e.to)
+          transitions[e.to] = transitions[e.to] || [];
       };
 
       if (initial) {
@@ -81,6 +83,7 @@
       fsm.transitions = function()      { return (transitions[this.current] || []).concat(transitions[StateMachine.WILDCARD] || []); };
       fsm.isFinished  = function()      { return this.is(terminal); };
       fsm.error       = cfg.error || function(name, from, to, args, error, msg, e) { throw e || msg; }; // default behavior when something unexpected happens is to throw an exception, but caller can override this behavior if desired (see github issue #3 and #17)
+      fsm.states      = function() { return Object.keys(transitions).sort() };
 
       if (initial && !initial.defer)
         fsm[initial.event]();
diff --git a/state-machine.min.js b/state-machine.min.js
diff --git a/test/test_basics.js b/test/test_basics.js
@@ -114,6 +114,24 @@ test("is", function() {
 
 //-----------------------------------------------------------------------------
 
+test("states", function() {
+
+  var fsm = StateMachine.create({
+    initial: 'green',
+    events: [
+      { name: 'warn',   from: 'green',  to: 'yellow' },
+      { name: 'panic',  from: 'yellow', to: 'red'    },
+      { name: 'calm',   from: 'red',    to: 'yellow' },
+      { name: 'clear',  from: 'yellow', to: 'green'  },
+      { name: 'finish', from: 'green',  to: 'done'   },
+  ]});
+
+  deepEqual(fsm.states(), [ 'done', 'green', 'none', 'red', 'yellow' ]);
+
+});
+
+//-----------------------------------------------------------------------------
+
 test("transitions", function() {
 
   var fsm = StateMachine.create({
