-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #251 from vivid-money/feature/elm-renderer
introduce handy way to start Store when lifecycle reached CREATED state
- Loading branch information
Showing
4 changed files
with
123 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
elmslie-android/src/main/kotlin/money/vivid/elmslie/android/renderer/ElmRendererDelegate.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,117 @@ | ||
| package money.vivid.elmslie.android.renderer | ||
|
|
||
| import android.os.Bundle | ||
| import androidx.activity.ComponentActivity | ||
| import androidx.annotation.MainThread | ||
| import androidx.core.os.bundleOf | ||
| import androidx.fragment.app.Fragment | ||
| import androidx.lifecycle.LifecycleOwner | ||
| import androidx.lifecycle.SavedStateHandle | ||
| import androidx.lifecycle.ViewModelStoreOwner | ||
| import androidx.lifecycle.lifecycleScope | ||
| import androidx.lifecycle.withCreated | ||
| import androidx.savedstate.SavedStateRegistryOwner | ||
| import kotlinx.coroutines.launch | ||
| import money.vivid.elmslie.android.elmStore | ||
| import money.vivid.elmslie.core.store.Store | ||
|
|
||
| @Suppress("OptionalUnit") | ||
| interface ElmRendererDelegate<Effect : Any, State : Any> { | ||
| fun render(state: State) | ||
| fun handleEffect(effect: Effect): Unit? = Unit | ||
| fun mapList(state: State): List<Any> = emptyList() | ||
| fun renderList(state: State, list: List<Any>): Unit = Unit | ||
| } | ||
|
|
||
| /** | ||
| * The function makes a connection between the store and the lifecycle owner by collecting states and effects | ||
| * and calling corresponds callbacks. | ||
| * | ||
| * Store creates and connects all required entities when given lifecycle reached CREATED state. | ||
| * | ||
| * In order to access previously saved state (via [saveState]) in [storeFactory] one must use | ||
| * SavedStateHandle.get<Bundle>(StateBundleKey) | ||
| * | ||
| * NOTE: If you implement your own ElmRendererDelegate, you should also implement the following interfaces: | ||
| * [ViewModelStoreOwner], [SavedStateRegistryOwner], [LifecycleOwner]. | ||
| */ | ||
| @Suppress("LongParameterList") | ||
| @MainThread | ||
| fun < | ||
| Event : Any, | ||
| Effect : Any, | ||
| State : Any, | ||
| > ElmRendererDelegate<Effect, State>.androidElmStore( | ||
| key: String = this::class.java.canonicalName ?: this::class.java.simpleName, | ||
| defaultArgs: () -> Bundle = { | ||
| val args = when (this) { | ||
| is Fragment -> arguments | ||
| is ComponentActivity -> intent.extras | ||
| else -> null | ||
| } | ||
| args ?: bundleOf() | ||
| }, | ||
| saveState: Bundle.(State) -> Unit = {}, | ||
| storeFactory: SavedStateHandle.() -> Store<Event, Effect, State>, | ||
| ): Lazy<Store<Event, Effect, State>> { | ||
| require(this is ViewModelStoreOwner) { | ||
| "Should implement [ViewModelStoreOwner]" | ||
| } | ||
| require(this is SavedStateRegistryOwner) { | ||
| "Should implement [SavedStateRegistryOwner]" | ||
| } | ||
| return androidElmStore( | ||
| key = key, | ||
| viewModelStoreOwner = { this }, | ||
| savedStateRegistryOwner = { this }, | ||
| defaultArgs = defaultArgs, | ||
| saveState = saveState, | ||
| storeFactory = storeFactory, | ||
| ) | ||
| } | ||
|
|
||
| @Suppress("LongParameterList") | ||
| @MainThread | ||
| fun < | ||
| Event : Any, | ||
| Effect : Any, | ||
| State : Any, | ||
| > ElmRendererDelegate<Effect, State>.androidElmStore( | ||
| key: String = this::class.java.canonicalName ?: this::class.java.simpleName, | ||
| viewModelStoreOwner: () -> ViewModelStoreOwner, | ||
| savedStateRegistryOwner: () -> SavedStateRegistryOwner, | ||
| defaultArgs: () -> Bundle = { | ||
| val args = when (this) { | ||
| is Fragment -> arguments | ||
| is ComponentActivity -> intent.extras | ||
| else -> null | ||
| } | ||
| args ?: bundleOf() | ||
| }, | ||
| saveState: Bundle.(State) -> Unit = {}, | ||
| storeFactory: SavedStateHandle.() -> Store<Event, Effect, State>, | ||
| ): Lazy<Store<Event, Effect, State>> { | ||
| require(this is LifecycleOwner) { | ||
| "Should implement [LifecycleOwner]" | ||
| } | ||
| val lazyStore = elmStore( | ||
| storeFactory = storeFactory, | ||
| key = key, | ||
| viewModelStoreOwner = viewModelStoreOwner, | ||
| savedStateRegistryOwner = savedStateRegistryOwner, | ||
| saveState = saveState, | ||
| defaultArgs = defaultArgs, | ||
| ) | ||
| with(this) { | ||
| lifecycleScope.launch { | ||
| withCreated { | ||
| ElmRenderer( | ||
| store = lazyStore.value, | ||
| delegate = this@with, | ||
| lifecycle = lifecycle, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| return lazyStore | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters