Merge pull request #420 from square/zachklipp/rename-noop-workflowaction

Rename WorkflowAction.noop() to noAction().

Author: zach-klippenstein

kotlin/samples/hello-terminal/hello-terminal-app/src/main/java/com/squareup/sample/helloterminal/HelloTerminalWorkflow.kt

@@ -27,7 +27,7 @@ import com.squareup.workflow.Snapshot
 import com.squareup.workflow.StatefulWorkflow
 import com.squareup.workflow.WorkflowAction.Companion.emitOutput
 import com.squareup.workflow.WorkflowAction.Companion.enterState
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 import com.squareup.workflow.onWorkerOutput
 import com.squareup.workflow.renderChild
 
@@ -70,7 +70,7 @@ class HelloTerminalWorkflow : TerminalWorkflow,
         key.keyType == Backspace -> enterState(state.backspace())
         key.character == 'Q' -> emitOutput(0)
         key.character != null -> enterState(state.append(key.character!!))
-        else -> noop()
+        else -> noAction()
       }
     }
 

kotlin/samples/hello-terminal/todo-terminal-app/src/main/java/com/squareup/sample/hellotodo/EditTextWorkflow.kt

@@ -11,7 +11,7 @@ import com.squareup.workflow.RenderContext
 import com.squareup.workflow.Snapshot
 import com.squareup.workflow.StatefulWorkflow
 import com.squareup.workflow.WorkflowAction.Companion.enterState
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 import com.squareup.workflow.onWorkerOutput
 
 class EditTextWorkflow : StatefulWorkflow<EditTextInput, EditTextState, String, String>() {
@@ -58,7 +58,7 @@ class EditTextWorkflow : StatefulWorkflow<EditTextInput, EditTextState, String,
         )
         Backspace -> {
           if (input.text.isEmpty()) {
-            noop()
+            noAction()
           } else {
             enterState(
                 moveCursor(input, state, -1),
@@ -70,7 +70,7 @@ class EditTextWorkflow : StatefulWorkflow<EditTextInput, EditTextState, String,
         }
         ArrowLeft -> enterState(moveCursor(input, state, -1))
         ArrowRight -> enterState(moveCursor(input, state, 1))
-        else -> noop()
+        else -> noAction()
       }
     }
 

kotlin/samples/hello-terminal/todo-terminal-app/src/main/java/com/squareup/sample/hellotodo/TodoWorkflow.kt

@@ -29,7 +29,7 @@ import com.squareup.workflow.RenderContext
 import com.squareup.workflow.Snapshot
 import com.squareup.workflow.StatefulWorkflow
 import com.squareup.workflow.WorkflowAction.Companion.enterState
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 import com.squareup.workflow.onWorkerOutput
 
 class TodoWorkflow : TerminalWorkflow,
@@ -91,10 +91,10 @@ class TodoWorkflow : TerminalWorkflow,
           if (state.focusedField > TITLE_FIELD_INDEX) {
             enterState(state.toggleChecked(state.focusedField))
           } else {
-            noop()
+            noAction()
           }
         }
-        else -> noop()
+        else -> noAction()
       }
     }
 

kotlin/samples/tictactoe/common/src/main/java/com/squareup/sample/gameworkflow/TakeTurnsWorkflow.kt

@@ -27,7 +27,7 @@ import com.squareup.workflow.Workflow
 import com.squareup.workflow.WorkflowAction
 import com.squareup.workflow.WorkflowAction.Companion.emitOutput
 import com.squareup.workflow.WorkflowAction.Companion.enterState
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 
 typealias TakeTurnsWorkflow = Workflow<TakeTurnsInput, CompletedGame, GamePlayScreen>
 
@@ -84,7 +84,7 @@ class RealTakeTurnsWorkflow : TakeTurnsWorkflow,
     val newBoard = lastTurn.board.takeSquare(event.row, event.col, lastTurn.playing)
 
     return when {
-      newBoard == lastTurn.board -> noop()
+      newBoard == lastTurn.board -> noAction()
       newBoard.hasVictory() -> emitOutput(CompletedGame(Victory, lastTurn.copy(board = newBoard)))
       newBoard.isFull() -> emitOutput(CompletedGame(Draw, lastTurn.copy(board = newBoard)))
       else -> enterState(Turn(playing = lastTurn.playing.other, board = newBoard))

kotlin/workflow-core/src/main/java/com/squareup/workflow/RenderContext.kt

@@ -20,7 +20,7 @@ package com.squareup.workflow
 import com.squareup.workflow.Worker.OutputOrFinished
 import com.squareup.workflow.Worker.OutputOrFinished.Finished
 import com.squareup.workflow.Worker.OutputOrFinished.Output
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 
 /**
  * Facilities for a [Workflow] to interact with other [Workflow]s and the outside world from inside
@@ -152,7 +152,7 @@ fun <InputT, StateT, OutputT : Any, ChildRenderingT>
       child: Workflow<InputT, Nothing, ChildRenderingT>,
       input: InputT,
       key: String = ""
-    ): ChildRenderingT = renderChild(child, input, key) { noop() }
+    ): ChildRenderingT = renderChild(child, input, key) { noAction() }
 // @formatter:on
 
 /**
@@ -166,7 +166,7 @@ fun <StateT, OutputT : Any, ChildRenderingT>
 // @formatter:off
       child: Workflow<Unit, Nothing, ChildRenderingT>,
       key: String = ""
-    ): ChildRenderingT = renderChild(child, Unit, key) { noop() }
+    ): ChildRenderingT = renderChild(child, Unit, key) { noAction() }
 // @formatter:on
 
 /**
@@ -183,7 +183,7 @@ fun <StateT, OutputT : Any, T> RenderContext<StateT, OutputT>.onWorkerOutput(
 ) = onWorkerOutputOrFinished(worker, key) { outputOrFinished ->
   when (outputOrFinished) {
     is Output -> handler(outputOrFinished.value)
-    Finished -> noop()
+    Finished -> noAction()
   }
 }
 

kotlin/workflow-core/src/main/java/com/squareup/workflow/WorkflowAction.kt

@@ -41,9 +41,12 @@ interface WorkflowAction<StateT, out OutputT : Any> : (StateT) -> Pair<StateT, O
     }
 
     /**
-     * Returns a [WorkflowAction] that does nothing.
+     * Returns a [WorkflowAction] that does nothing: no output will be emitted, and `render` will be
+     * called again with the same `state` as last time.
+     *
+     * Use this to, for example, ignore the output of a child workflow or worker.
      */
-    fun <StateT, OutputT : Any> noop(): WorkflowAction<StateT, OutputT> =
+    fun <StateT, OutputT : Any> noAction(): WorkflowAction<StateT, OutputT> =
       WorkflowAction({ "noop" }) { Pair(it, null) }
 
     /**

kotlin/workflow-runtime/src/test/java/com/squareup/workflow/internal/RealRenderContextTest.kt

@@ -23,7 +23,7 @@ import com.squareup.workflow.StatefulWorkflow
 import com.squareup.workflow.Worker
 import com.squareup.workflow.Workflow
 import com.squareup.workflow.WorkflowAction.Companion.emitOutput
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 import com.squareup.workflow.internal.Behavior.WorkflowOutputCase
 import com.squareup.workflow.internal.RealRenderContext.Renderer
 import com.squareup.workflow.internal.RealRenderContextTest.TestRenderer.Rendering
@@ -88,7 +88,7 @@ class RealRenderContextTest {
 
   @Test fun `make sink completes update`() {
     val context = RealRenderContext<String, String>(PoisonRenderer())
-    val expectedUpdate = noop<String, String>()
+    val expectedUpdate = noAction<String, String>()
     val handler = context.onEvent<String> { expectedUpdate }
     val behavior = context.buildBehavior()
     assertFalse(behavior.nextActionFromEvent.isCompleted)

kotlin/workflow-testing/src/test/java/com/squareup/workflow/WorkerCompositionIntegrationTest.kt

@@ -22,7 +22,7 @@ import com.squareup.workflow.Worker.OutputOrFinished.Finished
 import com.squareup.workflow.Worker.OutputOrFinished.Output
 import com.squareup.workflow.WorkflowAction.Companion.emitOutput
 import com.squareup.workflow.WorkflowAction.Companion.enterState
-import com.squareup.workflow.WorkflowAction.Companion.noop
+import com.squareup.workflow.WorkflowAction.Companion.noAction
 import com.squareup.workflow.testing.testFromStart
 import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.TimeoutCancellationException
@@ -42,7 +42,7 @@ class WorkerCompositionIntegrationTest {
     var started = false
     val worker = Worker.create<Unit> { started = true }
     val workflow = Workflow.stateless<Boolean, Nothing, Unit> { input ->
-      if (input) onWorkerOutput(worker) { noop() }
+      if (input) onWorkerOutput(worker) { noAction() }
     }
 
     workflow.testFromStart(false) {
@@ -60,7 +60,7 @@ class WorkerCompositionIntegrationTest {
       }
     }
     val workflow = Workflow.stateless<Boolean, Nothing, Unit> { input ->
-      if (input) onWorkerOutput(worker) { noop() }
+      if (input) onWorkerOutput(worker) { noAction() }
     }
 
     workflow.testFromStart(true) {
@@ -83,7 +83,7 @@ class WorkerCompositionIntegrationTest {
       }
     }
     val workflow = Workflow.stateless<Unit, Nothing, Unit> { _ ->
-      onWorkerOutput(worker) { noop() }
+      onWorkerOutput(worker) { noAction() }
     }
 
     workflow.testFromStart {
@@ -113,7 +113,7 @@ class WorkerCompositionIntegrationTest {
       }
     }
     val workflow = Workflow.stateless<Boolean, Nothing, Unit> { input ->
-      if (input) onWorkerOutput(worker) { noop() }
+      if (input) onWorkerOutput(worker) { noAction() }
     }
 
     workflow.testFromStart(false) {