Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# workflow

[![Kotlin CI](https://github.com/square/workflow-kotlin/workflows/Kotlin%20CI/badge.svg)](https://github.com/square/workflow-kotlin/actions?query=branch%3Amain)
[![Maven Central](https://img.shields.io/maven-central/v/com.squareup.workflow/workflow-core-jvm.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.squareup.workflow%22)
[![Maven Central](https://img.shields.io/maven-central/v/com.squareup.workflow1/workflow-core-jvm.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.squareup.workflow%22)
[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)
[![Kotlinlang slack](https://img.shields.io/static/v1?label=kotlinlang&message=squarelibraries&color=brightgreen&logo=slack)](https://kotlinlang.slack.com/archives/C5HT9AL7Q)

Expand Down Expand Up @@ -34,28 +34,28 @@ your `repositories` block, and then add dependencies on the following artifacts:
<th>Depend on this if…</th>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-core-jvm:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-core-jvm:x.y.z</code></td>
<td>You are writing a library module/project that uses Workflows, but you don't need to interact
with the runtime from the outside.</td>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-rx2:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-rx2:x.y.z</code></td>
<td>You need to interact with RxJava2 from your Workflows.</td>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-testing-jvm:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-testing-jvm:x.y.z</code></td>
<td>You are writing tests. This should only be included as a test dependency.</td>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-ui-core-android:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-ui-core-android:x.y.z</code></td>
<td>You're writing an Android app that uses Workflows.</td>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-ui-modal-android:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-ui-modal-android:x.y.z</code></td>
<td>Your Android app uses modals (popups).</td>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-ui-backstack-android:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-ui-backstack-android:x.y.z</code></td>
<td>Your android app uses backstacks.</td>
</tr>
</table>
Expand All @@ -71,11 +71,11 @@ higher-level integrations with UI frameworks.
<th>Depend on this if…</th>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-runtime-jvm:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-runtime-jvm:x.y.z</code></td>
<td>You need to interact directly with the runtime, i.e. streams of renderings and outputs.</td>
</tr>
<tr>
<td nowrap><code>com.squareup.workflow:workflow-ui-core-jvm:x.y.z</code></td>
<td nowrap><code>com.squareup.workflow1:workflow-ui-core-jvm:x.y.z</code></td>
<td>You are writing workflow-ui-android for another UI framework. Defines the core types used by
that artifact.</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ android.enableJetifier=true
# Required to publish to Nexus (see https://github.com/gradle/gradle/issues/11308)
systemProp.org.gradle.internal.publish.checksums.insecure=true

GROUP=com.squareup.workflow
GROUP=com.squareup.workflow1
VERSION_NAME=1.0.0-alpha.2-SNAPSHOT

POM_DESCRIPTION=Reactive workflows
Expand Down
4 changes: 2 additions & 2 deletions internal-testing-utils/api/internal-testing-utils.api
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
public final class com/squareup/workflow/internal/util/UncaughtExceptionGuard {
public final class com/squareup/workflow1/internal/util/UncaughtExceptionGuard {
public fun <init> ()V
public final fun reportUncaught (Ljava/lang/Throwable;)V
public final fun runRethrowingUncaught (Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
}

public final class com/squareup/workflow/internal/util/UncaughtExceptionGuardKt {
public final class com/squareup/workflow1/internal/util/UncaughtExceptionGuardKt {
public static final fun rethrowingUncaughtExceptions (Lkotlin/jvm/functions/Function0;)V
}

Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.squareup.workflow.internal.util
package com.squareup.workflow1.internal.util

import java.util.concurrent.atomic.AtomicReference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.squareup.workflow.internal.util
package com.squareup.workflow1.internal.util

import com.google.common.truth.Truth.assertThat
import junit.framework.TestCase.fail
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
*/
package com.squareup.sample.container

import com.squareup.workflow.ui.BuilderBinding
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.ViewFactory
import com.squareup.workflow.ui.ViewRegistry
import com.squareup.workflow.ui.backPressedHandler
import com.squareup.workflow.ui.bindShowRendering
import com.squareup.workflow.ui.buildView
import com.squareup.workflow.ui.getShowRendering
import com.squareup.workflow1.ui.BuilderBinding
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.ViewFactory
import com.squareup.workflow1.ui.ViewRegistry
import com.squareup.workflow1.ui.backPressedHandler
import com.squareup.workflow1.ui.bindShowRendering
import com.squareup.workflow1.ui.buildView
import com.squareup.workflow1.ui.getShowRendering

/**
* Adds optional back button handling to a [wrapped] rendering, possibly overriding that
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ package com.squareup.sample.container
import com.squareup.sample.container.overviewdetail.OverviewDetailContainer
import com.squareup.sample.container.panel.PanelContainer
import com.squareup.sample.container.panel.ScrimContainer
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.ViewRegistry
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.ViewRegistry

@OptIn(WorkflowUiExperimentalApi::class)
val SampleContainers = ViewRegistry(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
*/
package com.squareup.sample.container.overviewdetail

import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.ViewEnvironmentKey
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.ViewEnvironmentKey

/**
* [com.squareup.workflow.ui.ViewEnvironment] value that informs views
* [com.squareup.workflow1.ui.ViewEnvironment] value that informs views
* whether they're children of a [OverviewDetailContainer], and if so
* in what configuration.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ import com.squareup.sample.container.R
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Detail
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Overview
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Single
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.LayoutRunner
import com.squareup.workflow.ui.ViewFactory
import com.squareup.workflow.ui.ViewEnvironment
import com.squareup.workflow.ui.WorkflowViewStub
import com.squareup.workflow.ui.backstack.BackStackScreen
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.LayoutRunner
import com.squareup.workflow1.ui.ViewFactory
import com.squareup.workflow1.ui.ViewEnvironment
import com.squareup.workflow1.ui.WorkflowViewStub
import com.squareup.workflow1.ui.backstack.BackStackScreen

/**
* Displays [OverviewDetailScreen] renderings in either split pane or single pane
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ import android.view.View
import android.view.ViewGroup
import android.view.ViewGroup.LayoutParams.MATCH_PARENT
import com.squareup.sample.container.R
import com.squareup.workflow.ui.BuilderBinding
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.ViewFactory
import com.squareup.workflow.ui.bindShowRendering
import com.squareup.workflow.ui.modal.ModalViewContainer
import com.squareup.workflow1.ui.BuilderBinding
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.ViewFactory
import com.squareup.workflow1.ui.bindShowRendering
import com.squareup.workflow1.ui.modal.ModalViewContainer

/**
* Used by Tic Tac Workflow sample to show its [PanelContainerScreen]s.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ import android.util.AttributeSet
import android.view.View
import android.view.ViewGroup
import com.squareup.sample.container.R
import com.squareup.workflow.ui.BuilderBinding
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.ViewFactory
import com.squareup.workflow.ui.WorkflowViewStub
import com.squareup.workflow.ui.bindShowRendering
import com.squareup.workflow1.ui.BuilderBinding
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.ViewFactory
import com.squareup.workflow1.ui.WorkflowViewStub
import com.squareup.workflow1.ui.bindShowRendering

/**
* A view that renders only its first child, behind a smoke scrim if
* [isDimmed] is true (tablets only). Other children are ignored.
*
* Able to [render][com.squareup.workflow.ui.showRendering] [ScrimContainerScreen].
* Able to [render][com.squareup.workflow1.ui.showRendering] [ScrimContainerScreen].
*/
class ScrimContainer @JvmOverloads constructor(
context: Context,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
android:orientation="horizontal"
>

<com.squareup.workflow.ui.WorkflowViewStub
<com.squareup.workflow1.ui.WorkflowViewStub
android:id="@+id/detail_stub"
android:layout_width="0dp"
android:layout_height="match_parent"
Expand All @@ -33,7 +33,7 @@
android:background="@android:drawable/divider_horizontal_bright"
/>

<com.squareup.workflow.ui.WorkflowViewStub
<com.squareup.workflow1.ui.WorkflowViewStub
android:id="@+id/overview_stub"
android:layout_width="0dp"
android:layout_height="match_parent"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent" android:layout_height="match_parent">

<com.squareup.workflow.ui.WorkflowViewStub
<com.squareup.workflow1.ui.WorkflowViewStub
android:id="@+id/overview_detail_single_stub"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
android:orientation="horizontal"
>

<com.squareup.workflow.ui.WorkflowViewStub
<com.squareup.workflow1.ui.WorkflowViewStub
android:id="@+id/overview_stub"
android:layout_width="0dp"
android:layout_height="match_parent"
Expand All @@ -33,7 +33,7 @@
android:background="@android:drawable/divider_horizontal_bright"
/>

<com.squareup.workflow.ui.WorkflowViewStub
<com.squareup.workflow1.ui.WorkflowViewStub
android:id="@+id/detail_stub"
android:layout_width="0dp"
android:layout_height="match_parent"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ import androidx.recyclerview.widget.RecyclerView
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Overview
import com.squareup.sample.container.poetryapp.R
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.LayoutRunner
import com.squareup.workflow.ui.LayoutRunner.Companion.bind
import com.squareup.workflow.ui.ViewFactory
import com.squareup.workflow.ui.ViewEnvironment
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.LayoutRunner
import com.squareup.workflow1.ui.LayoutRunner.Companion.bind
import com.squareup.workflow1.ui.ViewFactory
import com.squareup.workflow1.ui.ViewEnvironment

@OptIn(WorkflowUiExperimentalApi::class)
class PoemListLayoutRunner(view: View) : LayoutRunner<PoemListRendering> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
package com.squareup.sample.poetryapp

import com.squareup.sample.poetry.model.Poem
import com.squareup.workflow.RenderContext
import com.squareup.workflow.StatelessWorkflow
import com.squareup.workflow.makeEventSink
import com.squareup.workflow1.RenderContext
import com.squareup.workflow1.StatelessWorkflow
import com.squareup.workflow1.makeEventSink

/**
* Renders a given ordered list of [Poem]s. Reports the index of any that are clicked.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ package com.squareup.sample.poetryapp
import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
import com.squareup.sample.poetry.PoemWorkflow
import com.squareup.sample.poetry.model.Poem
import com.squareup.workflow.RenderContext
import com.squareup.workflow.Snapshot
import com.squareup.workflow.StatefulWorkflow
import com.squareup.workflow.action
import com.squareup.workflow.parse
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.backstack.BackStackScreen
import com.squareup.workflow1.RenderContext
import com.squareup.workflow1.Snapshot
import com.squareup.workflow1.StatefulWorkflow
import com.squareup.workflow1.action
import com.squareup.workflow1.parse
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.backstack.BackStackScreen

typealias SelectedPoem = Int

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ import androidx.appcompat.app.AppCompatActivity
import com.squareup.sample.container.SampleContainers
import com.squareup.sample.poetry.PoetryViews
import com.squareup.sample.poetry.model.Poem
import com.squareup.workflow.SimpleLoggingWorkflowInterceptor
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.WorkflowRunner
import com.squareup.workflow.ui.backstack.BackStackContainer
import com.squareup.workflow.ui.plus
import com.squareup.workflow.ui.setContentWorkflow
import com.squareup.workflow1.SimpleLoggingWorkflowInterceptor
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.WorkflowRunner
import com.squareup.workflow1.ui.backstack.BackStackContainer
import com.squareup.workflow1.ui.plus
import com.squareup.workflow1.ui.setContentWorkflow
import timber.log.Timber

@OptIn(WorkflowUiExperimentalApi::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ import com.squareup.sample.container.SampleContainers
import com.squareup.sample.poetry.PoemWorkflow
import com.squareup.sample.poetry.PoetryViews
import com.squareup.sample.poetry.model.Raven
import com.squareup.workflow.SimpleLoggingWorkflowInterceptor
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.WorkflowRunner
import com.squareup.workflow.ui.backstack.BackStackContainer
import com.squareup.workflow.ui.plus
import com.squareup.workflow.ui.setContentWorkflow
import com.squareup.workflow1.SimpleLoggingWorkflowInterceptor
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.WorkflowRunner
import com.squareup.workflow1.ui.backstack.BackStackContainer
import com.squareup.workflow1.ui.plus
import com.squareup.workflow1.ui.setContentWorkflow
import timber.log.Timber

@OptIn(WorkflowUiExperimentalApi::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
*/
package com.squareup.sample.container.overviewdetail

import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.backstack.BackStackScreen
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.backstack.BackStackScreen

/**
* Rendering type for overview / detail containers, with [BackStackScreen] in both roles.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
*/
package com.squareup.sample.container.panel

import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.backstack.BackStackScreen
import com.squareup.workflow.ui.modal.HasModals
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.backstack.BackStackScreen
import com.squareup.workflow1.ui.modal.HasModals

/**
* Custom modal container used in Tic Tac Workflow sample. Shows one or more
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
package com.squareup.sample.container.overviewdetail

import com.google.common.truth.Truth.assertThat
import com.squareup.workflow.ui.WorkflowUiExperimentalApi
import com.squareup.workflow.ui.backstack.BackStackScreen
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.backstack.BackStackScreen
import org.junit.Test

@OptIn(WorkflowUiExperimentalApi::class)
Expand Down
Loading