Merge commit 'b5e3918837f4c6902ffa33346fcb6ec2e40962e2' into muti_wildcard

Author: QuentinRoy

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012, 2013, 2014, Jake Gordon and contributors
+Copyright (c) 2012, 2013, 2014, 2015, Jake Gordon and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-Javascript Finite State Machine (v2.3.2)
+Javascript Finite State Machine (v2.3.5)
 ========================================
 
 This standalone javascript micro-framework provides a finite state machine for your pleasure.
@@ -7,6 +7,11 @@ This standalone javascript micro-framework provides a finite state machine for y
  * You can find a [description here](http://codeincomplete.com/posts/2013/1/26/javascript_state_machine_v2_2_0/)
  * You can find a [working demo here](http://codeincomplete.com/posts/2011/8/19/javascript_state_machine_v2/example/)
 
+This library has also been ported to:
+
+ * [Go](https://github.com/looplab/fsm) by @maxpersson
+ * [Python](https://github.com/oxplot/fysom) by @oxplot
+
 Download
 ========
 
@@ -50,10 +55,11 @@ In its simplest form, create a standalone state machine using:
 
 along with the following members:
 
- * fsm.current   - contains the current state
- * fsm.is(s)     - return true if state `s` is the current state
- * fsm.can(e)    - return true if event `e` can be fired in the current state
- * fsm.cannot(e) - return true if event `e` cannot be fired in the current state
+ * fsm.current       - contains the current state
+ * fsm.is(s)         - return true if state `s` is the current state
+ * fsm.can(e)        - return true if event `e` can be fired in the current state
+ * fsm.cannot(e)     - return true if event `e` cannot be fired in the current state
+ * fsm.transitions() - return list of events that are allowed from the current state
 
 Multiple 'from' and 'to' states for a single event
 ==================================================
@@ -262,7 +268,7 @@ Initialization Options
 How the state machine should initialize can depend on your application requirements, so
 the library provides a number of simple options.
 
-By default, if you dont specify any initial state, the state machine will be in the `'none'`
+By default, if you don't specify any initial state, the state machine will be in the `'none'`
 state and you would need to provide an event to take it out of this state:
 
     var fsm = StateMachine.create({

RELEASE_NOTES.md

@@ -1,3 +1,18 @@
+Version 2.3.5 (January 20 2014)
+-------------------------------
+
+ * fix for broken transitions() method (issue #74)
+
+Version 2.3.4 (January 17 2014)
+-------------------------------
+
+ * helper method to list which events are allowed from the current state (issue #71 - thanks to @mgoldsborough and @chopj)
+
+Version 2.3.3 (October 17 2014)
+-------------------------------
+
+ * added web worker compatability (issue #65 - thanks to @offirmo)
+
 Version 2.3.2 (March 16 2014)
 -----------------------------
 

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "javascript-state-machine",
-  "version": "2.3.2",
+  "version": "2.3.5",
   "homepage": "https://github.com/jakesgordon/javascript-state-machine",
   "authors": [
     "Jake Gordon <jake@codeincomplete.com>"

package.json

@@ -9,5 +9,5 @@
   "devDependencies": {
     "qunit": "~0.6.2"
   },
-  "version":         "2.3.2"
+  "version":         "2.3.5"
 }

state-machine.js

@@ -2,7 +2,7 @@
 
   Javascript State Machine Library - https://github.com/jakesgordon/javascript-state-machine
 
-  Copyright (c) 2012, 2013, 2014, Jake Gordon and contributors
+  Copyright (c) 2012, 2013, 2014, 2015, Jake Gordon and contributors
   Released under the MIT license - https://github.com/jakesgordon/javascript-state-machine/blob/master/LICENSE
 
 */
@@ -13,7 +13,7 @@
 
     //---------------------------------------------------------------------------
 
-    VERSION: "2.3.2",
+    VERSION: "2.3.5",
 
     //---------------------------------------------------------------------------
 
@@ -37,18 +37,23 @@
 
     create: function(cfg, target) {
 
-      var initial   = (typeof cfg.initial == 'string') ? { state: cfg.initial } : cfg.initial; // allow for a simple string, or an object with { state: 'foo', event: 'setup', defer: true|false }
-      var terminal  = cfg.terminal || cfg['final'];
-      var fsm       = target || cfg.target  || {};
-      var events    = cfg.events || [];
-      var callbacks = cfg.callbacks || {};
-      var map       = {};
+      var initial      = (typeof cfg.initial == 'string') ? { state: cfg.initial } : cfg.initial; // allow for a simple string, or an object with { state: 'foo', event: 'setup', defer: true|false }
+      var terminal     = cfg.terminal || cfg['final'];
+      var fsm          = target || cfg.target  || {};
+      var events       = cfg.events || [];
+      var callbacks    = cfg.callbacks || {};
+      var map          = {}; // track state transitions allowed for an event { event: { from: [ to ] } }
+      var transitions  = {}; // track events allowed from a state            { state: [ event ] }
 
       var add = function(e) {
         var from = (e.from instanceof Array) ? e.from : (e.from ? [e.from] : [StateMachine.WILDCARD]); // allow 'wildcard' transition if 'from' is not specified
         map[e.name] = map[e.name] || {};
-        for (var n = 0 ; n < from.length ; n++)
+        for (var n = 0 ; n < from.length ; n++) {
+          transitions[from[n]] = transitions[from[n]] || [];
+          transitions[from[n]].push(e.name);
+
           map[e.name][from[n]] = e.to || from[n]; // allow no-op transition if 'to' is not specified
+        }
       };
 
       if (initial) {
@@ -69,13 +74,13 @@
           fsm[name] = callbacks[name]
       }
 
-      fsm.current = 'none';
-      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)
-
-      fsm.isFinished = function() { return this.is(terminal); };
+      fsm.current     = 'none';
+      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.transitions = function()      { return transitions[this.current]; };
+      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)
 
       if (initial && !initial.defer)
         fsm[initial.event]();
@@ -209,9 +214,14 @@
   //========
   // BROWSER
   //========
-  else if (window) {
+  else if (typeof window !== 'undefined') {
     window.StateMachine = StateMachine;
   }
+  //===========
+  // WEB WORKER
+  //===========
+  else if (typeof self !== 'undefined') {
+    self.StateMachine = StateMachine;
+  }
 
 }());
-

state-machine.min.js

@@ -209,7 +209,7 @@ test("callbacks are called when appropriate for multiple 'from' and 'to' transit
 
 test("callbacks are called when appropriate for prototype based state machine", function() {
 
-  myFSM = function() {
+  var myFSM = function() {
     this.called = [];
     this.startup();
   };

test/test_advanced.js

@@ -111,6 +111,73 @@ test("is", function() {
 
 //-----------------------------------------------------------------------------
 
+test("transitions", 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'  }
+  ]});
+
+  equal(fsm.current, 'green', 'current state should be yellow');
+  deepEqual(fsm.transitions(), ['warn'], 'current transition(s) should be yellow');
+
+  fsm.warn();
+  equal(fsm.current, 'yellow', 'current state should be yellow');
+  deepEqual(fsm.transitions(), ['panic', 'clear'], 'current transition(s) should be panic and clear');
+
+  fsm.panic();
+  equal(fsm.current, 'red', 'current state should be red');
+  deepEqual(fsm.transitions(), ['calm'], 'current transition(s) should be calm');
+
+  fsm.calm();
+  equal(fsm.current, 'yellow', 'current state should be yellow');
+  deepEqual(fsm.transitions(), ['panic', 'clear'], 'current transion(s) should be panic and clear');
+
+  fsm.clear();
+  equal(fsm.current, 'green', 'current state should be green');
+  deepEqual(fsm.transitions(), ['warn'], 'current transion(s) should be warn');
+});
+
+//-----------------------------------------------------------------------------
+
+test("transitions with multiple from states", function() {
+
+  var fsm = StateMachine.create({
+    events: [
+      { name: 'start', from: 'none',              to: 'green'  },
+      { name: 'warn',  from: ['green', 'red'],    to: 'yellow' },
+      { name: 'panic', from: ['green', 'yellow'], to: 'red'    },
+      { name: 'clear', from: ['red', 'yellow'],   to: 'green'  }
+    ]
+  });
+
+  equal(fsm.current, 'none', 'current state should be none');
+  deepEqual(fsm.transitions(), ['start'], 'current transition(s) should be start');
+
+  fsm.start();
+  equal(fsm.current, 'green', 'current state should be green');
+  deepEqual(fsm.transitions(), ['warn', 'panic'], 'current transition(s) should be warn and panic');
+
+  fsm.warn();
+  equal(fsm.current, 'yellow', 'current state should be yellow');
+  deepEqual(fsm.transitions(), ['panic', 'clear'], 'current transition(s) should be panic and clear');
+
+  fsm.panic();
+  equal(fsm.current, 'red', 'current state should be red');
+  deepEqual(fsm.transitions(), ['warn', 'clear'], 'current transition(s) should be warn and clear');
+
+  fsm.clear();
+  equal(fsm.current, 'green', 'current state should be green');
+  deepEqual(fsm.transitions(), ['warn', 'panic'], 'current transition(s) should be warn and panic');
+
+});
+
+//-----------------------------------------------------------------------------
+
 test("isFinished", function() {
 
   var fsm = StateMachine.create({