Arrow Optics ❤️ Compose #3299
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| public final class arrow/optics/CopyKt { | ||
| public static final fun update (Landroidx/compose/runtime/MutableState;Lkotlin/jvm/functions/Function1;)V | ||
| public static final fun updateCopy (Landroidx/compose/runtime/MutableState;Lkotlin/jvm/functions/Function1;)V | ||
| public static final fun updateCopy (Lkotlinx/coroutines/flow/MutableStateFlow;Lkotlin/jvm/functions/Function1;)V | ||
| } | ||
|
|
||
| public final class arrow/optics/FlowKt { | ||
| public static final fun optic (Lkotlinx/coroutines/flow/MutableStateFlow;Larrow/optics/PLens;)Lkotlinx/coroutines/flow/MutableStateFlow; | ||
| public static final fun optic (Lkotlinx/coroutines/flow/SharedFlow;Larrow/optics/Getter;)Lkotlinx/coroutines/flow/SharedFlow; | ||
| public static final fun optic (Lkotlinx/coroutines/flow/StateFlow;Larrow/optics/Getter;)Lkotlinx/coroutines/flow/StateFlow; | ||
| } | ||
|
|
||
| public final class arrow/optics/StateKt { | ||
| public static final fun optic (Landroidx/compose/runtime/MutableState;Larrow/optics/PLens;)Landroidx/compose/runtime/MutableState; | ||
| public static final fun optic (Landroidx/compose/runtime/State;Larrow/optics/Getter;)Landroidx/compose/runtime/State; | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| public final class arrow/optics/CopyKt { | ||
| public static final fun update (Landroidx/compose/runtime/MutableState;Lkotlin/jvm/functions/Function1;)V | ||
| public static final fun updateCopy (Landroidx/compose/runtime/MutableState;Lkotlin/jvm/functions/Function1;)V | ||
| public static final fun updateCopy (Lkotlinx/coroutines/flow/MutableStateFlow;Lkotlin/jvm/functions/Function1;)V | ||
| } | ||
|
|
||
| public final class arrow/optics/FlowKt { | ||
| public static final fun optic (Lkotlinx/coroutines/flow/MutableStateFlow;Larrow/optics/PLens;)Lkotlinx/coroutines/flow/MutableStateFlow; | ||
| public static final fun optic (Lkotlinx/coroutines/flow/SharedFlow;Larrow/optics/Getter;)Lkotlinx/coroutines/flow/SharedFlow; | ||
| public static final fun optic (Lkotlinx/coroutines/flow/StateFlow;Larrow/optics/Getter;)Lkotlinx/coroutines/flow/StateFlow; | ||
| } | ||
|
|
||
| public final class arrow/optics/StateKt { | ||
| public static final fun optic (Landroidx/compose/runtime/MutableState;Larrow/optics/PLens;)Landroidx/compose/runtime/MutableState; | ||
| public static final fun optic (Landroidx/compose/runtime/State;Larrow/optics/Getter;)Landroidx/compose/runtime/State; | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| @file:Suppress("DSL_SCOPE_VIOLATION") | ||
|
|
||
| import org.jetbrains.kotlin.gradle.tasks.KotlinCompile | ||
|
|
||
|
|
||
| repositories { | ||
| google() | ||
| mavenCentral() | ||
| maven("https://maven.pkg.jetbrains.space/public/p/compose/dev") | ||
| } | ||
|
|
||
| plugins { | ||
| id(libs.plugins.kotlin.multiplatform.get().pluginId) | ||
| // alias(libs.plugins.arrowGradleConfig.kotlin) | ||
| alias(libs.plugins.arrowGradleConfig.publish) | ||
| alias(libs.plugins.spotless) | ||
| alias(libs.plugins.jetbrainsCompose) | ||
| alias(libs.plugins.android.library) | ||
| } | ||
|
|
||
| apply(from = property("ANIMALSNIFFER_MPP")) | ||
|
|
||
| kotlin { | ||
| explicitApi() | ||
|
|
||
| jvm { | ||
| jvmToolchain(8) | ||
| } | ||
| js(IR) { | ||
| browser() | ||
| nodejs() | ||
| } | ||
| androidTarget() | ||
| // Native: https://kotlinlang.org/docs/native-target-support.html | ||
| // -- Tier 1 -- | ||
| linuxX64() | ||
| macosX64() | ||
| macosArm64() | ||
| iosSimulatorArm64() | ||
| iosX64() | ||
| // -- Tier 2 -- | ||
| // linuxArm64() | ||
| watchosSimulatorArm64() | ||
| watchosX64() | ||
| watchosArm64() | ||
| tvosSimulatorArm64() | ||
| tvosX64() | ||
| tvosArm64() | ||
| iosArm64() | ||
| // -- Tier 3 -- | ||
| mingwX64() | ||
|
|
||
| sourceSets { | ||
| commonMain { | ||
| dependencies { | ||
| api(projects.arrowOptics) | ||
| api(libs.coroutines.core) | ||
| api(compose.runtime) | ||
| implementation(libs.kotlin.stdlibCommon) | ||
| } | ||
| } | ||
|
|
||
| commonTest { | ||
| dependencies { | ||
| implementation(libs.kotlin.test) | ||
| implementation(libs.kotest.assertionsCore) | ||
| implementation(libs.kotest.property) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| tasks.withType<Test>().configureEach { | ||
| useJUnitPlatform() | ||
| } | ||
|
|
||
| compose { | ||
| // override the choice of Compose if we use a Kotlin -dev version | ||
| val kotlinVersion = project.rootProject.properties["kotlin_version"] as? String | ||
| if (kotlinVersion != null && kotlinVersion.contains("-dev-")) { | ||
| kotlinCompilerPlugin.set(dependencies.compiler.forKotlin("2.0.0-Beta1")) | ||
| kotlinCompilerPluginArgs.add("suppressKotlinVersionCompatibilityCheck=$kotlinVersion") | ||
| } | ||
| } | ||
|
|
||
| android { | ||
| namespace = "arrow.optics.compose" | ||
| compileSdk = libs.versions.android.compileSdk.get().toInt() | ||
| } | ||
|
|
||
| tasks.named<Jar>("jvmJar").configure { | ||
| manifest { | ||
| attributes["Automatic-Module-Name"] = "arrow.optics.compose" | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Maven publishing configuration | ||
| pom.name=Arrow Optics for Compose | ||
| # Build configuration | ||
| kapt.incremental.apt=false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package arrow.optics | ||
|
|
||
| import androidx.compose.runtime.MutableState | ||
| import androidx.compose.runtime.snapshots.Snapshot | ||
| import kotlinx.coroutines.flow.MutableStateFlow | ||
| import kotlinx.coroutines.flow.update | ||
|
|
||
| /** | ||
| * Modifies the value in this [MutableState] | ||
| * by applying the function [block] to the current value. | ||
| */ | ||
| public inline fun <T> MutableState<T>.update(crossinline block: (T) -> T) { | ||
| Snapshot.withMutableSnapshot { | ||
serras marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| value = block(value) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Modifies the value in this [MutableState] | ||
| * by performing the operations in the [Copy] [block]. | ||
| */ | ||
| public fun <T> MutableState<T>.updateCopy(block: Copy<T>.() -> Unit) { | ||
| update { it.copy(block) } | ||
| } | ||
|
|
||
| /** | ||
| * Updates the value in this [MutableStateFlow] | ||
| * by performing the operations in the [Copy] [block]. | ||
| */ | ||
| public fun <T> MutableStateFlow<T>.updateCopy(block: Copy<T>.() -> Unit) { | ||
| update { it.copy(block) } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,70 @@ | ||||||
| package arrow.optics | ||||||
|
|
||||||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||||||
| import kotlinx.coroutines.flow.FlowCollector | ||||||
| import kotlinx.coroutines.flow.MutableStateFlow | ||||||
| import kotlinx.coroutines.flow.SharedFlow | ||||||
| import kotlinx.coroutines.flow.StateFlow | ||||||
|
|
||||||
| /** | ||||||
| * Exposes the values of [this] through the optic. | ||||||
| */ | ||||||
| public fun <T, A> SharedFlow<T>.optic(g: Getter<T, A>): SharedFlow<A> = object : SharedFlow<A> { | ||||||
| override suspend fun collect(collector: FlowCollector<A>): Nothing = | ||||||
| this@optic.collect { collector.emit(g.get(it)) } | ||||||
|
|
||||||
| override val replayCache: List<A> | ||||||
| get() = this@optic.replayCache.map { g.get(it) } | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Exposes the values of [this] through the optic. | ||||||
| */ | ||||||
| public fun <T, A> StateFlow<T>.optic(g: Getter<T, A>): StateFlow<A> = object : StateFlow<A> { | ||||||
| override val value: A | ||||||
| get() = g.get(this@optic.value) | ||||||
|
|
||||||
| override suspend fun collect(collector: FlowCollector<A>): Nothing = | ||||||
| this@optic.collect { collector.emit(g.get(it)) } | ||||||
|
|
||||||
| override val replayCache: List<A> | ||||||
| get() = this@optic.replayCache.map { g.get(it) } | ||||||
|
There was a problem hiding this comment. Always contains single element.
Suggested change
There was a problem hiding this comment. I would prefer to keep this implementation, since it makes it more clear that we are just reusing the |
||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Exposes the values of [this] through the optic. | ||||||
| * Any change made to [value] is reflected in the original [MutableStateFlow]. | ||||||
| */ | ||||||
| public fun <T, A> MutableStateFlow<T>.optic(lens: Lens<T, A>): MutableStateFlow<A> = object : MutableStateFlow<A> { | ||||||
| override var value: A | ||||||
| get() = lens.get(this@optic.value) | ||||||
| set(newValue) { | ||||||
| this@optic.value = lens.set(this@optic.value, newValue) | ||||||
| } | ||||||
|
|
||||||
| override suspend fun collect(collector: FlowCollector<A>): Nothing = | ||||||
| this@optic.collect { collector.emit(lens.get(it)) } | ||||||
|
|
||||||
| override fun compareAndSet(expect: A, update: A): Boolean { | ||||||
| val expectT = lens.set(this@optic.value, expect) | ||||||
| val updateT = lens.set(this@optic.value, update) | ||||||
| return compareAndSet(expectT, updateT) | ||||||
| } | ||||||
|
|
||||||
| override fun tryEmit(value: A): Boolean = | ||||||
| this@optic.tryEmit(lens.set(this@optic.value, value)) | ||||||
|
|
||||||
| override suspend fun emit(value: A): Unit = | ||||||
| this@optic.emit(lens.set(this@optic.value, value)) | ||||||
|
|
||||||
| override val subscriptionCount: StateFlow<Int> | ||||||
| get() = this@optic.subscriptionCount | ||||||
|
|
||||||
| override val replayCache: List<A> | ||||||
| get() = this@optic.replayCache.map { lens.get(it) } | ||||||
|
|
||||||
|
|
||||||
| @ExperimentalCoroutinesApi | ||||||
| override fun resetReplayCache() { | ||||||
| this@optic.resetReplayCache() | ||||||
| } | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| package arrow.optics | ||
|
|
||
| import androidx.compose.runtime.MutableState | ||
| import androidx.compose.runtime.State | ||
|
|
||
| /** | ||
| * Exposes the value of [this] through the optic. | ||
| */ | ||
| public fun <T, A> State<T>.optic(g: Getter<T, A>): State<A> = object : State<A> { | ||
| override val value: A | ||
| get() = g.get(this@optic.value) | ||
| } | ||
|
|
||
| /** | ||
| * Exposes the value of [this] through the optic. | ||
| * Any change made to [value] is reflected in the original [MutableState]. | ||
| */ | ||
| public fun <T, A> MutableState<T>.optic(lens: Lens<T, A>): MutableState<A> = object : MutableState<A> { | ||
| override var value: A | ||
| get() = lens.get(this@optic.value) | ||
| set(newValue) { | ||
| this@optic.value = lens.set(this@optic.value, newValue) | ||
| } | ||
|
|
||
| override fun component1(): A = value | ||
| override fun component2(): (A) -> Unit = { value = it } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Off-topic: @serras how do you feel about doing this explicitly in Arrow instead of relying on the
arrowGradleConfig?Arrow Gradle Config came to live because of publishing, and I've in favor of replacing Arrow Gradle Config Nexus/Publish with https://github.com/vanniktech/gradle-maven-publish-plugin. I've tried it on a couple of my projects and it works better as what we have whilst supporting the same style of configuration we currently use.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds great (although having to define all the targets on each project seems tiresome). Maybe another thing to do in the
arrow-2branch?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was wondering if we could do something interesting in
buildSrcor something where we can define some top-level functions to avoid all the repetitive boilerplate. arrow-2 sounds good! Definitely not for 1.2.2 😅