Functional Constructs for Databinding + Kotlin + RxJava

Overview

ObservableFlow

Pt 1/3

Pt 2/3: Stepper Indicator

Pt 3/3: SugarPreferences

BuddyBuild Minimum API 9 Release rakshakhegde newsletter

Functional Kotlin constructs like map(), filter() and 12 more functions built for Android Data Binding library + RxJava 2 support. Check out the release apk here.

// tiny preview
val source = ObservableField("source")
val dest = source.filter { it.startsWith('s') }
		.map { it.capitalize() }

Please sign up for my newsletter rakshakhegde 📧

Installation

In your global build.gradle file:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Include any one of these in your app build.gradle file:

dependencies {
	compile 'com.github.rakshakhegde.ObservableFlow:observableflow:0.1-alpha'
}

(or, if you need RxJava 2 support. This includes the above ObservableFlow core library.)

dependencies {
	compile 'com.github.rakshakhegde.ObservableFlow:rxdatabinding:0.1-alpha'
}

Motivation

I personally find writing code in a functional way just makes my logic neatly encapsulated and broken up into simple parts. So I built these functional constructs as a part of my other projects where I use DataBinding and Kotlin (which is almost always), that kinda emulates RxJava's map and filter which I loved and used a lot, but for ObservableFields. So now I've open sourced it hoping others might find it useful too. Cheers :)

By the way, if you like my work please show some ❤️ and star this project above

GitHub stars GitHub forks GitHub watchers GitHub followers Twitter Follow

Documentation

Here are all the functions and extension functions for ObservableFields. Even though I've attempted to document how to use all the functional statements, the best source of documentation are the tests themselves. Here I'll just show the function prototype and code snippet in pairs. Hopefully meaning of the code becomes immediately apparent.

ObservableFlow

  • map
     val text: ObservableField<String> = ObservableField("Hello World")
     val textLength = text.map { it.length }
     inline fun <T, R> ObservableField<T>.map(
     	dstObsrv: ObservableField<R> = ObservableField(),
     	crossinline f: (T) -> R
     ): ObservableField<R>
  • vararg map
     val totalLength = map(text1, text2) {
     	text1.get().length + text2.get().length
     }
     inline fun <T> map(vararg sources: Observable, crossinline onChange: () -> T): ObservableField<T>
  • filter
     val evenLengthTextOnly = text.filter { it.length % 2 == 0 }
     inline fun <T> ObservableField<T>.filter(
     	defaultVal: T? = null,
     	crossinline predicate: (T) -> Boolean
     ): ObservableField<T>
  • onPropertyChanged
     text.onPropertyChanged { // block executed for every subsequent property change
     	val newVal = get()
     	println("text changed to $newVal")
     }
     inline fun <T : Observable> T.onPropertyChanged(crossinline listener: T.(propertyId: Int) -> Unit):
     	Observable.OnPropertyChangedCallback
  • vararg onPropertyChanged
     onPropertyChanged(text1, text2) {
     	performAction(text1.get(), text2.get())
     }
     inline fun onPropertyChanged(vararg sources: Observable, crossinline onChange: () -> Unit):
     	List<Observable.OnPropertyChangedCallback>
  • bind
     text.bind { // block executed immediately and for every subsequent property change
     	val newVal = get()
     	println("text changed to $newVal")
     }
     inline fun <T : Observable> T.bind(
     	crossinline listener: T.(Int) -> Unit
     ): Observable.OnPropertyChangedCallback
  • vararg bind
     bind(text1, text2) {
     	println(text1.get() + text2.get())
     }
     inline fun bind(vararg sources: Observable, crossinline onChange: () -> Unit):
     	List<Observable.OnPropertyChangedCallback>
  • observableListOf
     val observableInts = observableListOf(5, 6, 7, 9) // Int type inferred
     fun <T> observableListOf(vararg items: T): ObservableArrayList<T>
  • bindToList
     observableInts.bindToList { // block executed immediately and everytime anything changes in the list
     	forEach { item -> performActionOn(item) }
     }
     inline fun <T, S : ObservableList<T>> S.bindToList(crossinline listener: S.() -> Unit):
     	ObservableList.OnListChangedCallback<S>
  • onListChanged
     observableInts.onListChanged { // block executed everytime anything changes in the list
     	forEach { item -> performActionOn(item) }
     }
     inline fun <T, S : ObservableList<T>> S.onListChanged(crossinline listener: S.() -> Unit):
     	ObservableList.OnListChangedCallback<S>

RxDatabinding

  • rx
     val nameObservable = ObservableField("First")
     
     nameObservable.rx()
     	.subscribe(onNext)
     fun <T> ObservableField<T>.rx(): Observable<T>
  • toField - share()s the RxJava Observable so that when the last propertyChangedCallback is removed, the Observable is also finished
     val dest = Observable.create<String> { emitter = it }
     		.toField()
     fun <T> Observable<T>.toField(defaultVal: T? = null): RxObservableField<T>
  • rxOnPropertyChanged
     rxOnPropertyChange(src1, src2, src3)
     	.map { src1.get() + src2.get() + src3.get() }
     	.subscribe(onNext)
     fun rxOnPropertyChange(vararg observables: android.databinding.Observable): io.reactivex.Observable<Int>
  • rxBind
     rxBind(src1, src2, src3)
     	.map { src1.get() + src2.get() + src3.get() }
     	.subscribe(onNext)
     fun rxBind(vararg observables: android.databinding.Observable): io.reactivex.Observable<Int>

Miscellaneous

  • There are no extension functions for all the other primitive Observables, like ObservableInt, ObservableFloat, etc. because I didn't find these optimisations worthwhile to write code and tests for. So I just use ObservableField<Int>, ObservableField<Float>, etc even for Android projects and they are auto-boxed, well, automatically.
  • For the RxJava toField() binding, it was initially non-explicitly-writable, i.e., set() function was made useless and deprecated, so as to avoid side-effects, one of guiding principles of Functional Programming. But I once found myself desperately needing to change the value of that ObservableField imperatively. So I have reverted it back to a normal ObservableField whose value can be imperatively mutated anywhere in your code. But just don't go bonkers using this side-effect. Try and use it functionally as much as possible (:

Created & Maintained By

Rakshak R.Hegde (@rakshakhegde) Wanna contribute to this project? Pull requests welcome ❤️

Note: This project is a part of an ongoing series of open-source projects I'm working on. If you liked my work, please consider following me on Twitter @rakshakhegde and Github. Also please share this project with fellow developers. I'm also starting a newsletter of my own called rakshakhegde 📧 . It would be great if you could fill in your email address and subscribe to my new project announcements, releases or blog posts. Subscribe here :)

License

Copyright 2017 Rakshak Hegde

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You might also like...
Android + Kotlin + Github Actions + ktlint + Detekt + Gradle Kotlin DSL + buildSrc = ❤️

kotlin-android-template 🤖 A simple Github template that lets you create an Android/Kotlin project and be up and running in a few seconds. This templa

LifecycleMvp 1.2 0.0 Kotlin  is MVP architecture implementation with Android Architecture Components and Kotlin language features
LifecycleMvp 1.2 0.0 Kotlin is MVP architecture implementation with Android Architecture Components and Kotlin language features

MinSDK 14+ Download Gradle Add to project level build.gradle allprojects { repositories { ... maven { url 'https://jitpack.io' }

Opinionated Redux-like implementation backed by Kotlin Coroutines and Kotlin Multiplatform Mobile

CoRed CoRed is Redux-like implementation that maintains the benefits of Redux's core idea without the boilerplate. No more action types, action creato

👋 A common toolkit (utils) ⚒️ built to help you further reduce Kotlin boilerplate code and improve development efficiency. Do you think 'kotlin-stdlib' or 'android-ktx' is not sweet enough? You need this! 🍭

Toolkit [ 🚧 Work in progress ⛏ 👷 🔧️ 🚧 ] Snapshot version: repositories { maven("https://s01.oss.sonatype.org/content/repositories/snapshots") }

An app architecture for Kotlin/Native on Android/iOS. Use Kotlin Multiplatform Mobile.
An app architecture for Kotlin/Native on Android/iOS. Use Kotlin Multiplatform Mobile.

An app architecture for Kotlin/Native on Android/iOS. Use Kotlin Multiplatform Mobile. 项目架构主要分为原生系统层、Android/iOS业务SDK层、KMM SDK层、KMM业务逻辑SDK层、iOS sdkfra

Provides Kotlin libs and some features for building Kotlin plugins
Provides Kotlin libs and some features for building Kotlin plugins

Kotlin Plugin Provides Kotlin libs and some features for building awesome Kotlin plugins. Can be used instead of CreeperFace's KotlinLib (don't use to

Notes-App-Kotlin - Notes App Built Using Kotlin
Notes-App-Kotlin - Notes App Built Using Kotlin

Notes-App-Kotlin Splash Screen Home Page Adding New Notes Filter Feature Search

Kotlin-client-dsl - A kotlin-based dsl project for a (Client) - (Plugin) styled program

kotlin-client-dsl a kotlin-based dsl project for a (Client) - (Plugin) styled p

A Kotlin Native program to show the time since a date, using Kotlin LibUI
A Kotlin Native program to show the time since a date, using Kotlin LibUI

TimeSince A Kotlin Native program to show the time since a date, using Kotlin LibUI Report Bug . Request Feature About The Project TimeSince is a Kotl

Comments
  • Mocking framework

    Mocking framework

    Hi,

    hope find you well with this cold call.

    I am an author of mocking framework for Kotlin

    I see you are using mockito-kotlin.

    I just want you to be aware that there is solution that fully supports Kotlin and ask to try it in your new/current projects.

    I can help you if you answer to this issue.

    Thanks and please star it

    opened by oleksiyp 0
Releases(0.0.1-alpha)
Owner
Rakshak R.Hegde
Android Dev in Bengaluru My awesome app: https://goo.gl/XWur09
Rakshak R.Hegde
[Android-Kotlin] MVVM, ViewModel, LiveData, Observer, DataBinding, Repository, Retrofit, Dagger example

SimpleMvvmDaggerKotlin [Android-Kotlin] MVVM, ViewModel, LiveData, Observer, DataBinding, Repository, Retrofit, Dagger example [Image1 : User informat

DONGGEUN JUNG 2 Oct 24, 2022
Exercises for Functional Programming learning in Kotlin with Arrow

Exercises for Functional Programming in Kotlin with Arrow-kt Exercises and practice code for Functional Programming learning in Kotlin with Arrow Requ

Jack Lo 3 Nov 11, 2021
Functional Kotlin & Arrow based library for generating and verifying JWTs and JWSs

kJWT Functional Kotlin & Arrow based library for generating and verifying JWTs and JWSs. JWS JWT The following Algorithms are supported: HS256 HS384 H

Peter vR 31 Dec 25, 2022
Ivy FRP is a Functional Reactive Programming framework for declarative-style programming for Android

FRP (Functional Reactive Programming) framework for declarative-style programming for Andorid. :rocket: (compatible with Jetpack Compose)

null 8 Nov 24, 2022
Dead simple EventBus for Android made with Kotlin and RxJava 2

KBus Super lightweight (13 LOC) and minimalistic (post(), subscribe(), unsubscribe()) EventBus written with idiomatic Kotlin and RxJava 2 KBus in 3 st

Adriel Café 46 Dec 6, 2022
base url not included, rxJava, Retrofit

NewsFeed NewsFeed is an android sample application built using kotlin, androidx artifacts, kotlin-extensions in MVP pattern. Libraries Used Dagger 2 D

Sagar Raval 0 Dec 29, 2021
base url not included, rxJava, Retrofit

NewsFeed NewsFeed is an android sample application built using kotlin, androidx artifacts, kotlin-extensions in MVP pattern. Libraries Used Dagger 2 D

Sagar Raval 0 Dec 29, 2021
Run Kotlin/JS libraries in Kotlin/JVM and Kotlin/Native programs

Zipline This library streamlines using Kotlin/JS libraries from Kotlin/JVM and Kotlin/Native programs. It makes it possible to do continuous deploymen

Cash App 1.5k Dec 30, 2022
A somewhat copy past of Jetbrain's code from the kotlin plugin repo to make it humanly possible to test Intellij IDEA kotlin plugins that work on kotlin

A somewhat copy past of Jetbrain's code from the kotlin plugin repo to make it humanly possible to test Intellij IDEA kotlin plugins that work on kotlin

common sense OSS 0 Jan 20, 2022
Real life Kotlin Multiplatform project with an iOS application developed in Swift with SwiftUI, an Android application developed in Kotlin with Jetpack Compose and a backed in Kotlin hosted on AppEngine.

Conferences4Hall Real life Kotlin Multiplatform project with an iOS application developed in Swift with SwiftUI, an Android application developed in K

Gérard Paligot 98 Dec 15, 2022