Add Routing source

android/app-example/src/main/res/layout/activity_root.xml

@@ -15,4 +15,4 @@
         app:layout_constraintRight_toRightOf="parent"
         app:layout_constraintTop_toTopOf="parent" />
 
-</androidx.constraintlayout.widget.ConstraintLayout>
+</androidx.constraintlayout.widget.ConstraintLayout>

android/app-example/src/main/res/layout/debug_switcher.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    android:id="@+id/debug_switcher"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:padding="24dp"
+    android:orientation="horizontal"
+    android:layout_gravity="center"
+    android:gravity="center">
+
+    <Button
+        android:id="@+id/workflow_1"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:text="Workflow 1" />
+
+    <Button
+        android:id="@+id/workflow_2"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:text="Workflow 2"/>
+
+</LinearLayout>

android/libraries/rib-base-test/src/main/java/com/badoo/common/ribs/InteractorTestHelper.kt

@@ -7,7 +7,9 @@ import com.badoo.ribs.core.Interactor
 import com.badoo.ribs.core.Node
 import com.badoo.ribs.core.Router
 import com.badoo.ribs.core.builder.BuildParams
+import com.badoo.ribs.core.routing.RoutingSource
 import com.badoo.ribs.core.routing.action.RoutingAction
+import com.badoo.ribs.core.routing.history.Routing
 import com.badoo.ribs.core.view.RibView
 import com.jakewharton.rxrelay2.Relay
 import io.reactivex.ObservableSource
@@ -21,17 +23,14 @@ private val buildParams = BuildParams.Empty()
 
 class InteractorTestHelper<View : RibView>(
     val interactor: Interactor<*, View>,
-    val viewFactory: ((ViewGroup) -> View?)? = null,
-    router: Router<*, *, *, *, View>? = null
+    val viewFactory: ((ViewGroup) -> View?)? = null
 ) {
 
-    val router: Router<*, *, *, *, View> = router ?: TestRouter.createTestRouter()
-
     var nodeCreator: () -> Node<View> = {
         Node(
             buildParams = buildParams,
             viewFactory = viewFactory,
-            plugins = listOf(this.router, interactor)
+            plugins = listOf(interactor)
         )
     }
 
@@ -73,11 +72,10 @@ class InteractorTestHelper<View : RibView>(
     companion object {
         inline fun <reified View, ViewEvent> create(
             interactor: Interactor<*, View>,
-            viewEventRelay: Relay<ViewEvent>,
-            router: Router<*, *, *, *, View>? = null
+            viewEventRelay: Relay<ViewEvent>
         ): InteractorTestHelper<View> where View : RibView, View : ObservableSource<ViewEvent> {
             val view: View = viewEventRelay.subscribedView()
-            return InteractorTestHelper(interactor, { view }, router)
+            return InteractorTestHelper(interactor, { view })
         }
     }
 }
@@ -91,22 +89,20 @@ inline fun <reified RView, ViewEvent> Relay<ViewEvent>.subscribedView(): RView w
         }
     }
 
-private class TestRouter<C : Parcelable, Permanent : C, Content : C, Overlay : C, V : RibView>(
-    initialConfig: Content
-) : Router<C, Permanent, Content, Overlay, V>(
+private class TestRouter<C : Parcelable> : Router<C>(
     buildParams = buildParams,
-    transitionHandler = null,
-    initialConfiguration = initialConfig
+    routingSource = RoutingSource.Permanent<C>(emptySet()),
+    transitionHandler = null
 ) {
 
     var resolveConfiguration: (C) -> RoutingAction = { RoutingAction.noop() }
 
-    override fun resolveConfiguration(configuration: C): RoutingAction =
-        resolveConfiguration.invoke(configuration)
+    override fun resolve(routing: Routing<C>): RoutingAction =
+        resolveConfiguration.invoke(routing.configuration)
 
     companion object {
-        fun <V : RibView> createTestRouter() =
-            TestRouter<TestConfiguration, TestConfiguration, TestConfiguration, TestConfiguration, V>(TestConfiguration)
+        fun createTestRouter() =
+            TestRouter<TestConfiguration>()
     }
 }
 

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/android/lifecycle/BaseNodesTest.kt

@@ -4,6 +4,8 @@ import androidx.test.espresso.Espresso
 import com.badoo.common.ribs.RibsRule
 import com.badoo.ribs.android.lifecycle.helper.ExpectedState
 import com.badoo.ribs.android.lifecycle.helper.NodeState
+import com.badoo.ribs.core.builder.BuildParams
+import com.badoo.ribs.core.routing.configuration.feature.BackStackFeature
 import com.badoo.ribs.core.routing.configuration.feature.operation.push
 import com.badoo.ribs.core.routing.configuration.feature.operation.pushOverlay
 import com.badoo.ribs.test.util.ribs.TestNode
@@ -24,22 +26,35 @@ abstract class BaseNodesTest {
         val pushConfiguration2: TestRootRouter.Configuration? = null
     )
 
-    protected fun test(setup: When, expectedState: ExpectedState, testBlock: (TestRootRouter, TestNode<*>) -> Unit) {
+    protected fun test(
+        setup: When,
+        expectedState: ExpectedState,
+        testBlock: (BackStackFeature<TestRootRouter.Configuration>, TestNode<*>) -> Unit
+    ) {
         val rootProvider = TestRoot.Provider(
             initialConfiguration = setup.initialConfiguration,
             permanentParts = setup.permanentParts
         )
 
-        ribsRule.start { activity, savedInstanceState -> rootProvider.create(activity.dialogLauncher(), savedInstanceState) }
+        val backStack: BackStackFeature<TestRootRouter.Configuration> = BackStackFeature(
+            buildParams = BuildParams.Empty(),
+            initialConfiguration = setup.initialConfiguration
+        )
 
-        val router: TestRootRouter = rootProvider.rootNode?.getRouter() as TestRootRouter
+        ribsRule.start { activity, savedInstanceState ->
+            rootProvider.create(
+                dialogLauncher = activity.dialogLauncher(),
+                savedInstanceState = savedInstanceState,
+                routingSource = backStack
+            )
+        }
 
-        testBlock.invoke(router, rootProvider.rootNode!!)
+        testBlock.invoke(backStack, rootProvider.rootNode!!)
 
         rootProvider.makeAssertions(expectedState)
     }
 
-    protected fun TestRootRouter.pushIt(configuration: TestRootRouter.Configuration) {
+    protected fun BackStackFeature<TestRootRouter.Configuration>.pushIt(configuration: TestRootRouter.Configuration) {
         when (configuration) {
             is TestRootRouter.Configuration.Content -> push(configuration)
             is TestRootRouter.Configuration.Overlay -> pushOverlay(configuration)
@@ -48,11 +63,23 @@ abstract class BaseNodesTest {
 
     private fun TestRoot.Provider.makeAssertions(expected: ExpectedState) {
         Espresso.onIdle()
-        permanentNode1?.let { assertThat(it.toNodeState()).describedAs("Permanent node 1 state").isEqualTo(expected.permanentNode1) }
-        permanentNode2?.let { assertThat(it.toNodeState()).describedAs("Permanent node 2 state").isEqualTo(expected.permanentNode2) }
-        childNode1?.let { assertThat(it.toNodeState()).describedAs("Child node 1 state").isEqualTo(expected.node1) }
-        childNode2?.let { assertThat(it.toNodeState()).describedAs("Child node 2 state").isEqualTo(expected.node2) }
-        childNode3?.let { assertThat(it.toNodeState()).describedAs("Child node 3 state").isEqualTo(expected.node3) }
+        permanentNode1?.let {
+            assertThat(it.toNodeState()).describedAs("Permanent node 1 state")
+                .isEqualTo(expected.permanentNode1)
+        }
+        permanentNode2?.let {
+            assertThat(it.toNodeState()).describedAs("Permanent node 2 state")
+                .isEqualTo(expected.permanentNode2)
+        }
+        childNode1?.let {
+            assertThat(it.toNodeState()).describedAs("Child node 1 state").isEqualTo(expected.node1)
+        }
+        childNode2?.let {
+            assertThat(it.toNodeState()).describedAs("Child node 2 state").isEqualTo(expected.node2)
+        }
+        childNode3?.let {
+            assertThat(it.toNodeState()).describedAs("Child node 3 state").isEqualTo(expected.node3)
+        }
     }
 
     private fun TestNode<*>.toNodeState() =

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/android/lifecycle/PushTwoPopOneDefaultTest.kt

@@ -6,11 +6,11 @@ import com.badoo.ribs.test.util.runOnMainSync
 class PushTwoPopOneDefaultTest : PushTwoPopOneTest() {
 
     override fun pushTwoConfigurationAndPop(setup: When, expectedState: ExpectedState) {
-        test(setup, expectedState) { router, _ ->
+        test(setup, expectedState) { backStack, _ ->
             runOnMainSync {
-                router.pushIt(setup.pushConfiguration1!!)
-                router.pushIt(setup.pushConfiguration2!!)
-                router.popBackStack()
+                backStack.pushIt(setup.pushConfiguration1!!)
+                backStack.pushIt(setup.pushConfiguration2!!)
+                backStack.popBackStack()
             }
         }
     }

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/android/lifecycle/RootNodeLifecycleTest.kt

@@ -13,7 +13,12 @@ class RootNodeLifecycleTest {
     val node get() = provider.rootNode!!
 
     @get:Rule
-    val ribsRule = RibsRule { activity, savedInstanceState -> provider.create(activity.dialogLauncher(), savedInstanceState) }
+    val ribsRule = RibsRule { activity, savedInstanceState ->
+        provider.create(
+            dialogLauncher = activity.dialogLauncher(),
+            savedInstanceState = savedInstanceState
+        )
+    }
 
     @Test
     fun whenActivityResumed_nodeIsAttached() {

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/test/util/ribs/TestNode.kt

@@ -10,7 +10,7 @@ import com.badoo.ribs.core.view.ViewFactory
 class TestNode<V: RibView>(
     buildParams: BuildParams<*>,
     viewFactory: ViewFactory<Nothing?, V>,
-    private val router: Router<*, *, *, *, V>,
+    private val router: Router<*>,
     interactor: Interactor<*, V>
 ): Node<V>(
     buildParams = buildParams,

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/test/util/ribs/child/TestChildRouter.kt

@@ -3,20 +3,22 @@ package com.badoo.ribs.test.util.ribs.child
 import android.os.Parcelable
 import com.badoo.ribs.core.Router
 import com.badoo.ribs.core.builder.BuildParams
+import com.badoo.ribs.core.routing.RoutingSource.Permanent
 import com.badoo.ribs.core.routing.action.RoutingAction
+import com.badoo.ribs.core.routing.history.Routing
 import com.badoo.ribs.test.util.ribs.child.TestChildRouter.Configuration
 import kotlinx.android.parcel.Parcelize
 
 class TestChildRouter(
     buildParams: BuildParams<Nothing?>
-): Router<Configuration, Nothing, Configuration, Nothing, TestChildView>(
+): Router<Configuration>(
     buildParams = buildParams,
-    initialConfiguration = Configuration.Default
+    routingSource = Permanent(emptySet())
 ) {
     sealed class Configuration : Parcelable {
         @Parcelize object Default : Configuration()
     }
 
-    override fun resolveConfiguration(configuration: Configuration): RoutingAction =
+    override fun resolve(routing: Routing<Configuration>): RoutingAction =
         RoutingAction.noop()
 }

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/test/util/ribs/root/TestRoot.kt

@@ -5,6 +5,8 @@ import android.os.Bundle
 import com.badoo.ribs.core.builder.BuildParams
 import com.badoo.ribs.core.Rib
 import com.badoo.ribs.core.builder.BuildContext
+import com.badoo.ribs.core.routing.RoutingSource
+import com.badoo.ribs.core.routing.configuration.feature.BackStackFeature
 import com.badoo.ribs.dialog.DialogLauncher
 import com.badoo.ribs.test.util.LifecycleObserver
 import com.badoo.ribs.test.util.ribs.TestNode
@@ -44,13 +46,18 @@ interface TestRoot : Rib {
         var rootNode: TestNode<*>? = null
             private set
 
-        private fun builder(block: (TestNode<TestChildView>) -> Unit): (BuildContext) -> TestNode<TestChildView> = {
-            TestChildBuilder().build(it).also {
-                block.invoke(it)
+        private fun builder(block: (TestNode<TestChildView>) -> Unit): (BuildContext) -> TestNode<TestChildView> =
+            {
+                TestChildBuilder().build(it).also {
+                    block.invoke(it)
+                }
             }
-        }
 
-        fun create(dialogLauncher: DialogLauncher, savedInstanceState: Bundle?): TestNode<TestRootView> {
+        fun create(
+            dialogLauncher: DialogLauncher,
+            savedInstanceState: Bundle?,
+            routingSource: RoutingSource<Configuration> = RoutingSource.Empty()
+        ): TestNode<TestRootView> {
             val router = TestRootRouter(
                 buildParams = BuildParams(
                     payload = null,
@@ -59,12 +66,12 @@ interface TestRoot : Rib {
                         uuid = UUID.randomUUID()
                     )
                 ),
+                routingSource = routingSource,
                 builderPermanent1 = builder { permanentNode1 = it },
                 builderPermanent2 = builder { permanentNode2 = it },
                 builder1 = builder { childNode1 = it },
                 builder2 = builder { childNode2 = it },
                 builder3 = builder { childNode3 = it },
-                initialConfiguration = initialConfiguration,
                 permanentParts = permanentParts,
                 dialogLauncher = dialogLauncher
             )

android/libraries/rib-base/src/androidTest/java/com/badoo/ribs/test/util/ribs/root/TestRootRouter.kt

@@ -4,11 +4,14 @@ import android.os.Parcelable
 import com.badoo.ribs.core.Router
 import com.badoo.ribs.core.builder.BuildParams
 import com.badoo.ribs.core.builder.NodeFactory
+import com.badoo.ribs.core.routing.RoutingSource
+import com.badoo.ribs.core.routing.RoutingSource.Permanent.Companion.permanent
 import com.badoo.ribs.core.routing.action.AttachRibRoutingAction.Companion.attach
 import com.badoo.ribs.core.routing.action.CompositeRoutingAction.Companion.composite
 import com.badoo.ribs.core.routing.action.DialogRoutingAction.Companion.showDialog
 import com.badoo.ribs.core.routing.action.RoutingAction
 import com.badoo.ribs.core.routing.action.RoutingAction.Companion.noop
+import com.badoo.ribs.core.routing.history.Routing
 import com.badoo.ribs.dialog.DialogLauncher
 import com.badoo.ribs.test.util.ribs.TestRibDialog
 import com.badoo.ribs.test.util.ribs.root.TestRootRouter.Configuration
@@ -19,18 +22,17 @@ import kotlinx.android.parcel.Parcelize
 
 class TestRootRouter(
     buildParams: BuildParams<Nothing?>,
+    routingSource: RoutingSource<Configuration>,
     private val builderPermanent1: NodeFactory,
     private val builderPermanent2: NodeFactory,
     private val builder3: NodeFactory,
     private val builder1: NodeFactory,
     private val builder2: NodeFactory,
     private val dialogLauncher: DialogLauncher,
-    permanentParts: List<Permanent>,
-    initialConfiguration: Content
-) : Router<Configuration, Permanent, Content, Overlay, TestRootView>(
+    permanentParts: List<Permanent>
+) : Router<Configuration>(
     buildParams = buildParams,
-    initialConfiguration = initialConfiguration,
-    permanentParts = permanentParts
+    routingSource = routingSource + permanent(permanentParts)
 ) {
 
     sealed class Configuration : Parcelable {
@@ -54,8 +56,8 @@ class TestRootRouter(
         }
     }
 
-    override fun resolveConfiguration(configuration: Configuration): RoutingAction =
-        when (configuration) {
+    override fun resolve(routing: Routing<Configuration>): RoutingAction =
+        when (routing.configuration) {
             Permanent.Permanent1 -> attach(builderPermanent1)
             Permanent.Permanent2 -> attach(builderPermanent2)
             Content.NoOp -> noop()
@@ -66,8 +68,8 @@ class TestRootRouter(
                 attach(builder1),
                 attach(builder2)
             )
-            Overlay.AttachNode1AsOverlay -> showDialog(this, dialogLauncher, TestRibDialog(builder1))
-            Overlay.AttachNode2AsOverlay -> showDialog(this, dialogLauncher, TestRibDialog(builder2))
-            Overlay.AttachNode3AsOverlay -> showDialog(this, dialogLauncher, TestRibDialog(builder3))
+            Overlay.AttachNode1AsOverlay -> showDialog(routingSource, routing.identifier, dialogLauncher, TestRibDialog(builder1))
+            Overlay.AttachNode2AsOverlay -> showDialog(routingSource, routing.identifier, dialogLauncher, TestRibDialog(builder2))
+            Overlay.AttachNode3AsOverlay -> showDialog(routingSource, routing.identifier, dialogLauncher, TestRibDialog(builder3))
         }
 }