.gitignore @@ -15,7 +15,9 @@ instance.initialState = arguments.initialState; configureState(); - setInitialState(instance.initialState); + if(getState() eq '') { + setInitialState(instance.initialState); + } return this; </cfscript> @@ -65,13 +67,13 @@ <cfreturn invokeMethod("get#instance.stateMethod#") /> </cffunction> - <cffunction name="setState" access="public" output="false"> + <cffunction name="setInternalState" access="public" output="false"> <cfargument name="state" type="string" required="true" /> <cfset var local = structNew() /> <cfset local.state = arguments.state /> <cfset invokeMethod("set#instance.stateMethod#", local) /> </cffunction> - + <!--- Accessors ---> <cffunction name="getInitialState" access="public" returntype="string" output="false"> @@ -85,7 +87,7 @@ <cfscript> var state = instance.states[arguments.stateName]; state.before(this); - setState(arguments.stateName); + setInternalState(arguments.stateName); state.after(this); </cfscript> </cffunction> @@ -137,16 +139,22 @@ 1. To defined the state query handlers, i.e. isClosed() 2. To define the event firing shortcuts, i.e. close() - 3. To pass any unknown method on to the decorated object to handle - + 3. To pass any unknown method on to the decorated object to handle ---> <cffunction name="onMissingMethod" output="false" access="public"> <cfargument name="missingMethodName" type="string" /> <cfargument name="missingMethodArguments" type="struct" /> - <!--- - Shortcut to wire up event methods, so basically if you have a - 'trash' event, you can call obj.trash() rather than the longer obj.fireEvent('trash') ---> + <!--- This is to highly discourage the manual setting of state. + It can still be done by getting the original object and + setting it directly. BAD. ---> + <cfif arguments.missingMethodName is "set#getStateMethod()#" > + <cfthrow type="shade.InvalidStateChange" message="You cannot set the state directly. Please call an event instead to change the state." /> + </cfif> + + <!--- Shortcut to wire up event methods, so basically if you have a + 'trash' event, you can call obj.trash() rather than the longer + obj.fireEvent('trash') ---> <cfif structKeyExists(instance.eventTable, arguments.missingMethodName)> <cfreturn fireEvent(arguments.missingMethodName) /> </cfif> StateMachine.cfc @@ -50,7 +50,7 @@ if(not local.isLoopback) { if(local.nextState.before(obj)) { - obj.setState(getToState()); + obj.setInternalState(getToState()); local.nextState.after(obj); local.oldState.exit(obj); } else { StateTransition.cfc @@ -2,6 +2,7 @@ <cfset instance = structNew() /> <cffunction name="init" access="public" returntype="any" output="false" hint=""> + <cfset instance.state = '' /> <cfreturn this /> </cffunction> test/Conversation.cfc @@ -210,6 +210,15 @@ </cfscript> </cffunction> - + <cffunction name="testCannotSetStateDirectly" returntype="void" access="public" output="false"> + <cfscript> + try { + conversation.setMyState('new'); + fail('Should not be able to set state directly.'); + } catch( any e ) { + assertEquals( 'shade.InvalidStateChange', e.type ); + } + </cfscript> + </cffunction> </cfcomponent> \ No newline at end of file test/StateMachineTest.cfc 4245d4bde90bb8ef808702716d99aedae1409387 Ryan Wood ryan.wood@gmail.com http://github.com/ryanwood/shade/commit/a0424f7ec70c1d1f8a0d8c1d83097ef9b5b92d1c a0424f7ec70c1d1f8a0d8c1d83097ef9b5b92d1c 2008-08-08T12:16:52-07:00 2008-08-08T12:16:52-07:00 Prevented manually state change. 05209adc66da6a01cd3990e24855d512a8bc8a78 Ryan Wood ryan.wood@gmail.com