Merge pull request #35 from square/zachklipp/composedviewfactory

Rename bindCompose to composedViewFactory.

Author: zach-klippenstein

README.md

@@ -62,11 +62,11 @@ tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
 }
 ```
 
-To create a `ViewFactory`, call `bindCompose`. The lambda passed to `bindCompose` is a `@Composable`
-function.
+To create a `ViewFactory`, call `composedViewFactory`. The lambda passed to `composedViewFactory` is
+a `@Composable` function.
 
 ```kotlin
-val HelloBinding = bindCompose<MyRendering> { rendering, _ ->
+val HelloBinding = composedViewFactory<MyRendering> { rendering, _ ->
   MaterialTheme {
     Clickable(onClick = { rendering.onClick() }) {
       Text(rendering.message)
@@ -75,7 +75,7 @@ val HelloBinding = bindCompose<MyRendering> { rendering, _ ->
 }
 ```
 
-The `bindCompose` function returns a regular [`ViewFactory`][2] which can be added to a
+The `composedViewFactory` function returns a regular [`ViewFactory`][2] which can be added to a
 [`ViewRegistry`][3] like any other:
 
 ```kotlin

compose-tooling/src/androidTest/java/com/squareup/workflow/ui/compose/tooling/PreviewViewFactoryTest.kt

@@ -31,7 +31,7 @@ import androidx.ui.test.findByText
 import androidx.ui.tooling.preview.Preview
 import androidx.ui.unit.dp
 import com.squareup.workflow.ui.ViewEnvironmentKey
-import com.squareup.workflow.ui.compose.bindCompose
+import com.squareup.workflow.ui.compose.composedViewFactory
 import com.squareup.workflow.ui.compose.showRendering
 import org.junit.Rule
 import org.junit.Test
@@ -99,7 +99,7 @@ class PreviewViewFactoryTest {
     findByText("foo").assertIsDisplayed()
   }
 
-  private val ParentWithOneChild = bindCompose<Pair<String, String>> { rendering, environment ->
+  private val ParentWithOneChild = composedViewFactory<Pair<String, String>> { rendering, environment ->
     Column {
       Text(rendering.first)
       Semantics(container = true, mergeAllDescendants = true) {
@@ -113,7 +113,7 @@ class PreviewViewFactoryTest {
   }
 
   private val ParentWithTwoChildren =
-    bindCompose<Triple<String, String, String>> { rendering, environment ->
+    composedViewFactory<Triple<String, String, String>> { rendering, environment ->
       Column {
         Semantics(container = true) {
           environment.showRendering(rendering = rendering.first)
@@ -134,7 +134,7 @@ class PreviewViewFactoryTest {
     val child: RecursiveRendering? = null
   )
 
-  private val ParentRecursive = bindCompose<RecursiveRendering> { rendering, environment ->
+  private val ParentRecursive = composedViewFactory<RecursiveRendering> { rendering, environment ->
     Column {
       Text(rendering.text)
       rendering.child?.let { child ->
@@ -175,7 +175,7 @@ class PreviewViewFactoryTest {
     override val default: String get() = error("Not specified")
   }
 
-  private val ParentConsumesCustomKey = bindCompose<Unit> { _, environment ->
+  private val ParentConsumesCustomKey = composedViewFactory<Unit> { _, environment ->
     Text(environment[TestEnvironmentKey])
   }
 

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

@@ -42,14 +42,14 @@ import androidx.ui.unit.dp
 import androidx.ui.unit.px
 import androidx.ui.unit.toRect
 import com.squareup.workflow.ui.ViewFactory
-import com.squareup.workflow.ui.compose.bindCompose
+import com.squareup.workflow.ui.compose.composedViewFactory
 
 /**
  * A [ViewFactory] that will be used any time a [PreviewViewRegistry] is asked to show a rendering.
  * It displays a placeholder graphic and the rendering's `toString()` result.
  */
 internal fun placeholderViewFactory(modifier: Modifier): ViewFactory<Any> =
-  bindCompose { rendering, _ ->
+  composedViewFactory { rendering, _ ->
     Text(
         modifier = modifier
             .clipToBounds()

core-compose/src/androidTest/java/com/squareup/workflow/ui/compose/ComposeViewFactoryTest.kt

@@ -71,7 +71,7 @@ class ComposeViewFactoryTest {
   private data class TestRendering(val text: String)
 
   private companion object {
-    val TestFactory = bindCompose<TestRendering> { rendering, _ ->
+    val TestFactory = composedViewFactory<TestRendering> { rendering, _ ->
       Text(rendering.text)
     }
   }

core-compose/src/androidTest/java/com/squareup/workflow/ui/compose/internal/ViewFactoriesTest.kt

@@ -23,7 +23,7 @@ import androidx.ui.test.createComposeRule
 import androidx.ui.test.findByText
 import com.squareup.workflow.ui.ViewEnvironment
 import com.squareup.workflow.ui.ViewRegistry
-import com.squareup.workflow.ui.compose.bindCompose
+import com.squareup.workflow.ui.compose.composedViewFactory
 import com.squareup.workflow.ui.compose.showRendering
 import com.squareup.workflow.ui.compose.withComposeViewFactoryRoot
 import org.junit.Rule
@@ -54,7 +54,7 @@ class ViewFactoriesTest {
   private data class TestRendering(val text: String)
 
   private companion object {
-    val TestFactory = bindCompose<TestRendering> { rendering, _ ->
+    val TestFactory = composedViewFactory<TestRendering> { rendering, _ ->
       Text(rendering.text)
     }
   }

core-compose/src/main/java/com/squareup/workflow/ui/compose/ComposeRendering.kt

@@ -38,7 +38,7 @@ class ComposeRendering internal constructor(
     /**
      * A [ViewFactory] that renders a [ComposeRendering].
      */
-    val Factory: ViewFactory<ComposeRendering> = bindCompose { rendering, environment ->
+    val Factory: ViewFactory<ComposeRendering> = composedViewFactory { rendering, environment ->
       rendering.render(environment)
     }
 

core-compose/src/main/java/com/squareup/workflow/ui/compose/ComposeViewFactory.kt

@@ -43,7 +43,7 @@ import kotlin.reflect.KClass
  *
  * ```
  * // Function references to @Composable functions aren't supported yet.
- * val FooBinding = bindCompose { showFoo(it) }
+ * val FooBinding = composedViewFactory { showFoo(it) }
  *
  * @Composable
  * private fun showFoo(foo: FooRendering) {
@@ -73,14 +73,14 @@ import kotlin.reflect.KClass
  *
  * ## Initializing Compose context
  *
- * Often all the [bindCompose] factories in an app need to share some context – for example, certain
+ * Often all the [composedViewFactory]s in an app need to share some context – for example, certain
  * ambients need to be provided, such as `MaterialTheme`. To configure this shared context, include
  * a [ComposeViewFactoryRoot] in your top-level [ViewEnvironment] (e.g. by using
- * [withComposeViewFactoryRoot]). The first time a [bindCompose] is used to show a rendering, its
- * [showRendering] function will be wrapped with the [ComposeViewFactoryRoot]. See the documentation
- * on [ComposeViewFactoryRoot] for more information.
+ * [withComposeViewFactoryRoot]). The first time a [composedViewFactory] is used to show a
+ * rendering, its [showRendering] function will be wrapped with the [ComposeViewFactoryRoot].
+ * See the documentation on [ComposeViewFactoryRoot] for more information.
  */
-inline fun <reified RenderingT : Any> bindCompose(
+inline fun <reified RenderingT : Any> composedViewFactory(
   noinline showRendering: @Composable() (
     rendering: RenderingT,
     environment: ViewEnvironment

core-compose/src/main/java/com/squareup/workflow/ui/compose/ComposeViewFactoryRoot.kt

@@ -33,12 +33,12 @@ private val HasViewFactoryRootBeenApplied = staticAmbientOf { false }
 
 /**
  * A `@Composable` function that is stored in a [ViewEnvironment] and will be used to wrap the first
- * [bindCompose] composition. This can be used to setup any ambients that all [bindCompose]
- * factories need access to, such as ambients that specify the UI theme.
+ * [composedViewFactory] composition. This can be used to setup any ambients that all
+ * [composedViewFactory]s need access to, such as ambients that specify the UI theme.
  *
- * This function will called once, to wrap the _highest-level_ [bindCompose] in the tree. However,
- * ambients are propagated down to child [bindCompose] compositions, so any ambients provided here
- * will be available in _all_ [bindCompose] compositions.
+ * This function will called once, to wrap the _highest-level_ [composedViewFactory] in the tree.
+ * However, ambients are propagated down to child [composedViewFactory] compositions, so any
+ * ambients provided here will be available in _all_ [composedViewFactory] compositions.
  */
 interface ComposeViewFactoryRoot {
 
@@ -51,7 +51,7 @@ interface ComposeViewFactoryRoot {
 
 /**
  * Adds a [ComposeViewFactoryRoot] to this [ViewEnvironment] that uses [wrapper] to wrap the first
- * [bindCompose] composition. See [ComposeViewFactoryRoot] for more information.
+ * [composedViewFactory] composition. See [ComposeViewFactoryRoot] for more information.
  */
 fun ViewEnvironment.withComposeViewFactoryRoot(
   wrapper: @Composable() (content: @Composable() () -> Unit) -> Unit

core-compose/src/main/java/com/squareup/workflow/ui/compose/ComposeWorkflow.kt

@@ -27,7 +27,7 @@ import com.squareup.workflow.ui.compose.internal.ComposeWorkflowImpl
 /**
  * A stateless [Workflow][com.squareup.workflow.Workflow] that [renders][render] itself as
  * [Composable] function. Effectively defines an inline
- * [bindCompose][com.squareup.workflow.ui.compose.bindCompose].
+ * [composedViewFactory][com.squareup.workflow.ui.compose.composedViewFactory].
  *
  * This workflow does not have access to a [RenderContext][com.squareup.workflow.RenderContext]
  * since render contexts are only valid during render passes, and this workflow's [render] method

core-compose/src/main/java/com/squareup/workflow/ui/compose/ViewEnvironments.kt

@@ -38,7 +38,7 @@ import com.squareup.workflow.ui.compose.internal.showRendering
  *   val child: Any
  * )
  *
- * val FramedContainerViewFactory = bindCompose<FramedRendering> { rendering, environment ->
+ * val FramedContainerViewFactory = composedViewFactory<FramedRendering> { rendering, environment ->
  *   Surface(border = Border(rendering.borderColor, 8.dp)) {
  *     environment.showRendering(rendering.child)
  *   }