699: Cleanup and name Poetry components

Author: steve-the-edwards

benchmarks/performancepoetry/api/performancepoetry.api

@@ -0,0 +1,16 @@
+public final class com/squareup/benchmarks/performance/poetry/PerformancePoetryActivity : androidx/appcompat/app/AppCompatActivity {
+	public static final field Companion Lcom/squareup/benchmarks/performance/poetry/PerformancePoetryActivity$Companion;
+	public fun <init> ()V
+}
+
+public final class com/squareup/benchmarks/performance/poetry/PerformancePoetryActivity$Companion {
+}
+
+public final class com/squareup/benchmarks/performance/poetry/PerformancePoetryActivityKt {
+}
+
+public final class com/squareup/benchmarks/performance/poetry/PoetryModel : androidx/lifecycle/ViewModel {
+	public fun <init> (Landroidx/lifecycle/SavedStateHandle;)V
+	public final fun getRenderings ()Lkotlinx/coroutines/flow/StateFlow;
+}
+

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/PoemListRendering.kt

@@ -20,12 +20,16 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 data class PoemListRendering(
   val poems: List<Poem>,
   val onPoemSelected: (Int) -> Unit,
-  val selection: Int = -1
+  val selection: Int = NO_POEM_SELECTED
 ) : AndroidViewRendering<PoemListRendering> {
   override val viewFactory = LayoutRunner.bind(
     R.layout.list,
     ::PoemListLayoutRunner
   )
+
+  companion object {
+    const val NO_POEM_SELECTED: Int = -1
+  }
 }
 
 @OptIn(WorkflowUiExperimentalApi::class)

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/PoemListWorkflow.kt

@@ -4,9 +4,9 @@ import com.squareup.sample.poetry.model.Poem
 import com.squareup.workflow1.StatelessWorkflow
 
 /**
- * Renders a given ordered list of [Poem]s. Reports the index of any that are clicked.
+ * Renders a given ordered list of [Poem]s. Reports the index of any that are clicked via Output.
  */
-object PoemListWorkflow : StatelessWorkflow<List<Poem>, Int, PoemListRendering>() {
+object PoemListWorkflow : StatelessWorkflow<List<Poem>, SelectedPoem, PoemListRendering>() {
 
   override fun render(
     renderProps: List<Poem>,

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/PoemWorkflow.kt

@@ -20,29 +20,32 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.backstack.BackStackScreen
 import com.squareup.workflow1.ui.backstack.toBackStackScreen
 
+typealias SelectedStanza = Int
+
 /**
  * Renders a [Poem] as a [OverviewDetailScreen], whose overview is a [StanzaListRendering]
  * for the poem, and whose detail traverses through [StanzaRendering]s.
  */
-object PoemWorkflow : StatefulWorkflow<Poem, Int, ClosePoem, OverviewDetailScreen>() {
+object PoemWorkflow : StatefulWorkflow<Poem, SelectedStanza, ClosePoem, OverviewDetailScreen>() {
   object ClosePoem
+  public const val NO_SELECTED_STANZA = -1
 
   override fun initialState(
     props: Poem,
     snapshot: Snapshot?
   ): Int {
     return snapshot?.bytes?.parse { source -> source.readInt() }
-      ?: -1
+      ?: NO_SELECTED_STANZA
   }
 
   @OptIn(WorkflowUiExperimentalApi::class)
   override fun render(
     renderProps: Poem,
-    renderState: Int,
+    renderState: SelectedStanza,
     context: RenderContext
   ): OverviewDetailScreen {
     val previousStanzas: List<StanzaRendering> =
-      if (renderState == -1) emptyList()
+      if (renderState == NO_SELECTED_STANZA) emptyList()
       else renderProps.stanzas.subList(0, renderState)
         .mapIndexed { index, _ ->
           context.renderChild(StanzaWorkflow, Props(renderProps, index), "$index") {
@@ -88,7 +91,7 @@ object PoemWorkflow : StatefulWorkflow<Poem, Int, ClosePoem, OverviewDetailScree
     sink.writeInt(state)
   }
 
-  private sealed class Action : WorkflowAction<Poem, Int, ClosePoem>() {
+  private sealed class Action : WorkflowAction<Poem, SelectedStanza, ClosePoem>() {
     object ClearSelection : Action()
     object SelectPrevious : Action()
     object SelectNext : Action()
@@ -97,11 +100,11 @@ object PoemWorkflow : StatefulWorkflow<Poem, Int, ClosePoem, OverviewDetailScree
 
     override fun Updater.apply() {
       when (this@Action) {
-        ClearSelection -> state = -1
+        ClearSelection -> state = NO_SELECTED_STANZA
         SelectPrevious -> state -= 1
         SelectNext -> state += 1
         is HandleStanzaListOutput -> {
-          if (selection == -1) setOutput(ClosePoem)
+          if (selection == NO_SELECTED_STANZA) setOutput(ClosePoem)
           state = selection
         }
         ExitPoem -> setOutput(ClosePoem)

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/PoemsBrowserWorkflow.kt

@@ -1,6 +1,7 @@
 package com.squareup.sample.poetry
 
 import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
+import com.squareup.sample.poetry.PoemListRendering.Companion.NO_POEM_SELECTED
 import com.squareup.sample.poetry.model.Poem
 import com.squareup.workflow1.Snapshot
 import com.squareup.workflow1.StatefulWorkflow
@@ -13,12 +14,13 @@ typealias SelectedPoem = Int
 
 object PoemsBrowserWorkflow :
   StatefulWorkflow<List<Poem>, SelectedPoem, Nothing, OverviewDetailScreen>() {
+
   override fun initialState(
     props: List<Poem>,
     snapshot: Snapshot?
   ): SelectedPoem {
     return snapshot?.bytes?.parse { source -> source.readInt() }
-      ?: -1
+      ?: NO_POEM_SELECTED
   }
 
   @OptIn(WorkflowUiExperimentalApi::class)
@@ -32,7 +34,7 @@ object PoemsBrowserWorkflow :
         .copy(selection = renderState)
         .let { OverviewDetailScreen(BackStackScreen(it)) }
 
-    return if (renderState == -1) {
+    return if (renderState == NO_POEM_SELECTED) {
       poems
     } else {
       val poem: OverviewDetailScreen =
@@ -49,5 +51,5 @@ object PoemsBrowserWorkflow :
     state = index
   }
 
-  private val clearSelection = choosePoem(-1)
+  private val clearSelection = choosePoem(NO_POEM_SELECTED)
 }

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaListWorkflow.kt

@@ -1,14 +1,15 @@
 package com.squareup.sample.poetry
 
+import com.squareup.sample.poetry.PoemWorkflow.NO_SELECTED_STANZA
 import com.squareup.sample.poetry.model.Poem
 import com.squareup.workflow1.StatelessWorkflow
 
 /**
  * Given a [Poem], renders a list of its [initialStanzas][Poem.initialStanzas].
  *
- * Output is the index of a clicked stanza, or -1 on exit.
+ * Output is the index of a clicked stanza, or [-1][NO_SELECTED_STANZA] on exit.
  */
-object StanzaListWorkflow : StatelessWorkflow<Poem, Int, StanzaListRendering>() {
+object StanzaListWorkflow : StatelessWorkflow<Poem, SelectedStanza, StanzaListRendering>() {
 
   override fun render(
     renderProps: Poem,
@@ -19,7 +20,7 @@ object StanzaListWorkflow : StatelessWorkflow<Poem, Int, StanzaListRendering>()
       subtitle = renderProps.poet.fullName,
       firstLines = renderProps.initialStanzas,
       onStanzaSelected = context.eventHandler { index -> setOutput(index) },
-      onExit = context.eventHandler { setOutput(-1) }
+      onExit = context.eventHandler { setOutput(NO_SELECTED_STANZA) }
     )
   }
 }