Merge pull request #78 from JosephEarl/feature/better-task-description

Better -(NSString*)description for BFTask

Bolts/Common/BFTask.m

@@ -377,4 +377,29 @@ - (void)waitUntilFinished {
     [self.condition unlock];
 }
 
+#pragma mark - NSObject
+
+- (NSString *)description {
+    // Acquire the data from the locked properties
+    BOOL isCompleted;
+    BOOL isCancelled;
+    BOOL isFaulted;
+
+    @synchronized (self.lock) {
+        isCompleted = self.completed;
+        isCancelled = self.cancelled;
+        isFaulted = self.faulted;
+    }
+
+    // Description string includes status information and, if available, the
+    // result sisnce in some ways this is what a promise actually "is".
+    return [NSString stringWithFormat:@"<%@: %p; completed = %@; cancelled = %@; faulted = %@;%@>",
+        NSStringFromClass([self class]),
+        self,
+        isCompleted ? @"YES" : @"NO",
+        isCancelled ? @"YES" : @"NO",
+        isFaulted ? @"YES" : @"NO",
+        isCompleted ? [NSString stringWithFormat:@" result:%@", _result] : @""];
+}
+
 @end

BoltsTests/TaskTests.m

@@ -534,4 +534,13 @@ - (void)testExecuteOnOperationQueue {
     [task waitUntilFinished];
 }
 
+- (void)testDescription {
+    BFTask *task = [BFTask taskWithResult:nil];
+    NSString *expected = [NSString stringWithFormat:@"<BFTask: %p; completed = YES; cancelled = NO; faulted = NO; result:(null)>", task];
+
+    NSString *description = task.description;
+
+    XCTAssertTrue([expected isEqualToString:description]);
+}
+
 @end