test/ConversationService.cfc @@ -29,6 +29,8 @@ <cffunction name="fire" access="public" output="false"> <cfargument name="obj" type="any" required="true" /> + <cfargument name="persistenceObject" required="false" /> + <cfargument name="persistenceMethod" required="false" /> <cfset var i = 1 /> <cfset var transitions = instance.transitions.getTransitionsFromState(arguments.obj.getCurrentState()) /> <cfset transition = 0 /> @@ -36,7 +38,7 @@ <cfset transitions.reset() /> <cfloop condition="transitions.hasNext()"> <cfset transition = transitions.next() /> - <cfif transition.perform(obj)> + <cfif transition.perform(obj, arguments.persistenceObject, arguments.persistenceMethod)> <cfreturn true /> </cfif> </cfloop> Event.cfc @@ -19,6 +19,11 @@ <cfset invokeCallback('beforeAction', arguments.obj) /> <cfreturn invokeCallback('before#getName()#Action', arguments.obj) /> </cffunction> + + <cffunction name="fail" returntype="void" access="public" output="false"> + <cfargument name="obj" required="true" /> + <cfset invokeCallback('failedAction', arguments.obj) /> + </cffunction> <cffunction name="after" returntype="void" access="public" output="false"> <cfargument name="obj" required="true" /> @@ -35,6 +40,7 @@ <cffunction name="invokeCallback" returntype="boolean" access="private" output="false"> <cfargument name="callback" type="string" required="true" /> <cfargument name="obj" required="true" /> + <cftrace text="#callback#: #obj.getMyState()#" /> <cfif structKeyExists(arguments.obj, arguments.callback)> <cfinvoke component="#arguments.obj#" method="#arguments.callback#" returnvariable="result" /> <cfif isDefined('result') and isBoolean(result)> State.cfc @@ -3,16 +3,20 @@ <cfset instance = structNew() /> <cffunction name="init" access="public" output="false"> - <cfargument name="OriginalObject" required="true" /> + <cfargument name="originalObject" required="true" /> <cfargument name="initialState" type="string" required="true" /> <cfargument name="stateMethod" type="string" required="false" default="state" /> + <cfargument name="persistenceObject" required="false" default="" hint="a service that persist the business object" /> + <cfargument name="persistenceMethod" required="false" default="save" /> <cfscript> setOriginalObject(arguments.OriginalObject); instance.states = structNew(); instance.transitionTable = structNew(); instance.eventTable = structNew(); instance.stateMethod = arguments.stateMethod; - instance.initialState = arguments.initialState; + instance.initialState = arguments.initialState; + instance.persistenceObject = arguments.persistenceObject; + instance.persistenceMethod = arguments.persistenceMethod; configureState(); if(getState() eq '') { @@ -44,7 +48,7 @@ <cffunction name="fireEvent" access="public" output="false"> <cfargument name="name" type="string" required="true" /> <cfif structKeyExists(instance.eventTable, arguments.name)> - <cfreturn instance.eventTable[arguments.name].fire(this) /> + <cfreturn instance.eventTable[arguments.name].fire(this, instance.persistenceObject, instance.persistenceMethod) /> </cfif> <cfreturn false /> </cffunction> StateMachine.cfc @@ -1,4 +1,4 @@ -<cfcomponent displayname="Transition" output="false"> +<cfcomponent displayname="StateTransition" output="false"> <cfset instance = structNew() /> @@ -36,6 +36,9 @@ <cffunction name="perform" access="public" output="false"> <cfargument name="obj" required="true" /> + <cfargument name="persistenceObject" required="false" /> + <cfargument name="persistenceMethod" required="false" default="save" /> + <cfscript> var local = structNew(); @@ -49,8 +52,16 @@ local.oldState = local.states[obj.getCurrentState()]; if(not local.isLoopback) { - if(local.nextState.before(obj)) { + if(local.nextState.before(obj)) { + // Set the state obj.setInternalState(getToState()); + // Do the update if we have an updater reference + if(structKeyExists(arguments, 'persistenceObject') and isObject(arguments.persistenceObject)) { + if(not persist(arguments.persistenceObject, arguments.persistenceMethod, obj)) { + local.nextState.fail(obj); + return false; + } + } local.nextState.after(obj); local.oldState.exit(obj); } else { @@ -69,5 +80,18 @@ <cffunction name="getToState" access="public" returntype="string" output="false"> <cfreturn instance.to /> </cffunction> + + <cffunction name="persist" access="private" returntype="boolean" output="false"> + <cfargument name="component" required="true" /> + <cfargument name="method" required="true" /> + <cfargument name="obj" required="true" /> + <cfinvoke component="#arguments.component#" method="#arguments.method#" returnvariable="success"> + <cfinvokeargument name="1" value="#arguments.obj#" /> + </cfinvoke> + <!--- If the method returns void, assume it succeeded ---> + <cfparam name="success" default="true" type="boolean" /> + <cfreturn success /> + </cffunction> + </cfcomponent> \ No newline at end of file StateTransition.cfc @@ -72,7 +72,7 @@ <cfset instance.NeedingAttentionEnter = arguments.value /> </cffunction> - <cffunction name="getNeedingAttentionAfter" access="public" returntype="string" output="false"> + <cffunction name="getNeedingAttentionAfter" access="public" returntype="string" output="false"> <cfreturn instance.NeedingAttentionAfter /> </cffunction> @@ -97,5 +97,23 @@ <cffunction name="getBeforeActionCount" access="public" returntype="Numeric" output="false"> <cfreturn instance.beforeActionCount /> </cffunction> + + <cffunction name="getFailed" access="public" returntype="boolean" output="false"> + <cfreturn instance.Failed /> + </cffunction> + + <cffunction name="setFailed" access="public" returntype="void" output="false"> + <cfargument name="Failed" type="boolean" required="true" /> + <cfset instance.Failed = arguments.Failed /> + </cffunction> + + <cffunction name="getFailedForAwaitingResponse" access="public" returntype="boolean" output="false"> + <cfreturn instance.FailedForAwaitingResponse /> + </cffunction> + + <cffunction name="setFailedForAwaitingResponse" access="public" returntype="void" output="false"> + <cfargument name="FailedForAwaitingResponse" type="boolean" required="true" /> + <cfset instance.FailedForAwaitingResponse = arguments.FailedForAwaitingResponse /> + </cffunction> </cfcomponent> \ No newline at end of file test/Conversation.cfc @@ -2,8 +2,9 @@ <cfset instance = structNew() /> <cffunction name="init" access="public" returntype="any" output="false"> - <cfargument name="conversation" type="shade.test.Conversation" required="true" /> - <cfset super.init(arguments.conversation, 'needingAttention', 'MyState') /> + <cfargument name="conversation" type="shade.test.Conversation" required="true" /> + <cfargument name="persistenceObject" required="false" /> + <cfset super.init(arguments.conversation, 'needingAttention', 'MyState', arguments.persistenceObject, 'save') /> <cfreturn this /> </cffunction> @@ -62,4 +63,8 @@ <cfset getOriginalObject().incrementBeforeActionCount() /> </cffunction> + <cffunction name="failedAction" access="public" returntype="void" output="false"> + <cfset getOriginalObject().setFailed(true) /> + </cffunction> + </cfcomponent> \ No newline at end of file test/ConversationState.cfc @@ -2,8 +2,8 @@ <cffunction name="setup" returntype="void" access="public"> <cfscript> - original = createObject("component", "shade.test.Conversation").init(); - conversation = createObject( "component", "shade.test.ConversationState" ).init(original); + service = createObject("component", "shade.test.ConversationService").init(); + conversation = service.new(); </cfscript> </cffunction> @@ -72,10 +72,10 @@ <cfscript> conversation.view(); assertTrue(conversation.isInState('read')); - assertTrue(conversation.isRead()); + assertTrue(conversation.isRead()); </cfscript> </cffunction> - + <cffunction name="testCanGoFromReadToClosedBecauseGuardPasses" returntype="void" access="public" output="false"> <cfscript> conversation.setCanClose(true); @@ -155,13 +155,12 @@ <cfscript> conversation.setReadExit(false); conversation.view(); - conversation.junk(); - + conversation.junk(); assertTrue(conversation.getReadExit()); </cfscript> </cffunction> - <cffunction name="testEntryAndExitNotRunOnLoopbackTransation" returntype="void" access="public" output="false"> + <cffunction name="testEntryAndExitNotRunOnLoopbackTransition" returntype="void" access="public" output="false"> <cfscript> conversation.view(); conversation.setReadEnter(false); @@ -231,5 +230,33 @@ assertEquals(3, conversation.getBeforeActionCount()); </cfscript> </cffunction> + + <cffunction name="testRecordIsPersistedOnStateChange" returntype="void" access="public" output="false"> + <cfscript> + assertFalse(service.recordSaved()); + conversation.view(); + assertTrue(service.recordSaved()); + assertTrue(conversation.isRead()); + </cfscript> + </cffunction> + <cffunction name="testAfterAndExitNotRunOnPersistenceFailed" returntype="void" access="public" output="false"> + <cfscript> + service.setSaveShouldFail(true); + conversation.setReadAfterFirstAction(false); + assertFalse(conversation.view()); + assertFalse(service.recordSaved()); + assertFalse(conversation.getReadAfterFirstAction()); + </cfscript> + </cffunction> + + <cffunction name="testFailedActionExecuted" returntype="void" access="public" output="false"> + <cfscript> + service.setSaveShouldFail(true); + conversation.setFailed(false); + assertFalse(conversation.view()); + assertTrue(conversation.getFailed()); + </cfscript> + </cffunction> + </cfcomponent> \ No newline at end of file test/StateMachineTest.cfc 4c22d15ff9d74cfaf15153438ed0b4bb6ca7af08 Ryan Wood ryan.wood@gmail.com http://github.com/ryanwood/shade/commit/0bdacba1386989f5809b763877b67038f0bf609a 0bdacba1386989f5809b763877b67038f0bf609a 2008-10-13T06:52:34-07:00 2008-10-13T06:52:34-07:00 Added persistence object for saving which creates more accurate events fad87858025708f2f463ba9f617b29a9ab69e189 Ryan Wood ryan.wood@gmail.com