#184 #195 Add flow-resources with StringDesc bindings for Flow

README.md

@@ -55,6 +55,7 @@ dependencies {
     commonMainApi("dev.icerock.moko:mvvm-livedata:0.13.1") // api mvvm-core, LiveData and extensions
     commonMainApi("dev.icerock.moko:mvvm-state:0.13.1") // api mvvm-livedata, ResourceState class and extensions
     commonMainApi("dev.icerock.moko:mvvm-livedata-resources:0.13.1") // api mvvm-core, moko-resources, extensions for LiveData with moko-resources
+    commonMainApi("dev.icerock.moko:mvvm-flow-resources:0.13.1") // api mvvm-core, moko-resources, extensions for Flow with moko-resources
 
     androidMainApi("dev.icerock.moko:mvvm-flow-compose:0.13.1") // api mvvm-flow, binding extensions for Jetpack Compose (jvm, js, android)
     androidMainApi("dev.icerock.moko:mvvm-livedata-compose:0.13.1") // api mvvm-livedata, binding extensions for Jetpack Compose (jvm, js, android)

mvvm-flow-resources/build.gradle.kts

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+plugins {
+    id("kmm-library-convention")
+    id("detekt-convention")
+    id("publication-convention")
+}
+
+dependencies {
+    commonMainApi(projects.mvvmFlow)
+    commonMainApi(libs.mokoResources)
+}

mvvm-flow-resources/src/androidMain/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest package="dev.icerock.moko.mvvm.flow.resources" />

mvvm-flow-resources/src/androidMain/kotlin/dev/icerock/moko/mvvm/flow/resources/TextViewBindings.kt

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.mvvm.flow.resources
+
+import android.widget.TextView
+import androidx.lifecycle.LifecycleOwner
+import dev.icerock.moko.mvvm.flow.CStateFlow
+import dev.icerock.moko.mvvm.flow.binding.bind
+import dev.icerock.moko.resources.desc.StringDesc
+import kotlinx.coroutines.DisposableHandle
+
+fun <T : StringDesc?> TextView.bindText(
+    lifecycleOwner: LifecycleOwner,
+    flow: CStateFlow<T>
+): DisposableHandle {
+    return flow.bind(lifecycleOwner) { this.text = it?.toString(this.context) }
+}

mvvm-flow-resources/src/iosMain/kotlin/dev/icerock/moko/mvvm/flow/resources/UIButtonBinding.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.mvvm.flow.resources
+
+import dev.icerock.moko.mvvm.flow.CStateFlow
+import dev.icerock.moko.mvvm.flow.DisposableHandle
+import dev.icerock.moko.mvvm.flow.binding.bind
+import dev.icerock.moko.resources.desc.StringDesc
+import platform.UIKit.UIButton
+import platform.UIKit.UIControlStateNormal
+
+fun <T : StringDesc?> UIButton.bindTitle(
+    flow: CStateFlow<T>
+): DisposableHandle {
+    return bind(flow) {
+        this.setTitle(
+            it?.localized(),
+            forState = UIControlStateNormal
+        )
+    }
+}

mvvm-flow-resources/src/iosMain/kotlin/dev/icerock/moko/mvvm/flow/resources/UILabelBinding.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.mvvm.flow.resources
+
+import dev.icerock.moko.mvvm.flow.CStateFlow
+import dev.icerock.moko.mvvm.flow.DisposableHandle
+import dev.icerock.moko.mvvm.flow.binding.bind
+import dev.icerock.moko.resources.desc.StringDesc
+import platform.UIKit.UILabel
+
+fun <T : StringDesc?> UILabel.bindText(
+    flow: CStateFlow<T>
+): DisposableHandle {
+    return bind(flow) { this.text = it?.localized() }
+}

mvvm-flow-resources/src/iosMain/kotlin/dev/icerock/moko/mvvm/flow/resources/UITextFieldBinding.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.mvvm.flow.resources
+
+import dev.icerock.moko.mvvm.flow.CStateFlow
+import dev.icerock.moko.mvvm.flow.DisposableHandle
+import dev.icerock.moko.mvvm.flow.binding.bind
+import dev.icerock.moko.resources.desc.StringDesc
+import platform.UIKit.UITextField
+
+fun <T : StringDesc?> UITextField.bindText(
+    flow: CStateFlow<T>
+): DisposableHandle {
+    return bind(flow) { value ->
+        val newValue = value?.localized().orEmpty()
+        if (this.text == newValue) return@bind
+        this.text = newValue
+    }
+}

mvvm-flow-resources/src/iosMain/kotlin/dev/icerock/moko/mvvm/flow/resources/UITextViewBinding.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2022 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.mvvm.flow.resources
+
+import dev.icerock.moko.mvvm.flow.CStateFlow
+import dev.icerock.moko.mvvm.flow.DisposableHandle
+import dev.icerock.moko.mvvm.flow.binding.bind
+import dev.icerock.moko.resources.desc.StringDesc
+import platform.UIKit.UITextView
+
+fun <T : StringDesc?> UITextView.bindText(
+    flow: CStateFlow<T>
+): DisposableHandle {
+    return bind(flow) { value ->
+        val newValue = value?.localized().orEmpty()
+        if (this.text == newValue) return@bind
+        this.text = newValue
+    }
+}

mvvm-flow-resources/src/iosTest/kotlin/UIButtonBindingsTests.kt

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import dev.icerock.moko.mvvm.flow.cStateFlow
+import dev.icerock.moko.mvvm.flow.resources.bindTitle
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.desc.desc
+import kotlinx.cinterop.readValue
+import kotlinx.coroutines.flow.MutableStateFlow
+import platform.CoreGraphics.CGRectZero
+import platform.UIKit.UIButton
+import kotlin.test.BeforeTest
+import kotlin.test.Ignore
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+@Ignore
+class UIButtonBindingsTests {
+
+    private lateinit var destination: UIButton
+
+    @BeforeTest
+    fun setup() {
+        destination = UIButton(frame = CGRectZero.readValue())
+    }
+
+    @Test
+    fun `nonnullable stringdesc title`() {
+        val source: MutableStateFlow<StringDesc> = MutableStateFlow("init".desc())
+        destination.bindTitle(source.cStateFlow())
+        assertEquals(
+            expected = "init",
+            actual = destination.currentTitle
+        )
+        source.value = "second".desc()
+        assertEquals(
+            expected = "second",
+            actual = destination.currentTitle
+        )
+    }
+
+    @Test
+    fun `nullable stringdesc title`() {
+        val source: MutableStateFlow<StringDesc?> = MutableStateFlow(null)
+        destination.bindTitle(source.cStateFlow())
+        assertEquals(
+            expected = null,
+            actual = destination.currentTitle
+        )
+        source.value = "value".desc()
+        assertEquals(
+            expected = "value",
+            actual = destination.currentTitle
+        )
+    }
+}

mvvm-flow-resources/src/iosTest/kotlin/UILabelBindingsTests.kt

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import dev.icerock.moko.mvvm.flow.cStateFlow
+import dev.icerock.moko.mvvm.flow.resources.bindText
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.desc.desc
+import kotlinx.cinterop.readValue
+import kotlinx.coroutines.flow.MutableStateFlow
+import platform.CoreGraphics.CGRectZero
+import platform.UIKit.UILabel
+import kotlin.test.BeforeTest
+import kotlin.test.Ignore
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+@Ignore
+class UILabelBindingsTests {
+
+    private lateinit var destination: UILabel
+
+    @BeforeTest
+    fun setup() {
+        destination = UILabel(frame = CGRectZero.readValue())
+    }
+
+    @Test
+    fun `nonnullable stringdesc text`() {
+        val source: MutableStateFlow<StringDesc> = MutableStateFlow("init".desc())
+        destination.bindText(source.cStateFlow())
+        assertEquals(
+            expected = "init",
+            actual = destination.text
+        )
+        source.value = "second".desc()
+        assertEquals(
+            expected = "second",
+            actual = destination.text
+        )
+    }
+
+    @Test
+    fun `nullable stringdesc text`() {
+        val source: MutableStateFlow<StringDesc?> = MutableStateFlow(null)
+        destination.bindText(source.cStateFlow())
+        assertEquals(
+            expected = null,
+            actual = destination.text
+        )
+        source.value = "value".desc()
+        assertEquals(
+            expected = "value",
+            actual = destination.text
+        )
+    }
+}

mvvm-flow-resources/src/iosTest/kotlin/UITextFieldBindingsTests.kt

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import dev.icerock.moko.mvvm.flow.cStateFlow
+import dev.icerock.moko.mvvm.flow.resources.bindText
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.desc.desc
+import kotlinx.cinterop.readValue
+import kotlinx.coroutines.flow.MutableStateFlow
+import platform.CoreGraphics.CGRectZero
+import platform.UIKit.UITextField
+import kotlin.test.BeforeTest
+import kotlin.test.Ignore
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+@Ignore
+class UITextFieldBindingsTests {
+
+    private lateinit var destination: UITextField
+
+    @BeforeTest
+    fun setup() {
+        destination = UITextField(frame = CGRectZero.readValue())
+    }
+
+    @Test
+    fun `nonnullable stringdesc text`() {
+        val source: MutableStateFlow<StringDesc> = MutableStateFlow("init".desc())
+        destination.bindText(source.cStateFlow())
+        assertEquals(
+            expected = "init",
+            actual = destination.text
+        )
+        source.value = "second".desc()
+        assertEquals(
+            expected = "second",
+            actual = destination.text
+        )
+    }
+
+    @Test
+    fun `nullable stringdesc text`() {
+        val source: MutableStateFlow<StringDesc?> = MutableStateFlow(null)
+        destination.bindText(source.cStateFlow())
+        assertEquals(
+            expected = "",
+            actual = destination.text
+        )
+        source.value = "value".desc()
+        assertEquals(
+            expected = "value",
+            actual = destination.text
+        )
+    }
+}

mvvm-flow-resources/src/iosTest/kotlin/UITextViewBindingsTests.kt

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import dev.icerock.moko.mvvm.flow.cStateFlow
+import dev.icerock.moko.mvvm.flow.resources.bindText
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.desc.desc
+import kotlinx.cinterop.readValue
+import kotlinx.coroutines.flow.MutableStateFlow
+import platform.CoreGraphics.CGRectZero
+import platform.UIKit.UITextView
+import kotlin.test.BeforeTest
+import kotlin.test.Ignore
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+@Ignore
+class UITextViewBindingsTests {
+
+    private lateinit var destination: UITextView
+
+    @BeforeTest
+    fun setup() {
+        destination = UITextView(frame = CGRectZero.readValue())
+    }
+
+    @Test
+    fun `nonnullable stringdesc text`() {
+        val source: MutableStateFlow<StringDesc> = MutableStateFlow("init".desc())
+        destination.bindText(source.cStateFlow())
+        assertEquals(
+            expected = "init",
+            actual = destination.text
+        )
+        source.value = "second".desc()
+        assertEquals(
+            expected = "second",
+            actual = destination.text
+        )
+    }
+
+    @Test
+    fun `nullable stringdesc text`() {
+        val source: MutableStateFlow<StringDesc?> = MutableStateFlow(null)
+        destination.bindText(source.cStateFlow())
+        assertEquals(
+            expected = "",
+            actual = destination.text
+        )
+        source.value = "value".desc()
+        assertEquals(
+            expected = "value",
+            actual = destination.text
+        )
+    }
+}

settings.gradle.kts

@@ -19,6 +19,7 @@ include(":mvvm-core")
 include(":mvvm-flow")
 include(":mvvm-flow:apple")
 include(":mvvm-flow-compose")
+include(":mvvm-flow-resources")
 include(":mvvm-livedata")
 include(":mvvm-livedata-material")
 include(":mvvm-livedata-resources")