Skip to content

Commit 2d11bc5

Browse files
dougzilla32dougzilla32
committed
'Cancel' for PromiseKit -- provides the ability to cancel promises and promise chains
1 parent 651b754 commit 2d11bc5

12 files changed

+217
-241
lines changed

‎.travis.yml

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,64 @@
11
matrix:
22
include:
3-
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=iOS DST="OS=10.3.1,name=iPhone SE"', os: osx, language: objective-c}
4-
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=tvOS DST="OS=10.2,name=Apple TV 1080p"', os: osx, language: objective-c}
5-
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
6-
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=watchOS DST="OS=3.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
3+
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=iOS DST="OS=10.3.1,name=iPhone SE"', os: osx, language: objective-c}
4+
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=tvOS DST="OS=10.2,name=Apple TV 1080p"', os: osx, language: objective-c}
5+
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
6+
- {osx_image: xcode8.3, env: 'SWFT=3.1 PLAT=watchOS DST="OS=3.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
77

8-
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=iOS DST="OS=11.2,name=iPhone SE"', os: osx, language: objective-c}
9-
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=tvOS DST="OS=11.2,name=Apple TV"', os: osx, language: objective-c}
10-
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
11-
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=watchOS DST="OS=4.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
8+
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=iOS DST="OS=11.2,name=iPhone SE"', os: osx, language: objective-c}
9+
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=tvOS DST="OS=11.2,name=Apple TV"', os: osx, language: objective-c}
10+
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
11+
- {osx_image: xcode9.2, env: 'SWFT=3.2 PLAT=watchOS DST="OS=4.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
1212

13-
- {osx_image: xcode9.4, env: 'SWFT=3.3 PLAT=iOS DST="OS=11.4,name=iPhone 5s"', os: osx, language: objective-c}
14-
- {osx_image: xcode9.4, env: 'SWFT=3.3 PLAT=tvOS DST="OS=11.4,name=Apple TV"', os: osx, language: objective-c}
15-
- {osx_image: xcode9.3, env: 'SWFT=3.3 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
16-
- {osx_image: xcode9.3, env: 'SWFT=3.3 PLAT=watchOS DST="OS=4.3,name=Apple Watch - 38mm"', os: osx, language: objective-c}
13+
- {osx_image: xcode9.4, env: 'SWFT=3.3 PLAT=iOS DST="OS=11.4,name=iPhone 5s"', os: osx, language: objective-c}
14+
- {osx_image: xcode9.4, env: 'SWFT=3.3 PLAT=tvOS DST="OS=11.4,name=Apple TV"', os: osx, language: objective-c}
15+
- {osx_image: xcode9.3, env: 'SWFT=3.3 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
16+
- {osx_image: xcode9.3, env: 'SWFT=3.3 PLAT=watchOS DST="OS=4.3,name=Apple Watch - 38mm"', os: osx, language: objective-c}
1717

18-
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=iOS DST="OS=11.2,name=iPhone SE"', os: osx, language: objective-c}
19-
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=tvOS DST="OS=11.2,name=Apple TV"', os: osx, language: objective-c}
20-
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
21-
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=watchOS DST="OS=4.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
18+
- {osx_image: xcode10, env: 'SWFT=3.4 PLAT=iOS DST="OS=12.0,name=iPhone SE"', os: osx, language: objective-c}
19+
- {osx_image: xcode10, env: 'SWFT=3.4 PLAT=tvOS DST="OS=12.0,name=Apple TV"', os: osx, language: objective-c}
20+
- {osx_image: xcode10, env: 'SWFT=3.4 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
21+
- {osx_image: xcode10, env: 'SWFT=3.4 PLAT=watchOS DST="OS=5.0,name=Apple Watch Series 3 - 42mm"', os: osx, language: objective-c}
2222

23-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=macOS DST="arch=x86_64" TEST=1', os: osx, language: objective-c}
24-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=8.4,name=iPhone 4s"', os: osx, language: objective-c}
25-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=9.3,name=iPhone 5s"', os: osx, language: objective-c}
26-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=10.3.1,name=iPhone SE"', os: osx, language: objective-c}
27-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=11.4,name=iPhone 5s" TEST=1', os: osx, language: objective-c}
28-
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=tvOS DST="OS=9.2,name=Apple TV 1080p"', os: osx, language: objective-c}
29-
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=tvOS DST="OS=10.2,name=Apple TV 1080p"', os: osx, language: objective-c}
30-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=tvOS DST="OS=11.4,name=Apple TV" TEST=1', os: osx, language: objective-c}
31-
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=watchOS DST="OS=2.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
32-
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=watchOS DST="OS=3.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
33-
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=watchOS DST="OS=4.3,name=Apple Watch - 38mm"', os: osx, language: objective-c}
23+
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=iOS DST="OS=11.2,name=iPhone SE"', os: osx, language: objective-c}
24+
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=tvOS DST="OS=11.2,name=Apple TV"', os: osx, language: objective-c}
25+
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
26+
- {osx_image: xcode9.2, env: 'SWFT=4.0 PLAT=watchOS DST="OS=4.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
27+
28+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=macOS DST="arch=x86_64" TEST=1', os: osx, language: objective-c}
29+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=8.4,name=iPhone 4s"', os: osx, language: objective-c}
30+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=9.3,name=iPhone 5s"', os: osx, language: objective-c}
31+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=10.3.1,name=iPhone SE"', os: osx, language: objective-c}
32+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=iOS DST="OS=11.4,name=iPhone 5s" TEST=1', os: osx, language: objective-c}
33+
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=tvOS DST="OS=9.2,name=Apple TV 1080p"', os: osx, language: objective-c}
34+
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=tvOS DST="OS=10.2,name=Apple TV 1080p"', os: osx, language: objective-c}
35+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=tvOS DST="OS=11.4,name=Apple TV" TEST=1', os: osx, language: objective-c}
36+
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=watchOS DST="OS=2.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
37+
- {osx_image: xcode9.3, env: 'SWFT=4.1 PLAT=watchOS DST="OS=3.2,name=Apple Watch - 38mm"', os: osx, language: objective-c}
38+
- {osx_image: xcode9.4, env: 'SWFT=4.1 PLAT=watchOS DST="OS=4.3,name=Apple Watch - 38mm"', os: osx, language: objective-c}
39+
40+
- {osx_image: xcode10, env: 'SWFT=4.3 PLAT=iOS DST="OS=12.0,name=iPhone SE"', os: osx, language: objective-c}
41+
- {osx_image: xcode10, env: 'SWFT=4.3 PLAT=tvOS DST="OS=12.0,name=Apple TV"', os: osx, language: objective-c}
42+
- {osx_image: xcode10, env: 'SWFT=4.3 PLAT=macOS DST="arch=x86_64"', os: osx, language: objective-c}
43+
- {osx_image: xcode10, env: 'SWFT=4.3 PLAT=watchOS DST="OS=5.0,name=Apple Watch Series 3 - 42mm"', os: osx, language: objective-c}
44+
45+
# Swift 3.2.0 (we have some source-conditionals for this version)
46+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=3 SWIFT_VERSION=4.0'}
47+
# Swift 3.2.3
48+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=3 SWIFT_VERSION=4.0.3'}
49+
# Swift 3.3
50+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=3 SWIFT_VERSION=4.1.2 TEST=1'}
51+
# Swift 3.4
52+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=3 SWIFT_VERSION=DEVELOPMENT-SNAPSHOT-2018-06-20-a TEST=1'}
53+
# Swift 4.0.0 (we have some source-conditionals for this version)
54+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=4 SWIFT_VERSION=4.0'}
55+
# Swift 4.0.3
56+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=4 SWIFT_VERSION=4.0.3'}
57+
# Swift 4.1
58+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=4 SWIFT_VERSION=4.1.2 TEST=1'}
59+
# Swift 4.2
60+
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_BUILD_VERSION=4 SWIFT_VERSION=DEVELOPMENT-SNAPSHOT-2018-06-20-a TEST=1'}
3461

35-
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_VERSION=3.1'}
36-
- {os: linux, dist: trusty, sudo: required, language: generic, env: 'SWIFT_VERSION=4.0'}
3762
cache:
3863
directories:
3964
- Carthage
@@ -42,6 +67,7 @@ before_install:
4267
carthage bootstrap --cache-builds --no-use-binaries --platform $PLAT --verbose;
4368
else
4469
eval "$(curl -sL https://swiftenv.fuller.li/install.sh)";
70+
swift --version;
4571
fi
4672
install:
4773
- case $PLAT in
@@ -51,7 +77,7 @@ install:
5177
xcodebuild -scheme PMKFoundation -target PMKNSTests -quiet -destination "$DST" SWIFT_TREAT_WARNINGS_AS_ERRORS=YES build;
5278
fi;;
5379
*)
54-
swift build;;
80+
swift build -Xswiftc -swift-version -Xswiftc $SWIFT_BUILD_VERSION;;
5581
esac
5682
script:
5783
- case $PLAT in

‎Cartfile.resolved

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
github "AliSoftware/OHHTTPStubs" "6.1.0"
2-
github "dougzilla32/PromiseKit" "1e5519010c2b519f03a306f023accc93b46e2bf3"
2+
github "dougzilla32/PromiseKit" "ff694600d4d03458121515bdc027ba76df14f7ef"

‎Package.swift

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ let package = Package(
55
dependencies: [
66
// Switch this back before integrating:
77
// .Package(url: "https://github.com/mxcl/PromiseKit.git", majorVersion: 6)
8-
.Package(url: "https://github.com/dougzilla32/PromiseKitCoreCancel.git")
8+
.Package(url: "https://github.com/dougzilla32/PromiseKitCoreCancel.git", majorVersion: 6)
99
],
10+
swiftLanguageVersions: [3, 4],
1011
exclude: [
1112
"Sources/NSNotificationCenter+AnyPromise.m",
1213
"Sources/NSTask+AnyPromise.m",

‎Sources/NSNotificationCenter+Promise.swift

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -22,35 +22,17 @@ extension NotificationCenter {
2222
/// Observe the named notification once
2323
public func observe(once name: Notification.Name, object: Any? = nil) -> Guarantee<Notification> {
2424
let (promise, fulfill) = Guarantee<Notification>.pending()
25-
#if !os(Linux)
26-
let id = addObserver(forName: name, object: object, queue: nil, using: fulfill)
27-
#else
25+
#if os(Linux) && ((swift(>=4.0) && !swift(>=4.0.1)) || (swift(>=3.0) && !swift(>=3.2.1)))
2826
let id = addObserver(forName: name, object: object, queue: nil, usingBlock: fulfill)
27+
#else
28+
let id = addObserver(forName: name, object: object, queue: nil, using: fulfill)
2929
#endif
30+
promise.setCancellableTask(ObserverTask { self.removeObserver(id) })
3031
promise.done { _ in self.removeObserver(id) }
3132
return promise
3233
}
3334
}
3435

35-
//////////////////////////////////////////////////////////// Cancellation
36-
37-
extension NotificationCenter {
38-
/// Observe the named notification once
39-
public func observeCC(once name: Notification.Name, object: Any? = nil) -> CancellablePromise<Notification> {
40-
let (promise, resolver) = CancellablePromise<Notification>.pending()
41-
#if !os(Linux)
42-
let id = addObserver(forName: name, object: object, queue: nil, using: resolver.fulfill)
43-
#else
44-
let id = addObserver(forName: name, object: object, queue: nil, usingBlock: resolver.fulfill)
45-
#endif
46-
47-
promise.appendCancellableTask(task: ObserverTask { self.removeObserver(id) }, reject: resolver.reject)
48-
49-
_ = promise.ensure { self.removeObserver(id) }
50-
return promise
51-
}
52-
}
53-
5436
class ObserverTask: CancellableTask {
5537
let cancelBlock: () -> Void
5638

@@ -65,3 +47,12 @@ class ObserverTask: CancellableTask {
6547

6648
var isCancelled = false
6749
}
50+
51+
//////////////////////////////////////////////////////////// Cancellable wrapper
52+
53+
extension NotificationCenter {
54+
/// Observe the named notification once
55+
public func cancellableObserve(once name: Notification.Name, object: Any? = nil) -> CancellablePromise<Notification> {
56+
return cancellable(observe(once: name, object: object))
57+
}
58+
}

‎Sources/NSObject+Promise.swift

Lines changed: 20 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -29,62 +29,13 @@ extension NSObject {
2929
}
3030
}
3131

32-
private class KVOProxy: NSObject {
32+
private class KVOProxy: NSObject, CancellableTask {
3333
var retainCycle: KVOProxy?
3434
let fulfill: (Any?) -> Void
35-
36-
@discardableResult
37-
init(observee: NSObject, keyPath: String, resolve: @escaping (Any?) -> Void) {
38-
fulfill = resolve
39-
super.init()
40-
observee.addObserver(self, forKeyPath: keyPath, options: NSKeyValueObservingOptions.new, context: pointer)
41-
retainCycle = self
42-
}
43-
44-
fileprivate override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
45-
if let change = change, context == pointer {
46-
defer { retainCycle = nil }
47-
fulfill(change[NSKeyValueChangeKey.newKey])
48-
if let object = object as? NSObject, let keyPath = keyPath {
49-
object.removeObserver(self, forKeyPath: keyPath)
50-
}
51-
}
52-
}
53-
54-
private lazy var pointer: UnsafeMutableRawPointer = {
55-
return Unmanaged<KVOProxy>.passUnretained(self).toOpaque()
56-
}()
57-
}
58-
59-
//////////////////////////////////////////////////////////// Cancellation
60-
61-
extension NSObject {
62-
/**
63-
- Returns: A promise that resolves when the provided keyPath changes, or when the promise is cancelled.
64-
- Warning: *Important* The promise must not outlive the object under observation.
65-
- SeeAlso: Apple’s KVO documentation.
66-
*/
67-
public func observeCC(_: PMKNamespacer, keyPath: String) -> CancellablePromise<Any?> {
68-
var task: CancellableTask!
69-
var reject: ((Error) -> Void)!
70-
71-
let promise = CancellablePromise<Any?> { seal in
72-
reject = seal.reject
73-
task = CancellableKVOProxy(observee: self, keyPath: keyPath, resolve: seal.fulfill)
74-
}
75-
76-
promise.appendCancellableTask(task: task, reject: reject)
77-
return promise
78-
}
79-
}
80-
81-
private class CancellableKVOProxy: NSObject, CancellableTask {
82-
var retainCycle: CancellableKVOProxy?
83-
let fulfill: (Any?) -> Void
8435
let observeeObject: NSObject
8536
let observeeKeyPath: String
8637
var observing: Bool
87-
38+
8839
@discardableResult
8940
init(observee: NSObject, keyPath: String, resolve: @escaping (Any?) -> Void) {
9041
fulfill = resolve
@@ -95,18 +46,18 @@ private class CancellableKVOProxy: NSObject, CancellableTask {
9546
observee.addObserver(self, forKeyPath: keyPath, options: NSKeyValueObservingOptions.new, context: pointer)
9647
retainCycle = self
9748
}
98-
99-
fileprivate override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey: Any]?, context: UnsafeMutableRawPointer?) {
49+
50+
fileprivate override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
10051
if let change = change, context == pointer {
10152
defer { retainCycle = nil }
10253
fulfill(change[NSKeyValueChangeKey.newKey])
103-
if let object = object as? NSObject, let keyPath = keyPath, observing {
54+
if let object = object as? NSObject, let keyPath = keyPath {
10455
object.removeObserver(self, forKeyPath: keyPath)
10556
observing = false
10657
}
10758
}
10859
}
109-
60+
11061
func cancel() {
11162
if !isCancelled {
11263
if observing {
@@ -120,6 +71,19 @@ private class CancellableKVOProxy: NSObject, CancellableTask {
12071
var isCancelled = false
12172

12273
private lazy var pointer: UnsafeMutableRawPointer = {
123-
return Unmanaged<CancellableKVOProxy>.passUnretained(self).toOpaque()
74+
return Unmanaged<KVOProxy>.passUnretained(self).toOpaque()
12475
}()
12576
}
77+
78+
//////////////////////////////////////////////////////////// Cancellable wrapper
79+
80+
extension NSObject {
81+
/**
82+
- Returns: A promise that resolves when the provided keyPath changes, or when the promise is cancelled.
83+
- Warning: *Important* The promise must not outlive the object under observation.
84+
- SeeAlso: Apple’s KVO documentation.
85+
*/
86+
public func cancellableObserve(_: PMKNamespacer, keyPath: String) -> CancellablePromise<Any?> {
87+
return cancellable(observe(.promise, keyPath: keyPath))
88+
}
89+
}

0 commit comments

Comments
 (0)