Merge pull request #201 from andylolz/150-xml-root-path

Support user-defined XML root node

Author: Bjwebb

flattentool/__init__.py

@@ -111,7 +111,7 @@ def decimal_default(o):
 
 
 def unflatten(input_name, base_json=None, input_format=None, output_name=None,
-              root_list_path='main', encoding='utf8', timezone_name='UTC',
+              root_list_path=None, encoding='utf8', timezone_name='UTC',
               root_id=None, schema='', convert_titles=False, cell_source_map=None,
               heading_source_map=None, id_name='id', xml=False,
               vertical_orientation=False,
@@ -179,6 +179,9 @@ def unflatten(input_name, base_json=None, input_format=None, output_name=None,
         if result:
             base.update(result[0])
 
+    if root_list_path is None:
+        root_list_path = base_configuration.get('RootListPath', 'main')
+
     if not metatab_only:
         spreadsheet_input_class = INPUT_FORMATS[input_format]
         spreadsheet_input = spreadsheet_input_class(
@@ -208,14 +211,15 @@ def unflatten(input_name, base_json=None, input_format=None, output_name=None,
         base[root_list_path] = list(result)
 
     if xml:
+        xml_root_tag = base_configuration.get('XMLRootTag', 'iati-activities')
         if output_name is None:
             if sys.version > '3':
-                sys.stdout.buffer.write(toxml(base))
+                sys.stdout.buffer.write(toxml(base, xml_root_tag))
             else:
-                sys.stdout.write(toxml(base))
+                sys.stdout.write(toxml(base, xml_root_tag))
         else:
             with codecs.open(output_name, 'wb') as fp:
-                fp.write(toxml(base))
+                fp.write(toxml(base, xml_root_tag))
     else:
         if output_name is None:
             print(json.dumps(base, indent=4, default=decimal_default, ensure_ascii=False))

flattentool/lib.py

@@ -17,4 +17,8 @@ def parse_sheet_configuration(configuration_list):
             configuration['ignore'] = True
         if (len(parts) == 1 and parts[0].lower() in ("hashcomments", "hashcomment")):
             configuration['hashcomments'] = True
+        if (len(parts) == 2 and parts[0].lower() == "xmlroottag"):
+            configuration['XMLRootTag'] = parts[1]
+        if (len(parts) == 2 and parts[0].lower() == "rootlistpath"):
+            configuration['RootListPath'] = parts[1]
     return configuration

flattentool/tests/fixtures/iati-org.xml

@@ -0,0 +1 @@
+<iati-organisations><!--XML generated by flatten-tool--><iati-organisation><organisation-identifier>AA-AAA-123456789</organisation-identifier><reporting-org ref="AA-AAA-123456789" secondary-reporter="0" type="40" /></iati-organisation></iati-organisations>

flattentool/tests/fixtures/xlsx/iati-org.xlsx

@@ -66,3 +66,15 @@ def test_unflatten_xml(tmpdir):
         id_name='iati-identifier',
         xml=True)
     assert open('examples/iati/expected.xml').read() == tmpdir.join('output.xml').read()
+
+
+def test_unflatten_org_xml(tmpdir):
+    unflatten(
+        input_name='flattentool/tests/fixtures/xlsx/iati-org.xlsx',
+        output_name=tmpdir.join('output.xml').strpath,
+        input_format='xlsx',
+        id_name='organisation-identifier',
+        xml=True,
+        metatab_name='Meta'
+        )
+    assert open('flattentool/tests/fixtures/iati-org.xml').read() == tmpdir.join('output.xml').read()

flattentool/tests/test_unflatten.py

@@ -54,12 +54,12 @@ def dict_to_xml(data, tagname, toplevel=True, nsmap=None):
     return el
 
 
-def toxml(data):
+def toxml(data, xml_root_tag):
     nsmap = {
         # This is "bound by definition" - see https://www.w3.org/XML/1998/namespace
         'xml': 'http://www.w3.org/XML/1998/namespace'
     }
-    root = dict_to_xml(data, 'iati-activities', nsmap=nsmap)
+    root = dict_to_xml(data, xml_root_tag, nsmap=nsmap)
     comment = ET.Comment('XML generated by flatten-tool')
     root.insert(0, comment)
     return ET.tostring(root)