Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nejdetkadir/statemachine
A lightweight, easy-to-use state machine library for Go
https://github.com/nejdetkadir/statemachine
go golang state-machine state-management
Last synced: 4 days ago
JSON representation
A lightweight, easy-to-use state machine library for Go
- Host: GitHub
- URL: https://github.com/nejdetkadir/statemachine
- Owner: nejdetkadir
- License: mit
- Created: 2024-05-31T18:37:10.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-31T21:31:20.000Z (7 months ago)
- Last Synced: 2024-12-28T19:31:16.556Z (13 days ago)
- Topics: go, golang, state-machine, state-management
- Language: Go
- Homepage:
- Size: 109 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# StateMachine
StateMachine is a lightweight, easy-to-use state machine library for Go. It allows you to define states and events to manage complex state transitions in a clean and organized way.
## Features
- Define states and an initial state
- Register events with transitions between states
- Execute before and after hooks for state transitions
- Validate state transitions
- Render state transition graph for visualization
## Installation
To install StateMachine, use go get:
```bash
$ go get github.com/nejdetkadir/statemachine
```
## Usage
### Creating a StateMachine
Creating a new state machine is simple. Define your states and initial state:
```go
package main
import (
"fmt"
"github.com/nejdetkadir/statemachine"
)
func main() {
states := []string{"A", "B"}
initialState := "A"
sm, err := statemachine.New(states, initialState)
if err != nil {
fmt.Println("Error creating state machine:", err)
return
}
fmt.Println("Initial State:", sm.CurrentState())
}
```
### Registering Events
Register events that define transitions between states:
```go
func main() {
states := []string{"A", "B"}
initialState := "A"
sm, err := statemachine.New(states, initialState)
if err != nil {
fmt.Println("Error creating state machine:", err)
return
}
event := statemachine.Event{
Name: "event1",
From: []string{"A"},
To: "B",
}
err = sm.RegisterEvent(event)
if err != nil {
fmt.Println("Error registering event:", err)
return
}
fmt.Println("Event registered successfully")
}
```
### Firing Events
Fire events to transition between states:
```go
func main() {
states := []string{"A", "B"}
initialState := "A"
sm, err := statemachine.New(states, initialState)
if err != nil {
fmt.Println("Error creating state machine:", err)
return
}
event := statemachine.Event{
Name: "event1",
From: []string{"A"},
To: "B",
}
err = sm.RegisterEvent(event)
if err != nil {
fmt.Println("Error registering event:", err)
return
}
err = sm.Fire("event1")
if err != nil {
fmt.Println("Error firing event:", err)
return
}
fmt.Println("Current State:", sm.CurrentState())
}
```
### Hooks and Validation
You can define before, after, and validate hooks for each event:
```go
event := statemachine.Event{
Name: "event1",
From: []string{"A"},
To: "B",
Before: func() {
fmt.Println("Before transition")
},
After: func() {
fmt.Println("After transition")
},
Validate: func(from string, to string) error {
if from == "A" && to == "B" {
return nil
}
return fmt.Errorf("invalid transition from %s to %s", from, to)
},
}
```
### Rendering Graph
Render the state transition graph to visualize events:
```go
func main() {
states := []string{"A", "B"}
initialState := "A"
sm, err := statemachine.New(states, initialState)
if err != nil {
fmt.Println("Error creating state machine:", err)
return
}
event := statemachine.Event{
Name: "event1",
From: []string{"A"},
To: "B",
}
err = sm.RegisterEvent(event)
if err != nil {
fmt.Println("Error registering event:", err)
return
}
sm.RenderGraph()
}
```
## Examples
Check out the [examples](examples/README.md) directory for more usage examples.
## Testing
To run the tests, use go test:
```bash
$ go test ./...
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/nejdetkadir/statemachine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nejdetkadir/statemachine/blob/main/CODE_OF_CONDUCT.md).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.