v2.4.0: Multithreading support (fixing #40), kotlin + dependency updates

README.md

@@ -2,7 +2,7 @@
   <a href="https://github.com/cioccarellia/ksprefs" target="_blank"><img width="100" src="https://raw.githubusercontent.com/cioccarellia/ksprefs/master/extras/ksprefs.png"></a>
 </p>
 <h1 align="center">KsPrefs</h1>
-<p align="center">SharedPreferences. 100% Kotlin.</p>
+<p align="center">Secure SharedPreferences</p>
 <p align="center">
   <a href="https://search.maven.org/artifact/com.github.cioccarellia/ksprefs"><img src="https://img.shields.io/maven-central/v/com.github.cioccarellia/ksprefs.svg?label=Maven%20Central" alt="Download from MavenCentral"></a>
   <a href="https://app.circleci.com/pipelines/github/cioccarellia/ksprefs"><img src="https://circleci.com/gh/cioccarellia/ksprefs.svg?style=svg" alt="CircleCI"></a>
@@ -18,7 +18,7 @@
 
 ```gradle
 dependencies {
-    implementation 'com.github.cioccarellia:ksprefs:2.3.2'
+    implementation 'com.github.cioccarellia:ksprefs:2.4.0'
 }
 ```
 </details>
@@ -27,7 +27,7 @@ dependencies {
 
 ```gradle
 dependencies {
-    implementation("com.github.cioccarellia:ksprefs:2.3.2")
+    implementation("com.github.cioccarellia:ksprefs:2.4.0")
 }
 ```
 </details>
@@ -38,7 +38,7 @@ dependencies {
 <dependency>
     <groupId>com.github.cioccarellia</groupId>
     <artifactId>ksprefs</artifactId>
-    <version>2.3.2</version>
+    <version>2.4.0</version>
     <type>pom</type>
 </dependency>
 ```

library/src/main/kotlin/com/cioccarellia/ksprefs/KsPrefs.kt

@@ -100,6 +100,7 @@ class KsPrefs(
      * @param[value] The value to be derived and stored.
      * @param[commitStrategy] The strategy defining how to finalize this operation.
      * */
+    @Synchronized
     fun <T : Any> push(
         key: String,
         value: T,
@@ -124,6 +125,7 @@ class KsPrefs(
      * @param[key] The key for the target field.
      * @param[value] The value to be derived and stored.
      * */
+    @Synchronized
     fun <T : Any> queue(
         key: String,
         value: T
@@ -147,6 +149,7 @@ class KsPrefs(
      * @return The value KsPref got back for the matching key, or [fallback].
      * */
     @CheckResult
+    @Synchronized
     fun <T : Any> pull(
         key: String,
         fallback: T
@@ -178,7 +181,11 @@ class KsPrefs(
     @CheckResult
     inline fun <reified T : Any> pull(
         key: String
-    ): T = dispatcher.pull(key, kclass = T::class)
+    ): T {
+        synchronized(this) {
+            return dispatcher.pull(key, kclass = T::class)
+        }
+    }
 
     /**
      * This function (unsafely) pulls a value from the [Shared Preferences][SharedPreferences] object.
@@ -204,6 +211,7 @@ class KsPrefs(
      * @throws NoSuchKeyException If no value is found for the given [key].
      * */
     @CheckResult
+    @Synchronized
     fun <T : Any> pull(
         key: String,
         kclass: KClass<T>
@@ -233,6 +241,7 @@ class KsPrefs(
      * @throws NoSuchKeyException If no value is found for the given [key].
      * */
     @CheckResult
+    @Synchronized
     fun <T : Any> pull(
         key: String,
         jclass: Class<T>
@@ -259,6 +268,7 @@ class KsPrefs(
      * @return Whether the value exists inside the storage or not.
      * */
     @CheckResult
+    @Synchronized
     fun exists(
         key: String
     ): Boolean = dispatcher.exists(key)
@@ -277,6 +287,7 @@ class KsPrefs(
      *
      * @param[commitStrategy] Optional parameterization for the [commit strategy][KspConfig.commitStrategy].
      * */
+    @Synchronized
     fun save(
         commitStrategy: CommitStrategy = config.commitStrategy
     ): Unit = dispatcher.save(commitStrategy)
@@ -290,6 +301,7 @@ class KsPrefs(
      *
      * @param[key] The key for the target field.
      * */
+    @Synchronized
     fun remove(
         key: String
     ) {
@@ -299,6 +311,7 @@ class KsPrefs(
     /**
      * Calls the [clear()] method on [Shared Preferences][SharedPreferences], and removes all entries.
      * */
+    @Synchronized
     fun clear() {
         dispatcher.clear()
     }

library/src/main/kotlin/com/cioccarellia/ksprefs/extensions/ExceptionExts.kt

@@ -19,6 +19,6 @@ import com.cioccarellia.ksprefs.exceptions.EngineException
 
 internal fun <T> Result<T>.getOrThrowException(
     operation: String = ""
-): T = getOrElse { exception ->
+): T = this.getOrElse { exception ->
     throw EngineException.convertFrom(exception, operation)
 }

library_info.gradle

@@ -21,8 +21,8 @@ ext.library = [
         artifact            : "ksprefs",
 
         publish_group       : "com.github.cioccarellia",
-        publish_version     : "2.3.3",
-        publish_version_code: 233,
+        publish_version     : "2.4.0",
+        publish_version_code: 240,
 
         description         : "Kotlin SharedPreferences, Simplified",
         website             : "https://github.com/cioccarellia/ksprefs"

test/src/main/kotlin/com/cioccarellia/ksprefsample/activities/json/JsonActivity.kt

@@ -16,10 +16,15 @@
 package com.cioccarellia.ksprefsample.activities.json
 
 import android.os.Bundle
+import android.util.Log
 import android.widget.Toast
 import androidx.appcompat.app.AppCompatActivity
 import com.cioccarellia.ksprefsample.App
 import com.cioccarellia.ksprefsample.R
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
 import org.json.JSONObject
 
 class JsonActivity : AppCompatActivity() {
@@ -51,6 +56,28 @@ class JsonActivity : AppCompatActivity() {
             Toast.LENGTH_LONG
         ).show()
 
+
+/*
+        // multithreading tests
+        for (i in 1..1000){
+            CoroutineScope(Dispatchers.Default).launch() {
+                App.prefs.push("xxx", true)
+                val isEnabled = App.prefs.pull("xxx", true)
+                Log.d("Testing", isEnabled.toString())
+            }
+        }
+
+
+
+        for (i in 1..1000){
+            CoroutineScope(Dispatchers.Default).launch() {
+                App.prefs.push("xxx", false)
+                val isEnabled = App.prefs.pull("xxx", true)
+                Log.d("Testing", isEnabled.toString())
+            }
+        }
+*/
+
         finish()
     }
 }

test/src/main/kotlin/com/cioccarellia/ksprefsample/activities/main/MainActivity.kt

@@ -89,6 +89,9 @@ class MainActivity : AppCompatActivity() {
 
             append(App.prefs.internalReport())
         }
+
+
+
     }
 
     private fun KsPrefs.internalReport() = buildString {