Merge pull request #2 from sergejsha/backpress-support

BackNavigation + Tests
sergejsha · Jul 22, 2024 · f8ef590 · f8ef590
2 parents e458dde + 0d4ee30
commit f8ef590
Show file tree

Hide file tree

Showing 20 changed files with 608 additions and 22 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,49 @@
+name: Check
+
+permissions:
+  checks: write
+
+on:
+  pull_request:
+    paths-ignore:
+      - 'documentation/**'
+      - '*.md'
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - 'documentation/**'
+      - '*.md'
+
+jobs:
+  test:
+    name: Run tests
+
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            task: testDebugUnit # jvm + android
+          - os: macos-latest
+            task: iosSimulatorArm64
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'adopt'
+          java-version: '17'
+
+      - name: Run ${{ matrix.task }} test
+        run: ./gradlew ${{ matrix.task }}Test --stacktrace
+
+      - name: Publish ${{ matrix.task }} report
+        uses: mikepenz/action-junit-report@v4
+        if: success() || failure()
+        with:
+          check_name: ${{ matrix.task }}
+          report_paths: "componental/build/test-results/${{ matrix.task }}Test/TEST-*.xml"
diff --git a/README.md b/README.md
@@ -64,9 +64,14 @@ dependencies {
 
 # Publishing
 
-1. Bump version in `root.publication.gradle.kts` of the root project
+1. Bump version in `root.publication.gradle.kts`
 2. `./gradlew clean build publishAllPublicationsToCentralRepository`
 
+## Local maven
+
+1. Set `X.X-SNAPSHOT` version in `root.publication.gradle.kts`
+2. `./gradlew clean build publishToMavenLocal`
+
 # Release Notes
 
 * 0.2 Module `componental` is exposed as API from `componental.compose` 

diff --git a/componental-compose/build.gradle.kts b/componental-compose/build.gradle.kts
@@ -47,3 +47,14 @@ android {
         minSdk = libs.versions.android.sdk.min.get().toInt()
     }
 }
+
+// https://youtrack.jetbrains.com/issue/KT-61313
+tasks.withType<Sign>().configureEach {
+    val publicationName = name.removePrefix("sign").removeSuffix("Publication")
+    tasks.findByName("linkDebugTest$publicationName")?.let {
+        mustRunAfter(it)
+    }
+    tasks.findByName("compileTestKotlin$publicationName")?.let {
+        mustRunAfter(it)
+    }
+}
diff --git a/componental/build.gradle.kts b/componental/build.gradle.kts
@@ -12,7 +12,12 @@ plugins {
 kotlin {
     explicitApi()
 
-    jvm()
+    jvm {
+        @OptIn(ExperimentalKotlinGradlePluginApi::class)
+        compilerOptions {
+            jvmTarget.set(JvmTarget.JVM_1_8)
+        }
+    }
     androidTarget {
         publishLibraryVariants("release")
         @OptIn(ExperimentalKotlinGradlePluginApi::class)
@@ -36,6 +41,7 @@ kotlin {
         }
         commonTest.dependencies {
             implementation(libs.kotlin.test)
+            implementation(libs.kotlinx.coroutines.test)
         }
     }
 }
@@ -47,3 +53,14 @@ android {
         minSdk = libs.versions.android.sdk.min.get().toInt()
     }
 }
+
+// https://youtrack.jetbrains.com/issue/KT-61313
+tasks.withType<Sign>().configureEach {
+    val publicationName = name.removePrefix("sign").removeSuffix("Publication")
+    tasks.findByName("linkDebugTest$publicationName")?.let {
+        mustRunAfter(it)
+    }
+    tasks.findByName("compileTestKotlin$publicationName")?.let {
+        mustRunAfter(it)
+    }
+}
diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/ComponentContext.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/ComponentContext.kt
@@ -1,5 +1,7 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
 package de.halfbit.componental
 
+import de.halfbit.componental.back.BackNavigationOwner
 import de.halfbit.componental.coroutines.CoroutineScopeOwner
 import de.halfbit.componental.lifecycle.Lifecycle
 import de.halfbit.componental.lifecycle.LifecycleOwner
@@ -11,7 +13,7 @@ import kotlinx.coroutines.cancel
 import kotlinx.coroutines.isActive
 import kotlinx.coroutines.launch
 
-public interface ComponentContext : LifecycleOwner, CoroutineScopeOwner, RestoratorOwner {
+public interface ComponentContext : LifecycleOwner, CoroutineScopeOwner, RestoratorOwner, BackNavigationOwner {
 
     public companion object {
         public fun create(
@@ -47,9 +49,12 @@ private class DefaultComponentContext(
     override val lifecycle: Lifecycle,
     override val coroutineScope: CoroutineScope,
     override val restorator: Restorator,
-) : ComponentContext
+) : ComponentContext,
+    BackNavigationOwner by BackNavigationOwner.create(lifecycle)
 
-internal inline fun ComponentContext.doOnDestroy(crossinline callback: () -> Unit): ComponentContext {
+internal inline fun ComponentContext.doOnDestroy(
+    crossinline callback: () -> Unit
+): ComponentContext {
     lifecycle.subscribe(
         object : Lifecycle.Subscriber.Callbacks {
             override fun onDestroy() {

diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/back/BackNavigation.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/back/BackNavigation.kt
@@ -0,0 +1,23 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
+package de.halfbit.componental.back
+
+public interface BackNavigation {
+    public fun register(onNavigateBack: OnNavigateBack)
+
+    public companion object {
+        private val callbacks: MutableList<OnNavigateBack> = mutableListOf()
+
+        internal fun register(callback: OnNavigateBack) {
+            callbacks += callback
+        }
+
+        internal fun unregister(callback: OnNavigateBack) {
+            callbacks -= callback
+        }
+
+        /** To be called by the screen holding compose UI, e.g. by an activity on android. */
+        public fun dispatchOnNavigateBack() {
+            callbacks.toList().lastOrNull()?.onNavigateBack()
+        }
+    }
+}
diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/back/BackNavigationOwner.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/back/BackNavigationOwner.kt
@@ -0,0 +1,34 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
+package de.halfbit.componental.back
+
+import de.halfbit.componental.lifecycle.Lifecycle
+
+public interface BackNavigationOwner {
+    public val backNavigation : BackNavigation
+
+    public companion object {
+        public fun create(lifecycle: Lifecycle): BackNavigationOwner =
+            object : BackNavigationOwner {
+                override val backNavigation: BackNavigation =
+                    object : BackNavigation {
+                        override fun register(onNavigateBack: OnNavigateBack) {
+                            lifecycle.subscribe(
+                                object : Lifecycle.Subscriber.Callbacks {
+                                    override fun onResume() {
+                                        BackNavigation.register(onNavigateBack)
+                                    }
+
+                                    override fun onPause() {
+                                        BackNavigation.unregister(onNavigateBack)
+                                    }
+                                }
+                            )
+                        }
+                    }
+            }
+    }
+}
+
+public inline fun BackNavigationOwner.onNavigateBack(onNavigateBack: OnNavigateBack) {
+    backNavigation.register(onNavigateBack)
+}
diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/back/OnNavigateBack.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/back/OnNavigateBack.kt
@@ -0,0 +1,6 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
+package de.halfbit.componental.back
+
+public fun interface OnNavigateBack {
+    public fun onNavigateBack()
+}
diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/router/Router.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/router/Router.kt
@@ -1,3 +1,4 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
 package de.halfbit.componental.router
 
 import kotlinx.coroutines.flow.Flow

diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/router/slot/SlotRouter.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/router/slot/SlotRouter.kt
@@ -1,3 +1,4 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
 package de.halfbit.componental.router.slot
 
 import de.halfbit.componental.ComponentContext
@@ -58,7 +59,7 @@ public fun <Id : Any, Child : Any> ComponentContext.childSlot(
         val context = createChildContext(
             childLifecycle = childLifecycle,
             childCoroutineScope = coroutineScope.createChildCoroutineScope(tag),
-            restorator = Restorator(restoredChildState)
+            restorator = Restorator(restoredChildState),
         )
         val node = RouteNode(id, childFactory(id, context))
         return RuntimeRouteNode(
@@ -71,7 +72,7 @@ public fun <Id : Any, Child : Any> ComponentContext.childSlot(
         }
     }
 
-    fun Id?.asSlot(): Slot<Id, Child> {
+    fun Id?.asRuntimeSlot(): Slot<Id, Child> {
         val oldNode = runtimeNode
         val newNode = when (this) {
             null -> {
@@ -108,14 +109,14 @@ public fun <Id : Any, Child : Any> ComponentContext.childSlot(
     }
 
     return flow {
-        emit(activeId.asSlot())
+        emit(activeId.asRuntimeSlot())
         router.events.collect { event ->
             activeId = event.transform(activeId)
-            emit(activeId.asSlot())
+            emit(activeId.asRuntimeSlot())
         }
     }.stateIn(
         coroutineScope,
         SharingStarted.Eagerly,
-        initial.asSlot(),
+        initial.asRuntimeSlot(),
     )
 }
diff --git a/componental/src/commonMain/kotlin/de/halfbit/componental/router/stack/StackRouter.kt b/componental/src/commonMain/kotlin/de/halfbit/componental/router/stack/StackRouter.kt
@@ -1,3 +1,4 @@
+/** Copyright 2024 Halfbit GmbH, Sergej Shafarenka */
 package de.halfbit.componental.router.stack
 
 import de.halfbit.componental.ComponentContext
@@ -32,7 +33,7 @@ public class StackRouter<I : Any> : Router<Event<I>>() {
 
 public fun <I : Any> StackRouter<I>.push(id: I) {
     route(
-        event = Event { keys -> keys + id }
+        event = Event { ids -> ids + id }
     )
 }
 
@@ -56,7 +57,6 @@ public fun <Id : Any, Child : Any> ComponentContext.childStack(
     childFactory: (id: Id, context: ComponentContext) -> Child,
 ): StateFlow<Stack<Id, Child>> {
     val runtimeNodes = mutableMapOf<Id, RuntimeRouteNode<Id, Child>>()
-
     val restoredRoute: Map<Id, RestorableRoute<Id>>? =
         restorator.restoreRoute()?.let {
             ProtoBuf.decodeFromByteArray(
@@ -71,7 +71,7 @@ public fun <Id : Any, Child : Any> ComponentContext.childStack(
         val context = createChildContext(
             childLifecycle = childLifecycle,
             childCoroutineScope = coroutineScope.createChildCoroutineScope(tag),
-            restorator = Restorator(restoredChildState)
+            restorator = Restorator(restoredChildState),
         )
         val node = RouteNode(id, childFactory(id, context))
         return RuntimeRouteNode(
@@ -84,10 +84,10 @@ public fun <Id : Any, Child : Any> ComponentContext.childStack(
         }
     }
 
-    fun Collection<Id>.asStack(): Stack<Id, Child> {
+    fun Collection<Id>.asRuntimeStack(): Stack<Id, Child> {
 
-        val stackNodes = map { key ->
-            runtimeNodes[key] ?: createRuntimeRouteNode(key)
+        val stackNodes = map { id ->
+            runtimeNodes[id] ?: createRuntimeRouteNode(id)
         }
 
         stackNodes.reversed().forEachIndexed { index, node ->
@@ -118,22 +118,22 @@ public fun <Id : Any, Child : Any> ComponentContext.childStack(
     }
 
     return flow {
-        emit(ids.asStack())
+        emit(ids.asRuntimeStack())
         router.events.collect { event ->
             ids = event.transform(ids)
-            emit(ids.asStack())
+            emit(ids.asRuntimeStack())
         }
     }.stateIn(
         coroutineScope,
         SharingStarted.Eagerly,
-        initial.asStack(),
+        initial.asRuntimeStack(),
     )
 }
 
 private fun <I : Any, C : Any> List<RouteNode<I, C>>.toStack(): Stack<I, C> {
-    check(isNotEmpty()) { "List used as a stack have at least one entry" }
+    check(isNotEmpty()) { "List used as a stack must have at least one entry" }
     return Stack(
         active = last(),
-        inactive = if (size == 1) emptyList() else subList(1, lastIndex),
+        inactive = if (size == 1) emptyList() else subList(0, lastIndex),
     )
 }