Create StateFlowWrapper for multiplatform use (#254)

alexandregpereira · Feb 14, 2024 · ebf4db0 · ebf4db0
1 parent 06ab763
commit ebf4db0
Show file tree

Hide file tree

Showing 66 changed files with 654 additions and 911 deletions.
diff --git a/core/flow/build.gradle.kts b/core/flow/build.gradle.kts
@@ -0,0 +1,13 @@
+plugins {
+    kotlin("multiplatform")
+}
+
+configureJvmTargets()
+
+kotlin {
+    sourceSets {
+        commonMain.dependencies {
+            api(libs.kotlin.coroutines.core)
+        }
+    }
+}
diff --git a/core/flow/src/commonMain/kotlin/br/alexandregpereira/flow/FlowWrapper.kt b/core/flow/src/commonMain/kotlin/br/alexandregpereira/flow/FlowWrapper.kt
@@ -0,0 +1,41 @@
+package br.alexandregpereira.flow
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.SharedFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.launchIn
+import kotlinx.coroutines.flow.onEach
+
+class StateFlowWrapper<T : Any>(
+    private val origin: StateFlow<T>,
+    private val coroutineScope: CoroutineScope,
+) : StateFlow<T> by origin {
+
+    fun subscribe(block: (T) -> Unit) {
+        origin.onEach(block).launchIn(coroutineScope)
+    }
+}
+
+class SharedFlowWrapper<T : Any>(
+    private val origin: SharedFlow<T>,
+    private val coroutineScope: CoroutineScope,
+) : SharedFlow<T> by origin {
+
+    fun subscribe(block: (T) -> Unit) {
+        origin.onEach(block).launchIn(coroutineScope)
+    }
+}
+
+fun <T : Any> StateFlow<T>.wrap(
+    coroutineScope: CoroutineScope
+): StateFlowWrapper<T> = StateFlowWrapper(
+    origin = this,
+    coroutineScope = coroutineScope
+)
+
+fun <T : Any> SharedFlow<T>.wrap(
+    coroutineScope: CoroutineScope
+): SharedFlowWrapper<T> = SharedFlowWrapper(
+    origin = this,
+    coroutineScope = coroutineScope
+)
diff --git a/core/state-holder/build.gradle.kts b/core/state-holder/build.gradle.kts
@@ -6,13 +6,8 @@ configureJvmTargets()
 
 kotlin {
     sourceSets {
-        val commonMain by getting {
-            dependencies {
-                implementation(libs.kotlin.coroutines.core)
-            }
-        }
-        if (isMac()) {
-            val iosMain by getting
+        commonMain.dependencies {
+            api(project(":core:flow"))
         }
     }
 }
diff --git a/core/state-holder/src/commonMain/kotlin/br/alexandregpereira/hunter/state/ActionHandler.kt b/core/state-holder/src/commonMain/kotlin/br/alexandregpereira/hunter/state/ActionHandler.kt
@@ -16,33 +16,44 @@
 
 package br.alexandregpereira.hunter.state
 
+import br.alexandregpereira.flow.SharedFlowWrapper
+import br.alexandregpereira.flow.wrap
+import kotlinx.coroutines.MainScope
+import kotlinx.coroutines.cancel
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.flow.MutableSharedFlow
-import kotlinx.coroutines.flow.SharedFlow
 
-interface ActionHandler<Action> {
+interface ActionHandler<Action : Any> {
 
-    val action: SharedFlow<Action>
+    val action: SharedFlowWrapper<Action>
 }
 
-interface MutableActionHandler<Action> : ActionHandler<Action> {
+interface MutableActionHandler<Action : Any> : ActionHandler<Action> {
 
     fun sendAction(action: Action)
+
+    fun onActionHandlerClose()
 }
 
-fun <Action> MutableActionHandler(): MutableActionHandler<Action> {
+fun <Action : Any> MutableActionHandler(): MutableActionHandler<Action> {
     return MutableActionHandlerImpl()
 }
 
-private class MutableActionHandlerImpl<Action> : MutableActionHandler<Action> {
+private class MutableActionHandlerImpl<Action : Any> : MutableActionHandler<Action> {
+
+    private val coroutineScope = MainScope()
 
     private val _action = MutableSharedFlow<Action>(
         extraBufferCapacity = 1,
         onBufferOverflow = BufferOverflow.DROP_OLDEST
     )
-    override val action: SharedFlow<Action> = _action
+    override val action: SharedFlowWrapper<Action> = _action.wrap(coroutineScope)
 
     override fun sendAction(action: Action) {
         _action.tryEmit(action)
     }
+
+    override fun onActionHandlerClose() {
+        coroutineScope.cancel()
+    }
 }
diff --git a/core/state-holder/src/commonMain/kotlin/br/alexandregpereira/hunter/state/StateHolder.kt b/core/state-holder/src/commonMain/kotlin/br/alexandregpereira/hunter/state/StateHolder.kt
@@ -16,78 +16,35 @@
 
 package br.alexandregpereira.hunter.state
 
+import br.alexandregpereira.flow.StateFlowWrapper
+import br.alexandregpereira.flow.wrap
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.StateFlow
 
-abstract class UiModel<State>(
+abstract class UiModel<State : Any>(
     initialState: State
 ) : StateHolder<State> {
 
-    val scope = CoroutineScope(
+    protected val scope = CoroutineScope(
         SupervisorJob() + Dispatchers.Main.immediate
     )
 
     private val _state = MutableStateFlow(initialState)
-    override val state: StateFlow<State> = _state
+    override val state: StateFlowWrapper<State> = _state.wrap(scope)
 
     protected fun setState(block: State.() -> State) {
-        _state.value = state.value.block()
+        _state.value = _state.value.block()
     }
 
-    fun onCleared() {
+    open fun onCleared() {
         scope.cancel()
     }
 }
 
-interface StateHolder<State> {
+interface StateHolder<State : Any> {
 
-    val state: StateFlow<State>
-}
-
-interface MutableStateHolder<State>: StateHolder<State> {
-
-    fun setState(block: State.() -> State)
-}
-
-fun <State> MutableStateHolder(initialState: State): MutableStateHolder<State> {
-    return DefaultStateHolderImpl(initialState)
-}
-
-fun <State> MutableStateHolder(
-    stateRecovery: StateRecovery<State>
-): MutableStateHolder<State> {
-    return DefaultStateHolderWithRecovery(stateRecovery)
-}
-
-private class DefaultStateHolderImpl<State>(
-    initialState: State
-): MutableStateHolder<State> {
-
-    private val _state = MutableStateFlow(initialState)
-    override val state: StateFlow<State> = _state
-
-    override fun setState(block: State.() -> State) {
-        _state.value = state.value.block()
-    }
-}
-
-private class DefaultStateHolderWithRecovery<State>(
-    private val stateRecovery: StateRecovery<State>
-): MutableStateHolder<State> {
-
-    private val stateHolderDelegate = DefaultStateHolderImpl(stateRecovery.getState())
-
-    override val state: StateFlow<State> = stateHolderDelegate.state
-
-    override fun setState(block: State.() -> State) {
-        stateHolderDelegate.setState {
-            block().also {
-                stateRecovery.saveState(it)
-            }
-        }
-    }
+    val state: StateFlowWrapper<State>
 }
diff --git a/...in/kotlin/br/alexandregpereira/hunter/monster/compendium/domain/MonsterCompendiumError.kt b/...in/kotlin/br/alexandregpereira/hunter/monster/compendium/domain/MonsterCompendiumError.kt
@@ -16,6 +16,9 @@
 
 package br.alexandregpereira.hunter.monster.compendium.domain
 
+import kotlin.native.ObjCName
+
+@ObjCName(name = "MonsterCompendiumError", exact = true)
 sealed class MonsterCompendiumError(cause: Throwable? = null) : Throwable(cause) {
     class NoMonsterError(cause: Throwable? = null) : MonsterCompendiumError(cause)
     class UnknownError(cause: Throwable? = null) : MonsterCompendiumError(cause)

diff --git a/...commonMain/kotlin/br/alexandregpereira/hunter/domain/folder/model/MonsterPreviewFolder.kt b/...commonMain/kotlin/br/alexandregpereira/hunter/domain/folder/model/MonsterPreviewFolder.kt
@@ -20,7 +20,7 @@ data class MonsterPreviewFolder(
     val index: String,
     val name: String = "",
     val type: MonsterPreviewFolderType = MonsterPreviewFolderType.ABERRATION,
-    val challengeRating: Float = 0f,
+    val challengeRating: String = "",
     val imageUrl: String = "",
     val backgroundColorLight: String,
     val backgroundColorDark: String,

diff --git a/...nMain/kotlin/br/alexandregpereira/hunter/data/monster/folder/MonsterFolderEntityMapper.kt b/...nMain/kotlin/br/alexandregpereira/hunter/data/monster/folder/MonsterFolderEntityMapper.kt
@@ -40,7 +40,7 @@ internal fun List<MonsterEntity>.asDomainMonsterPreviewFolderEntity(): List<Mons
                 index = index,
                 name = name,
                 type = MonsterPreviewFolderType.valueOf(type),
-                challengeRating = challengeRating,
+                challengeRating = challengeRating.getChallengeRatingFormatted(),
                 imageUrl = imageUrl,
                 backgroundColorLight = backgroundColorLight,
                 backgroundColorDark = backgroundColorDark,
@@ -49,3 +49,12 @@ internal fun List<MonsterEntity>.asDomainMonsterPreviewFolderEntity(): List<Mons
         }
     }
 }
+
+private fun Float.getChallengeRatingFormatted(): String {
+    return if (this < 1) {
+        val value = 1 / this
+        "1/${value.toInt()}"
+    } else {
+        this.toInt().toString()
+    }
+}
diff --git a/...in/monster/core/src/commonMain/kotlin/br/alexandregpereira/hunter/domain/model/Monster.kt b/...in/monster/core/src/commonMain/kotlin/br/alexandregpereira/hunter/domain/model/Monster.kt
@@ -58,6 +58,17 @@ data class Monster(
 ) {
 
     val xp: Int = challengeRatingToXp()
+
+    val challengeRatingFormatted: String = challengeRating.getChallengeRatingFormatted()
+}
+
+private fun Float.getChallengeRatingFormatted(): String {
+    return if (this < 1) {
+        val value = 1 / this
+        "1/${value.toInt()}"
+    } else {
+        this.toInt().toString()
+    }
 }
 
 data class MonsterImageData(

diff --git a/...rc/commonMain/kotlin/br/alexandregpereira/hunter/folder/detail/FolderDetailStateHolder.kt b/...rc/commonMain/kotlin/br/alexandregpereira/hunter/folder/detail/FolderDetailStateHolder.kt
@@ -25,11 +25,8 @@ import br.alexandregpereira.hunter.event.monster.detail.MonsterDetailEvent.OnVis
 import br.alexandregpereira.hunter.event.monster.detail.MonsterDetailEventDispatcher
 import br.alexandregpereira.hunter.folder.preview.event.FolderPreviewEvent
 import br.alexandregpereira.hunter.folder.preview.event.FolderPreviewEventDispatcher
-import br.alexandregpereira.hunter.state.ScopeManager
-import br.alexandregpereira.hunter.state.StateHolder
+import br.alexandregpereira.hunter.state.UiModel
 import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.flowOn
@@ -45,12 +42,7 @@ class FolderDetailStateHolder internal constructor(
     private val monsterDetailEventDispatcher: MonsterDetailEventDispatcher,
     private val dispatcher: CoroutineDispatcher,
     private val analytics: FolderDetailAnalytics,
-) : ScopeManager(), StateHolder<FolderDetailState> {
-
-    private val _state: MutableStateFlow<FolderDetailState> = MutableStateFlow(
-        stateRecovery.getState()
-    )
-    override val state: StateFlow<FolderDetailState> = _state
+) : UiModel<FolderDetailState>(stateRecovery.getState()) {
 
     init {
         observeEvents()
@@ -119,8 +111,4 @@ class FolderDetailStateHolder internal constructor(
             }
             .launchIn(scope)
     }
-
-    private fun setState(block: FolderDetailState.() -> FolderDetailState) {
-        _state.value = state.value.block()
-    }
 }
diff --git a/...rc/commonMain/kotlin/br/alexandregpereira/hunter/folder/insert/FolderInsertStateHolder.kt b/...rc/commonMain/kotlin/br/alexandregpereira/hunter/folder/insert/FolderInsertStateHolder.kt
@@ -23,11 +23,8 @@ import br.alexandregpereira.hunter.event.folder.insert.FolderInsertEvent.Show
 import br.alexandregpereira.hunter.event.folder.insert.FolderInsertResult.OnMonsterRemoved
 import br.alexandregpereira.hunter.event.folder.insert.FolderInsertResult.OnSaved
 import br.alexandregpereira.hunter.localization.AppLocalization
-import br.alexandregpereira.hunter.state.ScopeManager
-import br.alexandregpereira.hunter.state.StateHolder
+import br.alexandregpereira.hunter.state.UiModel
 import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.flowOn
 import kotlinx.coroutines.flow.launchIn
@@ -44,10 +41,8 @@ class FolderInsertStateHolder internal constructor(
     private val dispatcher: CoroutineDispatcher,
     private val analytics: FolderInsertAnalytics,
     private val appLocalization: AppLocalization,
-) : ScopeManager(), StateHolder<FolderInsertState> {
+) : UiModel<FolderInsertState>(stateRecovery.getState()) {
 
-    private val _state = MutableStateFlow(stateRecovery.getState())
-    override val state: StateFlow<FolderInsertState> = _state
     private val strings: FolderInsertStrings
         get() = getFolderInsertStrings(appLocalization.getLanguage())
 
@@ -157,8 +152,4 @@ class FolderInsertStateHolder internal constructor(
             }
         }.launchIn(scope)
     }
-
-    private fun setState(block: FolderInsertState.() -> FolderInsertState) {
-        _state.value = state.value.block()
-    }
 }
diff --git a/feature/monster-compendium/android/build.gradle b/feature/monster-compendium/android/build.gradle
@@ -31,6 +31,7 @@ android {
 }
 
 dependencies {
+    implementation project(':core:localization')
     implementation project(':feature:folder-preview:event')
     implementation project(':feature:monster-detail:event')
     implementation project(':feature:monster-registration:event')

diff --git a/...rc/main/kotlin/br/alexandregpereira/hunter/monster/compendium/MonsterCompendiumFeature.kt b/...rc/main/kotlin/br/alexandregpereira/hunter/monster/compendium/MonsterCompendiumFeature.kt
@@ -25,7 +25,7 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.unit.dp
-import br.alexandregpereira.hunter.monster.compendium.MonsterCompendiumViewAction.GoToCompendiumIndex
+import br.alexandregpereira.hunter.monster.compendium.state.MonsterCompendiumAction.GoToCompendiumIndex
 import br.alexandregpereira.hunter.monster.compendium.ui.MonsterCompendiumScreen
 import org.koin.androidx.compose.koinViewModel