opc: refactor Describe_ContentTypeMap

* Extract fixture to clean main test and enable parameterized testing.
* Clean up ordering of objects in unitdata/rels.py

Author: Steve Canny

tests/opc/test_pkgreader.py

@@ -4,18 +4,23 @@
 Test suite for opc.pkgreader module
 """
 
+from __future__ import absolute_import, print_function, unicode_literals
+
 import pytest
 
 from mock import call, Mock, patch
 
-from docx.opc.constants import RELATIONSHIP_TARGET_MODE as RTM
+from docx.opc.constants import (
+    CONTENT_TYPE as CT, RELATIONSHIP_TARGET_MODE as RTM
+)
 from docx.opc.packuri import PackURI
 from docx.opc.phys_pkg import _ZipPkgReader
 from docx.opc.pkgreader import (
     _ContentTypeMap, PackageReader, _SerializedPart, _SerializedRelationship,
     _SerializedRelationships
 )
 
+from .unitdata.types import a_Default, a_Types, an_Override
 from ..unitutil import (
     initializer_mock, class_mock, function_mock, instance_mock, loose_mock,
     method_mock
@@ -258,45 +263,13 @@ def _walk_phys_parts(self, request):
 
 class Describe_ContentTypeMap(object):
 
-    def it_can_construct_from_types_xml(self, oxml_fromstring_):
-        # test data --------------------
-        content_types = (
-            'app/vnd.type1', 'app/vnd.type2', 'app/vnd.type3',
-            'app/vnd.type4',
-        )
-        content_types_xml = '<DontCare/>'
-        extensions = ('rels', 'xml')
-        exts = tuple(['.%s' % extension for extension in extensions])
-        partnames = ('/part/name1.xml', '/part/name2.xml')
-        # mockery ----------------------
-        overrides = (
-            Mock(name='override_elm_1', partname=partnames[0],
-                 content_type=content_types[0]),
-            Mock(name='override_elm_2', partname=partnames[1],
-                 content_type=content_types[1]),
-        )
-        defaults = (
-            Mock(name='default_elm_1', extension=extensions[0],
-                 content_type=content_types[2]),
-            Mock(name='default_elm_2', extension=extensions[1],
-                 content_type=content_types[3]),
-        )
-        types_elm = Mock(
-            name='types_elm', overrides=overrides, defaults=defaults
+    def it_can_construct_from_ct_item_xml(self, from_xml_fixture):
+        content_types_xml, expected_defaults, expected_overrides = (
+            from_xml_fixture
         )
-        oxml_fromstring_.return_value = types_elm
-        # exercise ---------------------
         ct_map = _ContentTypeMap.from_xml(content_types_xml)
-        # verify -----------------------
-        expected_overrides = {
-            partnames[0]: content_types[0], partnames[1]: content_types[1]
-        }
-        expected_defaults = {
-            exts[0]: content_types[2], exts[1]: content_types[3]
-        }
-        oxml_fromstring_.assert_called_once_with(content_types_xml)
-        assert ct_map._overrides == expected_overrides
         assert ct_map._defaults == expected_defaults
+        assert ct_map._overrides == expected_overrides
 
     def it_matches_overrides(self):
         # test data --------------------
@@ -328,8 +301,44 @@ def it_should_raise_on_key_not_instance_of_PackURI(self):
     # fixtures ---------------------------------------------
 
     @pytest.fixture
-    def oxml_fromstring_(self, request):
-        return function_mock(request, 'docx.opc.pkgreader.oxml_fromstring')
+    def from_xml_fixture(self):
+        entries = (
+            ('Default', 'xml', CT.XML),
+            # ('Default', 'PNG', CT.PNG),
+            ('Override', '/ppt/presentation.xml', CT.PML_PRESENTATION_MAIN),
+        )
+        content_types_xml = self._xml_from(entries)
+        expected_defaults = {}
+        expected_overrides = {}
+        for entry in entries:
+            if entry[0] == 'Default':
+                ext = ('.%s' % entry[1]).lower()
+                content_type = entry[2]
+                expected_defaults[ext] = content_type
+            elif entry[0] == 'Override':
+                partname, content_type = entry[1:]
+                expected_overrides[partname] = content_type
+        return content_types_xml, expected_defaults, expected_overrides
+
+    def _xml_from(self, entries):
+        """
+        Return XML for a [Content_Types].xml based on items in *entries*.
+        """
+        types_bldr = a_Types().with_nsdecls()
+        for entry in entries:
+            if entry[0] == 'Default':
+                ext, content_type = entry[1:]
+                default_bldr = a_Default()
+                default_bldr.with_Extension(ext)
+                default_bldr.with_ContentType(content_type)
+                types_bldr.with_child(default_bldr)
+            elif entry[0] == 'Override':
+                partname, content_type = entry[1:]
+                override_bldr = an_Override()
+                override_bldr.with_PartName(partname)
+                override_bldr.with_ContentType(content_type)
+                types_bldr.with_child(override_bldr)
+        return types_bldr.xml()
 
 
 class Describe_SerializedPart(object):

tests/opc/unitdata/rels.py

@@ -13,6 +13,21 @@
 from docx.opc.oxml import oxml_fromstring
 
 
+class BaseBuilder(object):
+    """
+    Provides common behavior for all data builders.
+    """
+    @property
+    def element(self):
+        """Return element based on XML generated by builder"""
+        return oxml_fromstring(self.xml)
+
+    def with_indent(self, indent):
+        """Add integer *indent* spaces at beginning of element XML"""
+        self._indent = indent
+        return self
+
+
 class RelationshipsBuilder(object):
     """Builder class for test Relationships"""
     partname_tmpls = {
@@ -50,28 +65,6 @@ def build(self):
         return rels
 
 
-def a_rels():
-    """
-    Return a PartBuilder instance.
-    """
-    return RelationshipsBuilder()
-
-
-class BaseBuilder(object):
-    """
-    Provides common behavior for all data builders.
-    """
-    @property
-    def element(self):
-        """Return element based on XML generated by builder"""
-        return oxml_fromstring(self.xml)
-
-    def with_indent(self, indent):
-        """Add integer *indent* spaces at beginning of element XML"""
-        self._indent = indent
-        return self
-
-
 class CT_DefaultBuilder(BaseBuilder):
     """
     Test data builder for CT_Default (Default) XML element that appears in
@@ -277,25 +270,20 @@ def xml(self):
 
 
 def a_Default():
-    """Return a CT_DefaultBuilder instance"""
     return CT_DefaultBuilder()
 
 
-def an_Override():
-    """Return a CT_OverrideBuilder instance"""
-    return CT_OverrideBuilder()
-
-
 def a_Relationship():
-    """Return a CT_RelationshipBuilder instance"""
     return CT_RelationshipBuilder()
 
 
 def a_Relationships():
-    """Return a CT_RelationshipsBuilder instance"""
     return CT_RelationshipsBuilder()
 
 
 def a_Types():
-    """Return a CT_TypesBuilder instance"""
     return CT_TypesBuilder()
+
+
+def an_Override():
+    return CT_OverrideBuilder()

tests/opc/unitdata/types.py

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+"""
+XML test data builders for [Content_Types].xml elements
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+from docx.opc.oxml import nsmap
+
+from ...unitdata import BaseBuilder
+
+
+class CT_DefaultBuilder(BaseBuilder):
+    __tag__ = 'Default'
+    __nspfxs__ = ('ct',)
+    __attrs__ = ('Extension', 'ContentType')
+
+
+class CT_OverrideBuilder(BaseBuilder):
+    __tag__ = 'Override'
+    __nspfxs__ = ('ct',)
+    __attrs__ = ('PartName', 'ContentType')
+
+
+class CT_TypesBuilder(BaseBuilder):
+    __tag__ = 'Types'
+    __nspfxs__ = ('ct',)
+    __attrs__ = ()
+
+    def with_nsdecls(self, *nspfxs):
+        self._nsdecls = ' xmlns="%s"' % nsmap['ct']
+        return self
+
+
+def a_Default():
+    return CT_DefaultBuilder()
+
+
+def a_Types():
+    return CT_TypesBuilder()
+
+
+def an_Override():
+    return CT_OverrideBuilder()