LICENSE @@ -37,9 +37,10 @@ <cfloop condition="transitions.hasNext()"> <cfset transition = transitions.next() /> <cfif transition.perform(obj)> - <cfbreak /> + <cfreturn true /> </cfif> - </cfloop> + </cfloop> + <cfreturn false /> </cffunction> <cffunction name="transitions" access="public" output="false"> Event.cfc @@ -10,51 +10,35 @@ <cfreturn this /> </cffunction> - <!--- Set up chainable callback handlers ---> - - <cffunction name="setEnterCallback" access="public" output="false"> - <cfargument name="method" type="string" required="true" /> - <cfset instance.callbacks.enter = arguments.method /> - <cfreturn this /> - </cffunction> - - <cffunction name="setAfterCallback" access="public" output="false"> - <cfargument name="method" type="string" required="true" /> - <cfset instance.callbacks.after = arguments.method /> - <cfreturn this /> - </cffunction> - - <cffunction name="setExitCallback" access="public" output="false"> - <cfargument name="method" type="string" required="true" /> - <cfset instance.callbacks.exit = arguments.method /> - <cfreturn this /> - </cffunction> - <cffunction name="getName" returntype="string" access="public" output="false"> <cfreturn instance.name /> </cffunction> - <cffunction name="entering" returntype="void" access="public" output="false"> + <cffunction name="before" returntype="boolean" access="public" output="false"> <cfargument name="obj" required="true" /> - <cfset invokeCallback('#getName()#EnteringAction', arguments.obj) /> + <cfreturn invokeCallback('before#getName()#Action', arguments.obj) /> </cffunction> - <cffunction name="entered" returntype="void" access="public" output="false"> + <cffunction name="after" returntype="void" access="public" output="false"> <cfargument name="obj" required="true" /> - <cfset invokeCallback('#getName()#AfterAction', arguments.obj) /> + <cfset invokeCallback('after#getName()#Action', arguments.obj) /> </cffunction> - <cffunction name="exited" returntype="void" access="public" output="false"> + <cffunction name="exit" returntype="void" access="public" output="false"> <cfargument name="obj" required="true" /> - <cfset invokeCallback('#getName()#ExitAction', arguments.obj) /> + <cfset invokeCallback('exit#getName()#Action', arguments.obj) /> </cffunction> - <cffunction name="invokeCallback" returntype="void" access="public" output="false"> + <cffunction name="invokeCallback" returntype="boolean" access="public" output="false"> <cfargument name="callback" type="string" required="true" /> - <cfargument name="obj" required="true" /> + <cfargument name="obj" required="true" /> <cfif structKeyExists(arguments.obj, arguments.callback)> - <cfinvoke component="#arguments.obj#" method="#arguments.callback#" /> + <cfinvoke component="#arguments.obj#" method="#arguments.callback#" returnvariable="result" /> + <cfif isDefined('result') and isBoolean(result)> + <cfreturn result /> + </cfif> </cfif> + <cfreturn true /> </cffunction> </cfcomponent> \ No newline at end of file State.cfc @@ -83,9 +83,9 @@ <cfargument name="stateName" required="true" /> <cfscript> var state = instance.states[arguments.stateName]; - state.entering(this); + state.before(this); setState(arguments.stateName); - state.entered(this); + state.after(this); </cfscript> </cffunction> StateMachine.cfc @@ -39,22 +39,23 @@ <cfscript> var local = structNew(); - if(not guard(obj)) return false; + if(not guard(obj)) { + return false; + } local.isLoopback = obj.getCurrentState() eq getToState(); local.states = arguments.obj.getStates(); local.nextState = local.states[getToState()]; local.oldState = local.states[obj.getCurrentState()]; - if(not local.isLoopback) { - local.nextState.entering(obj); - } - - obj.setState(getToState()); - - if(not local.isLoopback) { - local.nextState.entered(obj); - local.oldState.exited(obj); + if(not local.isLoopback) { + if(local.nextState.before(obj)) { + obj.setState(getToState()); + local.nextState.after(obj); + local.oldState.exit(obj); + } else { + return false; + } } return true; StateTransition.cfc @@ -13,6 +13,7 @@ addState('read'); addState('closed'); addState('awaitingResponse'); + addState('filed'); addState('junk'); addEvent('newMessage').addTransitions('read,closed,awaitingResponse', 'needingAttention'); @@ -21,33 +22,39 @@ addEvent('close').addTransitions('read,awaitingResponse', 'closed', 'getCanClose').addTransitions('read,awaitingResponse', 'read', 'alwaysTrue'); addEvent('junk').addTransitions('read,closed,awaitingResponse', 'junk'); addEvent('unjunk').addTransitions('junk', 'closed'); + addEvent('file').addTransitions('read,closed,awaitingResponse', 'filed'); </cfscript> </cffunction> <!--- State Observer Events ---> - <cffunction name="readEnteringAction" access="public" returntype="void" output="false"> + <cffunction name="beforeReadAction" access="public" returntype="void" output="false"> <cfset getOriginalObject().setReadEnter(true) /> </cffunction> - <cffunction name="readExitAction" access="public" returntype="void" output="false"> + <cffunction name="beforeFiledAction" access="public" returntype="boolean" output="false"> + <!--- Let's assume this event checked for the existence of a folder and failed ---> + <cfreturn false /> + </cffunction> + + <cffunction name="exitReadAction" access="public" returntype="void" output="false"> <cfset getOriginalObject().setReadExit(true) /> </cffunction> - <cffunction name="readAfterAction" access="public" returntype="void" output="false"> + <cffunction name="afterReadAction" access="public" returntype="void" output="false"> <cfset getOriginalObject().setReadAfterFirstAction(true) /> <cfset getOriginalObject().setReadAfterSecondAction(true) /> </cffunction> - <cffunction name="needingAttentionEnteringAction" access="public" returntype="void" output="false"> + <cffunction name="beforeNeedingAttentionAction" access="public" returntype="void" output="false"> <cfset getOriginalObject().setNeedingAttentionEnter(true) /> </cffunction> - <cffunction name="needingAttentionAfterAction" access="public" returntype="void" output="false"> + <cffunction name="afterNeedingAttentionAction" access="public" returntype="void" output="false"> <cfset getOriginalObject().setNeedingAttentionAfter(true) /> </cffunction> - <cffunction name="closedAfterAction" access="public" returntype="void" output="false"> + <cffunction name="afterClosedAction" access="public" returntype="void" output="false"> <cfset getOriginalObject().setClosedAfter(true) /> </cffunction> test/ConversationState.cfc @@ -112,7 +112,7 @@ assertTrue(conversation.getReadEnter()); </cfscript> </cffunction> - + <cffunction name="testAfterActionsExecuted" returntype="void" access="public" output="false"> <cfscript> conversation.setReadAfterFirstAction(false); @@ -193,5 +193,23 @@ assertTrue(conversation.isJunk()); </cfscript> </cffunction> + + <cffunction name="testTransitionAbortedIfBeforeActionReturnsFalse" returntype="void" access="public" output="false"> + <cfscript> + assertTrue(conversation.view()); + assertTrue(conversation.isRead()); + assertFalse(conversation.file()); + assertTrue(conversation.isRead()); + </cfscript> + </cffunction> + + <cffunction name="testEventReturnsTrueWhenTransitionIsSuccessful" returntype="void" access="public" output="false"> + <cfscript> + assertFalse(conversation.junk()); + assertTrue(conversation.view()); + </cfscript> + </cffunction> + + </cfcomponent> \ No newline at end of file test/StateMachineTest.cfc b336ed32deeb1f7a7410b1ad692e363d88624a07 Ryan Wood ryan.wood@gmail.com http://github.com/ryanwood/shade/commit/94ee712cb48348cfe764d06a9181405bfb125a95 94ee712cb48348cfe764d06a9181405bfb125a95 2008-07-18T12:11:38-07:00 2008-07-18T12:11:38-07:00 Added License. Changed 'entering' callback to 'before'. Events now return a boolean value as to their success. Before callback will halt the transition if false. [#1 state:resolved] f8fcfd4417fe161a7a9f9867cee834091c073a3b Ryan Wood ryan.wood@gmail.com