Merge pull request #12 from adidas/enhancement/remove-MviState-in-fav…

…or-of-State

Enhancement/remove mvi state in favor of state

mvi/src/main/kotlin/com/adidas/mvi/IntentExecutor.kt

@@ -3,6 +3,6 @@ package com.adidas.mvi
 import com.adidas.mvi.transform.StateTransform
 import kotlinx.coroutines.flow.Flow
 
-public fun interface IntentExecutor<TIntent : Intent, TState : State> {
+public fun interface IntentExecutor<TIntent : Intent, TState : LoggableState> {
     public fun executeIntent(intent: TIntent, jobTerminator: JobTerminator<TIntent>): Flow<StateTransform<TState>>
 }

mvi/src/main/kotlin/com/adidas/mvi/LoggableState.kt

@@ -0,0 +1,3 @@
+package com.adidas.mvi
+
+public interface LoggableState : Loggable

mvi/src/main/kotlin/com/adidas/mvi/Reducer.kt

@@ -26,7 +26,7 @@ public class Reducer<TIntent, TState> @Deprecated("Use the other constructor, th
     private val defaultDispatcher: CoroutineDispatcher = Dispatchers.Default,
     private val intentExecutor: IntentExecutor<TIntent, TState>
 ) where TIntent : Intent,
-        TState : State {
+        TState : LoggableState {
     @Suppress("DEPRECATION")
     public constructor(
         coroutineScope: CoroutineScope,

mvi/src/main/kotlin/com/adidas/mvi/State.kt

@@ -1,3 +1,5 @@
 package com.adidas.mvi
 
-public interface State : Loggable
+import com.adidas.mvi.sideeffects.SideEffects
+
+public data class State<out TState, TSideEffect>(val view: TState, val sideEffects: SideEffects<TSideEffect>) : LoggableState

mvi-declarative/src/main/kotlin/com/adidas/mvi/declarative/ReducerExtensions.kt → mvi/src/main/kotlin/com/adidas/mvi/reducer/ReducerExtensions.kt

@@ -1,25 +1,26 @@
-package com.adidas.mvi.declarative
+package com.adidas.mvi.reducer
 
 import com.adidas.mvi.Intent
+import com.adidas.mvi.LoggableState
 import com.adidas.mvi.Logger
 import com.adidas.mvi.Reducer
 import com.adidas.mvi.SimplifiedIntentExecutor
 import com.adidas.mvi.State
-import com.adidas.mvi.actions.Actions
+import com.adidas.mvi.sideeffects.SideEffects
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 
-public fun <TIntent : Intent, TInnerState : State, TAction> Reducer(
+public fun <TIntent : Intent, TInnerState : LoggableState, TAction> Reducer(
     coroutineScope: CoroutineScope,
     initialInnerState: TInnerState,
-    intentExecutor: SimplifiedIntentExecutor<TIntent, MviState<TInnerState, TAction>>,
+    intentExecutor: SimplifiedIntentExecutor<TIntent, State<TInnerState, TAction>>,
     logger: Logger? = null,
     defaultDispatcher: CoroutineDispatcher = Dispatchers.Default
-): Reducer<TIntent, MviState<TInnerState, TAction>> {
+): Reducer<TIntent, State<TInnerState, TAction>> {
     return Reducer(
         coroutineScope = coroutineScope,
-        initialState = MviState(initialInnerState, Actions()),
+        initialState = State(initialInnerState, SideEffects()),
         intentExecutor = intentExecutor,
         logger = logger,
         defaultDispatcher = defaultDispatcher

mvi/src/main/kotlin/com/adidas/mvi/requirements/ReduceExtensions.kt

@@ -1,20 +1,20 @@
 package com.adidas.mvi.requirements
 
-import com.adidas.mvi.State
+import com.adidas.mvi.LoggableState
 
-public inline fun <TState : State, reified TRequiredState : TState> requireAndReduceState(
+public inline fun <TState : LoggableState, reified TRequiredState : TState> requireAndReduceState(
     state: TState,
     noinline reduce: (TRequiredState) -> TState
 ): TState {
     return StateReduceRequirement(TRequiredState::class, reduce).reduce(state)
 }
 
-public inline fun <TState : State, reified TRequiredState : TState> requireState(
+public inline fun <TState : LoggableState, reified TRequiredState : TState> requireState(
     noinline reduce: (TRequiredState) -> TState
 ): ReduceRequirement<TState> {
     return StateReduceRequirement(TRequiredState::class, reduce)
 }
 
-public infix fun <TState : State> ReduceRequirement<TState>.or(another: ReduceRequirement<TState>): ReduceRequirement<TState> {
+public infix fun <TState : LoggableState> ReduceRequirement<TState>.or(another: ReduceRequirement<TState>): ReduceRequirement<TState> {
     return DoubleReduceRequirement(this, another)
 }

mvi/src/main/kotlin/com/adidas/mvi/requirements/StateReduceRequirement.kt

@@ -1,14 +1,14 @@
 package com.adidas.mvi.requirements
 
-import com.adidas.mvi.State
+import com.adidas.mvi.LoggableState
 import com.adidas.mvi.StateRequiredNotFulfilledException
 import kotlin.reflect.KClass
 import kotlin.reflect.cast
 
 public class StateReduceRequirement<TState, TRequiredState>(
     private val expectedState: KClass<out TRequiredState>,
     private val reduceFunction: (TRequiredState) -> TState
-) : ReduceRequirement<TState> where TState : State, TRequiredState : TState {
+) : ReduceRequirement<TState> where TState : LoggableState, TRequiredState : TState {
 
     public override fun reduce(state: TState): TState {
         if (expectedState.isInstance(state)) {

mvi-declarative/src/main/kotlin/com/adidas/mvi/declarative/transform/SideEffectTransform.kt → mvi/src/main/kotlin/com/adidas/mvi/transform/SideEffectTransform.kt

@@ -1,15 +1,14 @@
-package com.adidas.mvi.declarative.transform
+package com.adidas.mvi.transform
 
-import com.adidas.mvi.declarative.MviState
+import com.adidas.mvi.State
 import com.adidas.mvi.sideeffects.SideEffects
-import com.adidas.mvi.transform.StateTransform
 
 public abstract class SideEffectTransform<TState, TSideEffect> :
-    StateTransform<MviState<TState, TSideEffect>> {
+    StateTransform<State<TState, TSideEffect>> {
 
     protected abstract fun mutate(sideEffects: SideEffects<TSideEffect>): SideEffects<TSideEffect>
 
-    final override fun reduce(currentState: MviState<TState, TSideEffect>): MviState<TState, TSideEffect> {
+    final override fun reduce(currentState: State<TState, TSideEffect>): State<TState, TSideEffect> {
         val sideEffects = currentState.sideEffects
         return currentState.copy(sideEffects = mutate(sideEffects))
     }

mvi-declarative/src/test/kotlin/com/adidas/mvi/declarative/transform/product/FakeProductSideEffectTransform.kt → mvi/src/test/kotlin/com/adidas/mvi/product/FakeProductSideEffectTransform.kt

@@ -1,7 +1,7 @@
-package com.adidas.mvi.declarative.transform.product
+package com.adidas.mvi.product
 
-import com.adidas.mvi.declarative.transform.SideEffectTransform
 import com.adidas.mvi.sideeffects.SideEffects
+import com.adidas.mvi.transform.SideEffectTransform
 
 class FakeProductSideEffectTransform(private val sideEffect: ProductSideEffect) :
     SideEffectTransform<ProductState, ProductSideEffect>() {

mvi/src/test/kotlin/com/adidas/mvi/product/FakeProductStateTransform.kt

@@ -0,0 +1,12 @@
+package com.adidas.mvi.product
+
+import com.adidas.mvi.State
+import com.adidas.mvi.transform.StateTransform
+
+class FakeProductStateTransform(private val state: State<ProductState, ProductSideEffect>) :
+    StateTransform<ProductState> {
+
+    override fun reduce(currentState: ProductState): ProductState {
+        return state.view
+    }
+}

mvi-declarative/src/test/kotlin/com/adidas/mvi/declarative/transform/product/ProductSideEffect.kt → mvi/src/test/kotlin/com/adidas/mvi/product/ProductSideEffect.kt

@@ -1,4 +1,4 @@
-package com.adidas.mvi.declarative.transform.product
+package com.adidas.mvi.product
 
 sealed class ProductSideEffect {
     object NavigateToProductDetailsSideEffect : ProductSideEffect()

mvi/src/test/kotlin/com/adidas/mvi/product/ProductState.kt

@@ -0,0 +1,8 @@
+package com.adidas.mvi.product
+
+import com.adidas.mvi.LoggableState
+
+sealed class ProductState : LoggableState {
+    object Loading : ProductState()
+    object Loaded : ProductState()
+}

mvi-declarative/src/test/kotlin/com/adidas/mvi/declarative/transform/ReducerExtensionsTest.kt → mvi/src/test/kotlin/com/adidas/mvi/reducer/ReducerExtensionsTest.kt

@@ -1,10 +1,9 @@
-package com.adidas.mvi.declarative.transform
+package com.adidas.mvi.reducer
 
 import com.adidas.mvi.Intent
-import com.adidas.mvi.declarative.MviState
-import com.adidas.mvi.declarative.Reducer
-import com.adidas.mvi.declarative.transform.product.ProductState
-import com.adidas.mvi.transform.Transform
+import com.adidas.mvi.State
+import com.adidas.mvi.product.ProductState
+import com.adidas.mvi.transform.StateTransform
 import io.kotest.core.spec.style.ShouldSpec
 import io.kotest.matchers.shouldBe
 import kotlinx.coroutines.flow.emptyFlow
@@ -16,12 +15,12 @@ class ReducerExtensionsTest : ShouldSpec({
             coroutineScope = TestScope(),
             initialInnerState = ProductState.Loading,
             intentExecutor = { _: Intent ->
-                emptyFlow<Transform<MviState<ProductState, Unit>>>()
+                emptyFlow<StateTransform<State<ProductState, Unit>>>()
             }
         )
 
         should("The initial inner state should be Loading") {
-            reducer.state.value.state shouldBe ProductState.Loading
+            reducer.state.value.view shouldBe ProductState.Loading
         }
     }
 })

mvi/src/test/kotlin/com/adidas/mvi/reducer/TestState.kt

@@ -1,8 +1,8 @@
 package com.adidas.mvi.reducer
 
-import com.adidas.mvi.State
+import com.adidas.mvi.LoggableState
 
-internal sealed class TestState : State {
+internal sealed class TestState : LoggableState {
     object InitialState : TestState()
 
     object StateFromTransform1 : TestState()

mvi/src/test/kotlin/com/adidas/mvi/requirements/ReduceRequirementTests.kt

@@ -1,14 +1,14 @@
 package com.adidas.mvi.requirements
 
-import com.adidas.mvi.State
+import com.adidas.mvi.LoggableState
 import com.adidas.mvi.StateRequiredNotFulfilledException
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.IsolationMode
 import io.kotest.core.spec.style.BehaviorSpec
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.types.shouldBeInstanceOf
 
-private sealed class TestState : State {
+private sealed class TestState : LoggableState {
     object State1 : TestState()
     object State2 : TestState()
     object State3 : TestState()

mvi/src/test/kotlin/com/adidas/mvi/transform/SideEffectTransformTest.kt

@@ -0,0 +1,22 @@
+package com.adidas.mvi.transform
+
+import com.adidas.mvi.State
+import com.adidas.mvi.product.FakeProductSideEffectTransform
+import com.adidas.mvi.product.ProductSideEffect
+import com.adidas.mvi.product.ProductState
+import com.adidas.mvi.sideeffects.SideEffects
+import io.kotest.core.spec.style.ShouldSpec
+import io.kotest.matchers.collections.shouldContainExactly
+
+class SideEffectTransformTest : ShouldSpec({
+
+    context("SideEffectTransform") {
+        val sideEffect = ProductSideEffect.NavigateToProductDetailsSideEffect
+
+        should("use mutate() function for reducing SideEffects") {
+            val state = State(ProductState.Loading, SideEffects<ProductSideEffect>())
+            FakeProductSideEffectTransform(sideEffect).reduce(state).sideEffects shouldContainExactly
+                listOf<ProductSideEffect>(sideEffect)
+        }
+    }
+})