Refactor visibleBackstack to renderGroup

roudikk · Jan 30, 2023 · b0aab97 · b0aab97
1 parent 008f199
commit b0aab97
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 23 deletions.
diff --git a/guia/src/main/java/com/roudikk/guia/containers/NavContainer.kt b/guia/src/main/java/com/roudikk/guia/containers/NavContainer.kt
@@ -68,7 +68,7 @@ private fun Navigator.NavContainerContent(
 ) = Box(modifier = modifier) {
     val canGoBack by navigator.canGoBack()
     val lifecycleManager = rememberDefaultLifecycleManager(navigator = navigator)
-    val visibleBackstack = lifecycleManager.renderGroup
+    val renderGroup = lifecycleManager.renderGroup
 
     val backEnabled by remember(canGoBack, navigator.overrideBackPress) {
         derivedStateOf { canGoBack && navigator.overrideBackPress }
@@ -80,7 +80,7 @@ private fun Navigator.NavContainerContent(
 
     // Screen content
     ScreenContainer(
-        screenEntry = visibleBackstack.screenEntry
+        screenEntry = renderGroup.screenEntry
     ) { entry ->
         NavEntryContainer(
             lifecycleManager = lifecycleManager,
@@ -90,7 +90,7 @@ private fun Navigator.NavContainerContent(
 
     // Bottom sheet content
     BottomSheetContainer(
-        bottomSheetEntry = visibleBackstack.bottomSheetEntry,
+        bottomSheetEntry = renderGroup.bottomSheetEntry,
         bottomSheetScrimColor = bottomSheetScrimColor,
         container = bottomSheetContainer,
     ) { entry ->
@@ -106,7 +106,7 @@ private fun Navigator.NavContainerContent(
 
     // Dialog content
     DialogContainer(
-        dialogEntry = visibleBackstack.dialogEntry,
+        dialogEntry = renderGroup.dialogEntry,
         container = dialogContainer,
     ) { entry ->
         NavEntryContainer(

diff --git a/guia/src/main/java/com/roudikk/guia/lifecycle/DefaultLifecycleManager.kt b/guia/src/main/java/com/roudikk/guia/lifecycle/DefaultLifecycleManager.kt
@@ -53,7 +53,7 @@ fun rememberDefaultLifecycleManager(
                     entriesAfter.all { entry -> navigator.navigationNode(entry) is Dialog }
                 }?.let(createLifecycleEntry)
 
-            val visibleBackstack = DefaultRenderGroup(
+            val renderGroup = DefaultRenderGroup(
                 screenEntry = screenEntry,
                 dialogEntry = dialogEntry,
                 bottomSheetEntry = bottomSheetEntry
@@ -67,7 +67,7 @@ fun rememberDefaultLifecycleManager(
                 backstack.getOrNull(backstack.lastIndex - 1)
                     ?.let(navigator::navigationNode) !is BottomSheet
 
-            visibleBackstack.entries.forEach {
+            renderGroup.entries.forEach {
                 // If the current destination is a bottom sheet or a dialog
                 // we need to pause whatever is behind it. In the case of a dialog
                 // we might have a bottom sheet and/or a screen behind it, whereas a bottom sheet
@@ -83,22 +83,22 @@ fun rememberDefaultLifecycleManager(
                 }
             }
 
-            visibleBackstack
+            renderGroup
         },
         /**
          * Make sure all entries' lifecycle is up to date.
          *
-         * All entries that are not in the current visibleBackstack will be in the destroyed state.
+         * All entries that are not in the current renderGroup will be in the destroyed state.
          *
-         * We then check the entries that are in the visibleBackstack:
+         * We then check the entries that are in the render group:
          * - If the entry is the current last entry in the [Navigator] backstack, it's resumed.
          * - If the entry is not the current last entry, then it's paused.
          */
-        updateLifecycles = { visibleBackstack, lifeCycleEntries ->
-            lifeCycleEntries.filter { it !in visibleBackstack.entries }
+        updateLifecycles = { renderGroup, lifeCycleEntries ->
+            lifeCycleEntries.filter { it !in renderGroup.entries }
                 .forEach { it.maxLifecycleState = Lifecycle.State.CREATED }
 
-            visibleBackstack.entries.forEach {
+            renderGroup.entries.forEach {
                 if (it.id == navigator.backstack.lastOrNull()?.id) {
                     it.maxLifecycleState = Lifecycle.State.RESUMED
                 } else {

diff --git a/guia/src/main/java/com/roudikk/guia/lifecycle/LifecycleManager.kt b/guia/src/main/java/com/roudikk/guia/lifecycle/LifecycleManager.kt
@@ -222,16 +222,23 @@ class LifecycleManager<RG : RenderGroup> internal constructor(
     private fun savedStateKey(id: String) = "back-stack-manager-$id"
 }
 
-fun interface GetRenderGroup<VB : RenderGroup> {
+/**
+ * Generates a [RenderGroup] given a [Navigator]'s current backstack.
+ */
+fun interface GetRenderGroup<RG : RenderGroup> {
     operator fun invoke(
         backstack: List<BackstackEntry>,
         createEntry: (BackstackEntry) -> LifecycleEntry
-    ): VB
+    ): RG
 }
 
-fun interface UpdateLifecycles<VB : RenderGroup> {
+/**
+ * Updates the lifecycle of a [LifecycleManager]'s current lifecycle entries given the
+ * current [RenderGroup].
+ */
+fun interface UpdateLifecycles<RG : RenderGroup> {
     operator fun invoke(
-        visibleBackstack: VB,
+        renderGroup: RG,
         lifecycleEntries: List<LifecycleEntry>
     )
 }
diff --git a/...ature/custom/card/CardBackStackManager.kt → ...ature/custom/card/CardLifecycleManager.kt b/...ature/custom/card/CardBackStackManager.kt → ...ature/custom/card/CardLifecycleManager.kt
@@ -21,11 +21,11 @@ internal fun rememberCardLifecycleManager(navigator: Navigator): LifecycleManage
                     .map(createEntry)
             )
         },
-        updateLifecycles = { visibleBackstack, entries ->
-            entries.filter { it !in visibleBackstack.entries }
+        updateLifecycles = { renderGroup, entries ->
+            entries.filter { it !in renderGroup.entries }
                 .forEach { it.maxLifecycleState = Lifecycle.State.CREATED }
 
-            visibleBackstack.entries.forEach {
+            renderGroup.entries.forEach {
                 if (it.id == navigator.backstack.first().id) {
                     it.maxLifecycleState = Lifecycle.State.RESUMED
                 } else {

diff --git a/...om/viewpager/ViewPagerBackStackManager.kt → ...om/viewpager/ViewPagerLifecycleManager.kt b/...om/viewpager/ViewPagerBackStackManager.kt → ...om/viewpager/ViewPagerLifecycleManager.kt
@@ -26,12 +26,12 @@ fun rememberViewPagerLifecycleManager(navigator: Navigator): LifecycleManager<Vi
                 right = right?.let(createEntry)
             )
         },
-        updateLifecycles = { visibleBackstack, entries ->
-            entries.filter { it !in visibleBackstack.entries }
+        updateLifecycles = { renderGroup, entries ->
+            entries.filter { it !in renderGroup.entries }
                 .forEach { it.maxLifecycleState = Lifecycle.State.CREATED }
 
-            visibleBackstack.entries.forEach {
-                if (it.id == visibleBackstack.center?.id) {
+            renderGroup.entries.forEach {
+                if (it.id == renderGroup.center?.id) {
                     it.maxLifecycleState = Lifecycle.State.RESUMED
                 } else {
                     it.maxLifecycleState = Lifecycle.State.STARTED