📝 Add documentation comments to test library

Author: Peter Bryant

test/src/main/java/com/ptrbrynt/kotlin_bloc/test/MockBloc.kt

@@ -8,6 +8,18 @@ import io.mockk.mockk
 import kotlinx.coroutines.flow.emptyFlow
 import kotlin.reflect.KClass
 
+/**
+ * Creates a mocked instance of the given [Cubit] type [C].
+ *
+ * Uses [mockk] under the hood.
+ *
+ * @param name Mock name
+ * @param relaxed Allows creation without any explicit behavior
+ * @param moreInterfaces Additional interfaces for this mock to implement
+ * @param relaxUnitFun Allows creation with no specific behaviour for Unit function
+ * @param block Block to execute after the mock has been created, with the mock as the receiver
+ * @see mockk
+ */
 inline fun <reified C : Cubit<State>, reified State> mockCubit(
     name: String? = null,
     relaxed: Boolean = false,
@@ -27,6 +39,18 @@ inline fun <reified C : Cubit<State>, reified State> mockCubit(
     }
 }
 
+/**
+ * Creates a mocked instance of the given [Bloc] type [B].
+ *
+ * Uses [mockk] under the hood.
+ *
+ * @param name Mock name
+ * @param relaxed Allows creation without any explicit behavior
+ * @param moreInterfaces Additional interfaces for this mock to implement
+ * @param relaxUnitFun Allows creation with no specific behaviour for Unit function
+ * @param block Block to execute after the mock has been created, with the mock as the receiver
+ * @see mockk
+ */
 inline fun <reified B : Bloc<Event, State>, reified Event, reified State> mockBloc(
     name: String? = null,
     relaxed: Boolean = false,

test/src/main/java/com/ptrbrynt/kotlin_bloc/test/WhenListen.kt

@@ -3,13 +3,26 @@ package com.ptrbrynt.kotlin_bloc.test
 import com.ptrbrynt.kotlin_bloc.core.BlocBase
 import io.mockk.every
 import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.onEach
 
+/**
+ * Creates a stub response for the `stateFlow` property of the given [bloc].
+ *
+ * Use [whenListen] when you want to return a canned [Flow] of [State]s for a [bloc] instance.
+ *
+ * [whenListen] also handles stubbing the `state` of the [bloc] to stay in sync with the emitted
+ * state.
+ */
 fun <B : BlocBase<State>, State> whenListen(
     bloc: B,
     states: Flow<State>,
     initialState: State? = null,
 ) {
-    every { bloc.stateFlow } answers { states }
+    every { bloc.stateFlow } answers {
+        states.onEach {
+            every { bloc.state } returns it
+        }
+    }
     if (initialState != null) {
         every { bloc.state } returns initialState
     }

test/src/test/java/com/ptrbrynt/kotlin_bloc/test/MockBlocTest.kt

@@ -37,6 +37,8 @@ class MockBlocTest {
 
         whenListen(cubit, flowOf(0, 1, 2), initialState = 1)
 
+        assertEquals(1, cubit.state)
+
         testBloc(
             build = { cubit },
             expected = listOf(
@@ -46,7 +48,7 @@ class MockBlocTest {
             ),
         )
 
-        assertEquals(1, cubit.state)
+        assertEquals(2, cubit.state)
     }
 
     @Test
@@ -83,5 +85,7 @@ class MockBlocTest {
                 { equals(2) },
             ),
         )
+
+        assertEquals(2, bloc.state)
     }
 }