Update templates

[tir38]

IMO these templates would be more helpful if they let users set types in the creation dialog, not with a later refactor.

We don't always want state/props/rendering/output to have the same name as the workflow. Nor
do we always want to create those states/props/renderings/output. Sometimes those classes already
exist (e.g. Unit, Nothing, Any).

Stateful and Stateless Workflow templates now take in optional props/state/rendering/output. If these are left blank they will be auto created

Test

1. In Android Studio -> File -> New -> Edit File Templates....
2. create a new template or update existing and copy/paste code from these .kt files
3. File -> New -> select a template
4. see generated file

StatefulWorkflow Template

optionals left blank

generates:

package workflow.tutorial

import com.squareup.workflow1.Snapshot
import com.squareup.workflow1.StatefulWorkflow

import workflow.tutorial.MyFancyWorkflow.MyFancyProps
import workflow.tutorial.MyFancyWorkflow.MyFancyState
import workflow.tutorial.MyFancyWorkflow.MyFancyOutput
import workflow.tutorial.MyFancyWorkflow.MyFancyRendering

object MyFancyWorkflow : StatefulWorkflow<MyFancyProps, MyFancyState, MyFancyOutput, MyFancyRendering>() {

  data class MyFancyProps(
    // TODO add args
  )

  data class MyFancyState(
    // TODO add args
  )

  data class MyFancyOutput(
    // TODO add args
  )

  data class MyFancyRendering(
    // TODO add args
  )

  override fun initialState(
    props: MyFancyProps,
    snapshot: Snapshot?
  ): MyFancyState = TODO("Initialize state")

  override fun render(
    props: MyFancyProps,
    state: MyFancyState,
    context: RenderContext
  ): MyFancyRendering {
    TODO("Render")
  }

  override fun snapshotState(state: MyFancyState): Snapshot? = Snapshot.write {
    TODO("Save state")
  }
}

optionals supplied

generates:

package workflow.tutorial

import com.squareup.workflow1.Snapshot
import com.squareup.workflow1.StatefulWorkflow

object MyFancyWorkflow : StatefulWorkflow<ExistingProps, ExistingState, Unit, ExistingScreen>() {

  override fun initialState(
    props: ExistingProps,
    snapshot: Snapshot?
  ): ExistingState = TODO("Initialize state")

  override fun render(
    props: ExistingProps,
    state: ExistingState,
    context: RenderContext
  ): ExistingScreen {
    TODO("Render")
  }

  override fun snapshotState(state: ExistingState): Snapshot? = Snapshot.write {
    TODO("Save state")
  }
}

StatelessWorkflow template

optionals left blank

generates:

package workflow.tutorial

import com.squareup.workflow1.StatelessWorkflow

import workflow.tutorial.MyFancyWorkflow.MyFancyProps
import workflow.tutorial.MyFancyWorkflow.MyFancyOutput
import workflow.tutorial.MyFancyWorkflow.MyFancyRendering

object MyFancyWorkflow : StatelessWorkflow<MyFancyProps, MyFancyOutput, MyFancyRendering>() {

  data class MyFancyProps(
    // TODO add args   
  )

  data class MyFancyOutput(
    // TODO add args   
  )

  data class MyFancyRendering(
    // TODO add args   
  )

  override fun render(
    props: MyFancyProps,
    context: RenderContext
  ): MyFancyRendering {
    TODO("Render")
  }
}

optionals supplied

generates:

package workflow.tutorial

import com.squareup.workflow1.StatelessWorkflow

object MyFancyWorkflow : StatelessWorkflow<ExistingProps, Nothing, ExistingScreen>() {

  override fun render(
    props: ExistingProps,
    context: RenderContext
  ): ExistingScreen {
    TODO("Render")
  }
}

LayoutRunner template

generates:

package workflow.tutorial

import com.squareup.workflow1.ui.LayoutRunner
import com.squareup.workflow1.ui.LayoutRunner.Companion.bind
import com.squareup.workflow1.ui.ViewEnvironment
import com.squareup.workflow1.ui.ViewFactory
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi

@OptIn(WorkflowUiExperimentalApi::class)
class MyFancyLayoutRunner(
  private val binding: MyExistingBindings
) : LayoutRunner<MyExistingScreen> {

  override fun showRendering(
    rendering: MyExistingScreen,
    viewEnvironment: ViewEnvironment
  ) {
    TODO("Update ViewBinding from rendering")
  }

  companion object : ViewFactory<MyExistingScreen> by bind(
    MyExistingBindings::inflate, ::MyFancyLayoutRunner
  )
}

[CLAassistant]

All committers have signed the CLA.

[tir38]

LMK if there is a preference on camel case vs screaming snake case

[steve-the-edwards]

This is the part where it gets trickier as suggesting this pattern of internal data classes is a goal.

[steve-the-edwards]

Not sure how complex you want it to get, but there could be an option to leave the template blank for at type and then these would be generated?

[tir38]

cool. Didn't know about the internal pattern. I'll experiment with an if --> auto generate.

[tir38]

ok @steve-the-edwards I think I have it working. If you leave an "optional" field blank then it will auto generate inner class (and import)

[steve-the-edwards]

renderProps and renderState parameters are the new API and should be maintained.

[tir38]

👍 will revert.

My copy of render() (from com.squareup.workflow1:workflow-core-jvm:1.0.0-alpha.7) still shows props/state

[steve-the-edwards]

again renderProps is the new API.

[rjrjr]

LGTM. @steve-the-edwards, you good?

[steve-the-edwards]

LGTM. Thanks very much for this @tir38 . Very sorry for the delay in reviewing!