Introduces AlertOverlay

rjrjr · rjrjr · commit d03bed02adc4 · 2021-11-17T16:29:36.000-08:00
First concrete use of `Overlay`. Updates `hellobackbutton` sample. Note the commented out deprecations. Turns out its impossible to suppress deprecation warnings in `typealias` calls like the ones our sample apps are still using, and those can't be ported until we have a replacement for `ModalViewContainer`. Tracked in #589.
diff --git a/samples/containers/common/src/main/java/com/squareup/sample/container/panel/PanelContainerScreen.kt b/samples/containers/common/src/main/java/com/squareup/sample/container/panel/PanelContainerScreen.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.container.panel
 
 import com.squareup.workflow1.ui.Screen
diff --git a/samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/AreYouSureWorkflow.kt b/samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/AreYouSureWorkflow.kt
@@ -11,22 +11,23 @@ import com.squareup.workflow1.StatefulWorkflow
 import com.squareup.workflow1.WorkflowAction.Companion.noAction
 import com.squareup.workflow1.action
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.modal.AlertContainerScreen
-import com.squareup.workflow1.ui.modal.AlertScreen
-import com.squareup.workflow1.ui.modal.AlertScreen.Button.NEGATIVE
-import com.squareup.workflow1.ui.modal.AlertScreen.Button.POSITIVE
-import com.squareup.workflow1.ui.modal.AlertScreen.Event.ButtonClicked
-import com.squareup.workflow1.ui.modal.AlertScreen.Event.Canceled
+import com.squareup.workflow1.ui.container.AlertOverlay
+import com.squareup.workflow1.ui.container.AlertOverlay.Button.NEGATIVE
+import com.squareup.workflow1.ui.container.AlertOverlay.Button.POSITIVE
+import com.squareup.workflow1.ui.container.AlertOverlay.Event.ButtonClicked
+import com.squareup.workflow1.ui.container.AlertOverlay.Event.Canceled
+import com.squareup.workflow1.ui.container.BodyAndModalsScreen
 import com.squareup.workflow1.ui.toParcelable
 import com.squareup.workflow1.ui.toSnapshot
 import kotlinx.parcelize.Parcelize
 
 /**
- * Wraps [HelloBackButtonWorkflow] to (sometimes) pop a confirmation dialog when the back
+ * Wraps [HelloBackButtonWorkflow] to (sometimes) pop a confirmation alert when the back
  * button is pressed.
  */
 @OptIn(WorkflowUiExperimentalApi::class)
-object AreYouSureWorkflow : StatefulWorkflow<Unit, State, Finished, AlertContainerScreen<*>>() {
+object AreYouSureWorkflow :
+  StatefulWorkflow<Unit, State, Finished, BodyAndModalsScreen<*, AlertOverlay>>() {
   override fun initialState(
     props: Unit,
     snapshot: Snapshot?
@@ -44,42 +45,42 @@ object AreYouSureWorkflow : StatefulWorkflow<Unit, State, Finished, AlertContain
     renderProps: Unit,
     renderState: State,
     context: RenderContext
-  ): AlertContainerScreen<*> {
+  ): BodyAndModalsScreen<*, AlertOverlay> {
     val ableBakerCharlie = context.renderChild(HelloBackButtonWorkflow, Unit) { noAction() }
 
     return when (renderState) {
       Running -> {
-        AlertContainerScreen(
-            BackButtonScreen(ableBakerCharlie) {
-              // While we always provide a back button handler, by default the view code
-              // associated with BackButtonScreen ignores ours if the view created for the
-              // wrapped rendering sets a handler of its own. (Set BackButtonScreen.override
-              // to change this precedence.)
-              context.actionSink.send(maybeQuit)
-            }
+        BodyAndModalsScreen(
+          BackButtonScreen(ableBakerCharlie) {
+            // While we always provide a back button handler, by default the view code
+            // associated with BackButtonScreen ignores ours if the view created for the
+            // wrapped rendering sets a handler of its own. (Set BackButtonScreen.override
+            // to change this precedence.)
+            context.actionSink.send(maybeQuit)
+          }
         )
       }
       Quitting -> {
-        val dialog = AlertScreen(
-            buttons = mapOf(
-                POSITIVE to "I'm Positive",
-                NEGATIVE to "Negatory"
-            ),
-            message = "Are you sure you want to do this thing?",
-            onEvent = { alertEvent ->
-              context.actionSink.send(
-                  when (alertEvent) {
-                    is ButtonClicked -> when (alertEvent.button) {
-                      POSITIVE -> confirmQuit
-                      else -> cancelQuit
-                    }
-                    Canceled -> cancelQuit
-                  }
-              )
-            }
+        val alert = AlertOverlay(
+          buttons = mapOf(
+            POSITIVE to "I'm Positive",
+            NEGATIVE to "Negatory"
+          ),
+          message = "Are you sure you want to do this thing?",
+          onEvent = { alertEvent ->
+            context.actionSink.send(
+              when (alertEvent) {
+                is ButtonClicked -> when (alertEvent.button) {
+                  POSITIVE -> confirmQuit
+                  else -> cancelQuit
+                }
+                Canceled -> cancelQuit
+              }
+            )
+          }
         )
 
-        AlertContainerScreen(ableBakerCharlie, dialog)
+        BodyAndModalsScreen(ableBakerCharlie, alert)
       }
     }
   }
diff --git a/samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/HelloBackButtonActivity.kt b/samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/HelloBackButtonActivity.kt
@@ -1,3 +1,4 @@
+@file:Suppress("DEPRECATION")
 @file:OptIn(WorkflowUiExperimentalApi::class)
 
 package com.squareup.sample.hellobackbutton
diff --git a/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/Component.kt b/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/Component.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.dungeon
 
 import android.content.Context.VIBRATOR_SERVICE
diff --git a/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/DungeonAppWorkflow.kt b/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/DungeonAppWorkflow.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.dungeon
 
 import com.squareup.sample.dungeon.DungeonAppWorkflow.Props
diff --git a/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/GameSessionWorkflow.kt b/samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/GameSessionWorkflow.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.dungeon
 
 import android.os.Vibrator
diff --git a/samples/tictactoe/app/src/main/java/com/squareup/sample/mainactivity/TicTacToeActivity.kt b/samples/tictactoe/app/src/main/java/com/squareup/sample/mainactivity/TicTacToeActivity.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.mainactivity
 
 import android.os.Bundle
diff --git a/workflow-ui/container-android/src/main/java/com/squareup/workflow1/ui/modal/AlertContainer.kt b/workflow-ui/container-android/src/main/java/com/squareup/workflow1/ui/modal/AlertContainer.kt
@@ -27,6 +27,7 @@ import com.squareup.workflow1.ui.modal.AlertScreen.Event.Canceled
  * Renders the [AlertScreen]s of an [AlertContainerScreen] as [AlertDialog]s.
  */
 @WorkflowUiExperimentalApi
+@Deprecated("Use BodyAndModalsContainer and the built in OverlayDialogFactory for AlertOverlay")
 public class AlertContainer @JvmOverloads constructor(
   context: Context,
   attributeSet: AttributeSet? = null,
diff --git a/workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/modal/AlertContainerScreen.kt b/workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/modal/AlertContainerScreen.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.workflow1.ui.modal
 
 import com.squareup.workflow1.ui.Screen
@@ -9,6 +11,16 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
  * @param B the type of [beneathModals]
  */
 @WorkflowUiExperimentalApi
+// Can't quite deprecate this yet, because such warnings are impossible to suppress
+// in the typealias uses in the Tic Tac Toe sample. Will uncomment before merging to main.
+// https://github.com/square/workflow-kotlin/issues/589
+// @Deprecated(
+//   "Use BodyAndModalsScreen",
+//   ReplaceWith(
+//     "BodyAndModalsScreen<B>(beneathModals, modals)",
+//     "com.squareup.workflow1.ui.container.BodyAndModalsScreen"
+//   )
+// )
 public data class AlertContainerScreen<B : Any>(
   override val beneathModals: B,
   override val modals: List<AlertScreen> = emptyList()
diff --git a/workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/modal/AlertScreen.kt b/workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/modal/AlertScreen.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.workflow1.ui.modal
 
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
@@ -6,6 +8,16 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
  * Models a typical "You sure about that?" alert box.
  */
 @WorkflowUiExperimentalApi
+// Can't quite deprecate this yet, because such warnings are impossible to suppress
+// in the typealias uses in the Tic Tac Toe sample. Will uncomment before merging to main.
+// https://github.com/square/workflow-kotlin/issues/589
+// @Deprecated(
+//   "Use AlertOverlay",
+//   ReplaceWith(
+//     "AlertOverlay(buttons, message, title, cancelable, onEvent)",
+//     "com.squareup.workflow1.ui.container.AlertOverlay"
+//   )
+// )
 public data class AlertScreen(
   val buttons: Map<Button, String> = emptyMap(),
   val message: String = "",
@@ -32,9 +44,9 @@ public data class AlertScreen(
     other as AlertScreen
 
     return buttons == other.buttons &&
-        message == other.message &&
-        title == other.title &&
-        cancelable == other.cancelable
+      message == other.message &&
+      title == other.title &&
+      cancelable == other.cancelable
   }
 
   override fun hashCode(): Int {
diff --git a/workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/modal/HasModals.kt b/workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/modal/HasModals.kt
@@ -10,6 +10,10 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
  * like `ModalContainer` in the `workflow-ui:core-android` module.
  */
 @WorkflowUiExperimentalApi
+// Can't quite deprecate this yet, because such warnings are impossible to suppress
+// in the typealias uses in the Tic Tac Toe sample. Will uncomment before merging to main.
+// https://github.com/square/workflow-kotlin/issues/589
+// @Deprecated("Use BodyAndModalsScreen")
 public interface HasModals<out B : Any, out M : Any> {
   public val beneathModals: B
   public val modals: List<M>
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/AndroidScreen.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/AndroidScreen.kt
@@ -29,10 +29,10 @@ package com.squareup.workflow1.ui
  * the [viewFactory] returned by an [AndroidScreen].
  */
 @WorkflowUiExperimentalApi
-public interface AndroidScreen<V : AndroidScreen<V>> : Screen {
+public interface AndroidScreen<S : AndroidScreen<S>> : Screen {
   /**
    * Used to build instances of [android.view.View] as needed to
    * display renderings of this type.
    */
-  public val viewFactory: ScreenViewFactory<V>
+  public val viewFactory: ScreenViewFactory<S>
 }
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/DialogViewRunner.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/DialogViewRunner.kt
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/AlertDialogThemeResId.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/AlertDialogThemeResId.kt
@@ -0,0 +1,13 @@
+package com.squareup.workflow1.ui.container
+
+import com.squareup.workflow1.ui.ViewEnvironmentKey
+import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+
+/**
+ * The default [OverlayDialogFactory] for [AlertOverlay] reads this value
+ * for the `@StyleRes themeResId: Int` argument of `AlertDialog.Builder()`.
+ */
+@WorkflowUiExperimentalApi
+public object AlertDialogThemeResId : ViewEnvironmentKey<Int>(type = Int::class) {
+  override val default: Int = 0
+}
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/AlertOverlayDialogFactory.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/AlertOverlayDialogFactory.kt
@@ -0,0 +1,67 @@
+package com.squareup.workflow1.ui.container
+
+import android.app.AlertDialog
+import android.app.Dialog
+import android.content.Context
+import android.content.DialogInterface
+import android.view.View
+import com.squareup.workflow1.ui.ViewEnvironment
+import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+import com.squareup.workflow1.ui.container.AlertOverlay.Button
+import com.squareup.workflow1.ui.container.AlertOverlay.Button.NEGATIVE
+import com.squareup.workflow1.ui.container.AlertOverlay.Button.NEUTRAL
+import com.squareup.workflow1.ui.container.AlertOverlay.Button.POSITIVE
+import com.squareup.workflow1.ui.container.AlertOverlay.Event.ButtonClicked
+import com.squareup.workflow1.ui.container.AlertOverlay.Event.Canceled
+
+@WorkflowUiExperimentalApi
+internal object AlertOverlayDialogFactory : OverlayDialogFactory<AlertOverlay> {
+  override val type = AlertOverlay::class
+
+  override fun buildDialog(
+    initialRendering: AlertOverlay,
+    initialEnvironment: ViewEnvironment,
+    bounds: RectProvider,
+    context: Context
+  ): AlertDialog {
+    return AlertDialog.Builder(context, initialEnvironment[AlertDialogThemeResId])
+      .create()
+  }
+
+  override fun updateDialog(
+    dialog: Dialog,
+    rendering: AlertOverlay,
+    environment: ViewEnvironment
+  ) {
+    val alertDialog = dialog as AlertDialog
+
+    if (rendering.cancelable) {
+      alertDialog.setOnCancelListener { rendering.onEvent(Canceled) }
+      alertDialog.setCancelable(true)
+    } else {
+      alertDialog.setCancelable(false)
+    }
+
+    for (button in Button.values()) {
+      rendering.buttons[button]
+        ?.let { name ->
+          alertDialog.setButton(button.toId(), name) { _, _ ->
+            rendering.onEvent(ButtonClicked(button))
+          }
+        }
+        ?: run {
+          alertDialog.getButton(button.toId())
+            ?.visibility = View.INVISIBLE
+        }
+    }
+
+    alertDialog.setMessage(rendering.message)
+    alertDialog.setTitle(rendering.title)
+  }
+
+  private fun Button.toId(): Int = when (this) {
+    POSITIVE -> DialogInterface.BUTTON_POSITIVE
+    NEGATIVE -> DialogInterface.BUTTON_NEGATIVE
+    NEUTRAL -> DialogInterface.BUTTON_NEUTRAL
+  }
+}
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/AndroidOverlay.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/AndroidOverlay.kt
@@ -0,0 +1,8 @@
+package com.squareup.workflow1.ui.container
+
+import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+
+@WorkflowUiExperimentalApi
+public interface AndroidOverlay<O: AndroidOverlay<O>> : Overlay {
+  public val dialogFactory: OverlayDialogFactory<O>
+}
diff --git a/workflow-ui/core-android/src/test/java/com/squareup/workflow1/ui/AndroidViewEnvironmentTest.kt b/workflow-ui/core-android/src/test/java/com/squareup/workflow1/ui/AndroidViewEnvironmentTest.kt
@@ -35,7 +35,8 @@ internal class AndroidViewEnvironmentTest {
     }
     assertThat(error.message).isEqualTo(
       "A ScreenViewFactory should have been registered to display " +
-        "FooScreen, or that class should implement AndroidScreen."
+        "FooScreen, or that class should implement AndroidScreen. " +
+        "Instead found null."
     )
   }
 
diff --git a/workflow-ui/core-common/src/main/java/com/squareup/workflow1/ui/container/AlertOverlay.kt b/workflow-ui/core-common/src/main/java/com/squareup/workflow1/ui/container/AlertOverlay.kt
@@ -0,0 +1,47 @@
+package com.squareup.workflow1.ui.container
+
+import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+
+/**
+ * Models a typical "You sure about that?" alert box.
+ */
+@WorkflowUiExperimentalApi
+public data class AlertOverlay(
+  val buttons: Map<Button, String> = emptyMap(),
+  val message: String = "",
+  val title: String = "",
+  val cancelable: Boolean = true,
+  val onEvent: (Event) -> Unit
+) : Overlay {
+  public enum class Button {
+    POSITIVE,
+    NEGATIVE,
+    NEUTRAL
+  }
+
+  public sealed class Event {
+    public data class ButtonClicked(val button: Button) : Event()
+
+    public object Canceled : Event()
+  }
+
+  override fun equals(other: Any?): Boolean {
+    if (this === other) return true
+    if (javaClass != other?.javaClass) return false
+
+    other as AlertOverlay
+
+    return buttons == other.buttons &&
+      message == other.message &&
+      title == other.title &&
+      cancelable == other.cancelable
+  }
+
+  override fun hashCode(): Int {
+    var result = buttons.hashCode()
+    result = 31 * result + message.hashCode()
+    result = 31 * result + title.hashCode()
+    result = 31 * result + cancelable.hashCode()
+    return result
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+@file:Suppress("DEPRECATION")`
	`2`	`+`
`1`	`3`	`package com.squareup.sample.container.panel`
`2`	`4`
`3`	`5`	`import com.squareup.workflow1.ui.Screen`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+@file:Suppress("DEPRECATION")`
`1`	`2`	`@file:OptIn(WorkflowUiExperimentalApi::class)`
`2`	`3`
`3`	`4`	`package com.squareup.sample.hellobackbutton`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+@file:Suppress("DEPRECATION")`
	`2`	`+`
`1`	`3`	`package com.squareup.sample.dungeon`
`2`	`4`
`3`	`5`	`import android.content.Context.VIBRATOR_SERVICE`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+@file:Suppress("DEPRECATION")`
	`2`	`+`
`1`	`3`	`package com.squareup.sample.mainactivity`
`2`	`4`
`3`	`5`	`import android.os.Bundle`