Compose Helper

* Add compose helper library.
* Add setBlocking to Preference.
* Add defaultValue() to Preference.

Author: rumboalla

README.md

@@ -14,7 +14,7 @@ maven { url = uri("https://www.jitpack.io" ) }
 ```
 Import the library
 ```kotlin
-implementation("com.github.rumboalla.kryptostore:core:0.1.1")
+implementation("com.github.rumboalla.kryptostore:core:0.1.2")
 ```
 Use preferences
 ```kotlin
@@ -60,7 +60,7 @@ suspend fun doSomething(context: Context) {
 ## Advanced Usage
 Import the gson library for serialization
 ```kotlin
-implementation("com.github.rumboalla.kryptostore:gson:0.1.1")
+implementation("com.github.rumboalla.kryptostore:gson:0.1.2")
 ```
 Use serialized preferences
 ```kotlin
@@ -90,7 +90,7 @@ suspend fun doSomething(context: Context) {
 ## Encryption
 Import the library for encryption
 ```kotlin
-implementation("com.github.rumboalla.kryptostore:keystore:0.1.1")
+implementation("com.github.rumboalla.kryptostore:keystore:0.1.2")
 ```
 Use encrypted preferences
 ```kotlin
@@ -117,6 +117,37 @@ suspend fun doSomething(context: Context) {
 }
 ```
 
+## Compose
+Extensions for compose. Import the library
+```kotlin
+implementation("com.github.rumboalla.kryptostore:compose:0.1.2")
+```
+Use it
+```kotlin
+import android.content.Context
+import androidx.compose.runtime.Composable
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.preferencesDataStore
+import com.github.rumboalla.kryptostore.preference.booleanPref
+
+private val Context.store: DataStore<Preferences> by preferencesDataStore(name = "prefs")
+
+class Prefs(context: Context) {
+    val boolean = booleanPref(context.store, "boolean", true)
+}
+
+@Composable
+fun Component(prefs: Prefs) {
+    val state = prefs.boolean.collectAsStateWithLifecycle()
+    if (state.value) {
+        Text("Pref is true.")
+    } else {
+        Text("Pref is false.")
+    }
+}
+```
+
 ## Roadmap
 * More serialization options: Moshi, kotlinx.serialization.
 * More encryption options.

compose/.gitignore

@@ -0,0 +1 @@
+/build

compose/build.gradle.kts

@@ -0,0 +1,60 @@
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+    id("maven-publish")
+}
+
+android {
+    namespace = "com.github.rumboalla.kryptostore.compose"
+    compileSdk = 34
+
+    defaultConfig {
+        minSdk = 21
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+
+    testOptions {
+        targetSdk = 34
+    }
+}
+
+dependencies {
+    api(project(":core"))
+    api("androidx.compose.ui:ui:1.6.4")
+    api("androidx.lifecycle:lifecycle-runtime-compose:2.7.0")
+
+    testImplementation("junit:junit:4.13.2")
+
+    androidTestImplementation(project(":core"))
+    androidTestImplementation("androidx.test:runner:1.5.2")
+    androidTestImplementation("androidx.test.ext:junit:1.1.5")
+}
+
+afterEvaluate {
+    publishing {
+        publications {
+            create<MavenPublication>("maven") {
+                groupId = "com.github.rumboalla.kryptostore"
+                artifactId = "compose"
+                version = "0.1.2"
+                from(components["release"])
+            }
+        }
+    }
+}

compose/proguard-rules.pro

@@ -0,0 +1,32 @@
+package com.github.rumboalla.kryptostore.compose
+
+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.preferencesDataStore
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import kotlinx.coroutines.runBlocking
+import org.junit.Test
+import org.junit.runner.RunWith
+
+
+private val Context.store: DataStore<Preferences> by preferencesDataStore(name = "test")
+
+@RunWith(AndroidJUnit4::class)
+class KryptoStoreGsonInstrumentedTest {
+
+    private val context = InstrumentationRegistry.getInstrumentation().targetContext
+
+    init {
+        // Clears the datastore
+        runBlocking { context.store.edit { it.clear() } }
+    }
+
+    @Test
+    fun testCompose() = runBlocking {
+
+    }
+
+}

compose/src/androidTest/kotlin/com/github/rumboalla/kryptostore/compose/KryptoStoreComposeInstrumentedTest.kt

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest/>

compose/src/main/AndroidManifest.xml

@@ -0,0 +1,12 @@
+package com.github.rumboalla.kryptostore.compose
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.State
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
+import com.github.rumboalla.kryptostore.preference.Preference
+
+
+@Composable
+fun <T> Preference<T>.collectAsStateWithLifecycle(): State<T> {
+    return this.flow().collectAsStateWithLifecycle(defaultValue())
+}

compose/src/main/kotlin/com/github/rumboalla/kryptostore/compose/ComposeHelper.kt

@@ -49,7 +49,7 @@ afterEvaluate {
             create<MavenPublication>("maven") {
                 groupId = "com.github.rumboalla.kryptostore"
                 artifactId = "core"
-                version = "0.1.1"
+                version = "0.1.2"
                 from(components["release"])
             }
         }

core/build.gradle.kts

@@ -23,4 +23,5 @@ open class GenericPreference<T>(
     override suspend fun get() = flow.first()
     override suspend fun set(v: T) { store.edit { it[key] = transform.transform(v) } }
     override fun flow() = flow
+    override fun defaultValue(): T = defValue
 }

core/src/main/kotlin/com/github/rumboalla/kryptostore/preference/GenericPreference.kt

@@ -35,4 +35,19 @@ interface Preference<T> {
      */
     @DangerousApi
     fun getBlocking() = runBlocking { get() }
+
+    /**
+     * Sets the value of a preference. This call blocks until the preference is set.
+     *
+     * @param   v   {@T}   Value {@T} to set in the preference.
+     */
+    @DangerousApi
+    fun setBlocking(v: T) = runBlocking { set(v) }
+
+    /**
+     * Gets the default value of a preference.
+     *
+     * @return  {@T}  Value of the preference.
+     */
+    fun defaultValue(): T
 }

core/src/main/kotlin/com/github/rumboalla/kryptostore/preference/Preference.kt

@@ -17,4 +17,5 @@ open class PrimitivePreference<T>(
     override suspend fun get() = flow.first()
     override suspend fun set(v: T) { store.edit { it[key] = v } }
     override fun flow() = flow
+    override fun defaultValue(): T = defValue
 }

core/src/main/kotlin/com/github/rumboalla/kryptostore/preference/PrimitivePreference.kt

@@ -51,7 +51,7 @@ afterEvaluate {
             create<MavenPublication>("maven") {
                 groupId = "com.github.rumboalla.kryptostore"
                 artifactId = "gson"
-                version = "0.1.1"
+                version = "0.1.2"
                 from(components["release"])
             }
         }

gson/build.gradle.kts

@@ -50,7 +50,7 @@ afterEvaluate {
             create<MavenPublication>("maven") {
                 groupId = "com.github.rumboalla.kryptostore"
                 artifactId = "keystore"
-                version = "0.1.1"
+                version = "0.1.2"
                 from(components["release"])
             }
         }

keystore/build.gradle.kts

@@ -19,3 +19,4 @@ rootProject.name = "KryptoStore"
 include(":core")
 include(":gson")
 include(":keystore")
+include(":compose")