Bump versions and prepare for release 2.4.0 (#581)

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Change Log
+## 2.4.0
+- Add covariant recreation support (#565)
+- Exposing unique subscription handling for custom flow operations (#560)
+- Add support for restoring ViewModels that were initially created with a companion factory in a superclass #566
 
 ## 2.3.0
 - Error handling enhancements (#540)

build.gradle

@@ -27,7 +27,7 @@ buildscript {
 }
 
 plugins {
-    id("io.gitlab.arturbosch.detekt").version("1.16.0-RC2")
+    id("io.gitlab.arturbosch.detekt").version("1.18.1")
 }
 
 apply plugin: 'io.gitlab.arturbosch.detekt'

buildSrc/build.gradle.kts

@@ -14,5 +14,5 @@ dependencies {
     implementation(gradleApi())
     implementation("com.android.tools.build:gradle:7.0.0")
     implementation("org.jacoco:org.jacoco.core:0.8.5")
-    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.21")
+    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.30")
 }

buildSrc/src/main/java/dependencies.kt

@@ -1,9 +1,9 @@
 object Versions {
     // Build tools and SDK
     const val buildTools = "30.0.3"
-    const val compileSdk = 30
-    const val gradlePlugin = "7.0.0"
-    const val kotlin = "1.5.21"
+    const val compileSdk = 31
+    const val gradlePlugin = "7.0.2"
+    const val kotlin = "1.5.30"
     const val minSdk = 16
     const val targetSdk = 29
 
@@ -15,23 +15,23 @@ object Versions {
     const val cardview = "1.0.0"
     const val constraintlayout = "2.0.0"
     const val coordinatorLayout = "1.1.0"
-    const val compose = "1.0.2"
+    const val compose = "1.0.3"
     const val core = "1.5.0"
     const val fragment = "1.3.4"
     const val lifecycle = "2.3.1"
     const val navigation = "2.3.5"
-    const val navigationCompose = "2.4.0-alpha01"
+    const val navigationCompose = "2.4.0-alpha10"
     const val recyclerview = "1.2.0"
     const val room = "2.3.0"
-    const val viewModelCompose = "1.0.0-alpha05"
+    const val viewModelCompose = "2.4.0-rc01"
 
     // Libraries
     const val autoValue = "1.6.6"
     const val dagger = "2.38.1"
     const val epoxy = "4.0.0"
     const val hilt = "2.36"
     const val koin = "2.0.1"
-    const val kotlinCoroutines = "1.5.1"
+    const val kotlinCoroutines = "1.5.2"
     const val lottie = "3.4.0"
     const val moshi = "1.9.2"
     const val multidex = "2.0.1"

counter/src/test/java/com/airbnb/mvrx/counter/CounterViewModelTest.kt

@@ -22,4 +22,4 @@ class CounterViewModelTest {
         @ClassRule
         val mvrxTestRule = MvRxTestRule()
     }
-}
+}

detekt.gradle

@@ -3,7 +3,7 @@ apply plugin: 'io.gitlab.arturbosch.detekt'
 tasks.detekt.jvmTarget = "1.8"
 
 dependencies {
-    detektPlugins "io.gitlab.arturbosch.detekt:detekt-formatting:1.16.0-RC2"
+    detektPlugins "io.gitlab.arturbosch.detekt:detekt-formatting:1.18.1"
 }
 
 detekt {

detekt.yml

@@ -70,7 +70,7 @@ formatting:
     active: true
 
 comments:
-  excludes: ['.*/test/.*', '.*Test.kt', '.*Spec.kt']
+  excludes: ['**/test/**', '.*Test.kt']
   active: true
   CommentOverPrivateFunction:
     active: false
@@ -154,7 +154,7 @@ empty-blocks:
   EmptyForBlock:
     active: true
   EmptyFunctionBlock:
-    active: true
+    active: false
     ignoreOverridden: false
   EmptyIfBlock:
     active: true
@@ -261,6 +261,7 @@ naming:
     excludeClassPattern: '$^'
 
 performance:
+  excludes: ['**/test/**', '.*Test.kt']
   active: true
   ForEachOnRange:
     active: false
@@ -303,6 +304,7 @@ potential-bugs:
     active: true
 
 style:
+  excludes: ['**/test/**', '.*Test.kt']
   active: true
   CollapsibleIfStatements:
     active: true
@@ -339,6 +341,7 @@ style:
   MandatoryBracesIfStatements:
     active: false # TODO: consider this
   MaxLineLength:
+    excludes: ['**/test/**', '.*Test.kt']
     active: true
     maxLineLength: 175
     excludePackageStatements: false

dogs/src/test/java/com/airbnb/mvrx/dogs/DogStateTest.kt

@@ -12,4 +12,4 @@ class DogStateTest {
         val state = DogState(dogs = Success(listOf(dog)), lovedDogId = dog.id)
         assertEquals(dog, state.lovedDog)
     }
-}
+}

gradle.properties

@@ -1,4 +1,4 @@
-VERSION_NAME=2.4.0-SNAPSHOT
+VERSION_NAME=2.4.0
 GROUP=com.airbnb.android
 POM_DESCRIPTION=Mavericks is an Android application framework that makes product development fast and fun.
 POM_URL=https://github.com/airbnb/mavericks

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

hellodagger/src/test/java/com/airbnb/mvrx/hellodagger/HelloDaggerViewModelTest.kt

@@ -15,9 +15,8 @@ internal class HelloDaggerViewModelTest {
     @get:Rule
     val mvrxRule = MvRxTestRule()
 
-
     @Test
-    fun `fetches message when created`()  {
+    fun `fetches message when created`() {
         val repo = mockk<HelloRepository> {
             every { sayHello() } returns flowOf("Hello!")
         }
@@ -26,4 +25,4 @@ internal class HelloDaggerViewModelTest {
             assertEquals(Success("Hello!"), state.message)
         }
     }
-}
+}

launcher/src/main/java/com/airbnb/mvrx/launcher/MavericksLauncherFragment.kt

@@ -176,7 +176,11 @@ class MavericksLauncherFragment : MavericksLauncherBaseFragment() {
         }
     }
 
-    private fun EpoxyController.addMocksForSelectedView(state: MavericksLauncherState, mocksToShow: List<MockedViewProvider<*>>?, context: Context) {
+    private fun EpoxyController.addMocksForSelectedView(
+        state: MavericksLauncherState,
+        mocksToShow: List<MockedViewProvider<*>>?,
+        context: Context
+    ) {
         if (mocksToShow == null || mocksToShow.isEmpty()) {
             textRow {
                 id("no mocks")

mvrx-mocking/src/main/kotlin/com/airbnb/mvrx/mocking/DataClassSetDsl.kt

@@ -59,14 +59,18 @@ interface DataClassSetDsl {
     /**
      * A shortcut to setting an Async property to Loading, instead of "data.set { ::property }.with { Loading() }".
      */
-    fun <DataClass : Any, Type : Async<AsyncType>, AsyncType> DataClass.setLoading(block: DataClass.() -> KProperty0<Type>): DataClass {
+    fun <DataClass : Any, Type : Async<AsyncType>, AsyncType> DataClass.setLoading(
+        block: DataClass.() -> KProperty0<Type>
+    ): DataClass {
         return Setter<DataClass, Async<AsyncType>?>(this, block()).with { Loading() }
     }
 
     /**
      * A shortcut to setting an Async property to Fail, instead of "data.set { ::property }.with { Fail() }".
      */
-    fun <DataClass : Any, Type : Async<AsyncType>, AsyncType> DataClass.setNetworkFailure(block: DataClass.() -> KProperty0<Type>): DataClass {
+    fun <DataClass : Any, Type : Async<AsyncType>, AsyncType> DataClass.setNetworkFailure(
+        block: DataClass.() -> KProperty0<Type>
+    ): DataClass {
         return Setter<DataClass, Async<AsyncType>?>(this, block()).with { Fail(Throwable("Network request failed")) }
     }
 
@@ -125,7 +129,10 @@ interface DataClassSetDsl {
     /**
      * Helper to copy a nested class and update a property on it.
      */
-    class Setter<DataClass : Any, PropType>(private val instance: DataClass, internal val property: KProperty0<PropType>) {
+    class Setter<DataClass : Any, PropType>(
+        private val instance: DataClass,
+        internal val property: KProperty0<PropType>
+    ) {
         init {
             val clazz = instance::class
             if (instance is Async<*>) {

mvrx-mocking/src/main/kotlin/com/airbnb/mvrx/mocking/MockableMavericksViewModelConfig.kt

@@ -53,11 +53,15 @@ class MockableMavericksViewModelConfig<S : MavericksState>(
         updateStateStore()
     }
 
-    fun addOnExecuteListener(listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit) {
+    fun addOnExecuteListener(
+        listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit
+    ) {
         onExecuteListeners.add(listener)
     }
 
-    fun removeOnExecuteListener(listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit) {
+    fun removeOnExecuteListener(
+        listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit
+    ) {
         onExecuteListeners.remove(listener)
     }
 
@@ -300,12 +304,16 @@ open class MockMavericksViewModelConfigFactory(
     /**
      * Add a lambda that will be invoked whenever [MavericksViewModel.execute] is used.
      */
-    fun addOnExecuteListener(listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit) {
+    fun addOnExecuteListener(
+        listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit
+    ) {
         onExecuteListeners.add(listener)
         mockConfigs.values.forEach { it.addOnExecuteListener(listener) }
     }
 
-    fun removeOnExecuteListener(listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit) {
+    fun removeOnExecuteListener(
+        listener: (MavericksViewModelConfig<*>, MavericksViewModel<*>, MavericksViewModelConfig.BlockExecutions) -> Unit
+    ) {
         onExecuteListeners.remove(listener)
         mockConfigs.values.forEach { it.removeOnExecuteListener(listener) }
     }

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/AutoValueTypePrinterTest.kt

@@ -26,7 +26,8 @@ class AutoValueTypePrinterTest : BaseTest() {
             "val mockAutoValue_AutoValueClass by lazy { AutoValueClass.builder()\n" +
                 ".setName(\"foo\")\n" +
                 ".setNumberOfLegs(1)\n" +
-                ".build() }", constructorCode.lazyPropertyToCreateObject
+                ".build() }",
+            constructorCode.lazyPropertyToCreateObject
         )
     }
 

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/BaseTest.kt

@@ -89,7 +89,6 @@ abstract class BaseTest {
             }
             .commitNow()
 
-
         return controller
     }
 }

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/ConstructorCodeGeneratorTest.kt

@@ -217,14 +217,18 @@ class ConstructorCodeGeneratorTest : BaseTest() {
         ).expect("ConstructorCodeGeneratorTest.Test(list=arrayOf(1,2,3,4))")
     }
 
-    private fun <T : MavericksState> com.airbnb.mvrx.mocking.printer.ConstructorCodeGenerator<T>.expect(expectedCode: String) {
+    private fun <T : MavericksState> com.airbnb.mvrx.mocking.printer.ConstructorCodeGenerator<T>.expect(
+        expectedCode: String
+    ) {
         assertEquals("valmockTestbylazy{$expectedCode}", lazyPropertyToCreateObject.removeWhiteSpace())
     }
 
     data class StateWithJsonObject(val json: String = """{"color":"red","numbers":[{"favorite":7},{"lowest":0}]}""") :
         MavericksState
 
-    data class StateWithInvalidJsonObject(val json: String = """not valid{"color":"red","numbers":[{"favorite":7},{"lowest":0}]}""") :
+    data class StateWithInvalidJsonObject(
+        val json: String = """not valid{"color":"red","numbers":[{"favorite":7},{"lowest":0}]}"""
+    ) :
         MavericksState
 
     data class StateWithJsonArray(val json: String = """[{"favorite":7},{"lowest":0}]""") :
@@ -268,4 +272,4 @@ private fun String.removeWhiteSpace(): String {
         .replace("\n", "")
         .replace("\r", "")
         .replace("\t", "")
-}
+}

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/CoroutineTestUtil.kt

@@ -6,4 +6,4 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.test.TestCoroutineDispatcher
 
-fun testCoroutineScope() = CoroutineScope(SupervisorJob() + TestCoroutineDispatcher())
+fun testCoroutineScope() = CoroutineScope(SupervisorJob() + TestCoroutineDispatcher())

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/DataClassSetDslTest.kt

@@ -98,4 +98,4 @@ data class TestClass2(
 
 data class TestClass3(
     val str: String = ""
-)
+)

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/MavericksViewModelConfigTest.kt

@@ -146,4 +146,4 @@ class MavericksViewModelConfigTest : BaseTest() {
     class TestViewModel : MavericksViewModel<TestState>(TestState())
 
     data class TestState(val num: Int = 0) : MavericksState
-}
+}

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/MockStateHolderTest.kt

@@ -82,7 +82,6 @@ class MockStateHolderTest : BaseTest() {
                             defaultState = defaultState,
                             defaultArgs = null
                         ) {
-
                         }
                     }
                     else -> MavericksViewMocks.DefaultViewMocksProvider.mavericksViewMocks(view)
@@ -220,7 +219,6 @@ class MockStateHolderTest : BaseTest() {
                             defaultState = TestState(num = 4),
                             defaultArgs = null
                         ) {
-
                         }
                     }
                     else -> MavericksViewMocks.DefaultViewMocksProvider.mavericksViewMocks(view)
@@ -253,7 +251,6 @@ class MockStateHolderTest : BaseTest() {
             defaultState = TestState(num = 3),
             defaultArgs = null
         ) {
-
         }
     }
 
@@ -266,4 +263,4 @@ class MockStateHolderTest : BaseTest() {
 
     data class TestState(val num: Int = 0) : MavericksState
     class FragmentVM(initialState: TestState) : MavericksViewModel<TestState>(initialState)
-}
+}

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/MockableMavericksStateStoreTest.kt

@@ -195,4 +195,4 @@ class MockableMavericksStateStoreTest : BaseTest() {
     }
 
     private data class TestState(val num: Int = 0) : MavericksState
-}
+}

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/TestActivity.kt

@@ -21,4 +21,4 @@ open class TestActivity : AppCompatActivity() {
     }
 }
 
-const val CONTAINER_ID = 111
+const val CONTAINER_ID = 111

mvrx-mocking/src/test/kotlin/com/airbnb/mvrx/mocking/ViewModelBlockExecutionTest.kt

@@ -58,4 +58,4 @@ class ViewModelBlockExecutionTest : BaseTest() {
     }
 }
 
-fun <S : MavericksState, VM : MavericksViewModel<S>> VM.state(): S = config.stateStore.state
+fun <S : MavericksState, VM : MavericksViewModel<S>> VM.state(): S = config.stateStore.state