Mini 4.0.0

Fix mini-processor-test

Add rules for StateContainer

Author: adriangl

.idea/kotlinc.xml

@@ -18,6 +18,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - No security issues fixed!
 
+## [4.0.0] - 2023-10-31
+## 🎃🎃 Happy Halloween! 🎃🎃
+### Changed
+- BREAKING CHANGE: Mini has been updated to use Java 17 instead of Java 8.
+- BREAKING CHANGE: Mini states must now implement `mini.State`.
+- Update all project dependencies.
+- Update documentation.
+
 ## [3.1.0] - 2022-09-18
 ### Added
 - Add **EXPERIMENTAL** support for Kotlin Symbol Processing (KSP). Be mindful of [the gotchas](README.md#ksp-gotchas). 
@@ -174,7 +182,8 @@ state (`success` or `failure`)
 ### Added
 - Initial architecture release.
 
-[Unreleased]: https://github.com/hyperdevs-team/mini-kotlin/compare/3.1.0...HEAD
+[Unreleased]: https://github.com/hyperdevs-team/mini-kotlin/compare/4.0.0...HEAD
+[4.0.0]: https://github.com/hyperdevs-team/mini-kotlin/compare/3.1.0...4.0.0
 [3.1.0]: https://github.com/hyperdevs-team/mini-kotlin/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/hyperdevs-team/mini-kotlin/compare/2.0.0...3.0.0
 [2.0.0]: https://github.com/hyperdevs-team/mini-kotlin/compare/1.4.0...2.0.0

CHANGELOG.md

@@ -147,14 +147,14 @@ ksp("com.github.hyperdevs-team.mini-kotlin:mini-processor:${miniVersion}")
 
 </details>
 
-### JDK8 requirements
-Ensure that your project has compatibility with Java 8:
+### JDK
+Ensure that your project has compatibility with Java 17:
 
 For Kotlin projects:
 ```groovy 
 tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {
     kotlinOptions {
-        jvmTarget = "1.8"
+        jvmTarget = "17"
     }
 }
 ```
@@ -163,12 +163,12 @@ For Android:
 ```groovy
 android {
     compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
     }
 
     kotlinOptions {
-        jvmTarget = "1.8"
+        jvmTarget = "17"
     }
 }
 ```

README.md

@@ -28,8 +28,8 @@ apply plugin: "kotlin-kapt"
 apply plugin: "com.google.devtools.ksp"
 
 android {
-    compileSdkVersion android_target_sdk
-    buildToolsVersion android_build_tools_version
+    compileSdk = android_target_sdk
+    buildToolsVersion = android_build_tools_version
 
     namespace "com.example.androidsample"
 
@@ -55,19 +55,19 @@ android {
     }
 
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
 
     kotlinOptions {
-        jvmTarget = "1.8"
+        jvmTarget = "17"
     }
     lint {
         abortOnError false
     }
 
-    configurations.all {
-        //This is library is included with two different versions
+    configurations.configureEach {
+        //This library is included with two different versions
         resolutionStrategy.force "com.google.code.findbugs:jsr305:3.0.1"
     }
 }

app/build.gradle

@@ -21,10 +21,10 @@ import mini.Reducer
 import mini.SuspendingAction
 import java.io.Serializable
 
-data class State(
+data class MainState(
         val text: String = "0",
         val loading: Boolean = false
-) : Serializable
+) : Serializable, mini.State
 
 @Action
 data class SetLoadingAction(val loading: Boolean)

app/src/main/java/com/example/androidsample/SampleActions.kt

@@ -30,19 +30,19 @@ import mini.android.FluxActivity
 
 private val dispatcher = Dispatcher()
 
-class MainStore : Store<State>() {
+class MainStore : Store<MainState>() {
 
     init {
         Mini.link(dispatcher, this).track()
     }
 
     @Reducer
-    fun handleLoading(state: State, action: SetLoadingAction): State {
+    fun handleLoading(state: MainState, action: SetLoadingAction): MainState {
         return state.copy(loading = action.loading)
     }
 
     @Reducer
-    fun handleSetTextAction(state: State, action: SetTextAction): State {
+    fun handleSetTextAction(state: MainState, action: SetTextAction): MainState {
         return state.copy(text = action.text)
     }
 

app/src/main/java/com/example/androidsample/StoreSampleActivity.kt

@@ -32,33 +32,33 @@ import mini.android.FluxStoreViewModel
 
 private val dispatcher = Dispatcher()
 
-class MainViewModelReducer : NestedStateContainer<State>() {
+class MainViewModelReducer : NestedStateContainer<MainState>() {
 
     @Reducer
-    fun handleLoading(state: State, action: SetLoadingAction): State {
+    fun handleLoading(state: MainState, action: SetLoadingAction): MainState {
         return state.copy(loading = action.loading)
     }
 
     @Reducer
-    fun handleSetTextAction(state: State, action: SetTextAction): State {
+    fun handleSetTextAction(state: MainState, action: SetTextAction): MainState {
         return state.copy(text = action.text)
     }
 }
 
-class MainStoreViewModel(savedStateHandle: SavedStateHandle) : FluxStoreViewModel<State>(savedStateHandle) {
+class MainStoreViewModel(savedStateHandle: SavedStateHandle) : FluxStoreViewModel<MainState>(savedStateHandle) {
     private val reducerSlice = MainViewModelReducer().apply { parent = this@MainStoreViewModel }
 
     init {
         Mini.link(dispatcher, listOf(this, reducerSlice)).track()
     }
 
-    override fun saveState(state: State, handle: SavedStateHandle) {
+    override fun saveState(state: MainState, handle: SavedStateHandle) {
         println("State saved")
         handle.set("state", state)
     }
 
-    override fun restoreState(handle: SavedStateHandle): State? {
-        val restored = handle.get<State>("state")
+    override fun restoreState(handle: SavedStateHandle): MainState? {
+        val restored = handle.get<MainState>("state")
         println("State restored $restored")
         return restored
     }

app/src/main/java/com/example/androidsample/ViewModelSampleActivity.kt

@@ -21,25 +21,25 @@ apply plugin: "com.gladed.androidgitversion"
 
 buildscript {
     ext {
-        kotlin_version = "1.7.0"
+        kotlin_version = "1.9.10"
 
-        android_compile_sdk = 33
-        android_target_sdk = 33
-        android_build_tools_version = "30.0.3"
+        android_compile_sdk = 34
+        android_target_sdk = 34
+        android_build_tools_version = "34.0.0"
 
-        activity_version = "1.5.0"
-        fragment_version = "1.5.0"
-        lifecycle_version = "2.5.1"
-        coroutines_version = "1.6.4"
+        activity_version = "1.8.0"
+        fragment_version = "1.6.1"
+        lifecycle_version = "2.6.2"
+        coroutines_version = "1.7.3"
 
-        kodein_version = "7.14.0"
+        kodein_version = "7.20.2"
 
         junit_version = "4.13.2"
-        test_runner_version = "1.4.0"
-        espresso_version = "3.4.0"
+        test_runner_version = "1.5.2"
+        espresso_version = "3.5.1"
         kluent_version = "1.68"
 
-        ksp_version = "${kotlin_version}-1.0.6"
+        ksp_version = "${kotlin_version}-1.0.13"
     }
 
     repositories {
@@ -49,11 +49,11 @@ buildscript {
     }
 
     dependencies {
-        classpath "com.android.tools.build:gradle:7.2.2"
+        classpath "com.android.tools.build:gradle:8.1.2"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath "org.junit.platform:junit-platform-gradle-plugin:1.2.0"
         classpath "com.gladed.androidgitversion:gradle-android-git-version:0.4.14"
-        classpath "com.github.ben-manes:gradle-versions-plugin:0.42.0"
+        classpath "com.github.ben-manes:gradle-versions-plugin:0.48.0"
         classpath "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin:$ksp_version"
     }
 }

build.gradle

@@ -1,6 +1,5 @@
-#Fri Jul 08 11:00:27 CEST 2022
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-all.zip
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -1,2 +1,2 @@
 jdk:
-  - openjdk11
+  - openjdk17

jitpack.yml

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
 /*
  * Copyright 2021 HyperDevs
  *
@@ -20,8 +22,8 @@ apply plugin: "com.android.library"
 apply plugin: "kotlin-android"
 
 android {
-    compileSdkVersion android_compile_sdk
-    buildToolsVersion android_build_tools_version
+    compileSdk = android_compile_sdk
+    buildToolsVersion = android_build_tools_version
 
     namespace "mini.android"
 
@@ -39,8 +41,16 @@ android {
         }
     }
 
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+tasks.withType(KotlinCompile).configureEach {
     kotlinOptions {
-        jvmTarget = "1.8"
+        jvmTarget = "17"
+
         freeCompilerArgs += [
                 "-opt-in=kotlin.Experimental",
                 "-opt-in=kotlinx.coroutines.ExperimentalCoroutinesApi",
@@ -52,7 +62,7 @@ dependencies {
     api project(':mini-common')
 
     api "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version"
-    api "androidx.appcompat:appcompat:1.4.2"
+    api "androidx.appcompat:appcompat:1.6.1"
     api "androidx.activity:activity-ktx:$activity_version"
     api "androidx.fragment:fragment-ktx:$fragment_version"
 

mini-android/build.gradle

@@ -20,12 +20,13 @@ import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.ViewModel
 import mini.CloseableTracker
 import mini.DefaultCloseableTracker
+import mini.State
 import mini.StateContainer
 import mini.assertOnUiThread
 import java.io.Closeable
 import java.util.concurrent.CopyOnWriteArrayList
 
-abstract class FluxStoreViewModel<S : Any>(
+abstract class FluxStoreViewModel<S : State>(
     val savedStateHandle: SavedStateHandle) :
     ViewModel(),
     StateContainer<S>,

mini-android/src/main/java/mini/android/FluxStoreViewModel.kt

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
 /*
  * Copyright 2021 HyperDevs
  *
@@ -16,12 +18,11 @@
  * limitations under the License.
  */
 
-apply plugin: 'kotlin'
 apply plugin: "kotlin"
 apply from: "../jitpack.gradle"
 
 dependencies {
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
 
     // Optional Rx and Android bindings, one day these should be modules,
@@ -35,12 +36,20 @@ dependencies {
     testImplementation "org.amshove.kluent:kluent:$kluent_version"
 }
 
-tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {
-    kotlinOptions.freeCompilerArgs += [
-            "-opt-in=kotlin.Experimental",
-            "-opt-in=kotlinx.coroutines.ExperimentalCoroutinesApi",
-            "-opt-in=kotlinx.coroutines.FlowPreview",
-    ]
+tasks.withType(KotlinCompile).configureEach {
+    kotlinOptions {
+        jvmTarget = "17"
+
+        freeCompilerArgs += [
+                "-opt-in=kotlin.Experimental",
+                "-opt-in=kotlinx.coroutines.ExperimentalCoroutinesApi",
+                "-opt-in=kotlinx.coroutines.FlowPreview"]
+    }
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_17
+    targetCompatibility = JavaVersion.VERSION_17
 }
 
 apply plugin: "idea"

mini-common/build.gradle

@@ -70,7 +70,8 @@ abstract class Mini {
     /**
      * Link all [Reducer] functions present in the store to the dispatcher.
      */
-    protected abstract fun <S> subscribe(dispatcher: Dispatcher, container: StateContainer<S>): Closeable
+    protected abstract fun <S: State> subscribe(dispatcher: Dispatcher,
+                                                container: StateContainer<S>): Closeable
 
     /**
      * Link all [Reducer] functions present in the store to the dispatcher.

mini-common/src/main/java/mini/Mini.kt

@@ -42,7 +42,9 @@ import java.io.Closeable
  * }
  * ```
  */
-abstract class NestedStateContainer<S : Any>(var parent: StateContainer<S>? = null) : StateContainer<S> {
+abstract class NestedStateContainer<S : State>(
+    var parent: StateContainer<S>? = null
+) : StateContainer<S> {
     override val state: S
         get() = parent!!.state