draft: resources-ktx: Make Text compatible with compose

buildSrc/src/main/kotlin/dependencies.kt

@@ -22,6 +22,11 @@ object androidx {
         val resources by this
     }
 
+    object compose {
+        const val version = "1.1.1"
+        const val ui = "androidx.compose.ui:ui:$version"
+    }
+
     object core : Group("androidx.core", version = "1.6.0") {
         val ktx by this
     }

resources/build.gradle.kts

@@ -0,0 +1,4 @@
+subprojects {
+    version = "1.3.1-0"
+    description = "A set of Kotlin extensions for accessing resources"
+}

resources-ktx/build.gradle.kts → resources/resources-common/build.gradle.kts

@@ -7,13 +7,11 @@ plugins {
     id("kotlin-parcelize")
 }
 
-version = "1.3.1-0"
-description = "A set of Kotlin extensions for accessing resources"
-
 dependencies {
     api(jetbrains.kotlin.stdlib)
     api(androidx.annotation)
-    api(androidx.fragment)
-    implementation(androidx.core)
-    implementation(androidx.appcompat.resources)
+}
+
+android {
+    namespace = "com.redmadrobot.extensions.resources.common"
 }

resources/resources-common/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest />

resources/resources-common/src/main/kotlin/TextValue.kt

@@ -0,0 +1,93 @@
+@file:Suppress("NOTHING_TO_INLINE")
+
+package com.redmadrobot.extensions.resources
+
+import android.content.Context
+import android.content.res.Resources
+import android.os.Parcelable
+import android.view.View
+import androidx.annotation.StringRes
+import kotlinx.parcelize.Parcelize
+
+/**
+ * Wrapper to make it possible to work with plain [String] and [StringRes] in the same way.
+ *
+ * ```
+ *  // in some place where we can't access Context
+ *  val errorMessage = TextValue(exception.message, defaultResourceId= R.string.unknown_error)
+ *  showMessage(errorMessage)
+ *
+ *  // in Activity, Fragment or View
+ *  val messageText = getString(message)
+ * ```
+ */
+public sealed class TextValue : Parcelable {
+
+    /** Retrieves [String] using the given [context]. */
+    @Deprecated("Use get with Resources instead.", ReplaceWith("this.get(context.resources)"))
+    public fun get(context: Context): String = get(context.resources)
+
+    /** Retrieves [String] using the given [resources]. */
+    public abstract fun get(resources: Resources): String
+
+    abstract override fun equals(other: Any?): Boolean
+    abstract override fun hashCode(): Int
+
+    /** Plain string. */
+    @Parcelize
+    public data class Plain(public val string: String) : TextValue() {
+        override fun get(resources: Resources): String = string
+    }
+
+    /** String resource, requires [Resources] to get [String]. */
+    @Parcelize
+    public data class Resource(@StringRes public val resourceId: Int) : TextValue() {
+        override fun get(resources: Resources): String = resources.getString(resourceId)
+    }
+
+    public companion object {
+
+        /** Empty [TextValue]. */
+        public val EMPTY: TextValue = TextValue("")
+    }
+}
+
+/** Creates [TextValue] from the given [resourceId]. */
+public inline fun TextValue(@StringRes resourceId: Int): TextValue = TextValue.Resource(resourceId)
+
+/** Creates [TextValue] from the given [string]. */
+public inline fun TextValue(string: String): TextValue = TextValue.Plain(string)
+
+/** Creates [TextValue] from the given [string], or from the [defaultResourceId] if string is `null`. */
+public inline fun TextValue(string: String?, @StringRes defaultResourceId: Int): TextValue {
+    return if (string != null) TextValue.Plain(string) else TextValue.Resource(defaultResourceId)
+}
+
+/**
+ * Unwraps and returns a string for the given [text].
+ * @see TextValue
+ */
+public inline fun Context.getString(text: TextValue): String = resources.getString(text)
+
+/**
+ * Unwraps and returns a string for the given [text].
+ * @see TextValue
+ */
+public inline fun View.getString(text: TextValue): String = resources.getString(text)
+
+/**
+ * Unwraps and returns a string for the given [text].
+ * @see TextValue
+ */
+public inline fun Resources.getString(text: TextValue): String = text.get(this)
+
+@Deprecated("Text renamed to TextValue for compatibility with compose", ReplaceWith("TextValue"))
+public typealias Text = TextValue
+
+@Suppress("FunctionName")
+@Deprecated("Text renamed to TextValue for compatibility with compose", ReplaceWith("TextValue(resourceId)"))
+public fun TextValue.Companion.Resource(@StringRes resourceId: Int): TextValue.Resource = TextValue.Resource(resourceId)
+
+@Suppress("FunctionName")
+@Deprecated("Text renamed to TextValue for compatibility with compose", ReplaceWith("TextValue(string)"))
+public fun TextValue.Companion.Plain(string: String): TextValue.Plain = TextValue.Plain(string)

resources/resources-compose/build.gradle.kts

@@ -0,0 +1,23 @@
+import com.redmadrobot.build.dependencies.androidx
+
+plugins {
+    id("com.redmadrobot.android-library")
+    id("com.redmadrobot.publish")
+}
+
+dependencies {
+    api(projects.resources.resourcesCommon)
+    api(androidx.compose.ui)
+}
+
+android {
+    namespace = "com.redmadrobot.extensions.resources.compose"
+
+    buildFeatures {
+        compose = true
+    }
+
+    composeOptions {
+        kotlinCompilerExtensionVersion = androidx.compose.version
+    }
+}

resources/resources-compose/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest />

resources/resources-compose/src/main/kotlin/StringResources.kt

@@ -0,0 +1,28 @@
+package com.redmadrobot.extensions.resources
+
+import android.content.res.Resources
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.ReadOnlyComposable
+import androidx.compose.ui.platform.LocalConfiguration
+import androidx.compose.ui.platform.LocalContext
+
+/**
+ * Unwraps and returns a string for the given [text].
+ * @see TextValue
+ */
+@Composable
+public fun stringResource(text: TextValue): String {
+    val resources = resources()
+    return resources.getString(text)
+}
+
+/**
+ * A composable function that returns the [Resources]. It will be recomposed when [Configuration]
+ * gets updated.
+ */
+@Composable
+@ReadOnlyComposable
+private fun resources(): Resources {
+    LocalConfiguration.current
+    return LocalContext.current.resources
+}

resources/resources-ktx/build.gradle.kts

@@ -0,0 +1,17 @@
+import com.redmadrobot.build.dependencies.androidx
+
+plugins {
+    id("com.redmadrobot.android-library")
+    id("com.redmadrobot.publish")
+}
+
+dependencies {
+    api(projects.resources.resourcesCommon)
+    api(androidx.fragment)
+    implementation(androidx.core)
+    implementation(androidx.appcompat.resources)
+}
+
+android {
+    namespace = "com.redmadrobot.extensions.resources"
+}

resources/resources-ktx/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest />

resources-ktx/src/main/kotlin/FragmentResourcesAccessors.kt → resources/resources-ktx/src/main/kotlin/FragmentResourcesAccessors.kt

@@ -82,3 +82,9 @@ public inline fun Fragment.getQuantityString(@PluralsRes resId: Int, quantity: I
 public inline fun Fragment.getQuantityString(@PluralsRes resId: Int, quantity: Int, vararg formatArgs: Any): String {
     return resources.getQuantityString(resId, quantity, *formatArgs)
 }
+
+/**
+ * Unwraps and returns a string for the given [text].
+ * @see TextValue
+ */
+public inline fun Fragment.getString(text: TextValue): String = requireContext().getString(text)

settings.gradle.kts

@@ -1,3 +1,5 @@
+enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
+
 pluginManagement {
     repositories {
         google()
@@ -12,6 +14,8 @@ include(
     "fragment-ktx",
     "fragment-args-ktx",
     "lifecycle-livedata-ktx",
-    "resources-ktx",
+    "resources:resources-common",
+    "resources:resources-compose",
+    "resources:resources-ktx",
     "viewbinding-ktx",
 )