extended fsm.is() to accept an array of states (in addition to just a single state)

Author: jakesgordon

README.md

@@ -274,7 +274,7 @@ state and you would need to provide an event to take it out of this state:
     fsm.startup();
     alert(fsm.current); // "green"
 
-If you specify the name of your initial event (as in all the earlier examples), then an
+If you specify the name of your initial state (as in all the earlier examples), then an
 implicit `startup` event will be created for you and fired when the state machine is constructed.
 
     var fsm = StateMachine.create({

RELEASE_NOTES.md

@@ -1,6 +1,7 @@
 Version 2.2.0 (unreleased)
 --------------------------
-
+ 
+ * extended `fsm.is()` to accept an array of states (in addition to a single state)
  * Added generic event callbacks 'onbeforeevent' and 'onafterevent' (issue #28)
  * Added generic state callbacks 'onleavestate' and 'onenterstate'  (issue #28)
  * Fixed 'undefined' event return codes (issue #34) - pull from gentooboontoo (thanks!)

state-machine.js

@@ -69,7 +69,7 @@
       }
 
       fsm.current = 'none';
-      fsm.is      = function(state) { return this.current == state; };
+      fsm.is      = function(state) { return (state instanceof Array) ? (state.indexOf(this.current) >= 0) : (this.current === state); };
       fsm.can     = function(event) { return !this.transition && (map[event].hasOwnProperty(this.current) || map[event].hasOwnProperty(StateMachine.WILDCARD)); }
       fsm.cannot  = function(event) { return !this.can(event); };
       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)

state-machine.min.js

@@ -80,6 +80,37 @@ test("can & cannot", function() {
 
 //-----------------------------------------------------------------------------
 
+test("is", 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'  }
+  ]});
+
+  equals(fsm.current, 'green', "initial state should be green");
+
+  equals(fsm.is('green'),           true,   'current state should match');
+  equals(fsm.is('yellow'),          false,  'current state should NOT match');
+  equals(fsm.is(['green',  'red']), true,   'current state should match when included in array');
+  equals(fsm.is(['yellow', 'red']), false,  'current state should NOT match when not included in array');
+
+  fsm.warn();
+
+  equals(fsm.current, 'yellow', "current state should be yellow");
+
+  equals(fsm.is('green'),           false, 'current state should NOT match');
+  equals(fsm.is('yellow'),          true,  'current state should match');
+  equals(fsm.is(['green',  'red']), false, 'current state should NOT match when not included in array');
+  equals(fsm.is(['yellow', 'red']), true,  'current state should match when included in array');
+
+});
+
+//-----------------------------------------------------------------------------
+
 test("inappropriate events", function() {
 
   var fsm = StateMachine.create({