oxml: add unit tests for BaseOxmlElement

Steve Canny · Steve Canny · commit 57892dd4702c · 2014-06-15T16:53:59.000-07:00
diff --git a/docx/oxml/ns.py b/docx/oxml/ns.py
@@ -20,6 +20,8 @@
     'xml': ('http://www.w3.org/XML/1998/namespace')
 }
 
+pfxmap = dict((value, key) for key, value in nsmap.items())
+
 
 class NamespacePrefixedTag(str):
     """
@@ -37,6 +39,12 @@ def __init__(self, nstag):
     def clark_name(self):
         return '{%s}%s' % (self._ns_uri, self._local_part)
 
+    @classmethod
+    def from_clark_name(cls, clark_name):
+        nsuri, local_name = clark_name[1:].split('}')
+        nstag = '%s:%s' % (pfxmap[nsuri], local_name)
+        return cls(nstag)
+
     @property
     def local_part(self):
         """
diff --git a/docx/oxml/xmlchemy.py b/docx/oxml/xmlchemy.py
@@ -11,7 +11,7 @@
 
 import re
 
-from .ns import qn
+from .ns import NamespacePrefixedTag, qn
 from ..compat import Unicode
 
 
@@ -95,6 +95,11 @@ class BaseOxmlElement(etree.ElementBase):
     Base class for all custom element classes, to add standardized behavior
     to all classes in one place.
     """
+    def __repr__(self):
+        return "<%s '<%s>' at 0x%0x>" % (
+            self.__class__.__name__, self._nsptag, id(self)
+        )
+
     def first_child_found_in(self, *tagnames):
         """
         Return the first child found with tag in *tagnames*, or None if
@@ -122,3 +127,7 @@ def xml(self):
         top.
         """
         return serialize_for_reading(self)
+
+    @property
+    def _nsptag(self):
+        return NamespacePrefixedTag.from_clark_name(self.tag)
diff --git a/tests/oxml/test_ns.py b/tests/oxml/test_ns.py
@@ -20,6 +20,10 @@ def it_behaves_like_a_string_when_you_want_it_to(self, nsptag):
     def it_knows_its_clark_name(self, nsptag, clark_name):
         assert nsptag.clark_name == clark_name
 
+    def it_can_construct_from_a_clark_name(self, clark_name, nsptag):
+        _nsptag = NamespacePrefixedTag.from_clark_name(clark_name)
+        assert _nsptag == nsptag
+
     def it_knows_its_local_part(self, nsptag, local_part):
         assert nsptag.local_part == local_part
 
diff --git a/tests/oxml/test_xmlchemy.py b/tests/oxml/test_xmlchemy.py
@@ -10,8 +10,71 @@
 
 from docx.compat import Unicode
 from docx.oxml import parse_xml
+from docx.oxml.ns import qn
 from docx.oxml.xmlchemy import serialize_for_reading, XmlString
 
+from .unitdata.text import a_b, a_u, an_i, an_rPr
+
+
+class DescribeBaseOxmlElement(object):
+
+    def it_can_find_the_first_of_its_children_named_in_a_sequence(
+            self, first_fixture):
+        element, tagnames, matching_child = first_fixture
+        assert element.first_child_found_in(*tagnames) is matching_child
+
+    def it_can_insert_an_element_before_named_successors(
+            self, insert_fixture):
+        element, child, tagnames, expected_xml = insert_fixture
+        element.insert_element_before(child, *tagnames)
+        assert element.xml == expected_xml
+
+    # fixtures ---------------------------------------------
+
+    @pytest.fixture(params=[
+        ('iu', 'b', 'iu', 'biu'),
+        ('u',  'b', 'iu', 'bu'),
+        ('',   'b', 'iu', 'b'),
+        ('bu', 'i', 'u',  'biu'),
+        ('bi', 'u', '',   'biu'),
+    ])
+    def insert_fixture(self, request):
+        present, new, successors, after = request.param
+        element = self.rPr_bldr(present).element
+        child = {
+            'b': a_b(), 'i': an_i(), 'u': a_u()
+        }[new].with_nsdecls().element
+        tagnames = [('w:%s' % char) for char in successors]
+        expected_xml = self.rPr_bldr(after).xml()
+        return element, child, tagnames, expected_xml
+
+    @pytest.fixture(params=[
+        ('biu', 'iu',  'i'),
+        ('bu',  'iu',  'u'),
+        ('bi',  'u',   None),
+        ('b',   'iu',  None),
+        ('iu',  'biu', 'i'),
+        ('',    'biu', None),
+    ])
+    def first_fixture(self, request):
+        present, matching, match = request.param
+        element = self.rPr_bldr(present).element
+        tagnames = [('w:%s' % char) for char in matching]
+        matching_child = element.find(qn('w:%s' % match)) if match else None
+        return element, tagnames, matching_child
+
+    # fixture components ---------------------------------------------
+
+    def rPr_bldr(self, children):
+        rPr_bldr = an_rPr().with_nsdecls()
+        if 'b' in children:
+            rPr_bldr.with_child(a_b())
+        if 'i' in children:
+            rPr_bldr.with_child(an_i())
+        if 'u' in children:
+            rPr_bldr.with_child(a_u())
+        return rPr_bldr
+
 
 class DescribeSerializeForReading(object):
 
