Add support for lifecycle-viewmodel-savedstate

.travis.yml

@@ -25,7 +25,7 @@ cache:
 
 deploy:
   provider: script
-  script: ./gradlew :core:bintrayUpload :android:bintrayUpload :androidx-viewmodel:bintrayUpload
+  script: ./gradlew :core:bintrayUpload :android:bintrayUpload :androidx-viewmodel:bintrayUpload :androidx-viewmodel-savedstate:bintrayUpload
   skip_cleanup: true
   on:
     branch: master

CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 1.7.0
+
+_2019-06-05_
+
+* Add experimental support for ViewModel injection with [saved state](https://developer.android.com/topic/libraries/architecture/viewmodel-savedstate).  
+  Please use artifact `org.rewedigital.katana:katana-androidx-viewmodel-savedstate:1.7.0-alpha01`.
+
 ## Version 1.6.3
 
 _2019-05-16_

README.md

@@ -199,9 +199,9 @@ a repository to your project. Then add the following dependencies:
 
 ```gradle
 dependencies {
-    implementation 'org.rewedigital.katana:katana-core:1.6.3'
+    implementation 'org.rewedigital.katana:katana-core:1.7.0'
     // Use this artifact for Katana on Android
-    implementation 'org.rewedigital.katana:katana-android:1.6.3'
+    implementation 'org.rewedigital.katana:katana-android:1.7.0'
 }
 ```
 

android-example/src/main/java/org/rewedigital/katana/android/example/fragment/SecondFragmentModule.kt

@@ -3,7 +3,7 @@ package org.rewedigital.katana.android.example.fragment
 import org.rewedigital.katana.Module
 import org.rewedigital.katana.android.example.fragment.inject.Container
 import org.rewedigital.katana.android.example.fragment.model.SecondFragmentViewModel
-import org.rewedigital.katana.androidx.viewmodel.viewModel
+import org.rewedigital.katana.androidx.viewmodel.savedstate.viewModelSavedState
 import org.rewedigital.katana.dsl.compact.factory
 import org.rewedigital.katana.dsl.get
 
@@ -15,5 +15,5 @@ val secondFragmentModule = Module {
 
     factory { Container(get(SOME_DEPENDENCY), get(FRAGMENT_DEPENDENCY2)) }
 
-    viewModel { SecondFragmentViewModel() }
+    viewModelSavedState { state -> SecondFragmentViewModel(state) }
 }

android-example/src/main/java/org/rewedigital/katana/android/example/fragment/model/SecondFragmentViewModel.kt

@@ -1,5 +1,19 @@
 package org.rewedigital.katana.android.example.fragment.model
 
+import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.ViewModel
 
-data class SecondFragmentViewModel(var message: String? = null) : ViewModel()
+data class SecondFragmentViewModel(
+    private val state: SavedStateHandle
+) : ViewModel() {
+
+    var message: String?
+        get() = state.get(KEY_MESSAGE)
+        set(value) {
+            state.set(KEY_MESSAGE, value)
+        }
+
+    private companion object {
+        private const val KEY_MESSAGE = "MESSAGE"
+    }
+}

android-example/src/main/java/org/rewedigital/katana/android/example/fragment/view/SecondFragment.kt

@@ -13,6 +13,7 @@ import org.rewedigital.katana.android.example.fragment.inject.Container
 import org.rewedigital.katana.android.example.fragment.model.SecondFragmentViewModel
 import org.rewedigital.katana.android.example.fragment.secondFragmentModule
 import org.rewedigital.katana.android.fragment.KatanaFragment
+import org.rewedigital.katana.androidx.viewmodel.savedstate.viewModelSavedStateNow
 import org.rewedigital.katana.androidx.viewmodel.viewModelNow
 import org.rewedigital.katana.injectNow
 
@@ -48,7 +49,7 @@ class SecondFragment : KatanaFragment(), KatanaTrait {
         component = (activity as KatanaTrait).component + secondFragmentModule
 
         container = injectNow()
-        viewModel = viewModelNow()
+        viewModel = viewModelSavedStateNow()
 
         updateMessage()
     }

android/src/main/AndroidManifest.xml

@@ -1,3 +1,2 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest
-        package="org.rewedigital.katana.android"/>
+<manifest package="org.rewedigital.katana.android"/>

androidx-viewmodel-savedstate/README.md

@@ -0,0 +1,38 @@
+# AndroidX ViewModel Saved State extensions for Katana
+
+The extensions declared in this artifact provide support for injection of [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel)
+with [Saved State module](https://developer.android.com/topic/libraries/architecture/viewmodel-savedstate). Also see
+[katana-androidx-viewmodel](../androidx-viewmodel).
+
+Create a ViewModel binding inside a module:
+
+```kotlin
+data class MyViewModel(
+    val state: SavedStateHandle,
+    val someDependency: SomeDependency
+) : ViewModel() {
+
+    var someValue: String?
+        get() = state.get("SOME_VALUE")
+        set(value) {
+            state.set("SOME_VALUE", value)
+        }
+}
+
+Module {
+
+    viewModelSavedState { state -> MyViewModel(state, get()) }
+}
+```
+
+Inject ViewModel in your `Activity` or `Fragment`:
+
+```kotlin
+class MyFragment : Fragment(),
+                   KatanaTrait {
+
+    override val component = Component(...)
+
+    private val viewModel by viewModelSavedState<MyViewModel, MyFragment>() 
+}
+```

androidx-viewmodel-savedstate/build.gradle.kts

@@ -0,0 +1,19 @@
+plugins {
+    `base-android-plugin`
+}
+
+configureBase(
+    artifactName = "katana-androidx-viewmodel-savedstate",
+    sourcePath = android.sourceSets["main"].java.srcDirs,
+    publicationComponent = components["android"]
+)
+
+version = "1.7.0-alpha01"
+
+dependencies {
+    api(project(":core"))
+    api(project(":androidx-viewmodel")) {
+        exclude(group = "androidx.lifecycle", module = "lifecycle-viewmodel")
+    }
+    api(Dependencies.androidXLifecycleViewModelSavedState)
+}

androidx-viewmodel-savedstate/proguard-consumer-rules.pro

@@ -0,0 +1 @@
+# Currently Katana does not require any specific ProGuard configuration

androidx-viewmodel-savedstate/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest package="org.rewedigital.katana.androidx.viewmodel.savedstate"/>