Add LRU Cache (Memory)

Author: AraujoJordan

.github/workflows/gradle.yml

@@ -1,7 +1,5 @@
 name: Publish
 on:
-  release:
-    types: [released, prereleased]
   push:
     tags:
       - '*'
@@ -15,8 +13,8 @@ jobs:
       - name: Set up JDK 21
         uses: actions/setup-java@v4
         with:
-          distribution: 'zulu'
-          java-version: 21
+          distribution: 'microsoft'
+          java-version: 24
       - name: Publish to MavenCentral
         run: ./gradlew publishToMavenCentral --no-configuration-cache
         env:

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'microsoft'
+          java-version: 21.0.2
+
+      - name: Set up Gradle
+        uses: gradle/actions@v3
+
+      - name: Run Tests
+        run: ./gradlew :reflow:cleanJvmTest :reflow:jvmTest

.github/workflows/test.yml

@@ -1,4 +1,5 @@
 # Reflow
+[![Maven Central](https://github.com/AraujoJordan/Reflow/actions/workflows/publish.yml/badge.svg)](https://github.com/AraujoJordan/Reflow/actions/workflows/publish.yml) [![Tests](https://github.com/AraujoJordan/Reflow/actions/workflows/test.yml/badge.svg)](https://github.com/AraujoJordan/Reflow/actions/workflows/test.yml)  
 
 A Kotlin Multiplatform Flow that simplifies data fetching with automatic retry logic, loading state management, and flexible caching strategies. 
 It is designed to integrate seamlessly with Jetpack Compose.
@@ -13,11 +14,11 @@ class MyViewModel : ViewModel() {
 }
 ```
 
-you can also cache it in disk with:
+you can also cache it with:
 
 ```kotlin
 class MyViewModel : ViewModel() {
-    val uiState = reflow(cacheSource = CacheSource.Disk()) {
+    val uiState = reflow(cacheSource = CacheSource.Disk()) { // Or CacheSource.Memory() for a LRU cache
         api.fetchData()
     }
 }
@@ -83,7 +84,7 @@ fun UserListScreen(viewModel: MyViewModel) {
 ## Features
 
 - 🌐 **Kotlin Multiplatform** - Works on Android, iOS, and JVM
-- 🎨 **Flexible Configuration** - Customizable loading states, error handling and retry attempts
+- 🎨 **Flexible Configuration** - Customizable loading states, error handling, and retry attempts
 - ✈️ **Offline-first Support** - Reflow can cache the fetched data on disk for offline-first apps support
 - 🔌 **ViewModel Integration** - Extension functions for seamless ViewModel usage
 - 🧩 **Compose Ready** - First-class support for Jetpack Compose with animated reactive state

README.md

@@ -8,32 +8,35 @@ android-compileSdk = "36"
 kotlinxCoroutinesCore = "1.10.2"
 kotlinxIoCore = "0.8.2"
 kotlinxSerializationProtobuf = "1.9.0"
+androidxCollection = "1.5.0"
 lifecycleViewmodel = "2.9.6"
 vanniktechMavenPublish = "0.35.0"
-compose-plugin = "1.7.3"
+material3 = "1.9.0"
+compose = "1.9.3"
 
 [libraries]
 datastore = { module = "androidx.datastore:datastore", version.ref = "datastorePreferencesCore" }
 datastore-preferences-core = { module = "androidx.datastore:datastore-preferences-core", version.ref = "datastorePreferencesCore" }
 kermit = { module = "co.touchlab:kermit", version.ref = "kermit" }
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
-compose-runtime = { module = "org.jetbrains.compose.runtime:runtime", version.ref = "compose-plugin" }
-compose-foundation = { module = "org.jetbrains.compose.foundation:foundation", version.ref = "compose-plugin" }
-compose-material = { module = "org.jetbrains.compose.material:material", version.ref = "compose-plugin" }
-compose-material3 = { module = "org.jetbrains.compose.material3:material3", version.ref = "compose-plugin" }
-compose-ui = { module = "org.jetbrains.compose.ui:ui", version.ref = "compose-plugin" }
-compose-components-resources = { module = "org.jetbrains.compose.components:components-resources", version.ref = "compose-plugin" }
+compose-runtime = { module = "org.jetbrains.compose.runtime:runtime", version.ref = "compose" }
+compose-foundation = { module = "org.jetbrains.compose.foundation:foundation", version.ref = "compose" }
+compose-material = { module = "org.jetbrains.compose.material:material", version.ref = "compose" }
+compose-material3 = { module = "org.jetbrains.compose.material3:material3", version.ref = "material3" }
+compose-ui = { module = "org.jetbrains.compose.ui:ui", version.ref = "compose" }
+compose-components-resources = { module = "org.jetbrains.compose.components:components-resources", version.ref = "compose" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinxCoroutinesCore" }
 kotlinx-io-core = { module = "org.jetbrains.kotlinx:kotlinx-io-core", version.ref = "kotlinxIoCore" }
 protobuf-kotlin = { module = "org.jetbrains.kotlinx:kotlinx-serialization-protobuf", version.ref = "kotlinxSerializationProtobuf" }
 lifecycle-viewmodel = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel", version.ref = "lifecycleViewmodel" }
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinxCoroutinesCore" }
 lifecycle-viewmodel-compose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "lifecycleViewmodel" }
+androidxCollection = { module = "androidx.collection:collection", version.ref = "androidxCollection" }
 
 [plugins]
 android-kotlin-multiplatform-library = { id = "com.android.kotlin.multiplatform.library", version.ref = "agp" }
 kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 vanniktech-mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktechMavenPublish" }
-jetbrainsCompose = { id = "org.jetbrains.compose", version.ref = "compose-plugin" }
+jetbrainsCompose = { id = "org.jetbrains.compose", version.ref = "compose" }
 compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
 serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }

gradle/libs.versions.toml

@@ -54,6 +54,7 @@ kotlin {
             implementation(libs.protobuf.kotlin)
 
             implementation(libs.kermit)
+            implementation(libs.androidxCollection)
         }
 
         commonTest.dependencies {

reflow/build.gradle.kts

@@ -10,7 +10,6 @@ import androidx.compose.animation.togetherWith
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
-import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.material.Button
 import androidx.compose.material.CircularProgressIndicator
 import androidx.compose.material.Text
@@ -22,6 +21,8 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
+import io.github.araujojordan.cache.CacheSource
+import io.github.araujojordan.model.Resulting
 import io.github.araujojordan.reflow.generated.resources.Res
 import io.github.araujojordan.reflow.generated.resources.generic_error
 import io.github.araujojordan.reflow.generated.resources.retry
@@ -88,7 +89,7 @@ fun <T> ViewModel.reflow(
     dispatcher: CoroutineDispatcher = Dispatchers.IO,
     initial: Resulting<T> = Resulting.loading(),
     shouldLoadingOnRefresh: Boolean = true,
-    cacheSource: CacheSource<T> = CacheSource.Memory(),
+    cacheSource: CacheSource<T> = CacheSource.None(),
     maxRetries: Int = MAX_RETRIES,
     retryDelay: Long = RETRY_DELAY,
     shouldRetry: (Throwable) -> Boolean = { it is IOException },
@@ -109,7 +110,7 @@ fun <T> ViewModel.reflow(
     dispatcher: CoroutineDispatcher = Dispatchers.IO,
     initial: Resulting<T> = Resulting.loading(),
     shouldLoadingOnRefresh: Boolean = true,
-    cacheSource: CacheSource<T> = CacheSource.Memory(),
+    cacheSource: CacheSource<T> = CacheSource.None(),
     maxRetries: Int = MAX_RETRIES,
     retryDelay: Long = RETRY_DELAY,
     shouldRetry: (Throwable) -> Boolean = { it is IOException },
@@ -132,7 +133,7 @@ fun <T> reflowIn(
     dispatcher: CoroutineDispatcher = Dispatchers.IO,
     initial: Resulting<T> = Resulting.loading<T>(),
     shouldLoadingOnRefresh: Boolean = true,
-    cacheSource: CacheSource<T> = CacheSource.Memory(),
+    cacheSource: CacheSource<T> = CacheSource.None(),
     maxRetries: Int = MAX_RETRIES,
     retryDelay: Long = RETRY_DELAY,
     shouldRetry: (Throwable) -> Boolean = { it is IOException },
@@ -147,13 +148,16 @@ fun <T> reflowIn(
     var isFirstEmission = true
 
     val cached = when (cacheSource) {
-        is CacheSource.Disk<T> -> cacheSource.data.map { it?.let { Resulting.content<T>(it) } ?: Resulting.loading() }
-        is CacheSource.Memory -> flowOf(Resulting.loading())
+        is CacheSource.Store<T> -> cacheSource.data.map { it?.let { Resulting.content<T>(it) } ?: Resulting.loading() }
+        is CacheSource.None -> flowOf(Resulting.loading())
     }.filter { !(it.isLoading && !isFirstEmission && !shouldLoadingOnRefresh) }.flowOn(dispatcher)
 
     val fetched = fetchFlow
         .map {
-            scope.launch(Dispatchers.IO) { (cacheSource as? CacheSource.Disk<T>)?.store(it) }
+            when (cacheSource) {
+                is CacheSource.Store<T> -> scope.launch(Dispatchers.IO) { cacheSource.store(it) }
+                is CacheSource.None -> {}
+            }
             Resulting.content(it)
         }.retryWhen { cause, attempt ->
             val canRetry = (attempt + 1) < maxRetries && shouldRetry(cause)