Renames Workflow.run() to take(), improves kdoc, tweaks error messages.

Author: rjrjr

samples/containers/android/src/main/java/com/squareup/sample/container/overviewdetail/OverviewDetailContainer.kt

@@ -53,7 +53,7 @@ class OverviewDetailContainer(view: View) : LayoutRunner<OverviewDetailScreen> {
     if (rendering.detailRendering == null && rendering.selectDefault != null) {
       rendering.selectDefault!!.invoke()
     } else {
-      // Since we have two sibling backstacks, we need to give them each different
+      // Since we have two sibling back stacks, we need to give them each different
       // SavedStateRegistry key prefixes.
       val overviewViewEnvironment = viewEnvironment
         .withBackStackStateKeyPrefix(OverviewBackStackKey) + (OverviewDetailConfig to Overview)

samples/hello-workflow-fragment/src/main/java/com/squareup/sample/helloworkflowfragment/HelloWorkflowFragment.kt

@@ -26,7 +26,7 @@ class HelloWorkflowFragment : Fragment() {
     val model: HelloViewModel = ViewModelProvider(this).get(HelloViewModel::class.java)
 
     return WorkflowLayout(inflater.context).apply {
-      run(model.renderings)
+      take(model.renderings)
     }
   }
 }

samples/hello-workflow/src/main/java/com/squareup/sample/helloworkflow/HelloWorkflowActivity.kt

@@ -21,7 +21,7 @@ class HelloWorkflowActivity : AppCompatActivity() {
     // succeeding calls.
     val model: HelloViewModel by viewModels()
     setContentView(
-      WorkflowLayout(this).apply { run(model.renderings) }
+      WorkflowLayout(this).apply { take(model.renderings) }
     )
   }
 }

samples/stub-visibility/src/main/java/com/squareup/sample/stubvisibility/StubVisibilityActivity.kt

@@ -20,7 +20,7 @@ class StubVisibilityActivity : AppCompatActivity() {
 
     val model: StubVisibilityModel by viewModels()
     setContentView(
-      WorkflowLayout(this).apply { run(model.renderings) }
+      WorkflowLayout(this).apply { take(model.renderings) }
     )
   }
 }

workflow-ui/compose-tooling/src/main/java/com/squareup/workflow1/ui/compose/tooling/ViewFactories.kt

@@ -1,5 +1,3 @@
-@file:Suppress("DEPRECATION")
-
 package com.squareup.workflow1.ui.compose.tooling
 
 import androidx.compose.foundation.layout.Arrangement.Absolute.spacedBy
@@ -11,7 +9,6 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
-import com.squareup.workflow1.ui.AsScreen.Companion.asScreen
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.ViewFactory
 import com.squareup.workflow1.ui.ViewRegistry
@@ -43,7 +40,7 @@ import com.squareup.workflow1.ui.compose.composeViewFactory
 ) {
   val previewEnvironment =
     previewViewEnvironment(placeholderModifier, viewEnvironmentUpdater, mainFactory = this)
-  WorkflowRendering(asScreen(rendering), previewEnvironment, modifier)
+  WorkflowRendering(rendering, previewEnvironment, modifier)
 }
 
 @OptIn(WorkflowUiExperimentalApi::class)
@@ -56,8 +53,8 @@ import com.squareup.workflow1.ui.compose.composeViewFactory
     ) {
       BasicText("Top text")
       WorkflowRendering(
-        rendering = asScreen("Child rendering with very long text to suss out cross-hatch rendering " +
-          "edge cases"),
+        rendering = "Child rendering with very long text to suss out cross-hatch rendering " +
+          "edge cases",
         viewEnvironment = environment,
         modifier = Modifier
           .aspectRatio(1f)

workflow-ui/container-android/src/androidTest/AndroidManifest.xml

@@ -1,4 +1,4 @@
-<manifest package="container.test"
+<manifest package="com.squareup.workflow1.ui.container.test"
     xmlns:android="http://schemas.android.com/apk/res/android">
 
   <application>

workflow-ui/container-android/src/main/java/com/squareup/workflow1/ui/backstack/BackStackContainer.kt

@@ -6,6 +6,13 @@ import com.squareup.workflow1.ui.DecorativeViewFactory
 import com.squareup.workflow1.ui.ViewFactory
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 
+/**
+ * BackStackContainer has been promoted to the core workflow-ui modules,
+ * and is now built into [ViewRegistry][com.squareup.workflow1.ui.ViewRegistry] by default.
+ *
+ * This stub has been left in place to preserve the name of the legacy [ViewFactory],
+ * to ease conversion.
+ */
 @Deprecated("Use com.squareup.workflow1.ui.container.BackStackContainer")
 @WorkflowUiExperimentalApi
 public class BackStackContainer {

workflow-ui/container-android/src/main/java/com/squareup/workflow1/ui/modal/ModalContainer.kt

@@ -17,14 +17,13 @@ import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.Lifecycle.Event.ON_DESTROY
 import androidx.lifecycle.LifecycleObserver
 import androidx.lifecycle.OnLifecycleEvent
-import com.squareup.workflow1.ui.AsScreen.Companion.asScreen
 import com.squareup.workflow1.ui.Compatible
 import com.squareup.workflow1.ui.ViewEnvironment
-import com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.WorkflowViewStub
-import com.squareup.workflow1.ui.container.withBackStackStateKeyPrefix
+import com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner
 import com.squareup.workflow1.ui.compatible
+import com.squareup.workflow1.ui.container.withBackStackStateKeyPrefix
 
 /**
  * Base class for containers that show [HasModals.modals] in [Dialog] windows.

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

@@ -15,9 +15,9 @@ package com.squareup.workflow1.ui
  *       val onClick: () -> Unit
  *     ) : AndroidScreen<HelloScreen> {
  *       override val viewFactory: ScreenViewFactory<HelloScreen> =
- *         ScreenViewRunner.bind(HelloGoodbyeLayoutBinding::inflate) { r, _ ->
- *           helloMessage.text = r.message
- *           helloMessage.setOnClickListener { r.onClick() }
+ *         ScreenViewRunner.bind(HelloGoodbyeLayoutBinding::inflate) { screen, _ ->
+ *           helloMessage.text = screen.message
+ *           helloMessage.setOnClickListener { screen.onClick() }
  *         }
  *     }
  *

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

@@ -21,9 +21,8 @@ public fun <RenderingT : Any>
     }
     ?: (rendering as? Named<*>)?.let { NamedViewFactory as ViewFactory<RenderingT> }
     ?: throw IllegalArgumentException(
-      "A ${ViewFactory::class.qualifiedName} should have been registered to display " +
-        "${rendering::class.qualifiedName} instances, or that class should implement " +
-        "${AndroidViewRendering::class.simpleName}<${rendering::class.simpleName}>."
+      "A ViewFactory should have been registered to display $rendering, " +
+        "or that class should implement AndroidViewRendering."
     )
 }