Add list_name alias for dataset

XLSForm · Sep 15, 2023 · 0381770 · 0381770
1 parent f61833e
commit 0381770
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 5 deletions.
diff --git a/pyxform/aliases.py b/pyxform/aliases.py
@@ -108,6 +108,9 @@
     "parameters": "parameters",
     constants.ENTITIES_SAVETO: "bind::entities:saveto",
 }
+
+entities_header = {"list_name": "dataset"}
+
 # Key is the pyxform internal name, Value is the name used in error/warning messages.
 TRANSLATABLE_SURVEY_COLUMNS = {
     constants.LABEL: constants.LABEL,

diff --git a/pyxform/entities/entities_parsing.py b/pyxform/entities/entities_parsing.py
@@ -5,9 +5,9 @@
 from pyxform.xlsparseutils import find_sheet_misspellings, is_valid_xml_tag
 
 
-def get_entity_declaration(workbook_dict: Dict, warnings: List) -> Dict:
-    entities_sheet = workbook_dict.get(constants.ENTITIES, [])
-
+def get_entity_declaration(
+    entities_sheet: Dict, workbook_dict: Dict, warnings: List
+) -> Dict:
     if len(entities_sheet) == 0:
         similar = find_sheet_misspellings(
             key=constants.ENTITIES, keys=workbook_dict.keys()

diff --git a/pyxform/xls2json.py b/pyxform/xls2json.py
@@ -538,7 +538,11 @@ def workbook_to_json(
                             )  # noqa
 
     # ########## Entities sheet ###########
-    entity_declaration = get_entity_declaration(workbook_dict, warnings)
+    entities_sheet = workbook_dict.get(constants.ENTITIES, [])
+    entities_sheet = dealias_and_group_headers(
+        entities_sheet, aliases.entities_header, False
+    )
+    entity_declaration = get_entity_declaration(entities_sheet, workbook_dict, warnings)
 
     # ########## Survey sheet ###########
     survey_sheet = workbook_dict[constants.SURVEY]

diff --git a/tests/test_entities.py b/tests/test_entities.py
@@ -6,7 +6,6 @@ class EntitiesTest(PyxformTestCase):
     def test_basic_entity_creation_building_blocks(self):
         self.assertPyxformXform(
             name="data",
-            debug=True,
             md="""
             | survey   |         |       |       |
             |          | type    | name  | label |
@@ -336,3 +335,20 @@ def test_saveto_in_group__works(self):
             """,
             errored=False,
         )
+
+    def test_list_name_alias_to_dataset(self):
+        self.assertPyxformXform(
+            name="data",
+            md="""
+            | survey   |           |       |       |
+            |          | type      | name  | label |
+            |          | text      | a     | A     |
+            | entities |           |       |       |
+            |          | list_name | label |       |
+            |          | trees     | a     |       |
+            """,
+            xml__xpath_match=[
+                "/h:html/h:head/x:model/x:instance/x:data/x:meta/x:entity",
+                '/h:html/h:head/x:model/x:instance/x:data/x:meta/x:entity[@dataset = "trees"]',
+            ],
+        )