Merge pull request #677 from aashay-gaikwad/ribs-helpers

Moved Builder, SimpleBuilder, Interactor to separate module
bumble-tech · Feb 11, 2024 · a4ab1fe · a4ab1fe
2 parents f05f56f + 5f221b6
commit a4ab1fe
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 ## Pending changes
 
+### API breaking changes
+
+- [#677](https://github.com/bumble-tech/appyx/pull/677) – Moved Builder, SimpleBuilder, Interactor to separate module
+
+### Fixed
+
 - [#670](https://github.com/bumble-tech/appyx/pull/670) - Fixes ios lifecycle
 - [#673](https://github.com/bumble-tech/appyx/pull/673) – Fix canHandeBackPress typo
 

diff --git a/documentation/releases/2.0.0-alpha11.md b/documentation/releases/2.0.0-alpha11.md
@@ -11,4 +11,21 @@ interface AppyxComponent /*...*/ {
     /*...*/
 -    fun canHandeBackPress(): StateFlow<Boolean>
 +    fun canHandleBackPress(): StateFlow<Boolean>
+```
+
+## Moved `Builder`, `SimpleBuilder`, and `Interactor`
+
+If you were depending on these classes being part of appyx-navigation, you’ll now need to get them from "com.bumble.appyx:utils-ribs-helpers:$version".
+
+```diff
++    implementation("com.bumble.appyx:utils-ribs-helpers:$version")
+
+-    import com.bumble.appyx.navigation.builder.Builder
++    import com.bumble.appyx.utils.ribshelpers.builder.Builder
+
+-    import com.bumble.appyx.navigation.builder.SimpleBuilder
++    import com.bumble.appyx.utils.ribshelpers.builder.SimpleBuilder
+
+-    import com.bumble.appyx.navigation.clienthelper.interactor.Interactor
++    import com.bumble.appyx.utils.ribshelpers.interactor.Interactor
 ```
diff --git a/documentation/releases/downloads.md b/documentation/releases/downloads.md
@@ -218,6 +218,16 @@ dependencies {
 }
 ```
 
+### RIBs like helpers
+
+Adds client code helper classes like `Builder`, `SimpleBuilder`, and `Interactor`
+
+```kotlin
+dependencies {
+    implementation("com.bumble.appyx:utils-ribs-helpers:$version")
+}
+```
+
 
 ### Testing
 

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -85,6 +85,7 @@ include(
     ":utils:interop-ribs",
     ":utils:interop-rx2",
     ":utils:interop-rx3",
+    ":utils:ribs-helpers",
     ":utils:testing-junit4",
     ":utils:testing-junit5",
     ":utils:testing-ui",

diff --git a/utils/ribs-helpers/build.gradle.kts b/utils/ribs-helpers/build.gradle.kts
@@ -0,0 +1,17 @@
+plugins {
+    id("com.bumble.appyx.android.library")
+    id("appyx-publish-android")
+}
+
+publishingPlugin {
+    artifactId = "utils-ribs-helpers"
+}
+
+appyx {
+    namespace.set("com.bumble.appyx.utils.ribs.helpers")
+}
+
+dependencies {
+    api(project(":appyx-navigation:appyx-navigation"))
+    api(project(":appyx-interactions:appyx-interactions"))
+}
diff --git a/utils/ribs-helpers/lint-baseline.xml b/utils/ribs-helpers/lint-baseline.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<issues format="6" by="lint 7.1.3" type="baseline" client="gradle" dependencies="false" name="AGP (7.1.3)" variant="all" version="7.1.3">
+
+</issues>
diff --git a/...umble/appyx/navigation/builder/Builder.kt → ...ppyx/utils/ribshelpers/builder/Builder.kt b/...umble/appyx/navigation/builder/Builder.kt → ...ppyx/utils/ribshelpers/builder/Builder.kt
@@ -1,4 +1,4 @@
-package com.bumble.appyx.navigation.builder
+package com.bumble.appyx.utils.ribshelpers.builder
 
 import com.bumble.appyx.navigation.modality.NodeContext
 import com.bumble.appyx.navigation.node.Node

diff --git a/...appyx/navigation/builder/SimpleBuilder.kt → ...tils/ribshelpers/builder/SimpleBuilder.kt b/...appyx/navigation/builder/SimpleBuilder.kt → ...tils/ribshelpers/builder/SimpleBuilder.kt
@@ -1,4 +1,4 @@
-package com.bumble.appyx.navigation.builder
+package com.bumble.appyx.utils.ribshelpers.builder
 
 import com.bumble.appyx.navigation.modality.NodeContext
 import com.bumble.appyx.navigation.node.Node

diff --git a/...ion/clienthelper/interactor/Interactor.kt → ...tils/ribshelpers/interactor/Interactor.kt b/...ion/clienthelper/interactor/Interactor.kt → ...tils/ribshelpers/interactor/Interactor.kt
@@ -1,4 +1,4 @@
-package com.bumble.appyx.navigation.clienthelper.interactor
+package com.bumble.appyx.utils.ribshelpers.interactor
 
 import com.bumble.appyx.interactions.core.plugin.SavesInstanceState
 import com.bumble.appyx.navigation.children.ChildAware

diff --git a/utils/testing-unit-common/build.gradle.kts b/utils/testing-unit-common/build.gradle.kts
@@ -17,6 +17,7 @@ appyx {
 
 dependencies {
     api(project(":appyx-navigation:appyx-navigation"))
+    api(project(":utils:ribs-helpers"))
     implementation(project(":utils:utils-customisations"))
     implementation(libs.kotlin.test)
 }
diff --git a/...mon/src/main/kotlin/com/bumble/appyx/utils/testing/unit/common/util/InteropBuilderStub.kt b/...mon/src/main/kotlin/com/bumble/appyx/utils/testing/unit/common/util/InteropBuilderStub.kt
@@ -1,9 +1,9 @@
 package com.bumble.appyx.utils.testing.unit.common.util
 
-import com.bumble.appyx.navigation.builder.Builder
 import com.bumble.appyx.navigation.lifecycle.Lifecycle
 import com.bumble.appyx.navigation.modality.NodeContext
 import com.bumble.appyx.navigation.node.Node
+import com.bumble.appyx.utils.ribshelpers.builder.Builder
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 

diff --git a/...c/main/kotlin/com/bumble/appyx/utils/testing/unit/common/util/InteropSimpleBuilderStub.kt b/...c/main/kotlin/com/bumble/appyx/utils/testing/unit/common/util/InteropSimpleBuilderStub.kt
@@ -1,9 +1,9 @@
 package com.bumble.appyx.utils.testing.unit.common.util
 
-import com.bumble.appyx.navigation.builder.SimpleBuilder
 import com.bumble.appyx.navigation.lifecycle.Lifecycle
 import com.bumble.appyx.navigation.modality.NodeContext
 import com.bumble.appyx.navigation.node.Node
+import com.bumble.appyx.utils.ribshelpers.builder.SimpleBuilder
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue