├── .gitignore ├── DatastoreExt ├── .gitignore ├── build.gradle ├── consumer-rules.pro ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── me │ │ └── msoul │ │ └── datastore │ │ ├── DefaultOfTest.kt │ │ ├── MultipleWriteTest.kt │ │ ├── SingleWriteTest.kt │ │ └── TestHelpers.kt │ └── main │ ├── AndroidManifest.xml │ └── java │ └── me │ └── msoul │ └── datastore │ ├── Core.kt │ └── Extensions.kt ├── LICENSE.txt ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ └── main │ ├── AndroidManifest.xml │ ├── java │ └── me │ │ └── msoul │ │ └── datastore_sample │ │ ├── MainActivity.kt │ │ └── Utils.kt │ └── res │ ├── drawable-v24 │ └── ic_launcher_foreground.xml │ ├── drawable │ └── ic_launcher_background.xml │ ├── layout │ └── activity_main.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.xml │ ├── mipmap-hdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-mdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-xhdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-xxhdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-xxxhdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── values-night │ └── themes.xml │ └── values │ ├── colors.xml │ ├── strings.xml │ └── themes.xml ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /.idea 4 | /local.properties 5 | /.idea/caches 6 | /.idea/libraries 7 | /.idea/modules.xml 8 | /.idea/workspace.xml 9 | /.idea/navEditor.xml 10 | /.idea/assetWizardSettings.xml 11 | .DS_Store 12 | /build 13 | /captures 14 | .externalNativeBuild 15 | .cxx 16 | local.properties 17 | -------------------------------------------------------------------------------- /DatastoreExt/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /DatastoreExt/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.library' 3 | id 'kotlin-android' 4 | } 5 | 6 | android { 7 | compileSdkVersion 30 8 | buildToolsVersion "30.0.3" 9 | 10 | defaultConfig { 11 | minSdkVersion 21 12 | targetSdkVersion 30 13 | versionCode 1 14 | versionName "1.0" 15 | 16 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 17 | consumerProguardFiles "consumer-rules.pro" 18 | } 19 | 20 | buildTypes { 21 | release { 22 | minifyEnabled false 23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 24 | } 25 | } 26 | compileOptions { 27 | sourceCompatibility JavaVersion.VERSION_1_8 28 | targetCompatibility JavaVersion.VERSION_1_8 29 | } 30 | kotlinOptions { 31 | jvmTarget = '1.8' 32 | } 33 | } 34 | 35 | dependencies { 36 | implementation "androidx.datastore:datastore-preferences:1.0.0-beta02" 37 | testImplementation 'junit:junit:4.13.2' 38 | androidTestImplementation 'androidx.test.ext:junit:1.1.2' 39 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0' 40 | } -------------------------------------------------------------------------------- /DatastoreExt/consumer-rules.pro: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/msoultanidis/DatastoreExt/aac16853ccd14b27e9936446824bdd43d90e473b/DatastoreExt/consumer-rules.pro -------------------------------------------------------------------------------- /DatastoreExt/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /DatastoreExt/src/androidTest/java/me/msoul/datastore/DefaultOfTest.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore 2 | 3 | import androidx.test.ext.junit.runners.AndroidJUnit4 4 | import org.junit.Assert.assertTrue 5 | import org.junit.Test 6 | import org.junit.runner.RunWith 7 | 8 | @RunWith(AndroidJUnit4::class) 9 | class DefaultOfTest { 10 | @Test 11 | fun test() { 12 | assertTrue("Default pref has not been set properly", defaultOf() == Language.ENGLISH) 13 | assertTrue( 14 | "defaultOf does not fallback to the first entry", 15 | defaultOf() == LanguageWithoutDefault.values().first() 16 | ) 17 | assertTrue( 18 | "defaultOf does not throw exception for empty enums.", 19 | runCatching { defaultOf() }.getOrNull() == null 20 | ) 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /DatastoreExt/src/androidTest/java/me/msoul/datastore/MultipleWriteTest.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore 2 | 3 | import androidx.datastore.core.DataStore 4 | import androidx.datastore.preferences.core.Preferences 5 | import androidx.test.ext.junit.runners.AndroidJUnit4 6 | import androidx.test.platform.app.InstrumentationRegistry 7 | import kotlinx.coroutines.flow.first 8 | import kotlinx.coroutines.runBlocking 9 | import org.junit.Assert.assertTrue 10 | import org.junit.Before 11 | import org.junit.Test 12 | import org.junit.runner.RunWith 13 | 14 | @RunWith(AndroidJUnit4::class) 15 | class MultipleWriteTest { 16 | lateinit var dataStore: DataStore 17 | 18 | @Before 19 | fun prepare() { 20 | dataStore = InstrumentationRegistry.getInstrumentation().context.dataStore 21 | } 22 | 23 | @Test 24 | fun test() = runBlocking { 25 | val expectedLanguage = Language.TURKISH 26 | val expectedDarkMode = defaultOf() 27 | 28 | dataStore.setEnums(expectedDarkMode, expectedLanguage, LanguageWithoutDefault.GREEK) 29 | 30 | val actualLanguage = dataStore.getEnum().first() 31 | val actualLanguage2 = dataStore.getEnum().first() 32 | val actualDarkMode = dataStore.getEnum().first() 33 | 34 | assertTrue("Language without default was not set properly", actualLanguage2 == LanguageWithoutDefault.GREEK) 35 | assertTrue("Language was not set properly", actualLanguage == expectedLanguage) 36 | assertTrue("DarkMode was not set properly", actualDarkMode == expectedDarkMode) 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /DatastoreExt/src/androidTest/java/me/msoul/datastore/SingleWriteTest.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore 2 | 3 | import androidx.datastore.core.DataStore 4 | import androidx.datastore.preferences.core.Preferences 5 | import androidx.test.ext.junit.runners.AndroidJUnit4 6 | import androidx.test.platform.app.InstrumentationRegistry 7 | import kotlinx.coroutines.flow.first 8 | import kotlinx.coroutines.runBlocking 9 | import org.junit.Assert.assertTrue 10 | import org.junit.Before 11 | import org.junit.Test 12 | import org.junit.runner.RunWith 13 | 14 | @RunWith(AndroidJUnit4::class) 15 | class SingleWriteTest { 16 | lateinit var dataStore: DataStore 17 | 18 | @Before 19 | fun prepare() { 20 | dataStore = InstrumentationRegistry.getInstrumentation().context.dataStore 21 | } 22 | 23 | @Test 24 | fun test() = runBlocking { 25 | val expected = Language.SPANISH 26 | 27 | dataStore.setEnum(expected) 28 | 29 | val actual = dataStore.getEnum().first() 30 | 31 | assertTrue("Preference was not set properly", actual == expected) 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /DatastoreExt/src/androidTest/java/me/msoul/datastore/TestHelpers.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore 2 | 3 | import android.content.Context 4 | import androidx.datastore.preferences.preferencesDataStore 5 | 6 | val Context.dataStore by preferencesDataStore("test_preferences") 7 | 8 | enum class DarkMode : EnumPreference by key("dark_mode") { 9 | ENABLED, 10 | DISABLED { override val isDefault = true }, 11 | } 12 | 13 | enum class Language : EnumPreference by key("language") { 14 | GREEK, 15 | ENGLISH { override val isDefault = true }, 16 | SPANISH, 17 | TURKISH, 18 | } 19 | 20 | enum class LanguageWithoutDefault : EnumPreference by key("language_no_default") { 21 | GREEK, 22 | ENGLISH, 23 | SPANISH, 24 | TURKISH, 25 | } 26 | 27 | enum class EmptyEnum : EnumPreference by key("empty_enum") 28 | -------------------------------------------------------------------------------- /DatastoreExt/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | -------------------------------------------------------------------------------- /DatastoreExt/src/main/java/me/msoul/datastore/Core.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore 2 | 3 | /** 4 | * Represents an [Enum] preference. Requires a [String] key. 5 | */ 6 | interface EnumPreference { 7 | val key: String 8 | val isDefault: Boolean 9 | } 10 | 11 | /** 12 | * Function used to delegate implementation of the [EnumPreference] interface. 13 | * 14 | * @param key A [String] key which will be used as the name of the preference. Must be unique. 15 | * @return Implementation of the [EnumPreference] interface. 16 | */ 17 | fun key(key: String): EnumPreference { 18 | return object : EnumPreference { 19 | override val key = key 20 | override val isDefault: Boolean = false 21 | } 22 | } 23 | 24 | /** 25 | * Returns an enum entry with specified name or null if no such entry exists. 26 | */ 27 | inline fun > enumValueOfOrNull(value: String): T? { 28 | return runCatching { enumValueOf(value) }.getOrNull() 29 | } 30 | 31 | /** 32 | * Returns the default entry of an [EnumPreference] or the first if a default has not been set. 33 | * @throws [EmptyEnumPreferenceException] if the enum has no entries. 34 | */ 35 | inline fun defaultOf(): T where T : Enum, T : EnumPreference { 36 | val values = enumValues() 37 | return values.find { it.isDefault } ?: values.firstOrNull() ?: throw EmptyEnumPreferenceException(T::class.java.simpleName) 38 | } 39 | 40 | class EmptyEnumPreferenceException(enumName: String) : Exception("Enum $enumName has no entries and thus cannot be used as a preference.") 41 | -------------------------------------------------------------------------------- /DatastoreExt/src/main/java/me/msoul/datastore/Extensions.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore 2 | 3 | import androidx.datastore.core.DataStore 4 | import androidx.datastore.preferences.core.* 5 | import kotlinx.coroutines.flow.Flow 6 | import kotlinx.coroutines.flow.catch 7 | import kotlinx.coroutines.flow.map 8 | import java.io.IOException 9 | 10 | val EnumPreference.preferenceKey get() = stringPreferencesKey(key) 11 | 12 | /** 13 | * Returns the stored value of an [EnumPreference] or its default if the preference has not been set yet. 14 | * For use while transforming [DataStore.data]. 15 | * 16 | * @throws [EmptyEnumPreferenceException] if the enum has no entries. 17 | */ 18 | inline fun Preferences.getEnum(default: T = defaultOf()): T where T : Enum, T : EnumPreference { 19 | val name = this[default.preferenceKey] ?: return default 20 | return enumValueOfOrNull(name) ?: default 21 | } 22 | 23 | /** 24 | * Writes the new value of an [EnumPreference] to [MutablePreferences]. 25 | * For use inside [DataStore.edit] or [DataStore.updateData] 26 | */ 27 | fun MutablePreferences.setEnum(preference: T) where T : Enum<*>, T : EnumPreference { 28 | this[preference.preferenceKey] = preference.name 29 | } 30 | 31 | /** 32 | * Writes the new values of many [EnumPreference] to [MutablePreferences]. 33 | * For use inside [DataStore.edit] or [DataStore.updateData] 34 | */ 35 | fun MutablePreferences.setEnums(vararg preferences: EnumPreference) { 36 | for (pref in preferences) { 37 | if (pref is Enum<*>) setEnum(pref) 38 | } 39 | } 40 | 41 | /** 42 | * Returns a [Flow] containing the stored value of an [EnumPreference] or its default if the preference has not been set yet. 43 | * 44 | * @throws [EmptyEnumPreferenceException] if the enum has no entries. 45 | */ 46 | inline fun DataStore.getEnum(): Flow where T : Enum, T : EnumPreference { 47 | val default = defaultOf() 48 | 49 | return data 50 | .catch { 51 | if (it is IOException) { 52 | emit(emptyPreferences()) 53 | } else { 54 | throw it 55 | } 56 | } 57 | .map { preferences -> 58 | preferences.getEnum(default) 59 | } 60 | } 61 | 62 | /** 63 | * Writes the new value of an [EnumPreference] to disk. 64 | * 65 | * @param preference The value to write. 66 | * @throws [IOException] when an exception is encountered when writing data to disk. 67 | */ 68 | suspend fun DataStore.setEnum(preference: T) where T : Enum, T : EnumPreference { 69 | edit { it.setEnum(preference) } 70 | } 71 | 72 | /** 73 | * Writes the values of many [EnumPreference] to disk. 74 | * 75 | * @param preferences The values to write. 76 | * @throws [IOException] when an exception is encountered when writing data to disk. 77 | */ 78 | suspend fun DataStore.setEnums(vararg preferences: EnumPreference) { 79 | edit { it.setEnums(*preferences) } 80 | } 81 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DatastoreExt 2 | 3 | DatastoreExt is a small library on top of AndroidX DataStore which makes persisting Enum preferences a bit easier by reducing boilerplate code. 4 | 5 | 6 | ## Get the dependency 7 | ### Step 1. Add the JitPack repository to your build file 8 | ``` 9 | allprojects { 10 | repositories { 11 | ... 12 | maven { url 'https://jitpack.io' } 13 | } 14 | } 15 | ``` 16 | ### Step 2. Add the dependency 17 | ``` 18 | dependencies { 19 | implementation 'me.msoul:datastoreext:1.0.0' 20 | } 21 | ``` 22 | 23 | 24 | ## Define your enums 25 | 26 | ```kotlin 27 | enum class Language(val countryCode: String) : EnumPreference by key("language") { 28 | GREEK ("gr"), 29 | ENGLISH ("en") { override val isDefault = true }, 30 | ITALIAN ("it"), 31 | } 32 | 33 | enum class Syncing : EnumPreference by key("syncing") { 34 | ENABLED, 35 | DISABLED { override val isDefault = true }, // Setting a default is optional 36 | } 37 | ``` 38 | 39 | ## Store enum values 40 | 41 | ### One at a time 42 | 43 | ```kotlin 44 | val language = Language.GREEK 45 | dataStore.setEnum(language) 46 | 47 | // Or you can do the following if you want to set other preferences too at the same time 48 | dataStore.edit { preferences -> 49 | preferences[SOME_KEY] = "SOME_VALUE" 50 | preferences[OTHER_KEY] = "OTHER_VALUE" 51 | preferences.setEnum(language) 52 | } 53 | ``` 54 | 55 | ### Multiple at the same time 56 | 57 | ```kotlin 58 | val language = Language.GREEK 59 | // You can use the defaultOf() function to retrieve the enum constant you have set as the default. 60 | // It's useful when you want to reset preferences back to their default 61 | val syncingStatus = defaultOf() 62 | dataStore.setEnums(language, syncingStatus) 63 | 64 | // Or you can do the following if you want to set other preferences too at the same time 65 | dataStore.edit { preferences -> 66 | preferences[SOME_KEY] = "SOME_VALUE" 67 | preferences[OTHER_KEY] = "OTHER_VALUE" 68 | preferences.setEnums(language, syncingStatus) 69 | } 70 | ``` 71 | 72 | ## Retrieve a `Flow` which emits the latest value 73 | ```kotlin 74 | dataStore.getEnum().collect { 75 | textView.text = "The country code of the preferred language is [${it.countryCode}]" 76 | } 77 | 78 | // Or you can do the following if you want to retrieve multiple preferences from the same flow 79 | dataStore.data.map { preferences -> 80 | AppPreferences( // Some data class 81 | preferences[SOME_KEY], 82 | preferences[OTHER_KEY], 83 | preferences.getEnum(), 84 | ) 85 | } 86 | ``` 87 | 88 | ## Example: Create a dialog that can be used to set multiple preferences 89 | ```kotlin 90 | inline fun Activity.showPreferenceDialog( 91 | title: String, // or a string resource ID 92 | selected: T, // the enum entry that should be selected by default when showing the dialog 93 | ) where T : Enum, T : EnumPreference { 94 | val enumValues = enumValues() 95 | val selectedIndex = enumValues.indexOf(selected) 96 | val items = enumValues 97 | .map { it.name } // You could also store the string resource ID of each enum entry inside via its constructor 98 | .toTypedArray() 99 | 100 | MaterialAlertDialogBuilder(this) 101 | .setTitle(title) 102 | .setSingleChoiceItems(items, selectedIndex) { dialogInterface, which -> 103 | dialogInterface.dismiss() 104 | 105 | // Ideally you would want to pass an onClick lambda to this function and handle this in the ViewModel 106 | // Don't do the following in production! 107 | runBlocking { dataStore.setEnum(enumValues[which]) } 108 | } 109 | .setPositiveButton("Done") { dialogInterface, i -> 110 | dialogInterface.dismiss() 111 | } 112 | .show() 113 | } 114 | ``` 115 | 116 | 117 | # License 118 | ``` 119 | Copyright (C) 2021 Michael Soultanidis 120 | 121 | Licensed under the Apache License, Version 2.0 (the "License"); 122 | you may not use this file except in compliance with the License. 123 | You may obtain a copy of the License at 124 | 125 | http://www.apache.org/licenses/LICENSE-2.0 126 | 127 | Unless required by applicable law or agreed to in writing, software 128 | distributed under the License is distributed on an "AS IS" BASIS, 129 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 130 | See the License for the specific language governing permissions and 131 | limitations under the License. 132 | ``` -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | } 5 | 6 | android { 7 | compileSdkVersion 30 8 | buildToolsVersion "30.0.3" 9 | 10 | defaultConfig { 11 | applicationId "me.msoul.datastore_sample" 12 | minSdkVersion 21 13 | targetSdkVersion 30 14 | versionCode 1 15 | versionName "1.0" 16 | 17 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 18 | } 19 | 20 | buildTypes { 21 | release { 22 | minifyEnabled false 23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 24 | } 25 | } 26 | compileOptions { 27 | sourceCompatibility JavaVersion.VERSION_1_8 28 | targetCompatibility JavaVersion.VERSION_1_8 29 | } 30 | kotlinOptions { 31 | jvmTarget = '1.8' 32 | } 33 | } 34 | 35 | repositories { 36 | maven { url 'https://jitpack.io' } 37 | } 38 | 39 | dependencies { 40 | implementation 'me.msoul:datastoreext:0.1.0' 41 | implementation "androidx.datastore:datastore-preferences:1.0.0-beta02" 42 | 43 | implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.3.1" 44 | implementation "androidx.lifecycle:lifecycle-common-java8:2.3.1" 45 | 46 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 47 | implementation 'androidx.core:core-ktx:1.5.0' 48 | implementation 'androidx.appcompat:appcompat:1.3.0' 49 | implementation 'com.google.android.material:material:1.3.0' 50 | implementation 'androidx.constraintlayout:constraintlayout:2.0.4' 51 | testImplementation 'junit:junit:4.+' 52 | androidTestImplementation 'androidx.test.ext:junit:1.1.2' 53 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0' 54 | } -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /app/src/main/java/me/msoul/datastore_sample/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore_sample 2 | 3 | import android.os.Bundle 4 | import android.widget.Button 5 | import android.widget.TextView 6 | import androidx.appcompat.app.AppCompatActivity 7 | import androidx.lifecycle.lifecycleScope 8 | import kotlinx.coroutines.flow.collect 9 | import me.msoul.datastore.defaultOf 10 | import me.msoul.datastore.getEnum 11 | 12 | class MainActivity : AppCompatActivity() { 13 | private var currentLanguage = defaultOf() 14 | private var syncingStatus = defaultOf() 15 | 16 | lateinit var textView: TextView 17 | lateinit var buttonSetLanguage: Button 18 | lateinit var buttonSetSyncing: Button 19 | 20 | override fun onCreate(savedInstanceState: Bundle?) { 21 | super.onCreate(savedInstanceState) 22 | setContentView(R.layout.activity_main) 23 | 24 | textView = findViewById(R.id.textView) 25 | buttonSetLanguage = findViewById(R.id.button) 26 | buttonSetSyncing = findViewById(R.id.button2) 27 | 28 | buttonSetLanguage.setOnClickListener { showPreferenceDialog("Language", currentLanguage) } 29 | buttonSetSyncing.setOnClickListener { showPreferenceDialog("Syncing", syncingStatus) } 30 | 31 | // When collecting flows from UI, it's better to use the new repeatOnLifecycle() API 32 | // This code is for demonstration purposes only and is not safe for production 33 | lifecycleScope.launchWhenStarted { 34 | dataStore.getEnum().collect { 35 | currentLanguage = it 36 | textView.text = "The country code of the preferred language is [${currentLanguage.countryCode}]" 37 | } 38 | } 39 | 40 | lifecycleScope.launchWhenStarted { 41 | dataStore.getEnum().collect { 42 | syncingStatus = it 43 | buttonSetSyncing.text = "Syncing is $syncingStatus" 44 | } 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /app/src/main/java/me/msoul/datastore_sample/Utils.kt: -------------------------------------------------------------------------------- 1 | package me.msoul.datastore_sample 2 | 3 | import android.app.Activity 4 | import android.content.Context 5 | import androidx.datastore.preferences.preferencesDataStore 6 | import com.google.android.material.dialog.MaterialAlertDialogBuilder 7 | import kotlinx.coroutines.runBlocking 8 | import me.msoul.datastore.EnumPreference 9 | import me.msoul.datastore.key 10 | import me.msoul.datastore.setEnum 11 | 12 | enum class Language(val countryCode: String) : EnumPreference by key("language") { 13 | GREEK("gr"), 14 | ENGLISH("en") { override val isDefault = true }, 15 | ITALIAN("it"), 16 | } 17 | 18 | enum class Syncing : EnumPreference by key("syncing") { 19 | ENABLED, 20 | DISABLED { override val isDefault = true }, 21 | } 22 | 23 | val Context.dataStore by preferencesDataStore("prefs") 24 | 25 | inline fun Activity.showPreferenceDialog( 26 | title: String, // or a string resource ID 27 | selected: T, 28 | ) where T : Enum, T : EnumPreference { 29 | val enumValues = enumValues() 30 | val selectedIndex = enumValues.indexOf(selected) 31 | val items = enumValues 32 | .map { it.name } // You could also store the string resource ID of each enum entry inside via its constructor 33 | .toTypedArray() 34 | 35 | MaterialAlertDialogBuilder(this) 36 | .setTitle(title) 37 | .setSingleChoiceItems(items, selectedIndex) { dialogInterface, which -> 38 | dialogInterface.dismiss() 39 | 40 | // Ideally you would want to pass an onClick lambda to this function and handle this in the ViewModel 41 | // Don't do the following in production! 42 | runBlocking { dataStore.setEnum(enumValues[which]) } 43 | } 44 | .setPositiveButton("Done") { dialogInterface, i -> 45 | dialogInterface.dismiss() 46 | } 47 | .show() 48 | } 49 | -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 9 | 10 | 16 | 19 | 22 | 23 | 24 | 25 | 31 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 10 | 12 | 14 | 16 | 18 | 20 | 22 | 24 | 26 | 28 | 30 | 32 | 34 | 36 | 38 | 40 | 42 | 44 | 46 | 48 | 50 | 52 | 54 | 56 | 58 | 60 | 62 | 64 | 66 | 68 | 70 | 72 | 74 | 75 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 9 | 18 |