blkct: extract BlockItemContainer._add_paragraph()

Steve Canny · Steve Canny · commit aaf8da9d8a16 · 2015-02-08T00:01:15.000-08:00
Allows the core of .add_paragraph() to be tested integrated with oxml
while using mocks for the remainder.
diff --git a/docx/blkcntnr.py b/docx/blkcntnr.py
@@ -30,8 +30,7 @@ def add_paragraph(self, text='', style=None):
         paragraph style *style*. If *style* is |None|, no paragraph style is
         applied, which has the same effect as applying the 'Normal' style.
         """
-        p = self._element.add_p()
-        paragraph = Paragraph(p, self)
+        paragraph = self._add_paragraph()
         if text:
             paragraph.add_run(text)
         if style is not None:
@@ -68,3 +67,10 @@ def tables(self):
         """
         from .table import Table
         return [Table(tbl, self) for tbl in self._element.tbl_lst]
+
+    def _add_paragraph(self):
+        """
+        Return a paragraph newly added to the end of the content in this
+        container.
+        """
+        return Paragraph(self._element.add_p(), self)
diff --git a/tests/test_blkcntnr.py b/tests/test_blkcntnr.py
@@ -13,15 +13,21 @@
 from docx.text.paragraph import Paragraph
 
 from .unitutil.cxml import element, xml
+from .unitutil.mock import call, instance_mock, method_mock
 
 
 class DescribeBlockItemContainer(object):
 
     def it_can_add_a_paragraph(self, add_paragraph_fixture):
-        blkcntnr, text, style, expected_xml = add_paragraph_fixture
-        paragraph = blkcntnr.add_paragraph(text, style)
-        assert blkcntnr._element.xml == expected_xml
-        assert isinstance(paragraph, Paragraph)
+        blkcntnr, text, style, paragraph_, add_run_calls = (
+            add_paragraph_fixture
+        )
+        new_paragraph = blkcntnr.add_paragraph(text, style)
+
+        blkcntnr._add_paragraph.assert_called_once_with()
+        assert new_paragraph.add_run.call_args_list == add_run_calls
+        assert new_paragraph.style == style
+        assert new_paragraph is paragraph_
 
     def it_can_add_a_table(self, add_table_fixture):
         blkcntnr, rows, cols, expected_xml = add_table_fixture
@@ -54,23 +60,36 @@ def it_provides_access_to_the_tables_it_contains(self, tables_fixture):
             count += 1
         assert count == expected_count
 
+    def it_adds_a_paragraph_to_help(self, _add_paragraph_fixture):
+        blkcntnr, expected_xml = _add_paragraph_fixture
+        new_paragraph = blkcntnr._add_paragraph()
+        assert isinstance(new_paragraph, Paragraph)
+        assert new_paragraph._parent == blkcntnr
+        assert blkcntnr._element.xml == expected_xml
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
-        ('w:body', '', None,
-         'w:body/w:p'),
-        ('w:body', 'foobar', None,
-         'w:body/w:p/w:r/w:t"foobar"'),
-        ('w:body', '', 'Heading1',
-         'w:body/w:p/w:pPr/w:pStyle{w:val=Heading1}'),
-        ('w:body', 'barfoo', 'BodyText',
-         'w:body/w:p/(w:pPr/w:pStyle{w:val=BodyText},w:r/w:t"barfoo")'),
+        ('',    None),
+        ('Foo', None),
+        ('',    'Bar'),
+        ('Foo', 'Bar'),
     ])
-    def add_paragraph_fixture(self, request):
-        blkcntnr_cxml, text, style, after_cxml = request.param
+    def add_paragraph_fixture(self, request, _add_paragraph_, paragraph_,
+                              add_run_):
+        blkcntnr = BlockItemContainer(None, None)
+        text, style = request.param
+        _add_paragraph_.return_value = paragraph_
+        add_run_calls = [call(text)] if text else []
+        paragraph_.style = None
+        return blkcntnr, text, style, paragraph_, add_run_calls
+
+    @pytest.fixture
+    def _add_paragraph_fixture(self, request):
+        blkcntnr_cxml, after_cxml = 'w:body', 'w:body/w:p'
         blkcntnr = BlockItemContainer(element(blkcntnr_cxml), None)
         expected_xml = xml(after_cxml)
-        return blkcntnr, text, style, expected_xml
+        return blkcntnr, expected_xml
 
     @pytest.fixture(params=[
         ('w:body', 0, 0, 'w:body/w:tbl/(w:tblPr/w:tblW{w:type=auto,w:w=0},w:'
@@ -111,3 +130,17 @@ def tables_fixture(self, request):
         blkcntnr_cxml, expected_count = request.param
         blkcntnr = BlockItemContainer(element(blkcntnr_cxml), None)
         return blkcntnr, expected_count
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def _add_paragraph_(self, request):
+        return method_mock(request, BlockItemContainer, '_add_paragraph')
+
+    @pytest.fixture
+    def add_run_(self, request):
+        return method_mock(request, Paragraph, 'add_run')
+
+    @pytest.fixture
+    def paragraph_(self, request):
+        return instance_mock(request, Paragraph)
