Merge pull request #129 from ShikaSD/extract-binder

Extract binder from mvicore module
badoo · Jul 31, 2020 · 1663cb5 · 1663cb5
2 parents 773386a + 05a7012
commit 1663cb5
Show file tree

Hide file tree

Showing 46 changed files with 148 additions and 92 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,11 @@ Add the dependencies:
 implementation 'com.github.badoo.mvicore:mvicore:{latest-version}'
 ```
 
+- Binder (for versions higher than 1.2.4)
+```groovy
+implementation 'com.github.badoo.mvicore:binder:{latest-version}'
+```
+
 - Helper classes for Android:
 ```groovy
 implementation 'com.github.badoo.mvicore:mvicore-android:{latest-version}'

diff --git a/binder/.gitignore b/binder/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/binder/build.gradle b/binder/build.gradle
@@ -0,0 +1,49 @@
+apply plugin: 'java'
+apply plugin: 'maven'
+apply plugin: 'kotlin'
+apply plugin: 'org.jetbrains.dokka'
+
+group = 'com.github.badoo.mvicore'
+
+buildscript {
+    repositories {
+        jcenter()
+    }
+    dependencies {
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$rootProject.ext.kotlinVersion"
+    }
+}
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    def deps = rootProject.ext.deps
+
+    implementation deps('io.reactivex.rxjava2:rxjava')
+    implementation deps('io.reactivex.rxjava2:rxkotlin')
+    implementation deps("org.jetbrains.kotlin:kotlin-stdlib-jdk7")
+
+    testImplementation deps('junit:junit')
+    testImplementation deps('org.jetbrains.kotlin:kotlin-test-junit')
+    testImplementation deps('com.nhaarman:mockito-kotlin')
+}
+
+sourceCompatibility = "1.7"
+targetCompatibility = "1.7"
+
+task packageSources(type: Jar, dependsOn: 'classes') {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task packageJavadoc(type: Jar, dependsOn: javadoc) {
+    from javadoc.outputDirectory
+    classifier = 'javadoc'
+}
+
+artifacts {
+    archives packageSources
+    archives packageJavadoc
+}
diff --git a/...n/java/com/badoo/mvicore/binder/Binder.kt → .../src/main/java/com/badoo/binder/Binder.kt b/...n/java/com/badoo/mvicore/binder/Binder.kt → .../src/main/java/com/badoo/binder/Binder.kt
@@ -1,10 +1,10 @@
-package com.badoo.mvicore.binder
+package com.badoo.binder
 
-import com.badoo.mvicore.binder.lifecycle.Lifecycle
-import com.badoo.mvicore.binder.lifecycle.Lifecycle.Event.BEGIN
-import com.badoo.mvicore.binder.lifecycle.Lifecycle.Event.END
-import com.badoo.mvicore.consumer.middleware.base.Middleware
-import com.badoo.mvicore.consumer.wrapWithMiddleware
+import com.badoo.binder.lifecycle.Lifecycle
+import com.badoo.binder.lifecycle.Lifecycle.Event.BEGIN
+import com.badoo.binder.lifecycle.Lifecycle.Event.END
+import com.badoo.binder.middleware.base.Middleware
+import com.badoo.binder.middleware.wrapWithMiddleware
 import io.reactivex.Observable
 import io.reactivex.Observable.wrap
 import io.reactivex.ObservableSource

diff --git a/...va/com/badoo/mvicore/binder/Connection.kt → .../main/java/com/badoo/binder/Connection.kt b/...va/com/badoo/mvicore/binder/Connection.kt → .../main/java/com/badoo/binder/Connection.kt
@@ -1,7 +1,7 @@
-package com.badoo.mvicore.binder
+package com.badoo.binder
 
-import com.badoo.mvicore.connector.Connector
-import com.badoo.mvicore.connector.NotNullConnector
+import com.badoo.binder.connector.Connector
+import com.badoo.binder.connector.NotNullConnector
 import io.reactivex.ObservableSource
 import io.reactivex.functions.Consumer
 

diff --git a/.../com/badoo/mvicore/connector/Connector.kt → ...a/com/badoo/binder/connector/Connector.kt b/.../com/badoo/mvicore/connector/Connector.kt → ...a/com/badoo/binder/connector/Connector.kt
@@ -1,4 +1,4 @@
-package com.badoo.mvicore.connector
+package com.badoo.binder.connector
 
 import io.reactivex.ObservableSource
 

diff --git a/...doo/mvicore/connector/NotNullConnector.kt → ...adoo/binder/connector/NotNullConnector.kt b/...doo/mvicore/connector/NotNullConnector.kt → ...adoo/binder/connector/NotNullConnector.kt
@@ -1,4 +1,4 @@
-package com.badoo.mvicore.connector
+package com.badoo.binder.connector
 
 import io.reactivex.Observable
 import io.reactivex.Observable.wrap

diff --git a/...doo/mvicore/binder/lifecycle/Lifecycle.kt → ...a/com/badoo/binder/lifecycle/Lifecycle.kt b/...doo/mvicore/binder/lifecycle/Lifecycle.kt → ...a/com/badoo/binder/lifecycle/Lifecycle.kt
@@ -1,6 +1,6 @@
-package com.badoo.mvicore.binder.lifecycle
+package com.badoo.binder.lifecycle
 
-import com.badoo.mvicore.binder.lifecycle.internal.FromObservableSource
+import com.badoo.binder.lifecycle.internal.FromObservableSource
 import io.reactivex.ObservableSource
 
 interface Lifecycle : ObservableSource<Lifecycle.Event> {

diff --git a/...icore/binder/lifecycle/ManualLifecycle.kt → ...badoo/binder/lifecycle/ManualLifecycle.kt b/...icore/binder/lifecycle/ManualLifecycle.kt → ...badoo/binder/lifecycle/ManualLifecycle.kt
@@ -1,8 +1,8 @@
-package com.badoo.mvicore.binder.lifecycle
+package com.badoo.binder.lifecycle
 
-import com.badoo.mvicore.binder.lifecycle.Lifecycle.Event
-import com.badoo.mvicore.binder.lifecycle.Lifecycle.Event.BEGIN
-import com.badoo.mvicore.binder.lifecycle.Lifecycle.Event.END
+import com.badoo.binder.lifecycle.Lifecycle.Event
+import com.badoo.binder.lifecycle.Lifecycle.Event.BEGIN
+import com.badoo.binder.lifecycle.Lifecycle.Event.END
 import io.reactivex.subjects.BehaviorSubject
 
 class ManualLifecycle(private val subject : BehaviorSubject<Event> = BehaviorSubject.create()) : Lifecycle by Lifecycle.wrap(subject) {

diff --git a/...ifecycle/internal/FromObservableSource.kt → ...ifecycle/internal/FromObservableSource.kt b/...ifecycle/internal/FromObservableSource.kt → ...ifecycle/internal/FromObservableSource.kt
@@ -1,6 +1,6 @@
-package com.badoo.mvicore.binder.lifecycle.internal
+package com.badoo.binder.lifecycle.internal
 
-import com.badoo.mvicore.binder.lifecycle.Lifecycle
+import com.badoo.binder.lifecycle.Lifecycle
 import io.reactivex.ObservableSource
 
 internal class FromObservableSource(

diff --git a/...va/com/badoo/mvicore/consumer/Consumer.kt → ...a/com/badoo/binder/middleware/Consumer.kt b/...va/com/badoo/mvicore/consumer/Consumer.kt → ...a/com/badoo/binder/middleware/Consumer.kt
@@ -1,17 +1,17 @@
-package com.badoo.mvicore.consumer
+package com.badoo.binder.middleware
 
-import com.badoo.mvicore.consumer.middleware.base.Middleware
-import com.badoo.mvicore.consumer.middleware.base.StandaloneMiddleware
-import com.badoo.mvicore.consumer.middlewareconfig.Middlewares
-import com.badoo.mvicore.consumer.middlewareconfig.NonWrappable
+import com.badoo.binder.middleware.base.Middleware
+import com.badoo.binder.middleware.base.StandaloneMiddleware
+import com.badoo.binder.middleware.config.Middlewares
+import com.badoo.binder.middleware.config.NonWrappable
 import io.reactivex.functions.Consumer
 
 /**
  * Wraps a Consumer<T> with Middlewares. The list of Middlewares that will be applied is resolved
  * by calling on all available [com.badoo.mvicore.consumer.middlewareconfig.MiddlewareConfiguration]
  *
  * @param standalone    Whether the Consumer<T> is used as a standalone target (true), or as
- *                      part of a [com.badoo.mvicore.binder.Connection] used by [com.badoo.mvicore.binder.Binder].
+ *                      part of a [Connection] used by [Binder].
  *                      Defaults to true. In most cases you should not need to override the default value.
  * @param name          The name for the wrapping. Useful to add MiddlewareConfiguration
  *                      that only applies to named wrappings, or to make them human-readable
@@ -49,7 +49,7 @@ fun <In> Consumer<In>.wrapWithMiddleware(
     "Use wrapWithMiddleware directly",
     ReplaceWith(
         "wrapWithMiddleware(standalone, name, postfix, wrapperOf)",
-        "com.badoo.mvicore.consumer.wrapWithMiddleware"
+        "com.badoo.binder.middleware.wrapWithMiddleware"
     )
 )
 fun <In: Any> Consumer<In>.wrap(

diff --git a/...re/consumer/middleware/base/Middleware.kt → ...adoo/binder/middleware/base/Middleware.kt b/...re/consumer/middleware/base/Middleware.kt → ...adoo/binder/middleware/base/Middleware.kt
@@ -1,6 +1,6 @@
-package com.badoo.mvicore.consumer.middleware.base
+package com.badoo.binder.middleware.base
 
-import com.badoo.mvicore.binder.Connection
+import com.badoo.binder.Connection
 import io.reactivex.functions.Consumer
 
 abstract class Middleware<Out, In>(

diff --git a/...r/middleware/base/StandaloneMiddleware.kt → ...r/middleware/base/StandaloneMiddleware.kt b/...r/middleware/base/StandaloneMiddleware.kt → ...r/middleware/base/StandaloneMiddleware.kt
@@ -1,6 +1,6 @@
-package com.badoo.mvicore.consumer.middleware.base
+package com.badoo.binder.middleware.base
 
-import com.badoo.mvicore.binder.Connection
+import com.badoo.binder.Connection
 import io.reactivex.disposables.Disposable
 
 internal class StandaloneMiddleware<In>(

diff --git a/...lewareconfig/ConsumerMiddlewareFactory.kt → ...eware/config/ConsumerMiddlewareFactory.kt b/...lewareconfig/ConsumerMiddlewareFactory.kt → ...eware/config/ConsumerMiddlewareFactory.kt
@@ -1,6 +1,6 @@
-package com.badoo.mvicore.consumer.middlewareconfig
+package com.badoo.binder.middleware.config
 
-import com.badoo.mvicore.consumer.middleware.base.Middleware
+import com.badoo.binder.middleware.base.Middleware
 import io.reactivex.functions.Consumer
 
 typealias ConsumerMiddlewareFactory<T> = (Consumer<T>) -> Middleware<Any, T>
diff --git a/...ddlewareconfig/MiddlewareConfiguration.kt → ...dleware/config/MiddlewareConfiguration.kt b/...ddlewareconfig/MiddlewareConfiguration.kt → ...dleware/config/MiddlewareConfiguration.kt
@@ -1,6 +1,6 @@
-package com.badoo.mvicore.consumer.middlewareconfig
+package com.badoo.binder.middleware.config
 
-import com.badoo.mvicore.consumer.middleware.base.Middleware
+import com.badoo.binder.middleware.base.Middleware
 import io.reactivex.functions.Consumer
 
 data class MiddlewareConfiguration(

diff --git a/.../consumer/middlewareconfig/Middlewares.kt → ...o/binder/middleware/config/Middlewares.kt b/.../consumer/middlewareconfig/Middlewares.kt → ...o/binder/middleware/config/Middlewares.kt
@@ -1,4 +1,4 @@
-package com.badoo.mvicore.consumer.middlewareconfig
+package com.badoo.binder.middleware.config
 
 object Middlewares {
     val configurations: MutableList<MiddlewareConfiguration> = mutableListOf()

diff --git a/binder/src/main/java/com/badoo/binder/middleware/config/NonWrappable.kt b/binder/src/main/java/com/badoo/binder/middleware/config/NonWrappable.kt
@@ -0,0 +1,3 @@
+package com.badoo.binder.middleware.config
+
+interface NonWrappable
diff --git a/...mer/middlewareconfig/WrappingCondition.kt → ...er/middleware/config/WrappingCondition.kt b/...mer/middlewareconfig/WrappingCondition.kt → ...er/middleware/config/WrappingCondition.kt
@@ -1,4 +1,4 @@
-package com.badoo.mvicore.consumer.middlewareconfig
+package com.badoo.binder.middleware.config
 
 interface WrappingCondition {
 

diff --git a/...va/com/badoo/mvicore/binder/BinderTest.kt → .../test/java/com/badoo/binder/BinderTest.kt b/...va/com/badoo/mvicore/binder/BinderTest.kt → .../test/java/com/badoo/binder/BinderTest.kt
@@ -1,10 +1,7 @@
-package com.badoo.mvicore.binder
+package com.badoo.binder
 
-import com.badoo.mvicore.TestConsumer
-import com.badoo.mvicore.assertValues
-import com.badoo.mvicore.connector.Connector
-import io.reactivex.Observable.just
-import io.reactivex.Observable.wrap
+import com.badoo.binder.connector.Connector
+import io.reactivex.Observable
 import io.reactivex.ObservableSource
 import io.reactivex.subjects.PublishSubject
 import org.junit.Test
@@ -49,8 +46,8 @@ class BinderTest {
 
     object TestConnector: Connector<Int, String> {
         override fun invoke(it: ObservableSource<out Int>): ObservableSource<String> =
-            wrap(it).flatMap {
-                just(it.toString(), (it + 1).toString())
+            Observable.wrap(it).flatMap {
+                Observable.just(it.toString(), (it + 1).toString())
             }
     }
 }
diff --git a/.../badoo/mvicore/lifecycle/LifecycleTest.kt → ...st/java/com/badoo/binder/LifecycleTest.kt b/.../badoo/mvicore/lifecycle/LifecycleTest.kt → ...st/java/com/badoo/binder/LifecycleTest.kt
@@ -1,10 +1,7 @@
-package com.badoo.mvicore.lifecycle
+package com.badoo.binder
 
-import com.badoo.mvicore.TestConsumer
-import com.badoo.mvicore.assertValues
-import com.badoo.mvicore.binder.Binder
-import com.badoo.mvicore.binder.lifecycle.Lifecycle
-import com.badoo.mvicore.binder.lifecycle.ManualLifecycle
+import com.badoo.binder.lifecycle.Lifecycle
+import com.badoo.binder.lifecycle.ManualLifecycle
 import com.nhaarman.mockito_kotlin.any
 import com.nhaarman.mockito_kotlin.mock
 import com.nhaarman.mockito_kotlin.times

diff --git a/...st/java/com/badoo/mvicore/TestConsumer.kt → ...est/java/com/badoo/binder/TestConsumer.kt b/...st/java/com/badoo/mvicore/TestConsumer.kt → ...est/java/com/badoo/binder/TestConsumer.kt
@@ -1,4 +1,4 @@
-package com.badoo.mvicore
+package com.badoo.binder
 
 import io.reactivex.functions.Consumer
 import kotlin.test.assertEquals

diff --git a/build.gradle b/build.gradle
@@ -1,7 +1,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    ext.kotlinVersion = '1.3.40'
+    ext.kotlinVersion = '1.3.72'
 
     repositories {
         google()

diff --git a/documentation/binder/binder.md b/documentation/binder/binder.md
@@ -1,5 +1,8 @@
 # Binder usage and lifecycle
 
+!!! warning ""
+    After 1.2.4, `Binder` is located in a separate module. You may need to add dependency on `com.github.badoo.mvicore:binder` to have it available.
+
 ## What is the Binder and why is it good for me?
 
 If you wrote your first `Feature`, now you may wonder how to start using it.
@@ -17,7 +20,6 @@ The `Binder` is a tool that can:
 - dispose of this subscription when its lifecycle expires
 - automatically add `Middlewares` around all inputs (logging and time travel debugging, or your custom one)
 
-
 ## Binder creation
 
 Creating an instance is as simple as:

diff --git a/mvicore-android/src/main/java/com/badoo/mvicore/android/AndroidBindings.kt b/mvicore-android/src/main/java/com/badoo/mvicore/android/AndroidBindings.kt
@@ -1,9 +1,7 @@
 package com.badoo.mvicore.android
 
 import android.arch.lifecycle.LifecycleOwner
-import com.badoo.mvicore.binder.Binder
-import android.arch.lifecycle.Lifecycle as AndroidLifecycle
-import com.badoo.mvicore.binder.lifecycle.Lifecycle as BinderLifecycle
+import com.badoo.binder.Binder
 
 abstract class AndroidBindings<T : Any>(
     lifecycleOwner: LifecycleOwner

diff --git a/...e-android/src/main/java/com/badoo/mvicore/android/lifecycle/BaseAndroidBinderLifecycle.kt b/...e-android/src/main/java/com/badoo/mvicore/android/lifecycle/BaseAndroidBinderLifecycle.kt
@@ -5,7 +5,7 @@ import android.arch.lifecycle.LifecycleObserver
 import io.reactivex.ObservableSource
 import io.reactivex.subjects.BehaviorSubject
 import android.arch.lifecycle.Lifecycle as AndroidLifecycle
-import com.badoo.mvicore.binder.lifecycle.Lifecycle as BinderLifecycle
+import com.badoo.binder.lifecycle.Lifecycle as BinderLifecycle
 
 abstract class BaseAndroidBinderLifecycle private constructor(
     androidLifecycle: AndroidLifecycle,

diff --git a/...android/src/main/java/com/badoo/mvicore/android/lifecycle/CreateDestroyBinderLifecycle.kt b/...android/src/main/java/com/badoo/mvicore/android/lifecycle/CreateDestroyBinderLifecycle.kt
@@ -3,7 +3,7 @@ package com.badoo.mvicore.android.lifecycle
 import android.arch.lifecycle.DefaultLifecycleObserver
 import android.arch.lifecycle.LifecycleOwner
 import android.arch.lifecycle.Lifecycle as AndroidLifecycle
-import com.badoo.mvicore.binder.lifecycle.Lifecycle as BinderLifecycle
+import com.badoo.binder.lifecycle.Lifecycle as BinderLifecycle
 
 
 class CreateDestroyBinderLifecycle(

diff --git a/mvicore-android/src/main/java/com/badoo/mvicore/android/lifecycle/LifecycleExtensions.kt b/mvicore-android/src/main/java/com/badoo/mvicore/android/lifecycle/LifecycleExtensions.kt
@@ -1,7 +1,7 @@
 package com.badoo.mvicore.android.lifecycle
 
 import android.arch.lifecycle.Lifecycle
-import com.badoo.mvicore.binder.Binder
+import com.badoo.binder.Binder
 
 fun Lifecycle.createDestroy(f: Binder.() -> Unit) {
     Binder(CreateDestroyBinderLifecycle(this)).apply(f)

diff --git a/...e-android/src/main/java/com/badoo/mvicore/android/lifecycle/ResumePauseBinderLifecycle.kt b/...e-android/src/main/java/com/badoo/mvicore/android/lifecycle/ResumePauseBinderLifecycle.kt
@@ -3,7 +3,7 @@ package com.badoo.mvicore.android.lifecycle
 import android.arch.lifecycle.DefaultLifecycleObserver
 import android.arch.lifecycle.LifecycleOwner
 import android.arch.lifecycle.Lifecycle as AndroidLifecycle
-import com.badoo.mvicore.binder.lifecycle.Lifecycle as BinderLifecycle
+import com.badoo.binder.lifecycle.Lifecycle as BinderLifecycle
 
 
 class ResumePauseBinderLifecycle(

diff --git a/...ore-android/src/main/java/com/badoo/mvicore/android/lifecycle/StartStopBinderLifecycle.kt b/...ore-android/src/main/java/com/badoo/mvicore/android/lifecycle/StartStopBinderLifecycle.kt
@@ -3,7 +3,7 @@ package com.badoo.mvicore.android.lifecycle
 import android.arch.lifecycle.DefaultLifecycleObserver
 import android.arch.lifecycle.LifecycleOwner
 import android.arch.lifecycle.Lifecycle as AndroidLifecycle
-import com.badoo.mvicore.binder.lifecycle.Lifecycle as BinderLifecycle
+import com.badoo.binder.lifecycle.Lifecycle as BinderLifecycle
 
 
 class StartStopBinderLifecycle(

diff --git a/mvicore-demo/mvicore-demo-app/src/main/java/com/badoo/mvicoredemo/App.kt b/mvicore-demo/mvicore-demo-app/src/main/java/com/badoo/mvicoredemo/App.kt
@@ -2,12 +2,12 @@ package com.badoo.mvicoredemo
 
 import android.annotation.SuppressLint
 import android.app.Application
+import com.badoo.binder.middleware.config.MiddlewareConfiguration
+import com.badoo.binder.middleware.config.Middlewares
+import com.badoo.binder.middleware.config.WrappingCondition
 import com.badoo.mvicore.consumer.middleware.LoggingMiddleware
 import com.badoo.mvicore.consumer.middleware.PlaybackMiddleware
 import com.badoo.mvicore.consumer.middleware.PlaybackMiddleware.RecordStore
-import com.badoo.mvicore.consumer.middlewareconfig.MiddlewareConfiguration
-import com.badoo.mvicore.consumer.middlewareconfig.Middlewares
-import com.badoo.mvicore.consumer.middlewareconfig.WrappingCondition
 import com.badoo.mvicore.middleware.DefaultPluginStore
 import com.badoo.mvicore.middleware.IdeaPluginMiddleware
 import com.badoo.mvicoredemo.di.appscope.component.AppScopedComponent

diff --git a/...vicore-demo-app/src/main/java/com/badoo/mvicoredemo/ui/lifecycle/LifecycleDemoActivity.kt b/...vicore-demo-app/src/main/java/com/badoo/mvicoredemo/ui/lifecycle/LifecycleDemoActivity.kt
@@ -5,11 +5,11 @@ import android.support.v4.view.GravityCompat
 import android.support.v7.app.AppCompatActivity
 import android.util.Log
 import android.view.MenuItem
+import com.badoo.binder.Binder
+import com.badoo.binder.named
 import com.badoo.mvicore.android.lifecycle.CreateDestroyBinderLifecycle
 import com.badoo.mvicore.android.lifecycle.ResumePauseBinderLifecycle
 import com.badoo.mvicore.android.lifecycle.StartStopBinderLifecycle
-import com.badoo.mvicore.binder.Binder
-import com.badoo.mvicore.binder.named
 import com.badoo.mvicoredemo.R
 import init
 import io.reactivex.functions.Consumer

diff --git a/...demo/mvicore-demo-app/src/main/java/com/badoo/mvicoredemo/ui/main/MainActivityBindings.kt b/...demo/mvicore-demo-app/src/main/java/com/badoo/mvicoredemo/ui/main/MainActivityBindings.kt
@@ -1,10 +1,10 @@
 package com.badoo.mvicoredemo.ui.main
 
+import com.badoo.binder.named
+import com.badoo.binder.using
 import com.badoo.feature1.Feature1
 import com.badoo.feature2.Feature2
 import com.badoo.mvicore.android.AndroidBindings
-import com.badoo.mvicore.binder.named
-import com.badoo.mvicore.binder.using
 import com.badoo.mvicoredemo.ui.main.analytics.FakeAnalyticsTracker
 import com.badoo.mvicoredemo.ui.main.event.UiEventTransformer1
 import com.badoo.mvicoredemo.ui.main.event.UiEventTransformer2

diff --git a/mvicore-plugin/middleware/src/main/java/com/badoo/mvicore/middleware/DefaultPluginStore.kt b/mvicore-plugin/middleware/src/main/java/com/badoo/mvicore/middleware/DefaultPluginStore.kt
@@ -1,6 +1,6 @@
 package com.badoo.mvicore.middleware
 
-import com.badoo.mvicore.binder.Connection
+import com.badoo.binder.Connection
 import com.badoo.mvicore.middleware.data.parse
 import com.badoo.mvicore.middleware.gc.QueueWatcher
 import com.badoo.mvicore.middleware.gson.MviPluginTypeAdapterFactory