Skip to content

Latest commit

 

History

History
195 lines (136 loc) · 7.63 KB

README.md

File metadata and controls

195 lines (136 loc) · 7.63 KB
Raw

Promissum

Promissum is a promises library written in Swift. It features some known functions from Functional Programming like, map and flatMap.

It has useful combinators for working with promises like; whenAll for doing something when multiple promises complete, and whenAny for doing something when a single one of a list of promises completes. As well as their binary counterparts: whenBoth and whenEither.

Promissum really shines when used to combine asynchronous operations from different libraries. There are currently some basic extensions to UIKit and Alamofire, contributions for extensions to other libraries are very welcome.

This library has an extensive set of regression tests, documentation, and has been used in several high profile production apps at Q42.

Example

This example demonstrates the Alamofire+Promise and CoreDataKit+Promise extensions.

In this example, JSON data is loaded from the Github API. It is then parsed, and stored into CoreData. If both those succeed the result is shown to the user, if either of those fail, a description of the error is shown to the user.

let url = "https://api.github.com/repos/tomlokhorst/Promissum"
Alamofire.request(url).responseJSONPromise()
  .map(parseJson)
  .flatMap(storeInCoreData)
  .then { project in

    // Show project name and description
    self.nameLabel.text = project.name
    self.descriptionLabel.text = project.descr

    UIView.animate(withDuration: 0.5) {
      self.detailsView.alpha = 1
    }
  }
  .trap { e in

    // Either an Alamofire error or a CoreData error occured
    self.errorLabel.text = e.localizedDescription
    self.errorView.alpha = 1
  }

See FadeExample/ViewController.swift for an extended version of this example.

Cancellation

Promissum does not support cancellation, because cancellation does not work well with promises. Promises are future values, values can't be cancelled. If you do need cancellation (quite often useful), take a look at Tasks or Rx instead of promises. I don't have experience with any Swift Task/Rx libraries, so I can't recommend a specific one.

Although, if you're looking at adding cancellation to a PromiseSource, you could use the swift-cancellationtoken library I wrote. This is orthogonal to promises, however.

Combinators

Listed below are some of the methods and functions provided this library. More documentation is available inline.

Instance methods on Promise

  • .map(transform: Value -> NewValue)
    Returns a Promise containing the result of mapping a function over the promise value.

  • .flatMap(transform: Value -> Promise<NewValue, Error>)
    Returns the flattened result of mapping a function over the promise value.

  • .mapError(transform: Error -> NewError)
    Returns a Promise containing the result of mapping a function over the promise error.

  • .flatMapError(transform: Error -> Promise<Value, NewError>)
    Returns the flattened result of mapping a function over the promise error.

  • .dispatch(on: queue: DispatchQueue) Returns a new promise that will execute all callbacks on the specified dispatch_queue. See dispatch queues

Functions for dealing with Promises

  • flatten(promise: Promise<Promise<Value, Error>, Error>)
    Flattens a nested Promise of Promise into a single Promise.

  • whenBoth(promiseA: Promise<A, Error>, _ promiseB: Promise<B, Error>)
    Creates a Promise that resolves when both arguments to whenBoth resolve.

  • whenAll(promises: [Promise<Value, Error>])
    Creates a Promise that resolves when all provided Promises resolve.

  • whenEither(promise1: Promise<Value, Error>, _ promise2: Promise<Value, Error>)
    Creates a Promise that resolves when either argument to resolves.

  • whenAny(promises: [Promise<Value, Error>])
    Creates a Promise that resolves when any of the argument Promises resolves.

Dispatch queues

Promises can call handlers on different threads or queues. Handlers are all closures supplied to methods like .then, .trap, .map, and .flatMap.

If nothing else is specified, by default, all handlers will be called on the main queue. This way, you're free to update the UI, without having to worry about manually calling dispatch_async.

However, it's easy to change the dispatch queue used by a promise. In one of two ways:

  1. Set the dispatch queue when creating a PromiseSource, e.g.:
let background = DispatchQueue.global(qos: .background)
let source = PromiseSource<Int, Never>(dispatch: .queue(background))
source.promise
  .then { x in
    // Handler is called on background queue
  }
  1. Or, create a new promise using the .dispatchOn combinator:
let background = DispatchQueue.global(qos: .background)
somePromise()
  .dispatch(on: background)
  .then { x in
    // Handler is called on background queue
  }

For convenience, there's also .dispatchMain to move back to the main queue, after doing some work on a background queue:

let background = DispatchQueue.global(qos: .background)
somePromise()
  .dispatch(on: background)
  .map { expensiveComputation($0) }
  .dispatchMain()
  .then { x in
    self.updateUi(x)
  }

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Promissum into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'Promissum'

Then, run the following command:

$ pod install

Releases

  • 5.0.0 - 2020-08-22 - Update Alamofire+Promise to Alamofire 5, requires iOS 10
  • 4.0.0 - 2019-06-10 - Swift 5.1 support, use build-in Result type
  • 3.2.0 - 2019-04-03 - Deprecate delay and related functions
  • 3.1.0 - 2018-11-17 - Allow for use in extensions
  • 3.0.0 - 2018-10-02 - Swift 4.2 support, removed CoreDataKit extension
  • 2.2.0 - 2018-02-09 - Fix occasional "execute on wrong queue" issue
  • 2.1.0 - 2018-01-12 - watchOS support
  • 2.0.0 - 2017-11-27 - Swift 4 support, threadsafe
  • 1.0.0 - 2016-09-20 - Swift 3 support, requires iOS 9 & OSX 10.11
  • 0.5.0 - 2016-01-19 - Add dispatchOn methods for dispatching on different queues
  • 0.4.0 - 2015-11-04 - Update Alamofire+Promise to Alamofire 3
  • 0.3.0 - 2015-09-11 - Swift 2 support, added custom error types
  • 0.2.4 - 2015-05-31 - Fixed examples. Updated CoreDataKit+Promise
  • 0.2.3 - 2015-04-13 - Swift 1.2 support
  • 0.2.2 - 2015-03-01 - Mac OS X support
  • 0.2.1 - 2015-02-16 - Update for new CoreDataKit version
  • 0.2.0 - 2015-02-15 - Side-effects happen in a better order. Regression tests added.
  • 0.1.1 - 2015-05-31 - whenAnyFinalized combinator added
  • 0.1.0 - 2015-01-27 - Initial public release
  • 0.0.0 - 2014-10-12 - Initial private version for project at Q42

Licence & Credits

Promissum is written by Tom Lokhorst and available under the MIT license, so feel free to use it in commercial and non-commercial projects.