refactor: update extension functions

Author: adrielcafe

README.md

@@ -114,9 +114,9 @@ But unlike `SharedPreferences`, there's no `apply()` or `commit()`. Changes are
 ### Threading
 PufferDB uses a [ConcurrentHashMap](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentHashMap.html) to manage a thread-safe in-memory cache for fast read and write operations.
 
-Changes are saved asynchronously with the help of a [Conflated Channel](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.channels/-channel/index.html) (to save the most recent state in a race condition) and [Mutex](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.sync/-mutex/index.html) locker (to prevent simultaneous writes).
+Changes are saved asynchronously with the help of a [StateFlow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html) (to save the most recent state in a race condition) and [Mutex](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.sync/-mutex/index.html) locker (to prevent simultaneous writes).
 
-It is possible to run the API methods on the Android Main Thread, but you should *avoid that*. You can use one of the wrapper modules or built in extension functions for that.
+It is possible to run the API methods on the Android Main Thread, but you should *avoid that*. You can use one of the wrapper modules or built in extension functions for that (listed below).
 
 ## Android
 The Android module contains an `AndroidPufferDB` helper class:
@@ -182,10 +182,9 @@ launch {
 
         val myValue = getAsync<String>("myKey").await()
 
-        // You can use your custom coroutine context...
-        putSuspend("myOtherKey", 123, Dispatchers.Unconfined)
+        // You can use your own coroutine scope and dispatcher
+        putSuspend("myOtherKey", 123, myCoroutineScope, myCoroutineDispatcher)
 
-        // ... And your custom coroutine scope
         putAsync("myOtherKey", 123, myActivityScope).await()
     }
 }

coroutines/src/main/kotlin/cafe/adriel/pufferdb/coroutines/CoroutineExtensions.kt

@@ -2,13 +2,18 @@ package cafe.adriel.pufferdb.coroutines
 
 import kotlin.coroutines.CoroutineContext
 import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.async
 import kotlinx.coroutines.withContext
 
-internal suspend fun <T> runSuspend(context: CoroutineContext? = null, body: suspend CoroutineScope.() -> T) =
-    withContext(context ?: Dispatchers.IO) { body() }
+internal suspend fun <T> runSuspend(
+    context: CoroutineContext,
+    body: suspend CoroutineScope.() -> T
+) =
+    withContext(context) { body() }
 
-internal fun <T> runAsync(scope: CoroutineScope? = null, body: suspend CoroutineScope.() -> T) =
-    (scope ?: GlobalScope).async { body() }
+internal fun <T> runAsync(
+    scope: CoroutineScope,
+    dispatcher: CoroutineContext,
+    body: suspend CoroutineScope.() -> T
+) =
+    scope.async(dispatcher) { body() }

coroutines/src/main/kotlin/cafe/adriel/pufferdb/coroutines/CoroutinePufferDB.kt

@@ -10,7 +10,7 @@ import kotlinx.coroutines.GlobalScope
 class CoroutinePufferDB private constructor(
     pufferFile: File,
     scope: CoroutineScope,
-    dispatcher: CoroutineContext
+    private val dispatcher: CoroutineContext
 ) : CoroutinePuffer {
 
     companion object {
@@ -28,15 +28,21 @@ class CoroutinePufferDB private constructor(
 
     private val puffer by lazy { PufferDB.with(pufferFile, scope, dispatcher) }
 
-    override suspend fun <T : Any> get(key: String, defaultValue: T?) = puffer.suspendGet(key, defaultValue)
+    override suspend fun <T : Any> get(key: String, defaultValue: T?) =
+        puffer.getSuspend(key, defaultValue, dispatcher)
 
-    override suspend fun <T : Any> put(key: String, value: T) = puffer.suspendPut(key, value)
+    override suspend fun <T : Any> put(key: String, value: T) =
+        puffer.putSuspend(key, value, dispatcher)
 
-    override suspend fun getKeys(): Set<String> = puffer.suspendGetKeys()
+    override suspend fun getKeys(): Set<String> =
+        puffer.getKeysSuspend(dispatcher)
 
-    override suspend fun contains(key: String) = puffer.suspendContains(key)
+    override suspend fun contains(key: String) =
+        puffer.containsSuspend(key, dispatcher)
 
-    override suspend fun remove(key: String) = puffer.suspendRemove(key)
+    override suspend fun remove(key: String) =
+        puffer.removeSuspend(key, dispatcher)
 
-    override suspend fun removeAll() = puffer.suspendRemoveAll()
+    override suspend fun removeAll() =
+        puffer.removeAllSuspend(dispatcher)
 }

coroutines/src/main/kotlin/cafe/adriel/pufferdb/coroutines/PufferExtensions.kt

@@ -3,43 +3,71 @@ package cafe.adriel.pufferdb.coroutines
 import cafe.adriel.pufferdb.core.Puffer
 import kotlin.coroutines.CoroutineContext
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.GlobalScope
 
 // Suspend functions
+suspend fun <T : Any> Puffer.getSuspend(
+    key: String,
+    defaultValue: T? = null,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runSuspend(dispatcher) { get(key, defaultValue) }
 
-suspend fun <T : Any> Puffer.suspendGet(key: String, defaultValue: T? = null, context: CoroutineContext? = null) =
-    runSuspend(context) { get(key, defaultValue) }
+suspend fun <T : Any> Puffer.putSuspend(key: String, value: T, dispatcher: CoroutineContext = Dispatchers.IO) =
+    runSuspend(dispatcher) { put(key, value) }
 
-suspend fun <T : Any> Puffer.suspendPut(key: String, value: T, context: CoroutineContext? = null) =
-    runSuspend(context) { put(key, value) }
+suspend fun Puffer.getKeysSuspend(dispatcher: CoroutineContext = Dispatchers.IO) =
+    runSuspend(dispatcher) { getKeys() }
 
-suspend fun Puffer.suspendGetKeys(context: CoroutineContext? = null) =
-    runSuspend(context) { getKeys() }
+suspend fun Puffer.containsSuspend(key: String, dispatcher: CoroutineContext = Dispatchers.IO) =
+    runSuspend(dispatcher) { contains(key) }
 
-suspend fun Puffer.suspendContains(key: String, context: CoroutineContext? = null) =
-    runSuspend(context) { contains(key) }
+suspend fun Puffer.removeSuspend(key: String, dispatcher: CoroutineContext = Dispatchers.IO) =
+    runSuspend(dispatcher) { remove(key) }
 
-suspend fun Puffer.suspendRemove(key: String, context: CoroutineContext? = null) =
-    runSuspend(context) { remove(key) }
-
-suspend fun Puffer.suspendRemoveAll(context: CoroutineContext? = null) =
-    runSuspend(context) { removeAll() }
+suspend fun Puffer.removeAllSuspend(dispatcher: CoroutineContext = Dispatchers.IO) =
+    runSuspend(dispatcher) { removeAll() }
 
 // Async functions
+fun <T : Any> Puffer.getAsync(
+    key: String,
+    defaultValue: T? = null,
+    scope: CoroutineScope = GlobalScope,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runAsync(scope, dispatcher) { get(key, defaultValue) }
 
-fun <T : Any> Puffer.getAsync(key: String, defaultValue: T? = null, scope: CoroutineScope? = null) =
-    runAsync(scope) { get(key, defaultValue) }
-
-fun <T : Any> Puffer.putAsync(key: String, value: T, scope: CoroutineScope? = null) =
-    runAsync(scope) { put(key, value) }
+fun <T : Any> Puffer.putAsync(
+    key: String,
+    value: T,
+    scope: CoroutineScope = GlobalScope,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runAsync(scope, dispatcher) { put(key, value) }
 
-fun Puffer.getKeysAsync(scope: CoroutineScope? = null) =
-    runAsync(scope) { getKeys() }
+fun Puffer.getKeysAsync(
+    scope: CoroutineScope = GlobalScope,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runAsync(scope, dispatcher) { getKeys() }
 
-fun Puffer.containsAsync(key: String, scope: CoroutineScope? = null) =
-    runAsync(scope) { contains(key) }
+fun Puffer.containsAsync(
+    key: String,
+    scope: CoroutineScope = GlobalScope,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runAsync(scope, dispatcher) { contains(key) }
 
-fun Puffer.removeAsync(key: String, scope: CoroutineScope? = null) =
-    runAsync(scope) { remove(key) }
+fun Puffer.removeAsync(
+    key: String,
+    scope: CoroutineScope = GlobalScope,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runAsync(scope, dispatcher) { remove(key) }
 
-fun Puffer.removeAllAsync(scope: CoroutineScope? = null) =
-    runAsync(scope) { removeAll() }
+fun Puffer.removeAllAsync(
+    scope: CoroutineScope = GlobalScope,
+    dispatcher: CoroutineContext = Dispatchers.IO
+) =
+    runAsync(scope, dispatcher) { removeAll() }