feat: voyager module routing function improvements

Author: programadorthi

core-stack/common/src/dev/programadorthi/routing/core/StackManager.kt

@@ -1,7 +1,3 @@
-/*
- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
- */
-
 package dev.programadorthi.routing.core
 
 import dev.programadorthi.routing.core.application.Application

core-stack/common/src/dev/programadorthi/routing/core/StackRegexRouting.kt

@@ -1,7 +1,3 @@
-/*
- * Copyright 2014-2023 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
- */
-
 package dev.programadorthi.routing.core
 
 import dev.programadorthi.routing.core.application.ApplicationCall

core-stack/common/src/dev/programadorthi/routing/core/StackRouting.kt

@@ -1,7 +1,3 @@
-/*
-* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
-*/
-
 package dev.programadorthi.routing.core
 
 import io.ktor.http.Parameters

core-stack/common/src/dev/programadorthi/routing/core/StackRoutingBuilder.kt

@@ -1,7 +1,3 @@
-/*
-* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
-*/
-
 package dev.programadorthi.routing.core
 
 import dev.programadorthi.routing.core.application.ApplicationCall

resources-stack/common/src/dev/programadorthi/routing/resources/StackResourceRouting.kt

@@ -1,7 +1,3 @@
-/*
- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
- */
-
 package dev.programadorthi.routing.resources
 
 import dev.programadorthi.routing.core.Route

voyager/common/src/dev/programadorthi/routing/voyager/VoyagerCallHook.kt

@@ -0,0 +1,41 @@
+package dev.programadorthi.routing.voyager
+
+import cafe.adriel.voyager.core.screen.Screen
+import cafe.adriel.voyager.navigator.Navigator
+import dev.programadorthi.routing.core.application.Application
+import kotlinx.coroutines.CoroutineScope
+import kotlin.coroutines.CoroutineContext
+
+internal class VoyagerNavigatorManager(
+    private val application: Application,
+    val initialUri: String,
+) : CoroutineScope {
+
+    override val coroutineContext: CoroutineContext
+        get() = application.coroutineContext
+
+    internal var navigator: Navigator? = null
+
+    fun pop() {
+        val nav = navigator ?: navigator?.parent ?: return
+        nav.pop()
+    }
+
+    fun popUntil(predicate: (Screen) -> Boolean) {
+        val nav = navigator ?: navigator?.parent ?: return
+        nav.popUntil(predicate)
+    }
+
+    fun push(screen: Screen) {
+        val nav = navigator ?: navigator?.parent ?: return
+        nav.push(screen)
+    }
+
+    fun replace(screen: Screen, replaceAll: Boolean) {
+        val nav = navigator ?: navigator?.parent ?: return
+        when {
+            replaceAll -> nav.replaceAll(screen)
+            else -> nav.replace(screen)
+        }
+    }
+}

voyager/common/src/dev/programadorthi/routing/voyager/VoyagerEventManager.kt

@@ -0,0 +1,27 @@
+package dev.programadorthi.routing.voyager
+
+import dev.programadorthi.routing.core.application.Application
+import dev.programadorthi.routing.core.application.ApplicationCall
+import io.ktor.util.AttributeKey
+import io.ktor.util.Attributes
+
+private val VoyagerNavigatorManagerAttributeKey: AttributeKey<VoyagerNavigatorManager> =
+    AttributeKey("VoyagerNavigatorManager")
+
+private var Attributes.voyagerNavigatorManager: VoyagerNavigatorManager
+    get() = get(VoyagerNavigatorManagerAttributeKey)
+    private set(value) {
+        put(VoyagerNavigatorManagerAttributeKey, value)
+    }
+
+internal var Application.voyagerNavigatorManager: VoyagerNavigatorManager
+    get() = attributes.voyagerNavigatorManager
+    set(value) {
+        attributes.voyagerNavigatorManager = value
+    }
+
+internal var ApplicationCall.voyagerNavigatorManager: VoyagerNavigatorManager
+    get() = application.voyagerNavigatorManager
+    set(value) {
+        application.voyagerNavigatorManager = value
+    }

voyager/common/src/dev/programadorthi/routing/voyager/VoyagerEventManagerAttribute.kt

@@ -1,6 +1,5 @@
 package dev.programadorthi.routing.voyager
 
-import dev.programadorthi.routing.core.StackRouteMethod
 import dev.programadorthi.routing.core.StackRouting
 import dev.programadorthi.routing.core.application.ApplicationPlugin
 import dev.programadorthi.routing.core.application.createApplicationPlugin
@@ -14,19 +13,12 @@ public val VoyagerNavigator: ApplicationPlugin<VoyagerNavigatorConfig> = createA
     "VoyagerNavigator",
     ::VoyagerNavigatorConfig,
 ) {
-    application.install(StackRouting)
+    application.install(StackRouting) // Helps to track last pushed path
 
-    application.voyagerEventManager = VoyagerEventManager(
-        coroutineContext = application.coroutineContext,
+    application.voyagerNavigatorManager = VoyagerNavigatorManager(
+        application = application,
         initialUri = pluginConfig.initialUri,
     )
-
-    // Intercepts all call, check for a pop and emit to [VoyagerEventManager]
-    on(VoyagerCallHook) { call ->
-        if (call.routeMethod == StackRouteMethod.Pop) {
-            call.voyagerEventManager.pop()
-        }
-    }
 }
 
 @KtorDsl

voyager/common/src/dev/programadorthi/routing/voyager/VoyagerNavigatorManager.kt

@@ -1,45 +1,10 @@
-/*
- * Copyright 2014-2023 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
- */
-
 package dev.programadorthi.routing.voyager
 
 import dev.programadorthi.routing.core.Route
 import dev.programadorthi.routing.core.application.ApplicationCall
 import dev.programadorthi.routing.core.route
-import io.ktor.util.KtorDsl
-
-@KtorDsl
-public fun Route.pushScreen(
-    path: Regex,
-    body: VoyagerPipelineInterceptor<Unit, ApplicationCall>,
-): Route = route(path = path) {
-    pushScreen(body)
-}
-
-@KtorDsl
-public fun Route.replaceScreen(
-    path: Regex,
-    body: VoyagerPipelineInterceptor<Unit, ApplicationCall>,
-): Route = route(path = path) {
-    replaceScreen(body)
-}
-
-@KtorDsl
-public fun Route.replaceAllScreen(
-    path: Regex,
-    body: VoyagerPipelineInterceptor<Unit, ApplicationCall>,
-): Route = route(path = path) {
-    replaceAllScreen(body)
-}
 
-@KtorDsl
-public fun Route.handleScreen(
+public fun Route.screen(
     path: Regex,
     body: VoyagerPipelineInterceptor<Unit, ApplicationCall>,
-): Route = route(path) {
-    pushScreen(body)
-    replaceScreen(body)
-    replaceAllScreen(body)
-    // By default, there is reason to pop handle return a Screen
-}
+): Route = route(path) { handle(body) }

voyager/common/src/dev/programadorthi/routing/voyager/VoyagerNavigatorManagerAttribute.kt

@@ -2,9 +2,7 @@ package dev.programadorthi.routing.voyager
 
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
-import androidx.compose.runtime.LaunchedEffect
-import androidx.compose.runtime.collectAsState
-import androidx.compose.runtime.getValue
+import androidx.compose.runtime.SideEffect
 import androidx.compose.runtime.remember
 import cafe.adriel.voyager.core.screen.Screen
 import cafe.adriel.voyager.navigator.CurrentScreen
@@ -18,18 +16,13 @@ public fun VoyagerRouter(
     initialScreen: Screen = VoyagerEmptyScreen(),
 ) {
     val manager = remember(router) {
-        router.application.voyagerEventManager
+        router.application.voyagerNavigatorManager
     }
 
     CompositionLocalProvider(VoyagerLocalRouter provides router) {
         Navigator(initialScreen) { navigator ->
-            val event by manager.navigation.collectAsState()
-
-            LaunchedEffect(key1 = event) {
-                event.execute(navigator)
-                if (event !is VoyagerRouteEvent.Idle) {
-                    manager.clearEvent()
-                }
+            SideEffect {
+                manager.navigator = navigator
             }
 
             CurrentScreen()