oxml: add CT_Document type

Steve Canny · Steve Canny · commit dbf5cd2ffcad · 2013-12-20T20:12:01.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -13,7 +13,7 @@
 """
 
 from docx.oxml.base import register_custom_element_class
-from docx.oxml.parts import CT_Body
+from docx.oxml.parts import CT_Body, CT_Document
 from docx.oxml.text import CT_P, CT_R, CT_Text
 
 
@@ -22,6 +22,7 @@
 # ===========================================================================
 
 register_custom_element_class('w:body',     CT_Body)
+register_custom_element_class('w:document', CT_Document)
 register_custom_element_class('w:p',        CT_P)
 register_custom_element_class('w:r',        CT_R)
 register_custom_element_class('w:t',        CT_Text)
diff --git a/docx/oxml/parts.py b/docx/oxml/parts.py
@@ -15,6 +15,12 @@
 from docx.oxml.text import CT_P
 
 
+class CT_Document(OxmlBaseElement):
+    """
+    ``<w:document>`` element, the root element of a document.xml file.
+    """
+
+
 class CT_Body(OxmlBaseElement):
     """
     ``<w:body>``, the container element for the main document story in
diff --git a/features/add_paragraph.feature b/features/add_paragraph.feature
@@ -3,7 +3,6 @@ Feature: Add a paragraph of text
   As an python-docx developer
   I need to add a paragraph
 
-  @wip
   Scenario: Add a paragraph to a document created from the default template
      Given a new document created from the default template
       When I add a new paragraph to the body
diff --git a/tests/oxml/test_parts.py b/tests/oxml/test_parts.py
@@ -9,9 +9,10 @@
 
 """Test suite for the docx.oxml.parts module."""
 
+from docx.oxml.parts import CT_Body
 from docx.oxml.text import CT_P
 
-from ..unitdata import a_body
+from ..unitdata import a_body, a_document
 
 
 class DescribeCT_Body(object):
@@ -32,3 +33,10 @@ def it_can_add_a_p_to_itself(self):
             # verify -------------------
             assert body.xml == after_body_bldr.xml
             assert isinstance(p, CT_P)
+
+
+class DescribeCT_Document(object):
+
+    def it_holds_a_body_element(self):
+        document = a_document().with_body().element
+        assert isinstance(document.body, CT_Body)
diff --git a/tests/unitdata.py b/tests/unitdata.py
@@ -84,6 +84,35 @@ def xml(self):
         return xml
 
 
+class CT_DocumentBuilder(BaseBuilder):
+    """
+    XML data builder for CT_Document (<w:document>) element, the root element
+    in document.xml files.
+    """
+    def __init__(self):
+        """Establish instance variables with default values"""
+        super(CT_DocumentBuilder, self).__init__()
+        self._body = None
+
+    def with_body(self):
+        """Add an empty body element"""
+        self._body = a_body().with_indent(2)
+        return self
+
+    @property
+    def xml(self):
+        """
+        Return XML string based on settings accumulated via method calls.
+        """
+        if not self._body:
+            return '<w:document %s/>\n' % nsdecls('w')
+
+        xml = '<w:document %s>\n' % nsdecls('w')
+        xml += self._body.xml
+        xml += '</w:document>\n'
+        return xml
+
+
 class CT_PBuilder(BaseBuilder):
     """
     Test data builder for a CT_P (<w:p>) XML element that appears within the
@@ -190,6 +219,11 @@ def a_body():
     return CT_BodyBuilder()
 
 
+def a_document():
+    """Return a CT_DocumentBuilder instance"""
+    return CT_DocumentBuilder()
+
+
 def a_p():
     """Return a CT_PBuilder instance"""
     return CT_PBuilder()
