Eliminates OverlayDialogRunner, tweaks ScreenViewRunner.

rjrjr · rjrjr · commit cc9d4fdca4ea · 2022-06-13T16:53:04.000-07:00
`OverlayDialogRunner` really served no purpose. `ScreenViewRunner` is still a nice hook for feature developers, but it was the last thing that said `viewEnvironment` instead of just `environment`.
diff --git a/samples/compose-samples/src/main/java/com/squareup/sample/compose/nestedrenderings/LegacyRunner.kt b/samples/compose-samples/src/main/java/com/squareup/sample/compose/nestedrenderings/LegacyRunner.kt
@@ -23,9 +23,9 @@ class LegacyRunner(private val binding: LegacyViewBinding) : ScreenViewRunner<Le
 
   override fun showRendering(
     rendering: LegacyRendering,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
-    binding.stub.update(rendering.rendering, viewEnvironment)
+    binding.stub.update(rendering.rendering, environment)
   }
 
   companion object : ScreenViewFactory<LegacyRendering> by fromViewBinding(
diff --git a/samples/containers/android/src/main/java/com/squareup/sample/container/overviewdetail/OverviewDetailContainer.kt b/samples/containers/android/src/main/java/com/squareup/sample/container/overviewdetail/OverviewDetailContainer.kt
@@ -43,10 +43,10 @@ class OverviewDetailContainer(view: View) : ScreenViewRunner<OverviewDetailScree
 
   override fun showRendering(
     rendering: OverviewDetailScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
-    if (singleStub == null) renderSplitView(rendering, viewEnvironment)
-    else renderSingleView(rendering, viewEnvironment, singleStub)
+    if (singleStub == null) renderSplitView(rendering, environment)
+    else renderSingleView(rendering, environment, singleStub)
   }
 
   private fun renderSplitView(
diff --git a/samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/HelloBackButtonLayoutRunner.kt b/samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/HelloBackButtonLayoutRunner.kt
@@ -26,7 +26,7 @@ private class HelloBackButtonLayoutRunner(view: View) : ScreenViewRunner<HelloBa
 
   override fun showRendering(
     rendering: HelloBackButtonScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     messageView.text = rendering.message
     messageView.setOnClickListener { rendering.onClick() }
diff --git a/samples/containers/poetry/src/main/java/com/squareup/sample/poetry/PoemListRendering.kt b/samples/containers/poetry/src/main/java/com/squareup/sample/poetry/PoemListRendering.kt
@@ -49,10 +49,10 @@ private class PoemListLayoutRunner(view: View) : ScreenViewRunner<PoemListScreen
 
   override fun showRendering(
     rendering: PoemListScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     adapter.rendering = rendering
-    adapter.environment = viewEnvironment
+    adapter.environment = environment
     adapter.notifyDataSetChanged()
     if (recyclerView.adapter == null) recyclerView.adapter = adapter
 
diff --git a/samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaListScreen.kt b/samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaListScreen.kt
@@ -42,16 +42,16 @@ private class StanzaListLayoutRunner(view: View) : ScreenViewRunner<StanzaListSc
 
   override fun showRendering(
     rendering: StanzaListScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     adapter.view = rendering
-    adapter.environment = viewEnvironment
+    adapter.environment = environment
     adapter.notifyDataSetChanged()
     if (recyclerView.adapter == null) recyclerView.adapter = adapter
     toolbar.title = rendering.title
     toolbar.subtitle = rendering.subtitle
 
-    if (viewEnvironment[BackStackConfig] == Other) {
+    if (environment[BackStackConfig] == Other) {
       toolbar.setNavigationOnClickListener { rendering.onExit() }
       toolbar.backPressedHandler = rendering.onExit
     } else {
diff --git a/samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaScreen.kt b/samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaScreen.kt
@@ -51,9 +51,9 @@ private class StanzaLayoutRunner(private val view: View) : ScreenViewRunner<Stan
 
   override fun showRendering(
     rendering: StanzaScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
-    if (viewEnvironment[OverviewDetailConfig] == Detail) {
+    if (environment[OverviewDetailConfig] == Detail) {
       toolbar.title = "Stanza ${rendering.stanzaNumber}"
       toolbar.subtitle = null
     } else {
@@ -85,16 +85,16 @@ private class StanzaLayoutRunner(private val view: View) : ScreenViewRunner<Stan
         goBack.visibility = View.INVISIBLE
       }
 
-    if (viewEnvironment[OverviewDetailConfig] != Detail &&
-      viewEnvironment[BackStackConfig] != None
+    if (environment[OverviewDetailConfig] != Detail &&
+      environment[BackStackConfig] != None
     ) {
       toolbar.setNavigationOnClickListener { rendering.onGoUp.invoke() }
     } else {
       toolbar.navigationIcon = null
     }
 
     view.backPressedHandler = rendering.onGoBack
-      ?: rendering.onGoUp.takeIf { viewEnvironment[OverviewDetailConfig] != Detail }
+      ?: rendering.onGoUp.takeIf { environment[OverviewDetailConfig] != Detail }
   }
 
   private fun TextView.setTabulatedText(lines: List<String>) {
diff --git a/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/BoardsListLayoutRunner.kt b/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/BoardsListLayoutRunner.kt
@@ -73,14 +73,14 @@ class BoardsListLayoutRunner(rootView: View) : ScreenViewRunner<DisplayBoardsLis
 
   override fun showRendering(
     rendering: DisplayBoardsListScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     // Associate the viewEnvironment and event handler to each item because it needs to be used when
     // binding the RecyclerView item above.
     // Recycler is configured with a DataSource, which effectively (and often in practice) a simple
     // wrapper around a List.
     recycler.update {
-      data = rendering.toDataSource(viewEnvironment)
+      data = rendering.toDataSource(environment)
     }
   }
 
diff --git a/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/GameLayoutRunner.kt b/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/GameLayoutRunner.kt
@@ -41,9 +41,9 @@ class GameLayoutRunner(view: View) : ScreenViewRunner<GameRendering> {
 
   override fun showRendering(
     rendering: GameRendering,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
-    boardView.show(rendering.board, viewEnvironment)
+    boardView.show(rendering.board, environment)
     this.rendering = rendering
 
     // Disable the views if we don't have an event handler, e.g. when the game has finished.
diff --git a/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/LoadingBinding.kt b/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/LoadingBinding.kt
@@ -39,7 +39,7 @@ internal class LoadingLayoutRunner<RenderingT : Screen>(
 
   override fun showRendering(
     rendering: RenderingT,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     // No-op.
   }
diff --git a/samples/dungeon/timemachine-shakeable/src/main/java/com/squareup/sample/timemachine/shakeable/ShakeableTimeMachineLayoutRunner.kt b/samples/dungeon/timemachine-shakeable/src/main/java/com/squareup/sample/timemachine/shakeable/ShakeableTimeMachineLayoutRunner.kt
@@ -41,7 +41,7 @@ class ShakeableTimeMachineLayoutRunner(
 
   override fun showRendering(
     rendering: ShakeableTimeMachineScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     // Only handle back presses explicitly if in playback mode.
     view.backPressedHandler = rendering.onResumeRecording.takeUnless { rendering.recording }
@@ -80,7 +80,7 @@ class ShakeableTimeMachineLayoutRunner(
     }
 
     // Show the child screen.
-    childStub.show(rendering.rendering, viewEnvironment)
+    childStub.show(rendering.rendering, environment)
   }
 
   private fun Duration.toProgressInt(): Int = this.inWholeMilliseconds.toInt()
diff --git a/samples/tictactoe/app/src/main/java/com/squareup/sample/gameworkflow/GameOverLayoutRunner.kt b/samples/tictactoe/app/src/main/java/com/squareup/sample/gameworkflow/GameOverLayoutRunner.kt
@@ -34,7 +34,7 @@ internal class GameOverLayoutRunner(
 
   override fun showRendering(
     rendering: GameOverScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     exitItem.setOnMenuItemClickListener {
       rendering.onPlayAgain()
diff --git a/samples/todo-android/app/src/main/java/com/squareup/sample/todo/TodoEditorScreen.kt b/samples/todo-android/app/src/main/java/com/squareup/sample/todo/TodoEditorScreen.kt
@@ -53,14 +53,14 @@ private class Runner(
 
   override fun showRendering(
     rendering: TodoEditorScreen,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   ) {
     with(binding) {
       todoEditorToolbar.title = rendering.session.title.textValue
       rendering.session.title.control(todoTitle)
       itemListView.setRows(rendering.session.rows)
 
-      if (viewEnvironment[BackStackConfig] == Other) {
+      if (environment[BackStackConfig] == Other) {
         todoEditorToolbar.setNavigationOnClickListener { rendering.onGoBackClicked() }
         root.backPressedHandler = { rendering.onGoBackClicked() }
       } else {
diff --git a/workflow-ui/core-android/api/core-android.api b/workflow-ui/core-android/api/core-android.api
@@ -673,7 +673,7 @@ public abstract interface class com/squareup/workflow1/ui/container/OverlayDialo
 	public static final field Companion Lcom/squareup/workflow1/ui/container/OverlayDialogHolder$Companion;
 	public abstract fun getDialog ()Landroid/app/Dialog;
 	public abstract fun getEnvironment ()Lcom/squareup/workflow1/ui/ViewEnvironment;
-	public abstract fun getRunner ()Lcom/squareup/workflow1/ui/container/OverlayDialogRunner;
+	public abstract fun getRunner ()Lkotlin/jvm/functions/Function2;
 }
 
 public final class com/squareup/workflow1/ui/container/OverlayDialogHolder$Companion {
@@ -690,21 +690,17 @@ public final class com/squareup/workflow1/ui/container/OverlayDialogHolder$Compa
 }
 
 public final class com/squareup/workflow1/ui/container/OverlayDialogHolderKt {
-	public static final fun OverlayDialogHolder (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/app/Dialog;Lcom/squareup/workflow1/ui/container/OverlayDialogRunner;)Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;
+	public static final fun OverlayDialogHolder (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/app/Dialog;Lkotlin/jvm/functions/Function2;)Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;
 	public static final fun canShow (Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;Lcom/squareup/workflow1/ui/container/Overlay;)Z
 	public static final fun getShowing (Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;)Lcom/squareup/workflow1/ui/container/Overlay;
 	public static final fun show (Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;Lcom/squareup/workflow1/ui/container/Overlay;Lcom/squareup/workflow1/ui/ViewEnvironment;)V
 }
 
-public abstract interface class com/squareup/workflow1/ui/container/OverlayDialogRunner {
-	public abstract fun showRendering (Lcom/squareup/workflow1/ui/container/Overlay;Lcom/squareup/workflow1/ui/ViewEnvironment;)V
-}
-
 public final class com/squareup/workflow1/ui/container/RealOverlayDialogHolder : com/squareup/workflow1/ui/container/OverlayDialogHolder {
-	public fun <init> (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/app/Dialog;Lcom/squareup/workflow1/ui/container/OverlayDialogRunner;)V
+	public fun <init> (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/app/Dialog;Lkotlin/jvm/functions/Function2;)V
 	public fun getDialog ()Landroid/app/Dialog;
 	public fun getEnvironment ()Lcom/squareup/workflow1/ui/ViewEnvironment;
-	public fun getRunner ()Lcom/squareup/workflow1/ui/container/OverlayDialogRunner;
+	public fun getRunner ()Lkotlin/jvm/functions/Function2;
 }
 
 public class com/squareup/workflow1/ui/container/ScreenOverlayDialogFactory : com/squareup/workflow1/ui/container/OverlayDialogFactory {
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/ScreenViewHolder.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/ScreenViewHolder.kt
@@ -65,7 +65,7 @@ public interface ScreenViewHolder<in ScreenT : Screen> {
 public fun interface ScreenViewRunner<in ScreenT : Screen> {
   public fun showRendering(
     rendering: ScreenT,
-    viewEnvironment: ViewEnvironment
+    environment: ViewEnvironment
   )
 }
 
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/OverlayDialogHolder.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/OverlayDialogHolder.kt
@@ -27,7 +27,7 @@ public interface OverlayDialogHolder<in OverlayT : Overlay> {
    * The function that is run by [show] to update [dialog] with a new [Screen] rendering and
    * [ViewEnvironment].
    */
-  public val runner: OverlayDialogRunner<OverlayT>
+  public val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit
 
   public companion object {
     /**
@@ -48,25 +48,6 @@ public interface OverlayDialogHolder<in OverlayT : Overlay> {
   }
 }
 
-/**
- * The function that updates a [Dialog] instance built by a [OverlayDialogFactory].
- * Each [OverlayDialogRunner] instance is paired with a single [Dialog] instance,
- * its neighbor in a [OverlayDialogHolder].
- *
- * This is the interface you'll implement directly to update Android dialog code
- * from your [Overlay] renderings. An [OverlayDialogRunner] serves as the strategy
- * object of an [OverlayDialogHolder] instantiated by a [OverlayDialogFactory] -- the
- * runner provides the implementation for the holder's [OverlayDialogHolder.show]
- * method.
- */
-@WorkflowUiExperimentalApi
-public fun interface OverlayDialogRunner<in OverlayT : Overlay> {
-  public fun showRendering(
-    rendering: OverlayT,
-    viewEnvironment: ViewEnvironment
-  )
-}
-
 /**
  * Returns true if [overlay] is [compatible] with the [Overlay] instance that
  * was last [shown][show] by the [dialog][OverlayDialogHolder.dialog] managed by the receiver.
@@ -91,7 +72,7 @@ public fun <OverlayT : Overlay> OverlayDialogHolder<OverlayT>.show(
   // Why is this an extension rather than part of the interface?
   // When wrapping, we need to prevent recursive calls from clobbering
   // `environment[InOverlay]` with the nested rendering type.
-  runner.showRendering(overlay, environment + (InOverlay to overlay))
+  runner(overlay, environment + (InOverlay to overlay))
 }
 
 /**
@@ -106,7 +87,7 @@ public val OverlayDialogHolder<*>.showing: Overlay
 public fun <OverlayT : Overlay> OverlayDialogHolder(
   initialEnvironment: ViewEnvironment,
   dialog: Dialog,
-  runner: OverlayDialogRunner<OverlayT>
+  runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit
 ): OverlayDialogHolder<OverlayT> {
   return RealOverlayDialogHolder(initialEnvironment, dialog, runner)
 }
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/RealOverlayDialogHolder.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/RealOverlayDialogHolder.kt
@@ -8,15 +8,14 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 internal class RealOverlayDialogHolder<OverlayT : Overlay>(
   initialEnvironment: ViewEnvironment,
   override val dialog: Dialog,
-  dialogRunner: OverlayDialogRunner<OverlayT>
+  runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit
 ) : OverlayDialogHolder<OverlayT> {
 
   private var _environment: ViewEnvironment = initialEnvironment
   override val environment: ViewEnvironment get() = _environment
 
-  override val runner: OverlayDialogRunner<OverlayT> =
-    OverlayDialogRunner { newScreen, newEnvironment ->
-      _environment = newEnvironment
-      dialogRunner.showRendering(newScreen, newEnvironment)
-    }
+  override val runner = { newScreen: OverlayT, newEnvironment: ViewEnvironment ->
+    _environment = newEnvironment
+    runner(newScreen, newEnvironment)
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ internal class LoadingLayoutRunner<RenderingT : Screen>(`
`39`	`39`
`40`	`40`	`override fun showRendering(`
`41`	`41`	`rendering: RenderingT,`
`42`		`- viewEnvironment: ViewEnvironment`
	`42`	`+ environment: ViewEnvironment`
`43`	`43`	`) {`
`44`	`44`	`// No-op.`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ class ShakeableTimeMachineLayoutRunner(`
`41`	`41`
`42`	`42`	`override fun showRendering(`
`43`	`43`	`rendering: ShakeableTimeMachineScreen,`
`44`		`- viewEnvironment: ViewEnvironment`
	`44`	`+ environment: ViewEnvironment`
`45`	`45`	`) {`
`46`	`46`	`// Only handle back presses explicitly if in playback mode.`
`47`	`47`	`view.backPressedHandler = rendering.onResumeRecording.takeUnless { rendering.recording }`
`@@ -80,7 +80,7 @@ class ShakeableTimeMachineLayoutRunner(`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`// Show the child screen.`
`83`		`- childStub.show(rendering.rendering, viewEnvironment)`
	`83`	`+ childStub.show(rendering.rendering, environment)`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`private fun Duration.toProgressInt(): Int = this.inWholeMilliseconds.toInt()`