Kotlin coroutine capable Finite-State Machine (multiplatform)

Sergej Shafarenka

Last update: Dec 14, 2022

Related tags

Kotlin android kotlin fsm coroutines finite-state-machine unidirectional-data-flow kotlin-multiplatform

Overview

Comachine

Features

Kotlin corutines. Event handlers can launch coroutines for collecting external events of performing side effects.
Structured concurrency. Each states is launched in its own coroutine scope, called state scope. Coroutines running in a state scope will be properly cancelled on each state transition.
Suspendable event handlers. Four built-in suspendable event handler types can simplify handling of events.
Decomposition by feature. State machine can delegate declaration and handling of events to independent features.
State extras. Fearures can store objects in the current state even if they are not a part of the state type.

Examples

Binaries

// in project build file
allprojects {
    repositories {
        maven { url = "https://oss.sonatype.org/content/repositories/snapshots/" }
    }
}

// in module build file
dependencies {
    implementation 'de.halfbit:comachine-jvm:1.0-SNAPSHOT'
}

You might also like...

Android application showcasing the MVVM architecture, Clean code using Kotlin, Coroutine, Flow and databinding.

Code4Lyst Android application showcasing the MVVM architecture, Clean code using Kotlin, Coroutine, Flow and databinding. App Architecture MVVM CleanC

1 Nov 29, 2021

A Gallery app developed using kotlin and MVVM architecture with Coroutine

A Gallery app developed using kotlin and MVVM architecture Loading image from un

1 Dec 21, 2021

Android - kotlin Coroutine with MVVM and Paging 3

Android - kotlin Coroutine with MVVM and Paging 3 To Loarn more about paging 3 To Loarn more about LoadStateAdapter API Reference Get all items Api So

1 Mar 17, 2022

Coroutine for Bukkit

Heartbeat Coroutines 두근두근 ❤️ 코루틴 Coroutine for Paper Features Bukkit의 mainHeartBeat(GameLoop)에서 dispatch되는 Coroutine JavaPlugin 생명주기의 CoroutineScope 유

22 Dec 18, 2022

Android Clean Architechture with MVVM, LiveData, Coroutine, Dagger Hilt, Room, DataStore

MovKu An application that displays a list of popular movies and detail Concepts Tech Stack Kotlin -A modern programming language that makes developers

3 Jul 29, 2022

Simple State Machines in Kotlin (KSSM)

Simple State Machines in Kotlin (KSSM) What is this? KSSM (reordered: Kotlin - Simple State Machines) provides an easy and simple DSL (Domain Specific

22 Dec 12, 2022

Stresscraft - State-of-art Minecraft stressing software written in Kotlin

StressCraft (W.I.P) State-of-art Minecraft stressing software written in Kotlin.

57 Dec 4, 2022

ScopedState - Android Scoped State With Kotlin

Android Scoped State There is no need for complicated code - just define scopes

12 Jan 19, 2022

This repository contains the article describing my attempt to implement a simple state reducer based on Kotlin Flow and an example app that uses it.

18 Dec 29, 2022

Comments

Release 1.0
API refinement

[x] Make onEnter non suspending

[x] Add non suspending on<Event>

[x] Add getExtra and setExtra methods

[x] Add support for multiple handlers for the same event (to be used in delegates) & main handlers

[x] Rename launch into launchInState to distinguish it from coroutine's launch

Tests

[x] Add tests for updateState {}

[x] Add tests for transitionTo {}

[x] Add tests for onEnter {}

[x] Add tests for onExit {}

[x] Add tests for onSequential<Event> {}

[x] Add tests for onConcurrent<Event> {}

[x] Add tests for onLatest<Event> {}

[x] Add tests for onSingle<Event> {}

Runtime validation

[x] Prevent from adding multiple handlers of the same event type (with tests)

[ ] Prevent already started comachine from starting again (with tests)

Documentation

[ ] Add DSL documentation

[ ] Create quick reference - a single page documentation describing all features

Configuration

[x] Configure release upload to maven

[ ] Configure CI build & tests

[ ] Update README.md

Composition

[x] Add DSL and implementation for machine composition

[x] Add documentation

[x] Add tests
opened by sergejsha 0