Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add parameter to enable throwing exception on invalid transition #16

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions src/main/kotlin/com/tinder/StateMachine.kt
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ class StateMachine<STATE : Any, EVENT : Any, SIDE_EFFECT : Any> private construc
return Transition.Valid(this, event, toState, sideEffect)
}
}
if (graph.throwOnInvalidTransition) {
error("Unhandled event $event in state $this!")
}
return Transition.Invalid(this, event)
}

Expand Down Expand Up @@ -86,6 +89,7 @@ class StateMachine<STATE : Any, EVENT : Any, SIDE_EFFECT : Any> private construc

data class Graph<STATE : Any, EVENT : Any, SIDE_EFFECT : Any>(
val initialState: STATE,
val throwOnInvalidTransition: Boolean,
val stateDefinitions: Map<Matcher<STATE, STATE>, State<STATE, EVENT, SIDE_EFFECT>>,
val onTransitionListeners: List<(Transition<STATE, EVENT, SIDE_EFFECT>) -> Unit>
) {
Expand Down Expand Up @@ -128,13 +132,18 @@ class StateMachine<STATE : Any, EVENT : Any, SIDE_EFFECT : Any> private construc
graph: Graph<STATE, EVENT, SIDE_EFFECT>? = null
) {
private var initialState = graph?.initialState
private var throwOnInvalidTransition = false
private val stateDefinitions = LinkedHashMap(graph?.stateDefinitions ?: emptyMap())
private val onTransitionListeners = ArrayList(graph?.onTransitionListeners ?: emptyList())

fun initialState(initialState: STATE) {
this.initialState = initialState
}

fun throwOnInvalidTransition() {
this.throwOnInvalidTransition = true
}

fun <S : STATE> state(
stateMatcher: Matcher<STATE, S>,
init: StateDefinitionBuilder<S>.() -> Unit
Expand All @@ -154,9 +163,12 @@ class StateMachine<STATE : Any, EVENT : Any, SIDE_EFFECT : Any> private construc
onTransitionListeners.add(listener)
}

fun build(): Graph<STATE, EVENT, SIDE_EFFECT> {
return Graph(requireNotNull(initialState), stateDefinitions.toMap(), onTransitionListeners.toList())
}
fun build(): Graph<STATE, EVENT, SIDE_EFFECT> = Graph(
requireNotNull(initialState),
throwOnInvalidTransition,
stateDefinitions.toMap(),
onTransitionListeners.toList()
)

inner class StateDefinitionBuilder<S : STATE> {

Expand Down
22 changes: 22 additions & 0 deletions src/test/kotlin/com/tinder/StateMachineTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,28 @@ internal class StateMachineTest {
}
}

class ThrowingOnInvalidTransition {

private val stateMachine = StateMachine.create<String, Int, String> {
initialState(STATE_A)
throwOnInvalidTransition()
state(STATE_A) {}
}

@Test
fun transition_givenInvalidEvent_shouldThrowIllegalStateException() {
// When
val fromState = stateMachine.state

// Then
assertThatIllegalStateException().isThrownBy {
stateMachine.transition(EVENT_1)
}
assertThat(stateMachine.state).isEqualTo(fromState)

}
}

class WithoutInitialState {

@Test
Expand Down