Merge pull request #4 from ScottPierce/scott/Voyager

Support Voyager
ScottPierce · Jul 17, 2024 · 6864795 · 6864795
2 parents 866a97f + ffb3d8b
commit 6864795
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -13,16 +13,17 @@ A multiplatform Dependency Injection library.
 implementation("dev.scottpierce:kinject-core:<latest version here>")
 ```
 
-| Artifact                   | Description                                                                                                                                    |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
-| kinject-core               | Provides core DI functionality.                                                                                                                |
-| kinject-android            | Provides helper methods for working with `ObjectGraph`s embedded in `Context`s, and helper classes for embedding `ObjectGraph`s in `Contexts`. |
-| kinject-android-appcompat  | Provides `KinjectAppCompatActivity`.                                                                                                           |
-| kinject-android-compose    | Provides `KinjectComponentActivity`.                                                                                                           |
-| kinject-compose            | Provides the ability to provide an ObjectGraph in a Compose hierarchy.                                                                         |
-| kinject-compose-viewmodel  | Provides the ability to get a ViewModel in a compose hierarchy.                                                                                |
-| kinject-coroutines         | Provides a `KinjectCoroutineContextElement`, to easily allow passing an `ObjectGraph` via a `CoroutineContext`.                                |
-| kinject-viewmodel          | Provides the ability to declare a view model dependency, and a factory to create it.                                                           |
+| Artifact                  | Description                                                                                                                                    |
+|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| kinject-core              | Provides core DI functionality.                                                                                                                |
+| kinject-android           | Provides helper methods for working with `ObjectGraph`s embedded in `Context`s, and helper classes for embedding `ObjectGraph`s in `Contexts`. |
+| kinject-android-appcompat | Provides `KinjectAppCompatActivity`.                                                                                                           |
+| kinject-android-compose   | Provides `KinjectComponentActivity`.                                                                                                           |
+| kinject-compose           | Provides the ability to provide an ObjectGraph in a Compose hierarchy.                                                                         |
+| kinject-compose-viewmodel | Provides the ability to get a ViewModel in a compose hierarchy.                                                                                |
+| kinject-compose-voyager   | Provides the ability to get a ScreenModel in a compose hierarchy.                                                                              |
+| kinject-coroutines        | Provides a `KinjectCoroutineContextElement`, to easily allow passing an `ObjectGraph` via a `CoroutineContext`.                                |
+| kinject-viewmodel         | Provides the ability to declare a view model dependency, and a factory to create it.                                                           |
 
 
 ## Basic Usage

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -17,6 +17,7 @@ lifecycleRuntimeKtx = "2.8.3"
 activityCompose = "1.9.0"
 appcompat = "1.7.0"
 jetbrains-androidx-lifecycle = "2.8.0"
+voyager = "1.0.0"
 
 [libraries]
 androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "appcompat" }
@@ -33,6 +34,9 @@ androidx-lifecycle-viewmodel = { module = "androidx.lifecycle:lifecycle-viewmode
 androidx-lifecycle-viewmodel-compose = { module = "androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }
 jetbrains-androidx-lifecycle-viewmodel = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel", version.ref = "jetbrains-androidx-lifecycle" }
 jetbrains-androidx-lifecycle-viewmodel-compose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "jetbrains-androidx-lifecycle" }
+voyager-core = { module = "cafe.adriel.voyager:voyager-core", version.ref = "voyager" }
+voyager-navigator = { module = "cafe.adriel.voyager:voyager-navigator", version.ref = "voyager" }
+voyager-screenModel = { module = "cafe.adriel.voyager:voyager-screenmodel", version.ref = "voyager" }
 
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
 androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }

diff --git a/kinject-bom/build.gradle.kts b/kinject-bom/build.gradle.kts
@@ -15,6 +15,7 @@ dependencies {
         api(project(":kinject-android-compose"))
         api(project(":kinject-compose"))
         api(project(":kinject-compose-viewmodel"))
+        api(project(":kinject-compose-voyager"))
         api(project(":kinject-coroutines"))
         api(project(":kinject-viewmodel"))
     }

diff --git a/kinject-compose-voyager/build.gradle.kts b/kinject-compose-voyager/build.gradle.kts
@@ -0,0 +1,17 @@
+plugins {
+    alias(libs.plugins.android.library)
+    alias(libs.plugins.kotlin.android)
+    alias(libs.plugins.kotlin.compose)
+    alias(libs.plugins.gradleMavenPublish)
+}
+
+android {
+    namespace = "kinject.compose.voyager"
+}
+
+dependencies {
+    api(project(":kinject-compose"))
+    implementation(libs.voyager.core)
+    implementation(libs.voyager.navigator)
+    implementation(libs.voyager.screenModel)
+}
diff --git a/kinject-compose-voyager/src/main/kotlin/kinject/compose/voyager/InjectScreenModel.kt b/kinject-compose-voyager/src/main/kotlin/kinject/compose/voyager/InjectScreenModel.kt
@@ -0,0 +1,29 @@
+package kinject.compose.voyager
+
+import androidx.compose.runtime.Composable
+import cafe.adriel.voyager.core.model.ScreenModel
+import cafe.adriel.voyager.core.model.rememberScreenModel
+import cafe.adriel.voyager.core.model.rememberNavigatorScreenModel
+import cafe.adriel.voyager.core.screen.Screen
+import cafe.adriel.voyager.navigator.Navigator
+import kinject.compose.LocalKinjectContext
+
+@Composable
+inline fun <reified SM : ScreenModel> Screen.injectScreenModel(): SM {
+    val smClass = SM::class
+    val kinjectContext = LocalKinjectContext.current
+
+    return rememberScreenModel {
+        kinjectContext.objectGraph.get(smClass)
+    }
+}
+
+@Composable
+inline fun <reified SM : ScreenModel> Navigator.injectNavigatorScreenModel(): SM {
+    val smClass = SM::class
+    val kinjectContext = LocalKinjectContext.current
+
+    return rememberNavigatorScreenModel {
+        kinjectContext.objectGraph.get(smClass)
+    }
+}
diff --git a/kinject-compose/build.gradle.kts b/kinject-compose/build.gradle.kts
@@ -15,5 +15,5 @@ composeCompiler {
 
 dependencies {
     implementation(project(":kinject-core"))
-    implementation(libs.compose.runtime)
+    api(libs.compose.runtime)
 }
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -29,6 +29,7 @@ include(":kinject-android-compose")
 include(":kinject-bom")
 include(":kinject-compose")
 include(":kinject-compose-viewmodel")
+include(":kinject-compose-voyager")
 include(":kinject-core")
 include(":kinject-coroutines")
 include(":kinject-viewmodel")