Added feature to set a customBundle for a viewmodel

To avoid any interactions with the resource bundle, there is now a new custom bundle object that can be set via a builder and will be parsed to the viewmodel.

build.gradle

@@ -30,7 +30,7 @@ buildscript {
         powermock_version = '2.0.2'
         support_lib_lifecycle_testing_version = '2.1.0'
 
-        archtree_library_version = "1.0.0-beta4"
+        archtree_library_version = "1.0.0-beta5"
     }
 
     repositories {

builder/src/main/java/archtree/ArchTreeBuilder.kt

@@ -1,6 +1,7 @@
 package archtree
 
 import android.annotation.SuppressLint
+import android.os.Bundle
 import androidx.annotation.DrawableRes
 import androidx.annotation.IdRes
 import androidx.annotation.LayoutRes
@@ -32,6 +33,8 @@ abstract class ArchTreeBuilder<ViewModel : BaseViewModel, out Builder> {
     var lifecycleOwnerBindingKey: Int = -1
         private set
 
+    var customBundle: Bundle? = null
+        private set
     var componentLayer: ComponentLayer<ViewModel>? = null
         private set
 
@@ -129,6 +132,16 @@ abstract class ArchTreeBuilder<ViewModel : BaseViewModel, out Builder> {
         return this as Builder
     }
 
+    /**
+     * This method defines a custom bundle that will be used when initialising the viewmodel.
+     *
+     * @param bundle Bundle object that will be used for the viewmodel.
+     */
+    open fun setCustomBundle(bundle: Bundle?): Builder {
+        this.customBundle = bundle
+        return this as Builder
+    }
+
     /**
      * This method defines a menu for the component.
      *

builder/src/main/java/archtree/ArchTreeResource.kt

@@ -1,6 +1,7 @@
 package archtree
 
 import android.annotation.SuppressLint
+import android.os.Bundle
 import android.util.Log
 import android.view.LayoutInflater
 import android.view.View
@@ -20,6 +21,8 @@ abstract class ArchTreeResource<ViewModel : BaseViewModel> constructor(builder:
     var binding: ViewDataBinding? = null
         private set
 
+    val customBundle: Bundle? = builder.customBundle
+
     val layoutId: Int = builder.layoutId
     val bindingKey: Int = builder.bindingKey
 

builder/src/main/java/archtree/activity/ActivityResource.kt

@@ -34,8 +34,8 @@ constructor(builder: ActivityBuilder<ViewModel>) : ArchTreeResource<ViewModel>(b
             else Log.d(ActivityResource::class.java.name, "ViewModel is not attached to layout.")
 
             val resourceBundle = activity.intent.extras
-            if (viewModelInitMode == ViewModelInitMode.FORCE_INIT) viewModel?.init(true, resourceBundle, savedInstanceBundle)
-            else if (viewModelInitMode == ViewModelInitMode.NON_FORCE_INIT) viewModel?.init(false, resourceBundle, savedInstanceBundle)
+            if (viewModelInitMode == ViewModelInitMode.FORCE_INIT) viewModel?.init(true, resourceBundle, customBundle, savedInstanceBundle)
+            else if (viewModelInitMode == ViewModelInitMode.NON_FORCE_INIT) viewModel?.init(false, resourceBundle, customBundle, savedInstanceBundle)
         }
     }
 }

builder/src/main/java/archtree/activity/ArchTreeActivity.kt

@@ -318,4 +318,8 @@ abstract class ArchTreeActivity<ViewModel : BaseViewModel> : AppCompatActivity()
     open fun getBinding(): ViewDataBinding? {
         return activityResource?.binding
     }
+
+    open fun getCustomBundle(): Bundle? {
+        return activityResource?.customBundle
+    }
 }

builder/src/main/java/archtree/fragment/ArchTreeFragment.kt

@@ -160,4 +160,8 @@ abstract class ArchTreeFragment<ViewModel : BaseViewModel> : Fragment(), Injecta
     open fun getBinding(): ViewDataBinding? {
         return fragmentResource?.binding
     }
+
+    open fun getCustomBundle(): Bundle? {
+        return fragmentResource?.customBundle
+    }
 }

builder/src/main/java/archtree/fragment/FragmentResource.kt

@@ -30,8 +30,8 @@ constructor(builder: FragmentBuilder<ViewModel>) : ArchTreeResource<ViewModel>(b
             else Log.d(FragmentResource::class.java.name, "ViewModel is not attached to layout.")
 
             val resourceBundle = fragment.arguments
-            if (viewModelInitMode == ViewModelInitMode.FORCE_INIT) viewModel?.init(true, resourceBundle, savedInstanceBundle)
-            else if (viewModelInitMode == ViewModelInitMode.NON_FORCE_INIT) viewModel?.init(false, resourceBundle, savedInstanceBundle)
+            if (viewModelInitMode == ViewModelInitMode.FORCE_INIT) viewModel?.init(true, resourceBundle, customBundle, savedInstanceBundle)
+            else if (viewModelInitMode == ViewModelInitMode.NON_FORCE_INIT) viewModel?.init(false, resourceBundle, customBundle, savedInstanceBundle)
         }
     }
 }

viewmodel/src/main/java/archtree/viewmodel/BaseViewModel.kt

@@ -13,10 +13,10 @@ abstract class BaseViewModel : ViewModel() {
         private set
 
     @JvmOverloads
-    fun init(forceInit: Boolean = false, resourceBundle: Bundle? = null, savedInstanceBundle: Bundle? = null) {
+    fun init(forceInit: Boolean = false, resourceBundle: Bundle? = null, customBundle: Bundle? = null, savedInstanceBundle: Bundle? = null) {
         if (!isInitialised || forceInit) {
             isInitialised = true
-            onInit(resourceBundle, savedInstanceBundle)
+            onInit(resourceBundle, customBundle, savedInstanceBundle)
         }
     }
 
@@ -28,12 +28,13 @@ abstract class BaseViewModel : ViewModel() {
      *  within e.g. an activity.
      *
      *  @param resourceBundle Bundle object that is provided by the attached activity or fragment
+     *  @param customBundle Custom bundle object
      *  @param savedInstanceBundle Bundle object that is provided by the state of the attached
      *  activity or fragment
      *
      *  @since 1.0.0
      */
-    protected open fun onInit(resourceBundle: Bundle?, savedInstanceBundle: Bundle?) {
+    protected open fun onInit(resourceBundle: Bundle?, customBundle: Bundle?, savedInstanceBundle: Bundle?) {
         //do nothing by default
     }