Swiftpack.co - Package - tcldr/Entwine

Entwine

Accessories for Apple's Combine Framework.


About

Entwine consists of three libraries (over two repositories) to be used in conjuction with Apple's Combine framework:

Note: EntwineRx is maintained as a separate Swift package to minimize the SPM dependency graph.


Quick start guide

Create Combine publishers from any source

Use the Publishers.Factory publisher from the Entwine package to effortlessly create a publisher that meets Combine's backpressure requirements from any source. Find out more about the Entwine Utilities library.

Inline publisher creation for PhotoKit authorization status:


import Entwine

let photoKitAuthorizationStatus = Publishers.Factory<PHAuthorizationStatus, Never> { dispatcher in
    let status = PHPhotoLibrary.authorizationStatus()
    dispatcher.forward(status)
    switch status {
    case .notDetermined:
        PHPhotoLibrary.requestAuthorization { newStatus in
            dispatcher.forward(newStatus)
            dispatcher.forward(completion: .finished)
        }
    default:
        dispatcher.forward(completion: .finished)
    }
    return AnyCancellable {}
}

Unit test Combine publisher sequences

Use the TestScheduler, TestablePublisher and TestableSubscriber to simulate Combine sequences and test against expected output. Find out more about the EntwineTest library

Testing Combine's map(_:) operator:


import XCTest
import EntwineTest
    
func testMap() {
    
    let testScheduler = TestScheduler(initialClock: 0)
    
    // creates a publisher that will schedule it's elements relatively, at the point of subscription
    let testablePublisher: TestablePublisher<String, Never> = testScheduler.createRelativeTestablePublisher([
        (100, .input("a")),
        (200, .input("b")),
        (300, .input("c")),
    ])
    
    let subjectUnderTest = testablePublisher.map { $0.uppercased() }
    
    // schedules a subscription at 200, to be cancelled at 900
    let results = testScheduler.start { subjectUnderTest }
    
    XCTAssertEqual(results.sequence, [
        (200, .subscription),           // subscribed at 200
        (300, .input("A")),             // received uppercased input @ 100 + subscription time
        (400, .input("B")),             // received uppercased input @ 200 + subscription time
        (500, .input("C")),             // received uppercased input @ 300 + subscription time
    ])
}

Bridge your RxSwift view models to Combine and use with SwiftUI

First, make sure you add the EntwineRx Swift Package (located in an external repo) as a dependency to your project.

Example coming soon


Requirements

Entwine sits on top of Apple's Combine framework and therefore requires Xcode 11 and is has minimum deployment targets of macOS 10.15, iOS 13, tvOS 13 or watchOS 6.


Installation

Entwine is delivered via a Swift Package and can be installed either as a dependency to another Swift Package by adding it to the dependencies section of a Package.swift file or to an Xcode 11 project by via the File -> Swift Packages -> Add package dependency... menu in Xcode 11.


Documentation

Documentation for each package is available at:


Copyright and license

This project is released under the MIT license


Github

link
Stars: 36
Help us keep the lights on

Dependencies

Used By

Total: 1

Releases

v0.4.0 - Jul 3, 2019

Updated to reflect API changes in latest Combine beta that arrived with Xcode 11 beta 3. In particular, Subscribers.Demand has been changed from an enum to a struct and is far stricter in regards to allowing negative demand balances.

v0.3.0 - Jun 26, 2019

This release changes the cancellation behaviour to match that described at https://twitter.com/millenomi/status/1137382877870510080.

Namely, a publisher does not need to generate a completion event upon cancellation.

v0.2.0 - Jun 25, 2019

Adds CancellationBag and some documentation updates and fixes

v0.1.0 - Jun 24, 2019

Initial release.