Introduces fun Screen.deepMap(Screen): Screen
#1092
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| @file:OptIn(WorkflowUiExperimentalApi::class) | ||
|
|
||
| package com.squareup.workflow1.ui | ||
|
|
||
| import com.google.common.truth.Truth.assertThat | ||
| import com.squareup.workflow1.ui.container.BackStackScreen | ||
| import com.squareup.workflow1.ui.container.EnvironmentScreen | ||
| import com.squareup.workflow1.ui.container.withEnvironment | ||
| import org.junit.Test | ||
|
|
||
| internal class ScreenContainerTest { | ||
| object MyScreen : Screen | ||
|
|
||
| @Test | ||
| fun deepMapRecurses() { | ||
| val backStack = BackStackScreen(NamedScreen(MyScreen, "name")) | ||
|
|
||
| @Suppress("UNCHECKED_CAST") | ||
| val mappedBackStack = backStack | ||
| .deepMap { it.withEnvironment() } as BackStackScreen<NamedScreen<EnvironmentScreen<MyScreen>>> | ||
|
|
||
| assertThat(mappedBackStack.top.content.content).isSameInstanceAs(MyScreen) | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| package com.squareup.workflow1.ui | ||
|
|
||
| @WorkflowUiExperimentalApi | ||
| public fun interface VisualFactory<ContextT, in RenderingT, VisualT> { | ||
| /** | ||
| * Given a ui model ([rendering]), creates a [VisualHolder] which pairs: | ||
| * | ||
| * - a native view system object of type [VisualT] -- a [visual][VisualHolder.visual] | ||
| * - an [update function][VisualHolder.update] to apply [RenderingT] instances to | ||
| * the new [VisualT] instance. | ||
| * | ||
| * This method must not call [VisualHolder.update], to ensure that callers have | ||
| * complete control over the lifecycle of the new [VisualT]. | ||
| * | ||
| * @param getFactory can be used to make recursive calls to build VisualT | ||
| * instances for sub-parts of [rendering] | ||
| */ | ||
| public fun createOrNull( | ||
| rendering: RenderingT, | ||
| context: ContextT, | ||
| environment: ViewEnvironment, | ||
| getFactory: (ViewEnvironment) -> VisualFactory<ContextT, Any, VisualT> | ||
| ): VisualHolder<RenderingT, VisualT>? | ||
| } | ||
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,24 @@ | ||
| package com.squareup.workflow1.ui | ||
|
|
||
| @WorkflowUiExperimentalApi | ||
| public interface VisualHolder<in RenderingT, out VisualT> { | ||
|
There was a problem hiding this comment. It seems like some of the kdoc for There was a problem hiding this comment. Uh oh. I think this and |
||
| public val visual: VisualT | ||
|
|
||
| public fun update(rendering: RenderingT): Boolean | ||
|
|
||
| public companion object { | ||
| public operator fun <RenderingT, VisualT> invoke( | ||
| visual: VisualT, | ||
| onUpdate: (RenderingT) -> Unit | ||
| ): VisualHolder<RenderingT, VisualT> { | ||
| return object : VisualHolder<RenderingT, VisualT> { | ||
| override val visual = visual | ||
|
|
||
| override fun update(rendering: RenderingT): Boolean { | ||
| onUpdate(rendering) | ||
| return true | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
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
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,34 @@ | ||
| package com.squareup.workflow1.ui | ||
|
|
||
| @WorkflowUiExperimentalApi | ||
| public interface ScreenContainer<out C : Screen> : Container<Screen, C>, Screen { | ||
| public override fun <D : Screen> map(transform: (C) -> D): ScreenContainer<D> | ||
| } | ||
|
|
||
| @WorkflowUiExperimentalApi | ||
| public interface ScreenWrapper<out C : Screen> : ScreenContainer<C>, Wrapper<Screen, C>, Screen { | ||
| public override fun <D : Screen> map(transform: (C) -> D): ScreenWrapper<D> | ||
| } | ||
|
|
||
| /** | ||
| * Applies [transform] to the receiver unless it is a [ScreenContainer]. In that case, | ||
| * makes a recursive call to [ScreenContainer.map] and applies [deepMap] to its | ||
| * contents. | ||
| * | ||
| * For example, consider this snippet: | ||
| * | ||
| * val backStack = BackStackScreen(SomeWrapper(theRealScreen)) | ||
| * val loggingBackStack = backStack.deepMap { WithLogging(it) } | ||
| * | ||
| * `loggingBackStack` will have a structure like so: | ||
| * | ||
| * BackStackScreen(SomeWrapper(WithLogging(theRealScreen))) | ||
| */ | ||
| @WorkflowUiExperimentalApi | ||
| public fun Screen.deepMap(transform: (Screen) -> Screen): Screen { | ||
| return if (this is ScreenContainer<*>) { | ||
|
There was a problem hiding this comment. You know what? I don't know that
|
||
| map { it.deepMap(transform) } | ||
| } else { | ||
| transform(this) | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.