Common flow demo

Refs: #11

Author: motorro

.gitignore

@@ -10,6 +10,7 @@
 /.idea/assetWizardSettings.xml
 /.idea/copilot
 /.idea/*.xd
+/.idea/deviceManager.xml
 .DS_Store
 /build
 /.kotlin

.idea/compiler.xml

@@ -105,36 +105,35 @@ tasks.register("runCommonflowTests") {
     description = "Run unit tests for the commonflow library."
 }
 
-tasks.register("runRegisterUnitTests") {
-    dependsOn(":examples:welcome:commonregister:allTests")
-    description = "Run unit tests for the common register layer."
-}
-
-tasks.register("runLoginUnitTests") {
-    dependsOn(":examples:welcome:login:testDebugUnitTest")
-    description = "Run unit tests for the login module."
-}
-
-tasks.register("runLceUnitTests") {
+tasks.register("runLceExampleUnitTests") {
     dependsOn(":examples:lce:testDebugUnitTest")
     description = "Run unit tests for LCE app."
 }
 
-tasks.register("runWelcomeUnitTests") {
+tasks.register("runWelcomeExampleUnitTests") {
+    dependsOn(":examples:welcome:commonregister:allTests")
+    dependsOn(":examples:welcome:login:testDebugUnitTest")
     dependsOn(":examples:welcome:welcome:testDebugUnitTest")
     description = "Run unit tests for welcome app."
 }
 
-tasks.register("runTimerUnitTests") {
+tasks.register("runTimerExampleUnitTests") {
     dependsOn(":examples:timer:testAndroidHostTest")
     description = "Run unit tests for timer library."
 }
 
-tasks.register("runDiUnitTests") {
+tasks.register("runDiExampleUnitTests") {
     dependsOn(":examples:di:login:testDebugUnitTest")
+    dependsOn(":examples:di:social:testDebugUnitTest")
     description = "Run unit tests for di app."
 }
 
+tasks.register("runBooksExampleUnitTests") {
+    dependsOn(":examples:books:item:testDebugUnitTest")
+    dependsOn(":examples:books:app:testDebugUnitTest")
+    description = "Run unit tests for books app."
+}
+
 tasks.register("displayVersion") {
     description = "Display application version name"
     doLast {
@@ -147,12 +146,11 @@ tasks.register("runUnitTests") {
             "runStateMachineTests",
             "runCoroutinesTests",
             "runCommonflowTests",
-            "runLoginUnitTests",
-            "runRegisterUnitTests",
-            "runLceUnitTests",
-            "runWelcomeUnitTests",
-            "runTimerUnitTests",
-            "runDiUnitTests"
+            "runLceExampleUnitTests",
+            "runWelcomeExampleUnitTests",
+            "runTimerExampleUnitTests",
+            "runDiExampleUnitTests",
+            "runBooksExampleUnitTests"
     )
     group = "verification"
     description = "Run unit tests for all modules."

.idea/deploymentTargetSelector.xml

@@ -30,7 +30,7 @@ interface CommonFlowDataApi<G: Any, U: Any, I, R> {
     /**
      * Creates flow
      */
-    fun init(flowHost: CommonFlowHost<R>, input: I? = null): CommonMachineState<G, U>
+    fun init(flowHost: CommonFlowHost<R>, input: I): CommonMachineState<G, U>
 
     /**
      * Returns default UI state

.idea/gradle.xml

@@ -20,9 +20,10 @@ package com.motorro.commonstatemachine.flow.data
  * @see com.motorro.commonstatemachine.ProxyMachineState
  * @see CommonFlowDataApi
  */
-interface CommonFlowHost<in R> {
+fun interface CommonFlowHost<in R> {
     /**
      * Completes common flow
+     * @param result Optional result.
      */
-    fun onComplete(result: R? = null)
+    fun onComplete(result: R)
 }

build.gradle.kts

@@ -14,6 +14,7 @@
 package com.motorro.commonstatemachine.flow.viewmodel
 
 import android.view.View
+import androidx.activity.ComponentActivity
 import androidx.activity.compose.BackHandler
 import androidx.activity.compose.setContent
 import androidx.activity.viewModels
@@ -23,26 +24,32 @@ import androidx.compose.ui.platform.ComposeView
 import androidx.compose.ui.platform.ViewCompositionStrategy
 import androidx.fragment.app.Fragment
 import androidx.fragment.app.viewModels
+import androidx.lifecycle.ViewModelProvider.Factory
 import androidx.lifecycle.viewmodel.CreationExtras
 
 /**
  * Builds state machine composition
  * Ensure that [AppCompatActivity] has correct view model factory
  * @param extrasProducer optional extras producer
+ * @param factoryProducer optional factory producer
  * @param setResult implement to set the activity result or do any result processing
  * @param navigationBackHandler optional back navigation handler. Implement to pass back navigation to the view model
  * @param content content block
  */
-fun <G: Any,  U: Any, R> AppCompatActivity.setStateMachineContent(
-    extrasProducer: (() -> CreationExtras)? = null,
-    setResult: (R?) -> Unit = { },
-    navigationBackHandler: @Composable (Boolean, () -> Unit) -> Unit = { enabled, onBack ->
+inline fun <G: Any,  U: Any, R, reified VM: CommonFlowViewModel<G, U, *, R>> ComponentActivity.setStateMachineContent(
+    noinline extrasProducer: (() -> CreationExtras)? = null,
+    noinline factoryProducer: (() -> Factory)? = null,
+    noinline setResult: (R?) -> Unit = { },
+    noinline navigationBackHandler: @Composable (Boolean, () -> Unit) -> Unit = { enabled, onBack ->
         BackHandler(enabled = enabled) { onBack() }
     },
-    content: @Composable (U, (G) -> Unit) -> Unit
+    noinline content: @Composable (U, (G) -> Unit) -> Unit
 ) {
     setContent {
-        val viewModel: CommonFlowViewModel<G, U, *, R> by viewModels(extrasProducer = extrasProducer)
+        val viewModel: VM by viewModels(
+            extrasProducer = extrasProducer,
+            factoryProducer = factoryProducer
+        )
         CommonFlowComposition(
             viewModel = viewModel,
             navigationBackHandler = navigationBackHandler,
@@ -62,21 +69,26 @@ fun <G: Any,  U: Any, R> AppCompatActivity.setStateMachineContent(
  * Ensure that [Fragment] has correct view model factory
  * @param onFinish called when the flow is finished
  * @param extrasProducer optional extras producer
+ * @param factoryProducer optional factory producer
  * @param navigationBackHandler optional back navigation handler. Implement to pass back navigation to the view model
  * @param content content block
  */
-fun < G: Any,  U: Any, R> Fragment.createStateMachineView(
-    onFinish: (R?) -> Unit,
-    extrasProducer: (() -> CreationExtras)? = null,
-    navigationBackHandler: @Composable (Boolean, () -> Unit) -> Unit = { enabled, onBack ->
+inline fun <G: Any,  U: Any, R, reified VM: CommonFlowViewModel<G, U, *, R>> Fragment.createStateMachineView(
+    noinline onFinish: (R?) -> Unit,
+    noinline extrasProducer: (() -> CreationExtras)? = null,
+    noinline factoryProducer: (() -> Factory)? = null,
+    noinline navigationBackHandler: @Composable (Boolean, () -> Unit) -> Unit = { enabled, onBack ->
         BackHandler(enabled = enabled) { onBack() }
     },
-    content: @Composable (U, (G) -> Unit) -> Unit
+    noinline content: @Composable (U, (G) -> Unit) -> Unit
 ): View = ComposeView(requireContext()).apply {
     setViewCompositionStrategy(ViewCompositionStrategy.DisposeOnViewTreeLifecycleDestroyed)
 
     setContent {
-        val viewModel: CommonFlowViewModel<G, U, *, R> by viewModels(extrasProducer = extrasProducer)
+        val viewModel: VM by viewModels(
+            extrasProducer = extrasProducer,
+            factoryProducer = factoryProducer
+        )
         CommonFlowComposition(
             viewModel = viewModel,
             navigationBackHandler = navigationBackHandler,

commonflow/data/src/commonMain/kotlin/com/motorro/commonstatemachine/flow/data/CommonFlowDataApi.kt

@@ -23,7 +23,7 @@ import kotlinx.coroutines.flow.StateFlow
  */
 open class CommonFlowViewModel<G: Any, U: Any, I, R>(
     private val api: CommonFlowDataApi<G, U, I, R>,
-    private val init: I? = null,
+    private val init: I,
     vararg closeables: AutoCloseable
 ) : ViewModel(*closeables) {
 
@@ -46,12 +46,10 @@ open class CommonFlowViewModel<G: Any, U: Any, I, R>(
         object : ProxyMachineState<BaseFlowGesture<G>, BaseFlowUiState<U, R>, G, U>(api.getDefaultUiState()) {
 
             private var terminated = false
-            private val flowHost = object : CommonFlowHost<R> {
-                override fun onComplete(result: R?) {
-                    if (terminated.not()) {
-                        terminated = true
-                        setUiState(BaseFlowUiState.Terminated(result))
-                    }
+            private val flowHost = CommonFlowHost<R> { result ->
+                if (terminated.not()) {
+                    terminated = true
+                    setUiState(BaseFlowUiState.Terminated(result))
                 }
             }
 

commonflow/data/src/commonMain/kotlin/com/motorro/commonstatemachine/flow/data/CommonFlowHost.kt

@@ -38,7 +38,7 @@ class CommonFlowViewModelTest {
 
     private lateinit var dispatcher: TestDispatcher
     private lateinit var api: TestDataApi
-    private lateinit var model: CommonFlowViewModel<TestGesture, TestUiState, Int, String>
+    private lateinit var model: CommonFlowViewModel<TestGesture, TestUiState, Int, String?>
 
     @BeforeTest
     fun init() {