expose isCompleted sync accessor for testing

nevyn · Jun 22, 2016 · 7214f9f · 7214f9f
1 parent a580cef
commit 7214f9f
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/SPAsync.xcodeproj/project.pbxproj b/SPAsync.xcodeproj/project.pbxproj
@@ -416,6 +416,7 @@
 		05B647D116B85AF90050002D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
+				LastSwiftUpdateCheck = 0730;
 				LastUpgradeCheck = 0630;
 				ORGANIZATIONNAME = ThirdCog;
 				TargetAttributes = {

diff --git a/SPAsyncTests/SPTaskTest.m b/SPAsyncTests/SPTaskTest.m
@@ -19,7 +19,9 @@ - (void)testCallback
     __block BOOL firstCallbackTriggered = NO;
     __block BOOL secondCallbackTriggered = NO;
 
+    __weak __typeof(task) weakTask = task;
     [task addCallback:^(id value) {
+        XCTAssertTrue(weakTask.isCompleted, @"Should be completed by the time the first callback fires.");
         XCTAssertEqualObjects(value, @(1337), @"Unexpected value");
         XCTAssertEqual(firstCallbackTriggered, NO, @"Callback should only trigger once");
         firstCallbackTriggered = YES;
@@ -41,7 +43,7 @@ - (void)testCallback
 
     XCTAssertEqual(firstCallbackTriggered, YES, @"First callback should have triggered");
     XCTAssertEqual(secondCallbackTriggered, YES, @"Second callback should have triggered");
-
+    XCTAssertTrue(task.isCompleted, @"Completion state not altered by callbacks.");
 }
 
 - (void)testErrback
@@ -52,7 +54,9 @@ - (void)testErrback
     __block BOOL firstErrbackTriggered = NO;
     __block BOOL secondErrbackTriggered = NO;
 
+    __weak __typeof(task) weakTask = task;
     [task addErrorCallback:^(NSError *error) {
+        XCTAssertTrue(weakTask.isCompleted, @"Should be completed by the time the first callback fires.");
         XCTAssertEqual(error.code, (NSInteger)1337, @"Unexpected error code");
         XCTAssertEqual(firstErrbackTriggered, NO, @"Errback should only trigger once");
         firstErrbackTriggered = YES;
@@ -74,6 +78,7 @@ - (void)testErrback
 
     XCTAssertEqual(firstErrbackTriggered, YES, @"First errback should have triggered");
     XCTAssertEqual(secondErrbackTriggered, YES, @"Second errback should have triggered");
+    XCTAssertTrue(task.isCompleted, @"Completion state not altered by callbacks.");
 }
 
 - (void)testLateCallback

diff --git a/Sources/SPTask.m b/Sources/SPTask.m
@@ -14,13 +14,12 @@ @interface SPA_NS(Task) ()
     NSMutableArray *_errbacks;
     NSMutableArray *_finallys;
     NSMutableArray *_childTasks;
-    BOOL _isCompleted;
-	BOOL _isCancelled;
     id _completedValue;
     NSError *_completedError;
     __weak SPA_NS(TaskCompletionSource) *_source;
 }
 @property(getter=isCancelled,readwrite) BOOL cancelled;
+@property(getter=isCompleted,readwrite) BOOL completed;
 @end
 
 @interface SPA_NS(TaskCompletionSource) ()
@@ -29,6 +28,7 @@ - (void)cancel;
 
 @implementation SPA_NS(Task)
 @synthesize cancelled = _isCancelled;
+@synthesize completed = _isCompleted;
 
 - (instancetype)initFromSource:(SPA_NS(TaskCompletionSource)*)source;
 {

diff --git a/include/SPAsync/SPTask.h b/include/SPAsync/SPTask.h
@@ -237,6 +237,17 @@ typedef SPA_NS(Task)*(^SPTaskRecoverCallback)(NSError *error);
 @end
 
 
+@interface SPA_NS(Task) (Testing)
+
+/** Check a task's completed state.
+    @warning This is intended for testing purposes only, and it is not recommended to use
+             this property as a means to do micro optimizations for synchronous code.
+ 
+    @return  Whether or not the receiver has been completed with a value or error. */
+@property(getter=isCompleted,readonly) BOOL completed;
+
+@end
+
 /** Convenience holder of a callback and the queue that the callback should be called on */
 @interface SPA_NS(CallbackHolder) : NSObject
 - (id)initWithCallback:(SPTaskCallback)callback onQueue:(dispatch_queue_t)callbackQueue;