state_machine

Description:

state machine

Dart State Machine #





Easily create a finite state machine and define legal state transitions. Listen to state entrances, departures, and transitions.

Getting Started #
Import the state_machine package:
import 'package:state_machine/state_machine.dart';
copied to clipboard
Create a Machine #
Once created, the StateMachine will be used to create states and state transitions.
StateMachine light = new StateMachine('light');
copied to clipboard
Define a Set of States #
Use the machine to create all required states. A string name is required for ease of debugging.
State isOn = light.newState('on');
State isOff = light.newState('off');
copied to clipboard
It's recommended that states be named in the format "is[State]".
This may seem strange at first, but it has two main benefits:

It helps differentiate states from transitions, which can be confusing
since many words in English are the same as a verb and an adjective
("open" or "secure", for example).
It reads better when calling the state to determine if it's active,
as will be demonstrated later.

Define the Legal State Transitions #
By defining legal state transitions, you can prevent certain actions based on the current state of the machine.
Defining a state transition requires a name (again for ease of debugging), a list of valid "from" states, and
the state to transition the machine to.
StateTransition turnOn = light.newStateTransition('turnOn', [isOff], isOn);
StateTransition turnOff = light.newStateTransition('turnOff', [isOn], isOff);
copied to clipboard
Start the Machine #
Before executing any state transitions, the machine should be started at a specific starting state.
light.start(isOff);
copied to clipboard
Executing a State Transition #
The StateTransition class implements Function so that you can simply call a transition to execute it.
light.start(isOff);
turnOn(); // transitions machine from "isOff" to "isOn"
copied to clipboard
Determining the Active State #
The StateMachine instance exposes a current state property which allows you to retrieve the machine's current state
at any time.
light.start(isOff);
light.current == isOff; // true
copied to clipboard
Additionally, the State class implements Function so that you can simply call a state to determine if it's active.
light.start(isOff);
isOff(); // true
isOn(); // false
copied to clipboard
Listening to State Transitions #
The StateTransition class exposes a listen() method that allows you to listen to the transition and receive an
event every time the transition executes.
turnOn.listen((StateChange change) {
print('Light transitioned from ${change.from.name} to ${change.to.name}');
});
light.start(isOff);
turnOn(); // "Light transitioned from off to on"
copied to clipboard
Passing Data with a State Transition #
State transitions accept an optional payload in case you need to pass data along to listeners.
turnOn.listen((StateChange change) {
print('Light turned on. Wattage: ${change.payload}');
});
light.start(isOff);
turnOn('15w'); // "Light turned on. Wattage: 15w"
copied to clipboard
Listening for State Entrances and Departures #
The State class exposes two streams so that you can listen for the state being entered and the state being left.
isOff.onLeave.listen((StateChange change) {
print('Left: off');
});
isOn.onEnter.listen((StateChange change) {
print('Entered: on');
});
light.start(isOff);
turnOn(); // "Left: off"
// "Entered: on"
copied to clipboard
Wildcard State and State Transitions #
The State class exposes a static instance State.any that can be used as a wildcard when defining a state transition.
StateMachine machine = new StateMachine('machine');
State isFailed = machine.newState('failed');

// This transition will be valid regardless of which state the machine is in.
StateTransition fail = machine.newStateTransition('fail', [State.any], isFailed);
copied to clipboard
Illegal State Transitions #
When you create state transitions, you must define the list of valid "from" states. The machine must be in one of these
states in order to execute the transition. If that's not the case, an IllegalStateTransition exception will be thrown.
// Consider a door with the following states and transitions.
StateMachine door = new StateMachine('door');

State isOpen = door.newState('open');
State isClosed = door.newState('closed');
State isLocked = door.newState('locked');

StateTransition open = door.newStateTransition('open', [isClosed], isOpen);
StateTransition close = door.newStateTransition('close', [isOpen], isClosed);
StateTransition lock = door.newStateTransition('lock', [isClosed], isLocked);
StateTransition unlock = door.newStateTransition('unlock', [isLocked], isClosed);

// Let's transition the door from open, to closed, to locked.
door.start(isOpen);
close();
lock();

// In order to open the door, we must first unlock it.
// If we try to open it first, an exception will be thrown.
open(); // throws IllegalStateTransition
copied to clipboard
Canceling State Transitions #
State machines have a set of legal state transitions that are set in stone and provide the required structure.
But, there may be scenarios where a state transition may or may not be desirable based on additional logic.
To handle this, state transitions support cancellation conditions.
// Consider two state machines - a person and a door.
// The door can be locked or unlocked and the person
// can be with or without a key.
StateMachine door = new StateMachine('door');
State isLocked = door.newState('locked');
State isUnlocked = door.newState('unlocked');
StateTransition unlock = door.newStateTransition('unlock', [isLocked], isUnlocked);

StateMachine person = new StateMachine('person');
State isWithKey = person.newState('withKey');
State isWithoutKey = person.newState('withoutKey');
StateTransition obtainKey = person.newStateTransition('obtainKey', [isWithoutKey], isWithKey);

door.start(isLocked);
person.start(isWithoutKey);

// Add a cancellation condition for unlocking the door:
// If the person is without a key, cancel the unlock transition.
unlock.cancelIf((StateChange change) => isWithoutKey());

unlock(); // false (canceled)
isUnlocked(); // false
obtainKey();
unlock(); // true (not canceled)
isUnlocked(); // true
copied to clipboard
Example #
To run the example:
dart pub global activate webdev
webdev serve example:8080
open http://localhost:8080/
copied to clipboard