Merge pull request #845 from square/ray/let-it-show-let-it-show-let-it-show

Replaces `Showing` and `InOverlay` with `View` tags.

Author: rjrjr

samples/tictactoe/app/src/androidTest/java/com/squareup/sample/TicTacToeEspressoTest.kt

@@ -42,7 +42,7 @@ import org.junit.runner.RunWith
 class TicTacToeEspressoTest {
 
   private val scenarioRule = ActivityScenarioRule(TicTacToeActivity::class.java)
-  @get:Rule val rules = RuleChain.outerRule(DetectLeaksAfterTestSuccess())
+  @get:Rule val rules: RuleChain = RuleChain.outerRule(DetectLeaksAfterTestSuccess())
     .around(scenarioRule)
     .around(IdlingDispatcherRule)
   private val scenario get() = scenarioRule.scenario

workflow-ui/container-common/src/main/java/com/squareup/workflow1/ui/backstack/BackStackScreen.kt

@@ -8,9 +8,6 @@ import com.squareup.workflow1.ui.asScreen
 import com.squareup.workflow1.ui.container.BackStackScreen as NewBackStackScreen
 
 /**
- * **This will be deprecated in favor of
- * [com.squareup.workflow1.ui.container.BackStackScreen] very soon.**
- *
  * Represents an active screen ([top]), and a set of previously visited screens to which we may
  * return ([backStack]). By rendering the entire history we allow the UI to do things like maintain
  * cached view state, implement drag-back gestures without waiting for the workflow, etc.

workflow-ui/core-android/api/core-android.api

@@ -191,25 +191,11 @@ public final class com/squareup/workflow1/ui/ScreenViewFactoryKt {
 }
 
 public abstract interface class com/squareup/workflow1/ui/ScreenViewHolder {
-	public static final field Companion Lcom/squareup/workflow1/ui/ScreenViewHolder$Companion;
 	public abstract fun getEnvironment ()Lcom/squareup/workflow1/ui/ViewEnvironment;
 	public abstract fun getRunner ()Lcom/squareup/workflow1/ui/ScreenViewRunner;
 	public abstract fun getView ()Landroid/view/View;
 }
 
-public final class com/squareup/workflow1/ui/ScreenViewHolder$Companion {
-}
-
-public final class com/squareup/workflow1/ui/ScreenViewHolder$Companion$Showing : com/squareup/workflow1/ui/ViewEnvironmentKey {
-	public static final field INSTANCE Lcom/squareup/workflow1/ui/ScreenViewHolder$Companion$Showing;
-	public fun getDefault ()Lcom/squareup/workflow1/ui/Screen;
-	public synthetic fun getDefault ()Ljava/lang/Object;
-}
-
-public final class com/squareup/workflow1/ui/ScreenViewHolder$Companion$ShowingNothing : com/squareup/workflow1/ui/Screen {
-	public static final field INSTANCE Lcom/squareup/workflow1/ui/ScreenViewHolder$Companion$ShowingNothing;
-}
-
 public final class com/squareup/workflow1/ui/ScreenViewHolderKt {
 	public static final fun ScreenViewHolder (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/view/View;Lcom/squareup/workflow1/ui/ScreenViewRunner;)Lcom/squareup/workflow1/ui/ScreenViewHolder;
 	public static final fun canShow (Lcom/squareup/workflow1/ui/ScreenViewHolder;Lcom/squareup/workflow1/ui/Screen;)Z
@@ -277,10 +263,12 @@ public final class com/squareup/workflow1/ui/ViewShowRenderingKt {
 	public static final fun getEnvironment (Landroid/view/View;)Lcom/squareup/workflow1/ui/ViewEnvironment;
 	public static final fun getEnvironmentOrNull (Landroid/view/View;)Lcom/squareup/workflow1/ui/ViewEnvironment;
 	public static final synthetic fun getRendering (Landroid/view/View;)Ljava/lang/Object;
+	public static final fun getScreen (Landroid/view/View;)Lcom/squareup/workflow1/ui/Screen;
 	public static final fun getScreenOrNull (Landroid/view/View;)Lcom/squareup/workflow1/ui/Screen;
 	public static final fun getShowRendering (Landroid/view/View;)Lkotlin/jvm/functions/Function2;
 	public static final fun getStarter (Landroid/view/View;)Lkotlin/jvm/functions/Function1;
 	public static final fun getStarterOrNull (Landroid/view/View;)Lkotlin/jvm/functions/Function1;
+	public static final fun setScreen (Landroid/view/View;Lcom/squareup/workflow1/ui/Screen;)V
 	public static final fun setStarter (Landroid/view/View;Lkotlin/jvm/functions/Function1;)V
 	public static final fun showRendering (Landroid/view/View;Ljava/lang/Object;Lcom/squareup/workflow1/ui/ViewEnvironment;)V
 	public static final fun start (Landroid/view/View;)V
@@ -536,8 +524,16 @@ public final class com/squareup/workflow1/ui/container/CoveredByModal : com/squa
 	public synthetic fun getDefault ()Ljava/lang/Object;
 }
 
+public final class com/squareup/workflow1/ui/container/DialogOverlayKt {
+	public static final fun getDecorView (Landroid/app/Dialog;)Landroid/view/View;
+	public static final fun getDecorViewOrNull (Landroid/app/Dialog;)Landroid/view/View;
+	public static final fun getOverlay (Landroid/app/Dialog;)Lcom/squareup/workflow1/ui/container/Overlay;
+	public static final fun getOverlayOrNull (Landroid/app/Dialog;)Lcom/squareup/workflow1/ui/container/Overlay;
+	public static final fun setOverlay (Landroid/app/Dialog;Lcom/squareup/workflow1/ui/container/Overlay;)V
+}
+
 public final class com/squareup/workflow1/ui/container/DialogSession {
-	public fun <init> (ILcom/squareup/workflow1/ui/container/OverlayDialogHolder;)V
+	public fun <init> (ILcom/squareup/workflow1/ui/container/Overlay;Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;)V
 	public final fun dismiss ()V
 	public final fun getHolder ()Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;
 	public final fun getSavedStateRegistryKey ()Ljava/lang/String;
@@ -653,27 +649,13 @@ public final class com/squareup/workflow1/ui/container/OverlayDialogFactoryKt {
 }
 
 public abstract interface class com/squareup/workflow1/ui/container/OverlayDialogHolder {
-	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 getOnBackPressed ()Lkotlin/jvm/functions/Function0;
 	public abstract fun getOnUpdateBounds ()Lkotlin/jvm/functions/Function1;
 	public abstract fun getRunner ()Lkotlin/jvm/functions/Function2;
 }
 
-public final class com/squareup/workflow1/ui/container/OverlayDialogHolder$Companion {
-}
-
-public final class com/squareup/workflow1/ui/container/OverlayDialogHolder$Companion$InOverlay : com/squareup/workflow1/ui/ViewEnvironmentKey {
-	public static final field INSTANCE Lcom/squareup/workflow1/ui/container/OverlayDialogHolder$Companion$InOverlay;
-	public fun getDefault ()Lcom/squareup/workflow1/ui/container/Overlay;
-	public synthetic fun getDefault ()Ljava/lang/Object;
-}
-
-public final class com/squareup/workflow1/ui/container/OverlayDialogHolder$Companion$NoOverlay : com/squareup/workflow1/ui/container/Overlay {
-	public static final field INSTANCE Lcom/squareup/workflow1/ui/container/OverlayDialogHolder$Companion$NoOverlay;
-}
-
 public final class com/squareup/workflow1/ui/container/OverlayDialogHolderKt {
 	public static final fun OverlayDialogHolder (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/app/Dialog;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function0;Lkotlin/jvm/functions/Function2;)Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;
 	public static synthetic fun OverlayDialogHolder$default (Lcom/squareup/workflow1/ui/ViewEnvironment;Landroid/app/Dialog;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function0;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)Lcom/squareup/workflow1/ui/container/OverlayDialogHolder;

workflow-ui/core-android/src/androidTest/java/com/squareup/workflow1/ui/container/DialogIntegrationTest.kt

@@ -14,8 +14,6 @@ import com.squareup.workflow1.ui.ScreenViewHolder
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowLayout
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.container.OverlayDialogHolder.Companion.InOverlay
-import com.squareup.workflow1.ui.environmentOrNull
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -104,7 +102,7 @@ internal class DialogIntegrationTest {
 
     scenario.onActivity {
       root.show(twoDialogs)
-      val lastOverlay = latestContentView?.environmentOrNull?.get(InOverlay)!!
+      val lastOverlay = latestDialog?.overlay
       assertThat(lastOverlay).isEqualTo(dialog2)
     }
   }

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/AndroidViewRegistry.kt

@@ -10,10 +10,6 @@ import com.squareup.workflow1.ui.container.EnvironmentScreenLegacyViewFactory
 import kotlin.reflect.KClass
 
 /**
- * **This will be deprecated in favor of
- * [ScreenViewFactoryFinder.getViewFactoryForRendering]
- * very soon.**
- *
  * It is usually more convenient to use [WorkflowViewStub] or [DecorativeViewFactory]
  * than to call this method directly.
  *
@@ -49,8 +45,6 @@ public fun <RenderingT : Any> ViewRegistry.getFactoryForRendering(
 }
 
 /**
- * **This will be deprecated in favor of [ViewRegistry.getEntryFor] very soon.**
- *
  * This method is not for general use, use [WorkflowViewStub] instead.
  *
  * Returns the [ViewFactory] that was registered for the given [renderingType], or null
@@ -68,8 +62,6 @@ public fun <RenderingT : Any> ViewRegistry.getFactoryFor(
 }
 
 /**
- * **This will be deprecated in favor of [ScreenViewFactory.startShowing] very soon.**
- *
  * It is usually more convenient to use [WorkflowViewStub] or [DecorativeViewFactory]
  * than to call this method directly.
  *

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/AndroidViewRendering.kt

@@ -1,8 +1,6 @@
 package com.squareup.workflow1.ui
 
 /**
- * **This will be deprecated in favor of [AndroidScreen] very soon.**
- *
  * Interface implemented by a rendering class to allow it to drive an Android UI
  * via an appropriate [ViewFactory] implementation.
  *

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/BackButtonScreen.kt

@@ -1,9 +1,6 @@
 package com.squareup.workflow1.ui
 
 /**
- * **This will be deprecated in favor of
- * [com.squareup.workflow1.ui.container.BackButtonScreen] very soon.**
- *
  * Adds optional back button handling to a [wrapped] rendering, possibly overriding that
  * the wrapped rendering's own back button handler.
  *

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/BuilderViewFactory.kt

@@ -6,8 +6,6 @@ import android.view.ViewGroup
 import kotlin.reflect.KClass
 
 /**
- * **This will be deprecated in favor of [ScreenViewFactory.fromCode] very soon.**
- *
  * A [ViewFactory] that creates [View]s that need to be generated from code.
  * (Use [LayoutRunner] to work with XML layout resources.)
  *

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/DecorativeViewFactory.kt

@@ -6,8 +6,6 @@ import android.view.ViewGroup
 import kotlin.reflect.KClass
 
 /**
- * **This will be deprecated in favor of [ScreenViewFactory.forWrapper] very soon.**
- *
  * A [ViewFactory] for [OuterT] that delegates view construction responsibilities
  * to the factory registered for [InnerT]. Makes it convenient for [OuterT] to wrap
  * instances of [InnerT] to add information or behavior, without requiring wasteful wrapping

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/LayoutRunner.kt

@@ -6,8 +6,6 @@ import androidx.annotation.LayoutRes
 import androidx.viewbinding.ViewBinding
 
 /**
- * **This will be deprecated in favor of [ScreenViewRunner] very soon.**
- *
  * A delegate that implements a [showRendering] method to be called when a workflow rendering
  * of type [RenderingT] is ready to be displayed in a view inflated from a layout resource
  * by a [ViewRegistry]. (Use [BuilderViewFactory] if you want to build views from code rather