CHANGELOG.md

Version 1.0.0-beta10

• Update coroutines to 1.5.0
• Add a BOM for unified dependency versions (#219)
• Fix permanent cancellation when using withViewLifecycleScope (#236)

Version 1.0.0-beta09

• CoroutineTestExtension now creates a new scope instance for each test.
• Update Kotlin to 1.5.0
• Update coroutines to 1.4.3
• Update Android Gradle Plugin to 4.2.0
• Update Androidx Lifecycle to 2.3.1

Version 1.0.0-beta08

• Remove FlowCancellationException (#196)
• Update Kotlin to 1.4.21

Version 1.0.0-beta07

• Update to coroutines to 1.4.2
• Update to Kotlin to 1.4.20

Version 1.0.0-beta06

• Update to coroutines to 1.4.1 in order to fix an issue with SharedFlow(#189)

Version 1.0.0-beta05

Api changes

• ViewLifecycleCoroutineScope is a special DispatchLifecycleScope meant for binding a scope to a Fragment's view lifecycle. (#179)
• Make testProvided receive TestProvidedCoroutineScope (#157)
• LifecycleCoroutineScope has been renamed to DispatchLifecycleScope, along with its extension function. The old names are still functional with a deprecated typealias. They will be removed in the future. (#186)
• CoroutineViewModel has been renamed to DispatchViewModel. The old names are still functional with a deprecated typealias. They will be removed in the future. (#186)

Bug fixes

• Use currentCoroutineContext to resolve the inner CoroutineContext in flowOn___ functions. (#181)

Housekeeping

• Set the project JDK target to 8. This only affects the build environment since all previous builds were done on a JDK 8 machine. (#187)
• Coroutines has been updated to 1.4.0 (#183)
• Detekt has been updated to 1.4.2 (#184)
• JUnit5 has been updated to 5.7.0 (#178)

Version 1.0.0-beta04

Features

• DefaultDispatcherProvider is now a mutable singleton which allows for a custom global default.

Bug fixes

dispatch-test-junit5

• CoroutineTestExtension will now properly call Dispatchers.setMain(...) when injecting a CoroutineScope into a function or when not injecting at all. (#130)

dispatch-android-lifecycle

• LifecycleCoroutineScope will now be automatically cancelled when the associated Lifecycle drops to the Destroyed state. (#135)

dispatch-android-lifecycle-extensions

• Cached LifecycleCoroutineScopes will now be removed from the cache when they are destroyed. (#136)
• Fixed a race condition where multiple LifecycleCoroutineScopes may be created for concurrent cache misses. (#136)

Deprecations

• The DefaultDispatcherProvider class constructor has been changed to an object factory function (operator fun invoke(): DispatcherProvider) and deprecated. This function will be removed prior to the 1.0 release.

Breaking changes

• DefaultDispatcherProvider has been changed from a class to an object, and its functionality changed. It is now a singleton holder for a default DispatcherProvider instance. To create a default DispatcherProvider, use the interface's companion object factory function (DispatcherProvider()).

Version 1.0.0-beta03

Renames

• The project has been renamed from DispatcherProvider to Dispatch.
• Maven coordinates for existing modules have changed.
• The base Maven coordinate has changed from com.rickbusarow.DispatcherProvider to com.rickbusarow.dispatch.
• Base package names have been updated.

New artifacts

• dispatch-android-espresso adds support for IdlingResource dispatchers in Espresso testing.
• dispatch-android-lifecycle adds an alternative to the Androidx LifecycleScope functionality, with lots of configuration options.
  • dispatch-android-lifecycle-extensions adds the lifecycleScope extension property, but with a configurable factory (useful for Espresso testing).
• dispatch-android-viewmodel adds an alternative to Androidx viewModelScope with configuration options.
• dispatch-detekt adds Detekt rules to warn against accidentally using a hard-coded CoroutineDispatcher.
• dispatch-test-junit4 adds a JUnit4 Rule for automatically providing and cleaning up a TestProvidedCoroutineScope.
• dispatch-test-junit5 adds JUnit5 Extension support for automatically providing and cleaning up a TestProvidedCoroutineScope.

Version 1.0.0-beta02

Test features

• Added TestBasicDispatcherProvider factory which uses CommonPool for default and io, but a shared single-threaded ExecutorCoroutineDispatcher for main and mainImmediate to provide " natural" dispatch behavior in tests without Dispatchers.setMain(...).

Bug fixes and improvements

• runBlockingTestProvided now uses the same TestCoroutineDispatcher as its ContinuationInterceptor and in its TestDispatcherProvider (#15).
• runBlockingProvided now uses TestBasicDispatcherProvider as its DispatcherProvider.

Version 1.0.0-beta01

Flow

• Add non-suspending flowOn___() operators for the Flow api.

Misc

• Lots of Kdocs.
• Maven artifacts.
• Lower JDK version to 1.6