Move save logic into helper function. Remove unused tests and methods from Workbook class

Author: t8y8

tableaudocumentapi/archivefile.py tableaudocumentapi/containerfile.pytableaudocumentapi/archivefile.py renamed to tableaudocumentapi/containerfile.py

@@ -45,7 +45,7 @@ def build_archive_file(archive_contents, zip):
 
 def save_into_archive(xml_tree, filename, new_filename=None):
     # Saving a archive means extracting the contents into a temp folder,
-    # saving the changes over the twb in that folder, and then
+    # saving the changes over the twb/tds in that folder, and then
     # packaging it back up into a specifically formatted zip with the correct
     # relative file paths
 
@@ -56,12 +56,22 @@ def save_into_archive(xml_tree, filename, new_filename=None):
     with temporary_directory() as temp_path:
         file_type = os.path.splitext(filename)[-1].lower()
         with zipfile.ZipFile(filename) as zf:
-            twb_file = find_file_in_zip(zf, file_type)
+            xml_file = find_file_in_zip(zf, file_type)
             zf.extractall(temp_path)
-        # Write the new version of the twb to the temp directory
+        # Write the new version of the file to the temp directory
         xml_tree.write(os.path.join(
-            temp_path, twb_file), encoding="utf-8", xml_declaration=True)
+            temp_path, xml_file), encoding="utf-8", xml_declaration=True)
 
         # Write the new archive with the contents of the temp folder
         with zipfile.ZipFile(new_filename, "w", compression=zipfile.ZIP_DEFLATED) as new_archive:
             build_archive_file(temp_path, new_archive)
+
+
+def _save_file(container_file, xml_tree, new_filename=None):
+    if zipfile.is_zipfile(container_file):
+        save_into_archive(xml_tree, container_file, new_filename)
+    else:
+        xml_tree.write(container_file, encoding="utf-8", xml_declaration=True)
+
+
+

tableaudocumentapi/datasource.py

@@ -7,7 +7,7 @@
 import zipfile
 
 import xml.etree.ElementTree as ET
-from tableaudocumentapi import Connection, archivefile
+from tableaudocumentapi import Connection, containerfile
 
 
 class ConnectionParser(object):
@@ -61,7 +61,7 @@ def from_file(cls, filename):
         "Initialize datasource from file (.tds)"
 
         if zipfile.is_zipfile(filename):
-            dsxml = archivefile.get_xml_from_archive(filename).getroot()
+            dsxml = containerfile.get_xml_from_archive(filename).getroot()
         else:
             dsxml = ET.parse(filename).getroot()
         return cls(dsxml, filename)
@@ -80,11 +80,7 @@ def save(self):
 
         # save the file
 
-        if zipfile.is_zipfile(self._filename):
-            archivefile.save_into_archive(self._datasourceTree, self._filename)
-        else:
-            self._datasourceTree.write(
-                self._filename, encoding="utf-8", xml_declaration=True)
+        containerfile._save_file(self._filename, self._datasourceTree)
 
     def save_as(self, new_filename):
         """
@@ -97,12 +93,7 @@ def save_as(self, new_filename):
             Nothing.
 
         """
-        if zipfile.is_zipfile(self._filename):
-            archivefile.save_into_archive(
-                self._datasourceTree, self._filename, new_filename)
-        else:
-            self._datasourceTree.write(
-                new_filename, encoding="utf-8", xml_declaration=True)
+        containerfile._save_file(self._filename, self._datasourceTree, new_filename)
 
     ###########
     # name

tableaudocumentapi/workbook.py

@@ -8,7 +8,7 @@
 
 import xml.etree.ElementTree as ET
 
-from tableaudocumentapi import Datasource, archivefile
+from tableaudocumentapi import Datasource, containerfile
 
 ###########################################################################
 #
@@ -37,7 +37,7 @@ def __init__(self, filename):
 
         # Determine if this is a twb or twbx and get the xml root
         if zipfile.is_zipfile(self._filename):
-            self._workbookTree = archivefile.get_xml_from_archive(
+            self._workbookTree = containerfile.get_xml_from_archive(
                 self._filename)
         else:
             self._workbookTree = ET.parse(self._filename)
@@ -74,13 +74,7 @@ def save(self):
         """
 
         # save the file
-
-        if zipfile.is_zipfile(self._filename):
-            archivefile.save_into_archive(
-                self._workbookTree, filename=self._filename)
-        else:
-            self._workbookTree.write(
-                self._filename, encoding="utf-8", xml_declaration=True)
+        containerfile._save_file(self._filename, self._workbookTree)
 
     def save_as(self, new_filename):
         """
@@ -93,13 +87,8 @@ def save_as(self, new_filename):
             Nothing.
 
         """
-
-        if zipfile.is_zipfile(self._filename):
-            archivefile.save_into_archive(
-                self._workbookTree, self._filename, new_filename)
-        else:
-            self._workbookTree.write(
-                new_filename, encoding="utf-8", xml_declaration=True)
+        containerfile._save_file(
+            self._filename, self._workbookTree, new_filename)
 
     ###########################################################################
     #
@@ -115,8 +104,3 @@ def _prepare_datasources(self, xmlRoot):
             datasources.append(ds)
 
         return datasources
-
-    @staticmethod
-    def _is_valid_file(filename):
-        fileExtension = os.path.splitext(filename)[-1].lower()
-        return fileExtension in ('.twb', '.tds')

test/bvt.py

@@ -23,19 +23,6 @@
 TABLEAU_10_TDSX = os.path.join(TEST_DIR, 'assets', 'TABLEAU_10_TDSX.tdsx')
 
 
-class HelperMethodTests(unittest.TestCase):
-
-    def test_is_valid_file_with_valid_inputs(self):
-        self.assertTrue(Workbook._is_valid_file('file1.tds'))
-        self.assertTrue(Workbook._is_valid_file('file2.twb'))
-        self.assertTrue(Workbook._is_valid_file('tds.twb'))
-
-    def test_is_valid_file_with_invalid_inputs(self):
-        self.assertFalse(Workbook._is_valid_file(''))
-        self.assertFalse(Workbook._is_valid_file('file1.tds2'))
-        self.assertFalse(Workbook._is_valid_file('file2.twb3'))
-
-
 class ConnectionParserTests(unittest.TestCase):
 
     def test_can_extract_legacy_connection(self):