https://github.com/pakoito/RxActions

Simple ActionN composition to use with RxJava [STABLE]
https://github.com/pakoito/RxActions

Last synced: 25 days ago
JSON representation

Simple ActionN composition to use with RxJava [STABLE]

• Host: GitHub
• URL: https://github.com/pakoito/RxActions
• Owner: pakoito
• License: other
• Created: 2015-12-12T19:48:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-22T00:06:58.000Z (over 7 years ago)
• Last Synced: 2024-11-15T23:30:30.868Z (27 days ago)
• Language: Java
• Homepage:
• Size: 62.5 KB
• Stars: 33
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-rxjava - RxActions - Simple ActionN composition to use with RxJava. (Utilities)

README

        
# RxActions

RxActions is a library to smooth RxJava usage by functionally composing actions.

For the RxJava 2.X version please go to [RxConsumers](https://github.com/pakoito/RxConsumers).

## Rationale

Sometimes you have to describe side effects in your Observable chain, by means of doOnNext, doOnError, or even in the subscription. Writing several of those operators may incur on minimal performance penalties, and make the chain more verbose. RxActions allows you to combine those actions sequentially.

One acknowledged critique is that the composition can be done inlined and imperatively instead by using a lambda. That's not available on Java 1.6 versions without 3rd party tools, making it effectively more verbose.

## Usage

RxActions comes as lazily evaluated ActionN and its main use case is for doOnNext, doOnError, and subscribe operators. Please note subscribe comes in several flavours that accept ActionN for better composability.

Log correct server response, cache it, and display on UI:

    getApi().requestListFromServer()

            .subscribe(RxActions.act(logElement(), cacheElements(), getUi.displayElements()));

            

Log an error to console, then display UI message:

    getApi().requestListFromServer()

            .subscribe(/* ... */,

                       RxActions.act(logError(), getUi().displayErrorMessage()));

                

Log error, clear cache, and display a message before applying an error correction operator:

    getApi().storeInDatabase()

            .doOnError(RxActions.act(logError(), getUi().displayErrorMessage(), clearCache()))

            .onErrorReturn(Collections.emptyList())

            .subscribe(/* ... */);

## Distribution

Add as a dependency to your `build.gradle`

    repositories {

        ...

        maven { url "https://jitpack.io" }

        ...

    }

    

    dependencies {

        ...

        compile 'com.github.pakoito:RxActions:1.0.+'

        ...

    }

or to your `pom.xml`

    

        

            jitpack.io

            https://jitpack.io

        

    

    

    

        com.github.pakoito

        RxActions

        1.0.0

    

## License

Copyright (c) pakoito 2015

The Apache Software License, Version 2.0

See LICENSE.md