Merge pull request #34 from dimagi/progress-bar-fix-copy

Entire progress bar fix in one commit

Author: orangejenny

src/org/odk/collect/android/activities/FormEntryActivity.java

@@ -805,40 +805,34 @@ public void updateProgressBar(ODKView odkv) {
             event = mFormController.stepToPreviousEvent();
         }
 
-        boolean onCurrentScreen = false;
-        FormIndex currentScreenExit = null;
         while (event != FormEntryController.EVENT_END_OF_FORM) {
             int comparison = mFormController.getFormIndex().compareTo(currentFormIndex);
 
-            if (comparison == 0) {
-                onCurrentScreen = true;
-                mFormController.stepToNextEvent(true);
-                currentScreenExit = mFormController.getFormIndex();
-                mFormController.stepToPreviousEvent();
-            }
-            if (onCurrentScreen && mFormController.getFormIndex().equals(currentScreenExit)) {
-                onCurrentScreen = false;
-            }
-            
             if (event == FormEntryController.EVENT_QUESTION) {
-                FormEntryPrompt[] prompts = mFormController.getQuestionPrompts();
-                totalQuestions += prompts.length;
-                // Current questions are complete only if they're answered.
-                // Past questions are always complete.
-                // Future questions are never complete.
-                if (onCurrentScreen) {
-                    for (FormEntryPrompt prompt : prompts) {
-                      if (prompt.getAnswerValue() != null || prompt.getDataType() == Constants.DATATYPE_NULL) {
-                          completedQuestions++;
-                      }
-                  }
+                totalQuestions++;
+                
+                // Questions are counted as complete if any of the following are true:
+                // - User has already passed the question, regardless of if it's been answered
+                // - User is currently looking at the question, and it's been answered
+                // - User is currently looking at a group containing the question, and it's been answered
+                if (comparison < 0) {
+                    completedQuestions++;
                 }
-                else if (comparison < 0) {
-                    // For previous questions, consider all "complete"
-                    completedQuestions += prompts.length;
+                else {
+                    FormEntryPrompt prompt = mFormController.getQuestionPrompt();
+                    if (prompt.getAnswerValue() != null || prompt.getDataType() == Constants.DATATYPE_NULL) {
+                        if (comparison == 0) {
+                            completedQuestions++;
+                        }
+                        else if (FormIndex.isSubElement(currentFormIndex, mFormController.getFormIndex())) {
+                            completedQuestions++;
+                        }
+                    }
                 }
             }
-            event = mFormController.stepToNextEvent(false);
+            
+            // Make sure we visit every question inside every group
+            event = mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP, false);
         }
 
         // Set form back to correct state & actually update bar
@@ -1345,7 +1339,7 @@ private void showNextView(boolean resuming) {
             try{
 
             group_skip: do {
-                event = mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP);
+                event = mFormController.stepToNextEvent(FormController.STEP_OVER_GROUP);
                 switch (event) {
                     case FormEntryController.EVENT_QUESTION:
                     case FormEntryController.EVENT_END_OF_FORM:

src/org/odk/collect/android/activities/FormHierarchyActivity.java

@@ -206,7 +206,7 @@ public void refreshView() {
         if (FormEntryActivity.mFormController.getEvent() == FormEntryController.EVENT_REPEAT) {
             enclosingGroupRef =
                 FormEntryActivity.mFormController.getFormIndex().getReference().toString(false);
-            FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_OVER_GROUP);
+            FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP);
         } else {
             FormIndex startTest = stepIndexOut(currentIndex);
             // If we have a 'group' tag, we want to step back until we hit a repeat or the
@@ -230,14 +230,14 @@ public void refreshView() {
             if (FormEntryActivity.mFormController.getEvent() == FormEntryController.EVENT_REPEAT) {
                 enclosingGroupRef =
                     FormEntryActivity.mFormController.getFormIndex().getReference().toString(false);
-                FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_OVER_GROUP);
+                FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP);
             }
         }
 
         int event = FormEntryActivity.mFormController.getEvent();
         if (event == FormEntryController.EVENT_BEGINNING_OF_FORM) {
             // The beginning of form has no valid prompt to display.
-            FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_OVER_GROUP);
+            FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP);
             mPath.setVisibility(View.GONE);
             jumpPreviousButton.setEnabled(false);
         } else {
@@ -261,7 +261,7 @@ public void refreshView() {
                         // index.
                         event =
                             FormEntryActivity.mFormController
-                                    .stepToNextEvent(FormController.STEP_OVER_GROUP);
+                                    .stepToNextEvent(FormController.STEP_INTO_GROUP);
                         continue;
                     }
 
@@ -286,7 +286,7 @@ public void refreshView() {
                         // next event.
                         event =
                             FormEntryActivity.mFormController
-                                    .stepToNextEvent(FormController.STEP_OVER_GROUP);
+                                    .stepToNextEvent(FormController.STEP_INTO_GROUP);
                         continue;
                     }
 
@@ -329,7 +329,7 @@ public void refreshView() {
                     break;
             }
             event =
-                FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_OVER_GROUP);
+                FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP);
         }
 
         HierarchyListAdapter itla = new HierarchyListAdapter(this);

src/org/odk/collect/android/logic/FormController.java

@@ -56,8 +56,8 @@ public class FormController {
 
     private boolean mReadOnly;
 
-    public static final boolean STEP_INTO_GROUP = true;
-    public static final boolean STEP_OVER_GROUP = false;
+    public static final boolean STEP_OVER_GROUP = true;
+    public static final boolean STEP_INTO_GROUP = false;
 
     /**
      * OpenRosa metadata tag names.
@@ -310,7 +310,6 @@ public boolean saveAnswer(FormIndex index, IAnswerData data) {
         return mFormEntryController.saveAnswer(index, data);
     }
 
-
     /**
      * saveAnswer attempts to save the current answer into the data model without doing any
      * constraint checking. Only use this if you know what you're doing. For normal form filling you
@@ -324,20 +323,28 @@ public boolean saveAnswer(IAnswerData data) {
         return mFormEntryController.saveAnswer(data);
     }
 
+    /**
+     * Navigates forward in the form, expanding any repeats encountered.
+     * 
+     * @return the next event that should be handled by a view.
+     */
+    public int stepToNextEvent(boolean stepOverGroup) {
+       return stepToNextEvent(stepOverGroup, true);
+    }
 
     /**
      * Navigates forward in the form.
      * 
      * @return the next event that should be handled by a view.
      */
-    public int stepToNextEvent(boolean stepOverGroup) {
+    public int stepToNextEvent(boolean stepOverGroup, boolean expandRepeats) {
         if (mFormEntryController.getModel().getEvent() == FormEntryController.EVENT_GROUP && indexIsInFieldList() && stepOverGroup) {
             return stepOverGroup();
         } else {
-            int event =  mFormEntryController.stepToNextEvent();
+            int event =  mFormEntryController.stepToNextEvent(expandRepeats);
             if(event == FormEntryController.EVENT_PROMPT_NEW_REPEAT &&
                     this.mReadOnly) {
-                return stepToNextEvent(stepOverGroup);
+                return stepToNextEvent(stepOverGroup, expandRepeats);
             }
             return event;
         }

src/org/odk/collect/android/tasks/SaveToDiskTask.java

@@ -389,7 +389,7 @@ private int validateAnswers(Boolean markCompleted) {
 
         int event;
         while ((event =
-            FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_OVER_GROUP)) != FormEntryController.EVENT_END_OF_FORM) {
+            FormEntryActivity.mFormController.stepToNextEvent(FormController.STEP_INTO_GROUP)) != FormEntryController.EVENT_END_OF_FORM) {
             if (event != FormEntryController.EVENT_QUESTION) {
                 continue;
             } else {