Merge pull request ResearchKit#615 from apbendi/nav-ordered-progress

Allow user to opt-in to linear progress reporting on ORKNavigableOrderedTask

Author: YuanZhu-apple

ResearchKit/Common/ORKNavigableOrderedTask.h

@@ -98,6 +98,12 @@ ORK_CLASS_AVAILABLE
  */
 @property (nonatomic, copy, readonly) NSDictionary<NSString *, ORKStepNavigationRule *> *stepNavigationRules;
 
+/**
+ Determines whether the task should report its progress as a linear ordered task or not. 
+ The default value of this property is `NO`.
+ */
+@property (nonatomic) BOOL shouldReportProgress;
+
 @end
 
 

ResearchKit/Common/ORKNavigableOrderedTask.m

@@ -47,6 +47,7 @@ - (instancetype)initWithIdentifier:(NSString *)identifier steps:(NSArray<ORKStep
     self = [super initWithIdentifier:identifier steps:steps];
     if (self) {
         _stepNavigationRules = nil;
+        _shouldReportProgress = NO;
     }
     return self;
 }
@@ -106,8 +107,12 @@ - (ORKStep *)stepBeforeStep:(ORKStep *)step withResult:(ORKTaskResult *)result {
     return previousStep;
 }
 
-// ORKNavigableOrderedTask doesn't have a linear order
+// Assume ORKNavigableOrderedTask doesn't have a linear order unless user specifically overrides
 - (ORKTaskProgress)progressOfCurrentStep:(ORKStep *)step withResult:(ORKTaskResult *)result {
+    if (_shouldReportProgress) {
+        return [super progressOfCurrentStep:step withResult:result];
+    }
+
     return ORKTaskProgressMake(0, 0);
 }