From 19020070cc073c81bfe397454f2314d37a78ed31 Mon Sep 17 00:00:00 2001 From: Allan Wang Date: Mon, 8 Oct 2018 01:46:36 -0400 Subject: Enhancement/kpref (#170) * Deprecate kpref double * Update kpref tests and migration * Fix kpref file * Update changelog * Replace changelog angle brackets --- .../kotlin/ca/allanwang/kau/kpref/KPrefTest.kt | 26 +++++--- .../kotlin/ca/allanwang/kau/email/EmailBuilder.kt | 7 ++- .../kotlin/ca/allanwang/kau/kpref/KPrefDelegate.kt | 69 +++++++++++----------- .../ca/allanwang/kau/kpref/KPrefTransaction.kt | 64 ++++++++++++++++++++ docs/Migration.md | 15 ++++- sample/src/main/res/xml/kau_changelog.xml | 4 +- 6 files changed, 137 insertions(+), 48 deletions(-) create mode 100644 core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefTransaction.kt diff --git a/core/src/androidTest/kotlin/ca/allanwang/kau/kpref/KPrefTest.kt b/core/src/androidTest/kotlin/ca/allanwang/kau/kpref/KPrefTest.kt index e806a3f..2a9263a 100644 --- a/core/src/androidTest/kotlin/ca/allanwang/kau/kpref/KPrefTest.kt +++ b/core/src/androidTest/kotlin/ca/allanwang/kau/kpref/KPrefTest.kt @@ -16,40 +16,46 @@ import kotlin.test.assertTrue */ @RunWith(AndroidJUnit4::class) @MediumTest -class ChangelogTest { +class KPrefTest { lateinit var pref: TestPref class TestPref : KPref() { + init { initialize(InstrumentationRegistry.getTargetContext(), "kpref_test_${System.currentTimeMillis()}") } - var one: Int by kpref("one", 1) + var one by kpref("one", 1) + + var two by kpref("two", 2f) - var `true`: Boolean by kpref("true", true) + var `true` by kpref("true", true) - var hello: String by kpref("hello", "hello") + var hello by kpref("hello", "hello") - var set: StringSet by kpref("set", setOf("po", "ta", "to")) + var set by kpref("set", setOf("po", "ta", "to")) - val oneShot: Boolean by kprefSingle("asdf") + val oneShot by kprefSingle("asdf") } @Before fun init() { pref = TestPref() + pref.sp.edit().clear().commit() } @Test fun getDefaults() { assertEquals(1, pref.one) + assertEquals(2f, pref.two) assertEquals(true, pref.`true`) assertEquals("hello", pref.hello) assertEquals(3, pref.set.size) assertTrue(pref.set.contains("po")) assertTrue(pref.set.contains("ta")) assertTrue(pref.set.contains("to")) + assertEquals(0, pref.sp.all.size, "Defaults should not be set automatically") } @Test @@ -60,6 +66,7 @@ class ChangelogTest { pref.hello = "goodbye" assertEquals("goodbye", pref.hello) assertEquals(pref.hello, pref.sp.getString("hello", "hello")) + assertEquals(2, pref.sp.all.size) } @SuppressLint("CommitPrefEdits") @@ -67,12 +74,13 @@ class ChangelogTest { fun reset() { pref.one = 2 assertEquals(2, pref.one) + assertEquals(6, pref.prefMap.size, "Prefmap does not have all elements") pref.reset() //only invalidates our lazy delegate; doesn't change the actual pref - assertEquals(2, pref.one) + assertEquals(2, pref.one, "Kpref did not properly fetch from shared prefs") pref.sp.edit().putInt("one", -1).commit() - assertEquals(2, pref.one) //our lazy delegate still retains the old value + assertEquals(2, pref.one, "Lazy kpref should still retain old value") pref.reset() - assertEquals(-1, pref.one) //back in sync with sp + assertEquals(-1, pref.one, "Kpref did not refetch from shared prefs upon reset") } diff --git a/core/src/main/kotlin/ca/allanwang/kau/email/EmailBuilder.kt b/core/src/main/kotlin/ca/allanwang/kau/email/EmailBuilder.kt index 804eacb..dbdcf09 100644 --- a/core/src/main/kotlin/ca/allanwang/kau/email/EmailBuilder.kt +++ b/core/src/main/kotlin/ca/allanwang/kau/email/EmailBuilder.kt @@ -69,9 +69,14 @@ class EmailBuilder(val email: String, val subject: String) { if (appInfo) { try { val appInfo = context.packageManager.getPackageInfo(context.packageName, 0) + val versionCode = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) { + appInfo.longVersionCode.toString() + } else { + appInfo.versionCode.toString() + } emailBuilder.append("\nApp: ").append(context.packageName) .append("\nApp Version Name: ").append(appInfo.versionName) - .append("\nApp Version Code: ").append(appInfo.versionCode).append("\n") + .append("\nApp Version Code: ").append(versionCode).append("\n") } catch (e: PackageManager.NameNotFoundException) { KL.e { "EmailBuilder packageInfo not found" } } diff --git a/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefDelegate.kt b/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefDelegate.kt index 60d03ad..b80479e 100644 --- a/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefDelegate.kt +++ b/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefDelegate.kt @@ -3,15 +3,29 @@ package ca.allanwang.kau.kpref import ca.allanwang.kau.kotlin.ILazyResettable -fun KPref.kpref(key: String, fallback: Boolean, postSetter: (value: Boolean) -> Unit = {}) = KPrefDelegate(key, fallback, this, postSetter) -fun KPref.kpref(key: String, fallback: Double, postSetter: (value: Float) -> Unit = {}) = KPrefDelegate(key, fallback.toFloat(), this, postSetter) -fun KPref.kpref(key: String, fallback: Float, postSetter: (value: Float) -> Unit = {}) = KPrefDelegate(key, fallback, this, postSetter) -fun KPref.kpref(key: String, fallback: Int, postSetter: (value: Int) -> Unit = {}) = KPrefDelegate(key, fallback, this, postSetter) -fun KPref.kpref(key: String, fallback: Long, postSetter: (value: Long) -> Unit = {}) = KPrefDelegate(key, fallback, this, postSetter) -fun KPref.kpref(key: String, fallback: Set, postSetter: (value: Set) -> Unit = {}) = KPrefDelegate(key, StringSet(fallback), this, postSetter) -fun KPref.kpref(key: String, fallback: String, postSetter: (value: String) -> Unit = {}) = KPrefDelegate(key, fallback, this, postSetter) +fun KPref.kpref(key: String, fallback: Boolean, postSetter: (value: Boolean) -> Unit = {}) = + KPrefDelegate(key, fallback, this, KPrefBooleanTransaction, postSetter) -class StringSet(set: Collection) : LinkedHashSet(set) +fun KPref.kpref(key: String, fallback: Float, postSetter: (value: Float) -> Unit = {}) = + KPrefDelegate(key, fallback, this, KPrefFloatTransaction, postSetter) + +@Deprecated("Double is not supported in SharedPreferences; cast to float yourself", + ReplaceWith("kpref(key, fallback.toFloat(), postSetter)"), + DeprecationLevel.WARNING) +fun KPref.kpref(key: String, fallback: Double, postSetter: (value: Float) -> Unit = {}) = + kpref(key, fallback.toFloat(), postSetter) + +fun KPref.kpref(key: String, fallback: Int, postSetter: (value: Int) -> Unit = {}) = + KPrefDelegate(key, fallback, this, KPrefIntTransaction, postSetter) + +fun KPref.kpref(key: String, fallback: Long, postSetter: (value: Long) -> Unit = {}) = + KPrefDelegate(key, fallback, this, KPrefLongTransaction, postSetter) + +fun KPref.kpref(key: String, fallback: Set, postSetter: (value: Set) -> Unit = {}) = + KPrefDelegate(key, fallback, this, KPrefSetTransaction, postSetter) + +fun KPref.kpref(key: String, fallback: String, postSetter: (value: String) -> Unit = {}) = + KPrefDelegate(key, fallback, this, KPrefStringTransaction, postSetter) /** * Created by Allan Wang on 2017-06-07. @@ -20,20 +34,24 @@ class StringSet(set: Collection) : LinkedHashSet(set) * Contains a unique key for the shared preference as well as a nonnull fallback item * Also contains an optional mutable postSetter that will be called every time a new value is given */ -class KPrefDelegate internal constructor( - private val key: String, private val fallback: T, private val pref: KPref, private var postSetter: (value: T) -> Unit = {}, lock: Any? = null +class KPrefDelegate internal constructor( + private val key: String, + private val fallback: T, + private val pref: KPref, + private val transaction: KPrefTransaction, + private var postSetter: (value: T) -> Unit = {} ) : ILazyResettable { private object UNINITIALIZED @Volatile - private var _value: Any = UNINITIALIZED - private val lock = lock ?: this + private var _value: Any? = UNINITIALIZED + private val lock = this init { if (pref.prefMap.containsKey(key)) throw KPrefException("$key is already used elsewhere in preference ${pref.PREFERENCE_NAME}") - pref.prefMap.put(key, this@KPrefDelegate) + pref.prefMap[key] = this@KPrefDelegate } override fun invalidate() { @@ -53,15 +71,7 @@ class KPrefDelegate internal constructor( @Suppress("UNCHECKED_CAST") _v2 as T } else { - _value = when (fallback) { - is Boolean -> pref.sp.getBoolean(key, fallback) - is Float -> pref.sp.getFloat(key, fallback) - is Int -> pref.sp.getInt(key, fallback) - is Long -> pref.sp.getLong(key, fallback) - is StringSet -> StringSet(pref.sp.getStringSet(key, fallback)) - is String -> pref.sp.getString(key, fallback) - else -> throw KPrefException(fallback) - } + _value = transaction.get(pref.sp, key, fallback) @Suppress("UNCHECKED_CAST") _value as T } @@ -75,21 +85,10 @@ class KPrefDelegate internal constructor( operator fun setValue(any: Any, property: kotlin.reflect.KProperty<*>, t: T) { _value = t val editor = pref.sp.edit() - when (t) { - is Boolean -> editor.putBoolean(key, t) - is Float -> editor.putFloat(key, t) - is Int -> editor.putInt(key, t) - is Long -> editor.putLong(key, t) - is StringSet -> editor.putStringSet(key, t) - is String -> editor.putString(key, t) - else -> throw KPrefException(t) - } + transaction.set(editor, key, t) editor.apply() postSetter(t) } } -class KPrefException(message: String) : IllegalAccessException(message) { - constructor(element: Any?) : this("Invalid type in pref cache: ${element?.javaClass?.simpleName - ?: "null"}") -} \ No newline at end of file +class KPrefException(message: String) : IllegalAccessException(message) \ No newline at end of file diff --git a/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefTransaction.kt b/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefTransaction.kt new file mode 100644 index 0000000..773d208 --- /dev/null +++ b/core/src/main/kotlin/ca/allanwang/kau/kpref/KPrefTransaction.kt @@ -0,0 +1,64 @@ +package ca.allanwang.kau.kpref + +import android.content.SharedPreferences + +internal interface KPrefTransaction { + fun get(prefs: SharedPreferences, key: String, fallback: T): T + fun set(editor: SharedPreferences.Editor, key: String, data: T) +} + +internal object KPrefBooleanTransaction : KPrefTransaction { + override fun get(prefs: SharedPreferences, key: String, fallback: Boolean) = + prefs.getBoolean(key, fallback) + + override fun set(editor: SharedPreferences.Editor, key: String, data: Boolean) { + editor.putBoolean(key, data) + } +} + +internal object KPrefIntTransaction : KPrefTransaction { + override fun get(prefs: SharedPreferences, key: String, fallback: Int) = + prefs.getInt(key, fallback) + + override fun set(editor: SharedPreferences.Editor, key: String, data: Int) { + editor.putInt(key, data) + } +} + +internal object KPrefLongTransaction : KPrefTransaction { + override fun get(prefs: SharedPreferences, key: String, fallback: Long) = + prefs.getLong(key, fallback) + + override fun set(editor: SharedPreferences.Editor, key: String, data: Long) { + editor.putLong(key, data) + } +} + +internal object KPrefFloatTransaction : KPrefTransaction { + override fun get(prefs: SharedPreferences, key: String, fallback: Float) = + prefs.getFloat(key, fallback) + + override fun set(editor: SharedPreferences.Editor, key: String, data: Float) { + editor.putFloat(key, data) + } +} + +internal object KPrefStringTransaction : KPrefTransaction { + override fun get(prefs: SharedPreferences, key: String, fallback: String) = + prefs.getString(key, fallback) + + override fun set(editor: SharedPreferences.Editor, key: String, data: String) { + editor.putString(key, data) + } +} + +internal object KPrefSetTransaction : KPrefTransaction> { + override fun get(prefs: SharedPreferences, key: String, fallback: Set) = + prefs.getStringSet(key, fallback)!! + + override fun set(editor: SharedPreferences.Editor, key: String, data: Set) { + editor.putStringSet(key, data) + } +} + + diff --git a/docs/Migration.md b/docs/Migration.md index 721cd0d..ff89f87 100644 --- a/docs/Migration.md +++ b/docs/Migration.md @@ -6,9 +6,22 @@ Below are some highlights on major refactoring/breaking changes Along with the update to support Android Studio 3.1, a lot of changes have occurred with other dependencies and with lint. -* Resource ids can be negatives due to the bit overflow. Instead, `INVALID_ID` has been introduced to signify an unset or invalid id. +## Invalid Resource Id Equality + +Resource ids can be negatives due to the bit overflow. +Instead, `INVALID_ID` has been introduced to signify an unset or invalid id. Methods such as `Context.string(id, fallback)` now check against `INVALID_ID` through equality rather than using an inequality to address this. +## Deprecate Kotterknife + +Kotterknife has been deprecated in favour of `kotlin-android-extensions`. +See [official docs](https://kotlinlang.org/docs/tutorials/android-plugin.html#view-binding). + +## Update KPref + +KPref has been slightly refactored internally. +Preferences backed by `StringSet` can now go back to `Set` + # v3.6.0 ## startActivity diff --git a/sample/src/main/res/xml/kau_changelog.xml b/sample/src/main/res/xml/kau_changelog.xml index a5d0ea9..f6ec799 100644 --- a/sample/src/main/res/xml/kau_changelog.xml +++ b/sample/src/main/res/xml/kau_changelog.xml @@ -10,9 +10,9 @@ - + - + -- cgit v1.2.3