OlegKetrar/TaskKit

TaskKit

• Features
• Usage
• Requirements
• Installation
• License

Features

• Carthage support
• Swift PM support
• Result<T>
• Action<Out>
• LazyAction<In, Out> input can provided lazily
• onSuccess/onFailure/onAny/always
• map convert output
• mapInput convert input
• then/earlier compose sequence with another action
• with(input) converts LazyAction to Action
• ignoredOutput() ignores output
• recover after error by providing recoveryValue / recoveryClosure
• async / await / await(timeout:)
• DispatchQueue.asyncValue
• resolveOnQueue / execute on queue, completion on queue
• zip / either / union compose actions
• conditions onlyIf(_ closure:)
• catch & Non-fallible Action
• Optional<T>.unwrap() -> Action<T>

Usage

struct SomeError: Swift.Error {
  ...
}

// send Request and returns JSON
let downloadSmth = LazyAction<Request, JSON> { request, finish in
   request.send { response in
     if let json = response.json {
       finish(.success(json))
     } else {
       finish(.failure(SomeError()))
     }
   }
}

// parse User from JSON
let parseUser = LazyAction<JSON, User> { json, completion in
   DispatchQueue.global().async {

      // do heavy parsing on bg queue
      let parseResult = Result<User> { try User(json) }

      // it is recommended to always call completion on main queue
      DispatchQueue.main.async { completion(parseResult) }
   }
}

downloadSmth
   .onAny { print("request finished") }
   .then(parseUser)
   .onSuccess { print("user successfully parsed") }
   .onFailure { print("request failed or parsing failed") }
   .recover { error in
      if error is NetworkError {
         return someCachedUser // action failed and we recover by providing recover value
      } else {
         throw error // can't recover, so move error
      }
   }
   .always {
      // stop preloader
   }
   .map { user in
      // proccess user
      print("user email is \(user.email)")
   }
   .execute(with: FetchUserRequest())

Requirements

• Swift 5.4+
• xCode 12.5+
• iOS 8.0+

Installation

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate NumberPad into your Xcode project using Carthage, specify it in your Cartfile:

github "OlegKetrar/TaskKit"

Run carthage update to build the framework and drag the built TaskKit.framework into your Xcode project.

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but TaskKit does support its use on supported platforms.

Once you have your Swift package set up, adding TaskKit as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
   .Package(url: "https://github.com/OlegKetrar/TaskKit")
]

License

TaskKit is released under the MIT license. See LICENSE for details.