Merge pull request #1511 from dimagi/jt/visually-segmented-case-searc…

…h-groups Jt/visually segmented case search groups
dimagi · Dec 13, 2023 · eedb907 · eedb907
2 parents 56fe7e0 + 519223b
commit eedb907
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 9 deletions.
diff --git a/libs/commcare b/libs/commcare
diff --git a/src/main/java/org/commcare/formplayer/beans/menus/DisplayElement.java b/src/main/java/org/commcare/formplayer/beans/menus/DisplayElement.java
@@ -51,6 +51,9 @@ public class DisplayElement {
     @Nullable
     private String requiredMsg;
 
+    @Nullable
+    private String groupKey;
+
     public DisplayElement() {
     }
 
@@ -68,8 +71,8 @@ public DisplayElement(Action action, EvaluationContext ec) {
     public DisplayElement(DisplayUnit displayUnit, EvaluationContext ec, String id,
             @Nullable String input,
             @Nullable String receive, @Nullable String hidden, @Nullable String value,
-            @Nullable String[] itemsetChoicesKeys, @Nullable String[] itemsetChoicesLabels, boolean allowBlankValue, boolean required,
-            String requiredMsg, String error) {
+            @Nullable String[] itemsetChoicesKeys, @Nullable String[] itemsetChoicesLabels, boolean allowBlankValue,
+            boolean required, String requiredMsg, String error, @Nullable String groupKey) {
         this.id = id;
         this.text = displayUnit.getText().evaluate(ec);
         if (displayUnit.getImageURI() != null) {
@@ -91,6 +94,7 @@ public DisplayElement(DisplayUnit displayUnit, EvaluationContext ec, String id,
         this.allowBlankValue = allowBlankValue;
         this.required = required;
         this.requiredMsg = requiredMsg;
+        this.groupKey = groupKey;
         this.error = error;
     }
 
@@ -187,4 +191,9 @@ public String getError() {
     public String getRequiredMsg() {
         return requiredMsg;
     }
+
+    @Nullable
+    public String getGroupKey() {
+        return groupKey;
+    }
 }
diff --git a/src/main/java/org/commcare/formplayer/beans/menus/QueryResponseBean.java b/src/main/java/org/commcare/formplayer/beans/menus/QueryResponseBean.java
@@ -4,6 +4,7 @@
 import org.commcare.modern.util.Pair;
 import org.commcare.session.RemoteQuerySessionManager;
 import org.commcare.suite.model.QueryPrompt;
+import org.commcare.suite.model.QueryGroup;
 import org.commcare.util.screen.QueryScreen;
 import org.javarosa.core.model.condition.EvaluationContext;
 import org.javarosa.core.model.utils.ItemSetUtils;
@@ -14,6 +15,7 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Hashtable;
+import java.util.Map;
 
 /**
  * Created by willpride on 4/13/16.
@@ -23,6 +25,7 @@ public class QueryResponseBean extends MenuBean {
     private DisplayElement[] displays;
     private final String type = "query";
     private String description;
+    private Hashtable<String, String> groupHeaders;
 
     QueryResponseBean() {
     }
@@ -43,6 +46,14 @@ private void setDisplays(DisplayElement[] displays) {
         this.displays = displays;
     }
 
+    public Hashtable<String, String> getGroupHeaders(){
+        return groupHeaders;
+    }
+
+    public void setGroupHeaders(Hashtable<String, String> groupHeaders){
+        this.groupHeaders = groupHeaders;
+    }
+
     public QueryResponseBean(QueryScreen queryScreen) {
         OrderedHashtable<String, QueryPrompt> queryPromptMap = queryScreen.getUserInputDisplays();
         Hashtable<String, String> currentAnswers = queryScreen.getCurrentAnswers();
@@ -79,10 +90,13 @@ public QueryResponseBean(QueryScreen queryScreen) {
                     queryPromptItem.isAllowBlankValue(),
                     isRequired,
                     requiredMessage,
-                    errors.get(key)
+                    errors.get(key),
+                    queryPromptItem.getGroupKey()
                     );
             count++;
         }
+
+        setGroupHeaders(queryScreen.evalGroupHeaders());
         setTitle(queryScreen.getScreenTitle());
         setDescription(queryScreen.getDescriptionText());
         setQueryKey(queryScreen.getQueryKey());

diff --git a/src/test/java/org/commcare/formplayer/tests/CaseClaimTests.java b/src/test/java/org/commcare/formplayer/tests/CaseClaimTests.java
@@ -437,6 +437,27 @@ public void testQueryPromptRequired() throws Exception {
         assertTrue(queryResponseBean.getDisplays()[4].getRequiredMsg().contentEquals(expectedMessage));
     }
 
+    @Test
+    public void testQueryPromptGrouped() throws Exception {
+        QueryData queryData = new QueryData();
+
+        QueryResponseBean queryResponseBean = sessionNavigateWithQuery(
+                new String[]{"1", "action 1"},
+                "caseclaim",
+                queryData,
+                QueryResponseBean.class);
+
+        String groupKey1 = "group_header_0";
+        String groupKey2 = "group_header_3";
+        String expectedHeader1 = "Group1 Header";
+        String expectedHeader2 = "Group2 Header";
+
+        assertEquals(queryResponseBean.getGroupHeaders().get(groupKey1), expectedHeader1);
+        assertEquals(queryResponseBean.getGroupHeaders().get(groupKey2), expectedHeader2);
+        assertEquals(queryResponseBean.getDisplays()[0].getGroupKey(), groupKey1);
+        assertEquals(queryResponseBean.getDisplays()[4].getGroupKey(), groupKey2);
+    }
+
     @Test
     public void testDependentItemsets_DependentChoicesChangeWithSelection() throws Exception {
         Hashtable<String, String> inputs = new Hashtable<>();

diff --git a/src/test/resources/archives/caseclaim/default/app_strings.txt b/src/test/resources/archives/caseclaim/default/app_strings.txt
@@ -42,3 +42,5 @@ search_property.m1.age.validation=age should be greater than 18
 search_property.m1.age.required=One of age or DOB is required
 search_property.m1.dob=Date of Birth
 search_property.m1.dob.required=One of age or DOB is required
+search_property.m0.group_header_0=Group1 Header
+search_property.m0.group_header_3=Group2 Header
diff --git a/src/test/resources/archives/caseclaim/suite.xml b/src/test/resources/archives/caseclaim/suite.xml
@@ -371,14 +371,28 @@
         <data ref="'case2'" key="case_type"/>
         <data ref="'case3'" key="case_type"/>
         <data ref="'False'" key="include_closed"/>
-        <prompt key="name" default="instance('commcaresession')/session/context/deviceid" required="true()">
+        <group key="group_header_0">
+          <display>
+            <text>
+              <locale id="search_property.m0.group_header_0"/>
+            </text>
+          </display>
+        </group>
+        <group key="group_header_3">
+          <display>
+            <text>
+              <locale id="search_property.m0.group_header_3"/>
+            </text>
+          </display>
+        </group>
+        <prompt key="name" default="instance('commcaresession')/session/context/deviceid" required="true()" group_key="group_header_0">
           <display>
             <text>
               <locale id="search_property.m1.name"/>
             </text>
           </display>
         </prompt>
-        <prompt key="state" input="select1" default="&quot;ka&quot;" allow_blank_value="true" required="true()">
+        <prompt key="state" input="select1" default="&quot;ka&quot;" allow_blank_value="true" required="true()" group_key="group_header_0">
           <display>
             <text>
               <locale id="search_property.m1.state"/>
@@ -395,7 +409,7 @@
             <sort ref="id"/>
           </itemset>
         </prompt>
-        <prompt key="district" input="select">
+        <prompt key="district" input="select" group_key="group_header_3">
           <display>
             <text>
               <locale id="search_property.m1.district"/>
@@ -407,7 +421,7 @@
             <sort ref="id"/>
           </itemset>
         </prompt>
-        <prompt key="age">
+        <prompt key="age" group_key="group_header_3">
           <validation test="count(.) = 1 and int(instance('my-search-input')/input/field[@name='age'])>18">
             <text>
               <locale id="search_property.m1.age.validation"/>
@@ -424,7 +438,7 @@
             </text>
           </display>
         </prompt>
-        <prompt key="dob">
+        <prompt key="dob" group_key="group_header_3">
           <display>
             <text>
               <locale id="search_property.m1.dob"/>
+18 −0		src/cli/java/org/commcare/util/screen/QueryScreen.java
+47 −0		src/main/java/org/commcare/suite/model/QueryGroup.java
+12 −1		src/main/java/org/commcare/suite/model/QueryPrompt.java
+14 −2		src/main/java/org/commcare/suite/model/RemoteQueryDatum.java
+48 −0		src/main/java/org/commcare/xml/QueryGroupParser.java
+3 −1		src/main/java/org/commcare/xml/QueryPromptParser.java
+7 −1		src/main/java/org/commcare/xml/SessionDatumParser.java
+2 −1		src/main/java/org/javarosa/core/model/condition/EvaluationContext.java
+23 −0		src/test/java/org/commcare/xml/QueryDataParserTest.java