/RxNuke

RxSwift extensions for Nuke

Primary LanguageSwiftMIT LicenseMIT

This repository contains RxSwift extensions for Nuke as well as examples of common use cases solved by Rx.

Use Cases

Getting Started

Usage

RxNuke adds a new Loading protocol with a set of methods which returns RxSwift.Single observables:

public protocol Loading {
    func loadImage(with url: URL) -> Single<Image>
    func loadImage(with urlRequest: URLRequest) -> Single<Image>
    func loadImage(with request: Nuke.Request) -> Single<Image>
}

A Single is a variation of Observable that, instead of emitting a series of elements, is always guaranteed to emit either a single element or an error. The common use case of Single is to wrap HTTP requests. See Traits for more info.

Let's start with the basics. Here's an example of how to use a new RxNuke.Loading protocol to load an image and display the result on success:

Nuke.Manager.shared.loadImage(with: url)
    .observeOn(MainScheduler.instance)
    .subscribe(onSuccess: { imageView.image = $0 })
    .disposed(by: disposeBag)

Going From Low to High Resolution

Suppose you want to show users a high-resolution, slow-to-download image. Rather than let them stare a placeholder for a while, you might want to quickly download a smaller thumbnail first.

You can implement this using concat operator which results in a serial execution. It would first start a thumbnail request, wait until it finishes, and only then start a request for a high-resolution image.

Observable.concat(loader.loadImage(with: lowResUrl).orEmpty,
                  loader.loadImage(with: highResUtl).orEmpty)
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { imageView.image = $0 })
    .disposed(by: disposeBag)

orEmpty is a custom operator which dismisses errors and completes the sequence instead (equivalent to func catchErrorJustComplete() from RxSwiftExt

Loading the First Available Image

Suppose you have multiple URLs for the same image. For instance, you might have uploaded an image taken from the camera. In such case, it would be beneficial to first try to get the local URL, and if that fails, try to get the network URL. It would be a shame to download the image that we may have already locally.

This use case is very similar Going From Low to High Resolution, but an addition of .take(1) guarantees that we stop execution as soon as we receive the first result.

Observable.concat(loader.loadImage(with: localUrl).orEmpty,
                  loader.loadImage(with: networkUrl).orEmpty)
    .take(1)
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { imageView.image = $0 })
    .disposed(by: disposeBag)

Load Multiple Images, Display All at Once

Suppose you want to load two icons for a button, one icon for .normal state and one for .selected state. Only when both icons are loaded you can show the button to the user. This can be done using a combineLatest operator:

Observable.combineLatest(loader.loadImage(with: iconUrl).asObservable(),
                         loader.loadImage(with: iconSelectedUrl).asObservable())
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { icon, iconSelected in
        button.isHidden = false
        button.setImage(icon, for: .normal)
        button.setImage(iconSelected, for: .selected)
    }).disposed(by: disposeBag)

Showing Stale Image While Validating It

Suppose you want to show users a stale image stored in a disk cache (Foundation.URLCache) while you go to the server to validate it. This use case is actually similar to Going From Low to High Resolution.

let cacheRequest = URLRequest(url: imageUrl, cachePolicy: .returnCacheDataDontLoad)
let networkRequest = URLRequest(url: imageUrl, cachePolicy: .useProtocolCachePolicy)

Observable.concat(loader.loadImage(with: cacheRequest).orEmpty,
                  loader.loadImage(with: networkRequest).orEmpty)
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { imageView.image = $0 })
    .disposed(by: disposeBag)

See Image Caching to learn more about HTTP cache

Auto Retry

Auto-retry up to 3 times with an exponentially increasing delay using a retry operator provided by RxSwiftExt.

loader.loadImage(with: request).asObservable()
    .retry(.exponentialDelayed(maxCount: 3, initial: 3.0, multiplier: 1.0))
    .observeOn(MainScheduler.instance)
    .subscribe(onNext: { imageView.image = $0 })
    .disposed(by: disposeBag)

See A Smarter Retry with RxSwiftExt for more info about auto retries

Tracking Activities

Suppose you want to show an activity indicator while waiting for an image to load. Here's how you can do it using ActivityIndicator class provided by RxSwiftUtilities:

let isBusy = ActivityIndicator()

loader.loadImage(with: imageUrl)
    .observeOn(MainScheduler.instance)
    .trackActivity(isBusy)
    .subscribe(onNext: { imageView.image = $0 })
    .disposed(by: disposeBag)

isBusy.asDriver()
    .drive(activityIndicator.rx.isAnimating)
    .disposed(by: disposeBag)

In a Table or Collection View

Here's how you can integrate the code provided in the previous examples into your table or collection view cells:

final class ImageCell: UICollectionViewCell {

    private var imageView: UIImageView!
    private var disposeBag = DisposeBag()

    // <.. create an image view using your preferred way ..>

    func display(_ image: Single<Image>) {

        // Create a new dispose bag, previous dispose bag gets deallocated
        // and cancels all previous subscriptions.
        disposeBag = DisposeBag()

        imageView.image = nil

        // Load an image and display the result on success.
        image.subscribeOn(MainScheduler.instance)
            .subscribe(onSuccess: { [weak self] image in
                self?.imageView.image = image
            }).disposed(by: disposeBag)
    }
}

Requirements

  • iOS 9.0 / watchOS 2.0 / macOS 10.11 / tvOS 9.0
  • Xcode 8.3
  • Swift 3.1

License

RxNuke is available under the MIT license. See the LICENSE file for more info.