From 491c193760d79829a5fa91773a8313117810edb4 Mon Sep 17 00:00:00 2001 From: Rick Busarow Date: Sun, 12 Jul 2020 17:48:01 -0500 Subject: [PATCH 1/6] LifecycleScopeFactory README example cleanup --- dispatch-android-lifecycle-extensions/README.md | 8 ++++---- docs/kdoc/dispatch-android-lifecycle-extensions/index.md | 4 ++-- docs/modules/dispatch-android-lifecycle-extensions.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/dispatch-android-lifecycle-extensions/README.md b/dispatch-android-lifecycle-extensions/README.md index 80cd46feb..cf202d8ec 100644 --- a/dispatch-android-lifecycle-extensions/README.md +++ b/dispatch-android-lifecycle-extensions/README.md @@ -51,7 +51,7 @@ class SomeApplication : Application() { override fun onCreate() { super.onCreate() // A custom factory can be set to add elements to the CoroutineContext - LifecycleScopeFactory.set { MainImmediateProvidedCoroutineContext() + SomeCustomElement() } + LifecycleScopeFactory.set { MainImmediateContext() + SomeCustomElement() } } } ``` @@ -68,7 +68,7 @@ class SomeEspressoTest { @After fun tearDown() { // The factory can also be reset to default - LifecycleCoroutineScopeFactory.reset() + LifecycleScopeFactory.reset() } } ``` @@ -93,7 +93,7 @@ class SomeFragmentEspressoTest { fun setUp() { // set a custom factory which is applied to all newly created lifecycleScopes LifecycleScopeFactory.set { - MainImmediateProvidedCoroutineContext() + idlingRule.dispatcherProvider + MainImmediateContext() + idlingRule.dispatcherProvider } // now SomeFragment will use an IdlingDispatcher in its CoroutineScope @@ -142,7 +142,7 @@ dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.7") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.7") implementation("com.rickbusarow.dispatch:dispatch-android-lifecycle-extensions:1.0.0-beta04") - + implementation("androidx.lifecycle:lifecycle-common:2.2.0") } ``` diff --git a/docs/kdoc/dispatch-android-lifecycle-extensions/index.md b/docs/kdoc/dispatch-android-lifecycle-extensions/index.md index 28e5a1cb9..8a25d34db 100644 --- a/docs/kdoc/dispatch-android-lifecycle-extensions/index.md +++ b/docs/kdoc/dispatch-android-lifecycle-extensions/index.md @@ -65,7 +65,7 @@ class SomeEspressoTest { @After fun tearDown() { // The factory can also be reset to default - LifecycleCoroutineScopeFactory.reset() + LifecycleScopeFactory.reset() } } ``` @@ -152,4 +152,4 @@ dependencies { ### Index -[All Types](alltypes/index.md) \ No newline at end of file +[All Types](alltypes/index.md) diff --git a/docs/modules/dispatch-android-lifecycle-extensions.md b/docs/modules/dispatch-android-lifecycle-extensions.md index 80cd46feb..ee342bfed 100644 --- a/docs/modules/dispatch-android-lifecycle-extensions.md +++ b/docs/modules/dispatch-android-lifecycle-extensions.md @@ -68,7 +68,7 @@ class SomeEspressoTest { @After fun tearDown() { // The factory can also be reset to default - LifecycleCoroutineScopeFactory.reset() + LifecycleScopeFactory.reset() } } ``` From 28a43bf0866abaf75a65e2e7f3ef206e096f8612 Mon Sep 17 00:00:00 2001 From: Rick Busarow Date: Sun, 12 Jul 2020 17:48:51 -0500 Subject: [PATCH 2/6] remove duplicate dependency declarations in android-lifecycle gradle config --- dispatch-android-lifecycle/build.gradle.kts | 3 --- 1 file changed, 3 deletions(-) diff --git a/dispatch-android-lifecycle/build.gradle.kts b/dispatch-android-lifecycle/build.gradle.kts index 9dd0b5408..4494207bd 100644 --- a/dispatch-android-lifecycle/build.gradle.kts +++ b/dispatch-android-lifecycle/build.gradle.kts @@ -78,8 +78,5 @@ dependencies { testImplementation(Libs.RickBusarow.Hermit.coroutines) testImplementation(Libs.RickBusarow.Hermit.junit5) - testImplementation(Libs.RickBusarow.Hermit.coroutines) - testImplementation(Libs.RickBusarow.Hermit.junit5) - testImplementation(Libs.Robolectric.core) } From 8fd0ded2acc52b433c10124ac3cfa86f06ce43fa Mon Sep 17 00:00:00 2001 From: Rick Busarow Date: Sun, 12 Jul 2020 17:49:25 -0500 Subject: [PATCH 3/6] android-lifecycle sample annotation consolidation --- .../samples/LifecycleCoroutineScopeFactorySample.kt | 11 +++++------ .../java/samples/LifecycleCoroutineScopeSample.kt | 2 -- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeFactorySample.kt b/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeFactorySample.kt index c2e7d3a82..4fe2432e8 100644 --- a/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeFactorySample.kt +++ b/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeFactorySample.kt @@ -13,8 +13,6 @@ * limitations under the License. */ -@file:Suppress("EXPERIMENTAL_API_USAGE") - package samples import dispatch.android.lifecycle.* @@ -46,7 +44,8 @@ class LifecycleCoroutineScopeFactorySample { } } -private annotation class Before -private annotation class After -private annotation class Module -private annotation class Provides +internal annotation class Before +internal annotation class After +internal annotation class Module +internal annotation class Provides +internal annotation class Inject diff --git a/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeSample.kt b/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeSample.kt index 6e3b0423f..440e4a7d6 100644 --- a/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeSample.kt +++ b/dispatch-android-lifecycle/samples/src/test/java/samples/LifecycleCoroutineScopeSample.kt @@ -24,8 +24,6 @@ import kotlinx.coroutines.* import kotlinx.coroutines.channels.* import kotlinx.coroutines.flow.* -annotation class Inject - @CoroutineTest @ExperimentalCoroutinesApi class LifecycleCoroutineScopeSample( From 45ae8f455acd7853243bc3f0775d363bbe6b8042 Mon Sep 17 00:00:00 2001 From: Rick Busarow Date: Sun, 12 Jul 2020 17:49:57 -0500 Subject: [PATCH 4/6] lifecycleScope extension sample rename --- ...fecycleScopeSample.kt => LifecycleScopeExtensionSample.kt} | 4 ++-- .../main/java/dispatch/android/lifecycle/lifecycleScope.kt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename dispatch-android-lifecycle-extensions/samples/src/test/java/samples/{LifecycleScopeSample.kt => LifecycleScopeExtensionSample.kt} (94%) diff --git a/dispatch-android-lifecycle-extensions/samples/src/test/java/samples/LifecycleScopeSample.kt b/dispatch-android-lifecycle-extensions/samples/src/test/java/samples/LifecycleScopeExtensionSample.kt similarity index 94% rename from dispatch-android-lifecycle-extensions/samples/src/test/java/samples/LifecycleScopeSample.kt rename to dispatch-android-lifecycle-extensions/samples/src/test/java/samples/LifecycleScopeExtensionSample.kt index 3fda9662c..2dde633e3 100644 --- a/dispatch-android-lifecycle-extensions/samples/src/test/java/samples/LifecycleScopeSample.kt +++ b/dispatch-android-lifecycle-extensions/samples/src/test/java/samples/LifecycleScopeExtensionSample.kt @@ -18,10 +18,10 @@ package samples import dispatch.android.lifecycle.* import dispatch.core.* -class LifecycleScopeSample { +class LifecycleScopeExtensionSample { @Sample - fun lifecycleScopeSample() { + fun lifecycleScopeExtensionSample() { // This could be any LifecycleOwner -- Fragments, Activities, Services... class SomeFragment : Fragment() { diff --git a/dispatch-android-lifecycle-extensions/src/main/java/dispatch/android/lifecycle/lifecycleScope.kt b/dispatch-android-lifecycle-extensions/src/main/java/dispatch/android/lifecycle/lifecycleScope.kt index 9fbcf64e6..cbd5e284f 100644 --- a/dispatch-android-lifecycle-extensions/src/main/java/dispatch/android/lifecycle/lifecycleScope.kt +++ b/dispatch-android-lifecycle-extensions/src/main/java/dispatch/android/lifecycle/lifecycleScope.kt @@ -31,7 +31,7 @@ import kotlinx.coroutines.* * The `viewModelScope` is automatically cancelled when the [LifecycleOwner]'s * [lifecycle][LifecycleOwner.getLifecycle]'s [Lifecycle.State] drops to [Lifecycle.State.DESTROYED]. * - * @sample samples.LifecycleScopeSample.lifecycleScopeSample + * @sample samples.LifecycleScopeExtensionSample.lifecycleScopeExtensionSample */ val LifecycleOwner.lifecycleScope: LifecycleCoroutineScope get() = LifecycleCoroutineScopeStore.get(this.lifecycle) From 045209fc5436482c4b43c42265e7fc2b4cc7aba3 Mon Sep 17 00:00:00 2001 From: Rick Busarow Date: Sun, 12 Jul 2020 17:50:37 -0500 Subject: [PATCH 5/6] MainImmediateCoroutineScope factory function formatting --- dispatch-core/src/main/java/dispatch/core/CoroutineScopes.kt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dispatch-core/src/main/java/dispatch/core/CoroutineScopes.kt b/dispatch-core/src/main/java/dispatch/core/CoroutineScopes.kt index dfb991adb..4d93c4599 100644 --- a/dispatch-core/src/main/java/dispatch/core/CoroutineScopes.kt +++ b/dispatch-core/src/main/java/dispatch/core/CoroutineScopes.kt @@ -151,8 +151,8 @@ public fun MainCoroutineScope( * @see CoroutineScope */ public fun MainImmediateCoroutineScope( - job: Job = SupervisorJob(), dispatcherProvider: - DispatcherProvider = DefaultDispatcherProvider() + job: Job = SupervisorJob(), + dispatcherProvider: DispatcherProvider = DefaultDispatcherProvider() ): MainImmediateCoroutineScope = object : MainImmediateCoroutineScope { override val coroutineContext = job + dispatcherProvider.mainImmediate + dispatcherProvider From 615f4f81dc2e95b4e3e43e551036734a317dbc2c Mon Sep 17 00:00:00 2001 From: Rick Busarow Date: Sun, 12 Jul 2020 17:53:28 -0500 Subject: [PATCH 6/6] update docs --- docs/kdoc/dispatch-android-lifecycle-extensions/index.md | 8 ++++---- docs/modules/dispatch-android-lifecycle-extensions.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/kdoc/dispatch-android-lifecycle-extensions/index.md b/docs/kdoc/dispatch-android-lifecycle-extensions/index.md index 8a25d34db..961d662df 100644 --- a/docs/kdoc/dispatch-android-lifecycle-extensions/index.md +++ b/docs/kdoc/dispatch-android-lifecycle-extensions/index.md @@ -48,7 +48,7 @@ class SomeApplication : Application() { override fun onCreate() { super.onCreate() // A custom factory can be set to add elements to the CoroutineContext - LifecycleScopeFactory.set { MainImmediateProvidedCoroutineContext() + SomeCustomElement() } + LifecycleScopeFactory.set { MainImmediateContext() + SomeCustomElement() } } } ``` @@ -90,7 +90,7 @@ class SomeFragmentEspressoTest { fun setUp() { // set a custom factory which is applied to all newly created lifecycleScopes LifecycleScopeFactory.set { - MainImmediateProvidedCoroutineContext() + idlingRule.dispatcherProvider + MainImmediateContext() + idlingRule.dispatcherProvider } // now SomeFragment will use an IdlingDispatcher in its CoroutineScope @@ -139,7 +139,7 @@ dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.7") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.7") implementation("com.rickbusarow.dispatch:dispatch-android-lifecycle-extensions:1.0.0-beta04") - + implementation("androidx.lifecycle:lifecycle-common:2.2.0") } ``` @@ -152,4 +152,4 @@ dependencies { ### Index -[All Types](alltypes/index.md) +[All Types](alltypes/index.md) \ No newline at end of file diff --git a/docs/modules/dispatch-android-lifecycle-extensions.md b/docs/modules/dispatch-android-lifecycle-extensions.md index ee342bfed..cf202d8ec 100644 --- a/docs/modules/dispatch-android-lifecycle-extensions.md +++ b/docs/modules/dispatch-android-lifecycle-extensions.md @@ -51,7 +51,7 @@ class SomeApplication : Application() { override fun onCreate() { super.onCreate() // A custom factory can be set to add elements to the CoroutineContext - LifecycleScopeFactory.set { MainImmediateProvidedCoroutineContext() + SomeCustomElement() } + LifecycleScopeFactory.set { MainImmediateContext() + SomeCustomElement() } } } ``` @@ -93,7 +93,7 @@ class SomeFragmentEspressoTest { fun setUp() { // set a custom factory which is applied to all newly created lifecycleScopes LifecycleScopeFactory.set { - MainImmediateProvidedCoroutineContext() + idlingRule.dispatcherProvider + MainImmediateContext() + idlingRule.dispatcherProvider } // now SomeFragment will use an IdlingDispatcher in its CoroutineScope @@ -142,7 +142,7 @@ dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.7") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.7") implementation("com.rickbusarow.dispatch:dispatch-android-lifecycle-extensions:1.0.0-beta04") - + implementation("androidx.lifecycle:lifecycle-common:2.2.0") } ```