[Feature] Retain data order across app session (#28)

* retain data order across app session #9

* fixed flickering issue

---------

Co-authored-by: anas shikoh <[email protected]>

Author: Mutant-Slayer

app/build.gradle.kts

@@ -91,4 +91,5 @@ dependencies {
     implementation(libs.androidx.navigation3.ui)
     implementation(libs.androidx.navigation3.runtime)
     implementation(libs.androidx.lifecycle.viewmodel.navigation3)
+    implementation(libs.androidx.datastore.preferences)
 }

app/src/main/java/com/yogeshpaliyal/deepr/DeeprApplication.kt

@@ -3,6 +3,7 @@ package com.yogeshpaliyal.deepr
 import android.app.Application
 import app.cash.sqldelight.db.SqlDriver
 import app.cash.sqldelight.driver.android.AndroidSqliteDriver
+import com.yogeshpaliyal.deepr.preference.AppPreferenceDataStore
 import com.yogeshpaliyal.deepr.viewmodel.AccountViewModel
 import org.koin.android.ext.koin.androidContext
 import org.koin.androidx.viewmodel.dsl.viewModel
@@ -31,6 +32,8 @@ class DeeprApplication : Application() {
                 database.deeprQueries
             }
 
+            single { AppPreferenceDataStore(androidContext()) }
+
             viewModel { AccountViewModel(get()) }
         }
 

app/src/main/java/com/yogeshpaliyal/deepr/preference/AppPreferenceDataStore.kt

@@ -0,0 +1,29 @@
+package com.yogeshpaliyal.deepr.preference
+
+import android.content.Context
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.core.stringPreferencesKey
+import androidx.datastore.preferences.preferencesDataStore
+import com.yogeshpaliyal.deepr.viewmodel.SortOrder
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+
+private val Context.appDataStore: DataStore<Preferences> by preferencesDataStore(name = "app_data_store")
+
+class AppPreferenceDataStore(private val context: Context) {
+    companion object {
+        private val SORTING_ORDER = stringPreferencesKey("sorting_order")
+    }
+
+    val getSortingOrder: Flow<String> = context.appDataStore.data.map { preferences ->
+        preferences[SORTING_ORDER] ?: SortOrder.DESC.name
+    }
+
+    suspend fun setSortingOrder(order: String) {
+        context.appDataStore.edit { prefs ->
+            prefs[SORTING_ORDER] = order
+        }
+    }
+}

app/src/main/java/com/yogeshpaliyal/deepr/viewmodel/AccountViewModel.kt

@@ -6,23 +6,32 @@ import app.cash.sqldelight.coroutines.asFlow
 import app.cash.sqldelight.coroutines.mapToList
 import com.yogeshpaliyal.deepr.Deepr
 import com.yogeshpaliyal.deepr.DeeprQueries
+import com.yogeshpaliyal.deepr.preference.AppPreferenceDataStore
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.flatMapLatest
+import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
+import org.koin.core.component.KoinComponent
+import org.koin.core.component.get
 
 enum class SortOrder {
     ASC, DESC, OPENED_ASC, OPENED_DESC
 }
 
-class AccountViewModel(private val deeprQueries: DeeprQueries) : ViewModel() {
+class AccountViewModel(private val deeprQueries: DeeprQueries) : ViewModel(), KoinComponent {
 
+    private val preferenceDataStore: AppPreferenceDataStore = get()
     private val searchQuery = MutableStateFlow("")
-    private val sortOrder = MutableStateFlow(SortOrder.DESC)
+    private val sortOrder: Flow<SortOrder> =
+        preferenceDataStore.getSortingOrder.map { sortOrderName ->
+            SortOrder.valueOf(sortOrderName)
+        }
 
     @OptIn(ExperimentalCoroutinesApi::class)
     val accounts: StateFlow<List<Deepr>> =
@@ -51,7 +60,9 @@ class AccountViewModel(private val deeprQueries: DeeprQueries) : ViewModel() {
     }
 
     fun setSortOrder(order: SortOrder) {
-        sortOrder.value = order
+        viewModelScope.launch {
+            preferenceDataStore.setSortingOrder(order.name)
+        }
     }
 
     fun insertAccount(link: String, executed: Boolean) {

gradle/libs.versions.toml

@@ -14,7 +14,7 @@ koin-bom = "4.0.3"
 tablerIcons = "1.1.1"
 nav3Core = "1.0.0-alpha01"
 lifecycleViewmodelNav3 = "1.0.0-alpha01"
-
+dataStore = "1.1.7"
 
 [libraries]
 android-driver = { module = "app.cash.sqldelight:android-driver", version.ref = "androidDriver" }
@@ -37,6 +37,7 @@ koin-bom = { module = "io.insert-koin:koin-bom", version.ref = "koin-bom" }
 koin-core = { module = "io.insert-koin:koin-core" }
 koin-android = { module = "io.insert-koin:koin-android" }
 tabler-icons = { module = "br.com.devsrsouza.compose.icons:tabler-icons", version.ref = "tablerIcons" }
+androidx-datastore-preferences = { group = "androidx.datastore", name = "datastore-preferences", version.ref = "dataStore" }
 # Core Navigation 3 libraries
 androidx-navigation3-runtime = { module = "androidx.navigation3:navigation3-runtime", version.ref = "nav3Core" }
 androidx-navigation3-ui = { module = "androidx.navigation3:navigation3-ui", version.ref = "nav3Core" }