state-machine's Introduction

State Machine

Dead simple state machines in Swift.

Usage

Setup your states:

enum FetchStates: StateList {
    case idle, fetching, error
}

and your actions:

enum FetchActions: ActionList {
    case fetch, success, failure, retry, reset
}

Then create your machine:

var machine: StateMachine<FetchStates, FetchActions> = .idle <> .fetching <> .error <|> .idle

Bind your actions:

try machine.bindAction(.fetch, to: .idle)
try machine.bindAction(.success, to: .fetching, .cycle) // Go back to beginning of cycle (first <> before current state)
try machine.bindAction(.failure, to: .fetching)
try machine.bindAction(.retry, to: .error, .cycle)  // Go back to beginning of cycle (first <> before current state)
try machine.bindAction(.reset, to: .error)

Add events for your states and/or actions:

machine.addEvent(on: [.fetch, .retry]) {
    // Perform fetch operation
}
machine.addEvent(on: .success) {
    // Show data
}
machine.addEvent(on: .error) {
    // Show error
}

Send events:

try machine.send(.fetch)

And that's all it takes to get a working state machine 🎉

This state machine is equivalent to:

┌────┐ ----fetch---> ┌────────┐ --failure-> ┌─────┐
│idle│               │fetching│             │error│
└────┘ <--success--- └────────┘ <--retry--- └─────┘
  ⬑-------------------reset--------------------┘

Operators

|> One way state direction.

Always goes to the next state
<> Two way state direction.

Can either go to the next state, or go back to the first link in cycle (.first <> .second <> .third, cycle from .second or .third would go to .first)
<|> Loop state direction.

Returns to the initial state

Recommend Projects