Add Preference.update, rename PreferenceImpl to `DataStorePrefere…

…nce`, and more

.github/workflows/check-formatting.yml

@@ -0,0 +1,16 @@
+name: Check formatting
+on:
+  push:
+  pull_request:
+jobs:
+  check-formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: 21
+          distribution: zulu
+      - run: |
+          curl -sSL -o ktfmt.jar https://github.com/facebook/ktfmt/releases/download/v0.53/ktfmt-0.53-jar-with-dependencies.jar
+          java -jar ktfmt.jar --dry-run --kotlinlang-style --set-exit-if-changed .

.gitignore

@@ -1,17 +1,20 @@
 *.iml
 .DS_Store
-.cxx
-.externalNativeBuild
-.gradle
+.cxx/
+.externalNativeBuild/
+/.gradle/
 /.idea/assetWizardSettings.xml
-/.idea/caches
-/.idea/libraries
+/.idea/caches/
+/.idea/compiler.xml
+/.idea/gradle.xml
+/.idea/kotlinc.xml
+/.idea/libraries/
+/.idea/migrations.xml
 /.idea/modules.xml
 /.idea/navEditor.xml
-/.idea/shelf
+/.idea/runConfigurations.xml
+/.idea/shelf/
 /.idea/workspace.xml
-/build
-/captures
-/core/build
-/domain/build
-local.properties
+/build/
+/captures/
+/local.properties

build.gradle.kts

@@ -0,0 +1,5 @@
+plugins {
+    alias(libs.plugins.androidLibrary) apply false
+    alias(libs.plugins.kotlinAndroid) apply false
+    alias(libs.plugins.kotlinJvm) apply false
+}

core/.gitignore

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

core/build.gradle.kts

@@ -0,0 +1,34 @@
+plugins {
+    alias(libs.plugins.androidLibrary)
+    alias(libs.plugins.kotlinAndroid)
+    id("maven-publish")
+}
+
+android {
+    namespace = group.toString()
+    compileSdk = 34
+    defaultConfig { minSdk = 21 }
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"))
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+    kotlinOptions { jvmTarget = JavaVersion.VERSION_17.toString() }
+    publishing { singleVariant("release") { withSourcesJar() } }
+}
+
+kotlin { explicitApi() }
+
+afterEvaluate {
+    publishing { publications { create<MavenPublication>("core") { from(components["release"]) } } }
+}
+
+dependencies {
+    api(project(":domain"))
+    implementation(libs.preferencesDataStore)
+}

core/src/main/kotlin/com/patrykandpatrick/opto/core/DataStorePreference.kt

@@ -0,0 +1,30 @@
+package com.patrykandpatrick.opto.core
+
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.edit
+import com.patrykandpatrick.opto.domain.Preference
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+
+public class DataStorePreference<C, S>(
+    private val key: Preferences.Key<S>,
+    private val defaultValue: C,
+    private val serialize: (C) -> S,
+    private val deserialize: (S) -> C,
+    private val dataStore: DataStore<Preferences>,
+) : Preference<C> {
+    private fun S?.deserializedOrDefault() = if (this != null) deserialize(this) else defaultValue
+
+    public fun get(preferences: Preferences): C = preferences[key].deserializedOrDefault()
+
+    override fun get(): Flow<C> = dataStore.data.map(::get)
+
+    override suspend fun set(value: C) {
+        dataStore.edit { it[key] = serialize(value) }
+    }
+
+    override suspend fun update(function: (C) -> C) {
+        dataStore.edit { it[key] = serialize(function(it[key].deserializedOrDefault())) }
+    }
+}

core/src/main/kotlin/com/patrykandpatrick/opto/core/PreferenceManager.kt

@@ -3,18 +3,17 @@ package com.patrykandpatrick.opto.core
 import androidx.datastore.core.DataStore
 import androidx.datastore.preferences.core.Preferences
 
-interface PreferenceManager {
-    val preferencesDataStore: DataStore<Preferences>
+public interface PreferenceManager {
+    public val dataStore: DataStore<Preferences>
 
-    fun <S> preference(
-        key: Preferences.Key<S>,
-        defaultValue: S,
-    ) = preference(key = key, defaultValue = defaultValue, serialize = { it }, deserialize = { it })
-
-    fun <C, S> preference(
+    public fun <C, S> preference(
         key: Preferences.Key<S>,
         defaultValue: C,
         serialize: (C) -> S,
         deserialize: (S) -> C,
-    ) = PreferenceImpl(key, defaultValue, serialize, deserialize, preferencesDataStore)
+    ): DataStorePreference<C, S> =
+        DataStorePreference(key, defaultValue, serialize, deserialize, dataStore)
+
+    public fun <S> preference(key: Preferences.Key<S>, defaultValue: S): DataStorePreference<S, S> =
+        preference(key = key, defaultValue = defaultValue, serialize = { it }, deserialize = { it })
 }

domain/.gitignore

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

domain/build.gradle.kts

@@ -0,0 +1,17 @@
+plugins {
+    id("java-library")
+    alias(libs.plugins.kotlinJvm)
+    id("maven-publish")
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_17
+    targetCompatibility = JavaVersion.VERSION_17
+    withSourcesJar()
+}
+
+kotlin { explicitApi() }
+
+publishing { publications { create<MavenPublication>("domain") { from(components["java"]) } } }
+
+dependencies { implementation(libs.coroutinesCore) }

domain/src/main/kotlin/com/patrykandpatrick/opto/domain/Preference.kt

@@ -2,8 +2,10 @@ package com.patrykandpatrick.opto.domain
 
 import kotlinx.coroutines.flow.Flow
 
-interface Preference<T> {
-    fun get(): Flow<T>
+public interface Preference<T> {
+    public fun get(): Flow<T>
 
-    suspend fun set(value: T)
+    public suspend fun set(value: T)
+
+    public suspend fun update(function: T.() -> T)
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

settings.gradle.kts

@@ -0,0 +1,26 @@
+pluginManagement {
+    repositories {
+        google {
+            content {
+                includeGroupByRegex("com\\.android.*")
+                includeGroupByRegex("com\\.google.*")
+                includeGroupByRegex("androidx.*")
+            }
+        }
+        gradlePluginPortal()
+        mavenCentral()
+    }
+}
+
+@Suppress("UnstableApiUsage")
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        google()
+        mavenCentral()
+    }
+}
+
+rootProject.name = "Opto"
+
+include(":core", ":domain")