Merge remote-tracking branch 'origin/develop' into feature/MVI-2-delegation

Author: Arkadiusz Pałka

app/build.gradle

@@ -2,6 +2,7 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-kapt'
 apply plugin: 'kotlin-android-extensions'
+apply plugin: 'de.mannodermaus.android-junit5'
 
 // Android configuration
 android {

build.gradle

@@ -9,6 +9,7 @@ buildscript {
     dependencies {
         classpath deps.build.android_gradle_plugin
         classpath deps.build.kotlin_gradle_plugin
+        classpath "de.mannodermaus.gradle.plugins:android-junit5:1.3.2.0"
     }
 }
 

dependencies.gradle

@@ -41,7 +41,7 @@ versions.rx_java_extensions = "0.20.10"
 versions.crashlytics = "2.10.1@aar"
 versions.joda_time = "2.10.2"
 versions.mapstruct = "1.3.0.Final"
-versions.junit = "4.12"
+versions.junit = "5.5.2"
 versions.mockito = "2.25.1"
 versions.mockito_ktx = "2.1.0"
 versions.dropwizard_testing = "1.3.13"
@@ -51,7 +51,7 @@ versions.dexmaker_mockito = "1.2"
 versions.androidx_runner = "1.1.2-alpha02"
 versions.espresso = "3.2.0-alpha02"
 versions.okhttp = "3.14.0"
-versions.robolectric = "4.0.2"
+versions.robolectric = "4.3"
 versions.glide = "4.9.0"
 versions.realm = "5.12.0"
 versions.apache_lang = "3.9"
@@ -62,6 +62,7 @@ versions.easy_validation = "1.0.1"
 versions.fragmentation = "1.0.1"
 versions.material_progress_bar = "1.6.1"
 versions.fast_adapter = "4.0.1"
+versions.mockk = "1.9.3"
 deps.versions = versions
 ext.versions = versions
 
@@ -210,21 +211,22 @@ deps.utility = utility
  * Test variables.
  */
 def test = [:]
-test.junit = "junit:junit:$versions.junit"
+test.junit_api = "org.junit.jupiter:junit-jupiter-api:$versions.junit"
+test.junit_params = "org.junit.jupiter:junit-jupiter-params:$versions.junit"
+test.junit_engine = "org.junit.jupiter:junit-jupiter-engine:$versions.junit"
 test.mockito = "org.mockito:mockito-core:$versions.mockito"
 test.mockito_ktx = "com.nhaarman.mockitokotlin2:mockito-kotlin:$versions.mockito_ktx"
 test.toothpick = "com.github.stephanenicolas.toothpick:toothpick-testing:$versions.toothpick_testing"
 test.matchers_ktx = "com.github.stephanenicolas.toothpick:toothpick-testing:$versions.toothpick_testing"
 test.androidx_core = "androidx.test:core:$versions.androidx_test_core"
-test.junit_ext_ktx = "androidx.test.ext:junit-ktx:$versions.androidx_test_core"
-test.junit_ext = "aandroidx.test.ext:junit:$versions.androidx_test_core"
 test.dexmaker_mockito = "com.google.dexmaker:dexmaker-mockito:$versions.dexmaker_mockito"
 test.androidx_runner = "androidx.test:runner:$versions.androidx_runner"
 test.androidx_rules = "androidx.test:rules:$versions.androidx_runner"
 test.espresso = "androidx.test.espresso:espresso-core:$versions.espresso"
 test.espresso_intents = "androidx.test.espresso:espresso-intents:$versions.espresso"
 test.mock_web_server = "com.squareup.okhttp3:mockwebserver:$versions.okhttp"
 test.robolectric = "org.robolectric:robolectric:$versions.robolectric"
+test.mockk = "io.mockk:mockk:$versions.mockk"
 deps.test = test
 
 /**

mvi-valueadd/build.gradle

@@ -22,6 +22,12 @@ android {
         consumerProguardFiles 'consumer-rules.pro'
     }
 
+    testOptions {
+        unitTests.all {
+            useJUnitPlatform()
+        }
+    }
+
     buildTypes {
 
         debug {
@@ -57,4 +63,10 @@ dependencies {
 
     // Utility
     implementation deps.utility.fragmentation
+
+    // Test dependencies
+    testImplementation deps.test.mockk
+    testImplementation deps.test.junit_api
+    testImplementation deps.test.junit_params
+    testRuntimeOnly deps.test.junit_engine
 }

mvi-valueadd/src/main/java/pl/valueadd/mvi/exception/ViewWasNotDetachedException.kt

@@ -0,0 +1,5 @@
+package pl.valueadd.mvi.exception
+
+import java.lang.RuntimeException
+
+internal class ViewWasNotDetachedException : RuntimeException("Detach previous view first.")

mvi-valueadd/src/main/java/pl/valueadd/mvi/fragment/mvi/BaseMviPresenter.kt

@@ -9,11 +9,14 @@ import io.reactivex.schedulers.Schedulers
 import io.reactivex.subjects.BehaviorSubject
 import io.reactivex.subjects.PublishSubject
 import pl.valueadd.mvi.exception.ViewNotAttachedException
+import pl.valueadd.mvi.exception.ViewWasNotDetachedException
 
 abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI : IBaseView.IBaseIntent, V : IBaseView<VS, VI>>(
     initialState: VS
 ) : IMviPresenter<V> {
 
+    //region Variables
+
     /**
      * Current view state.
      */
@@ -36,8 +39,17 @@ abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI
      * @see subscribeViewStateConsumer
      * @see viewStateConsumerDisposable
      */
-    protected open val viewStateSubscriptionScheduler: Scheduler =
+    protected open val viewStateSubscriptionScheduler: Scheduler by lazy {
         Schedulers.io()
+    }
+
+    /**
+     * @see subscribeViewStateConsumer
+     * @see viewStateConsumerDisposable
+     */
+    protected open val viewStateObservationScheduler: Scheduler by lazy {
+        AndroidSchedulers.mainThread()
+    }
 
     /**
      * Internal nullable [view][IBaseView] of presenter.
@@ -76,6 +88,10 @@ abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI
     private val currentViewIntentsSubject =
         PublishSubject.create<VI>()
 
+    //endregion
+
+    //region Lifecycle methods
+
     /**
      * If view is attached the first time, the presenter subscribes its provided intents.
      * Each time subscribes to view state's consumer and bind view's intents.
@@ -84,10 +100,13 @@ abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI
      */
     @CallSuper
     override fun attachView(view: V) {
-        this.internalView = view
+        if (this.internalView != null) {
+            throw ViewWasNotDetachedException()
+        }
 
+        this.internalView = view
         if (isViewAttachedFirstTime) {
-            subscribeViewIntents()
+            startObservingCurrentViewStateSubject()
         }
 
         subscribeViewStateConsumer()
@@ -114,13 +133,15 @@ abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI
     /**
      * Dispose subscribed wrapped intents and current view's intents.
      *
-     * Resets presenter state.
+     * This should be called on fragment's **destroy**.
      */
     @CallSuper
     override fun destroy() {
         reset()
     }
 
+    //endregion
+
     /**
      * Map view's intent actions to [provided presenter intents][BaseMviPresenter.providePresenterIntents].
      *
@@ -185,7 +206,7 @@ abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI
     private fun subscribeViewStateConsumer() {
         viewStateConsumerDisposable = viewStateBehaviorSubject
             .subscribeOn(viewStateSubscriptionScheduler)
-            .observeOn(AndroidSchedulers.mainThread())
+            .observeOn(viewStateObservationScheduler)
             .subscribe(view::render)
     }
 
@@ -195,7 +216,7 @@ abstract class BaseMviPresenter<VS : IBaseViewState, PS : IBasePartialState, VI
      *
      * This method should be called **once**. The best time to call it when view is attached for the first time.
      */
-    private fun subscribeViewIntents() {
+    private fun startObservingCurrentViewStateSubject() {
         viewStateReducerDisposable =
             currentViewIntentsSubject
                 .flatMap(::mapViewIntentToPartialState)

mvi-valueadd/src/test/java/pl/valueadd/mvi/fragment/base/BaseMviFragmentTest.kt

@@ -0,0 +1,122 @@
+package pl.valueadd.mvi.fragment.base
+
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import io.reactivex.Observable
+import io.reactivex.schedulers.Schedulers
+import kotlinx.android.parcel.Parcelize
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import pl.valueadd.mvi.activity.BaseActivity
+import pl.valueadd.mvi.fragment.mvi.BaseMviPresenter
+import pl.valueadd.mvi.fragment.mvi.IBasePartialState
+import pl.valueadd.mvi.fragment.mvi.IBaseView
+import pl.valueadd.mvi.fragment.mvi.IBaseViewState
+
+class BaseMviFragmentTest {
+
+    private lateinit var mockPresenter: TestPresenter
+
+    private lateinit var fragment: TestMviFragment
+
+    @BeforeEach
+    fun setup() {
+        mockPresenter = mockk(relaxed = true)
+        fragment = TestMviFragment()
+        fragment.presenter = mockPresenter
+    }
+
+    @Test
+    fun `Should attach view to presenter on start`() {
+        // Given
+
+        // When
+        fragment.onStart()
+
+        // Then
+        verify(exactly = 1) { mockPresenter.attachView(fragment) }
+    }
+
+    @Test
+    fun `Should detach view to presenter on stop`() {
+        // Given
+
+        // When
+        fragment.onStop()
+
+        // Then
+        verify(exactly = 1) { mockPresenter.detachView() }
+    }
+
+    @Test
+    fun `Should call onDestroy on presenter`() {
+        // Given
+        val mockActivity = mockk<TestActivity>(relaxed = true) {
+            every { supportDelegate } returns mockk(relaxed = true)
+        }
+        fragment.onAttach(mockActivity)
+
+        // When
+        fragment.onDestroy()
+
+        // Then
+        verify(exactly = 1) { mockPresenter.destroy() }
+    }
+}
+
+private class TestMviFragment : BaseMviFragment<TestView, TestViewState, TestViewIntent, TestPresenter>(layoutId = 0), TestView {
+
+    override lateinit var presenter: TestPresenter
+
+    override fun render(state: TestViewState) {
+        // no-op
+    }
+
+    override fun provideViewIntents(): List<Observable<TestViewIntent>> {
+        return emptyList()
+    }
+}
+
+private class TestPresenter(
+    private val mapper: TestViewIntentToPartialStateMapper,
+    private val reducer: TestReducer
+) : BaseMviPresenter<TestViewState, TestPartialState, TestViewIntent, TestView>(
+    TestViewState()
+) {
+    override val viewStateSubscriptionScheduler = Schedulers.trampoline()
+    override val viewStateObservationScheduler = Schedulers.trampoline()
+
+    override fun mapViewIntentToPartialState(viewIntent: TestViewIntent): Observable<out TestPartialState> {
+        // For easier testing
+        return mapper.mapViewIntentToPartialState(viewIntent)
+    }
+
+    override fun reduce(previousState: TestViewState, action: TestPartialState): TestViewState {
+        // For easier testing
+        return reducer.reduce(previousState, action)
+    }
+}
+
+private interface TestView : IBaseView<TestViewState, TestViewIntent>
+
+@Parcelize
+private class TestViewState(var someProperty: Int = 0) : IBaseViewState
+
+private class TestPartialState(var someProperty: Int) : IBasePartialState
+
+private class TestViewIntent : IBaseView.IBaseIntent
+
+private class TestViewIntentToPartialStateMapper {
+    fun mapViewIntentToPartialState(viewIntent: TestViewIntent): Observable<out TestPartialState> {
+        throw RuntimeException("Should be mocked")
+    }
+}
+
+private class TestReducer {
+    fun reduce(previousState: TestViewState, action: TestPartialState): TestViewState {
+        throw RuntimeException("Should be mocked")
+    }
+}
+
+private class TestActivity : BaseActivity()