tbl: add CT_Tc._swallow_next_tc()

Author: Steve Canny

docx/oxml/table.py

@@ -254,6 +254,11 @@ def grid_span(self):
             return 1
         return tcPr.grid_span
 
+    @grid_span.setter
+    def grid_span(self, value):
+        tcPr = self.get_or_add_tcPr()
+        tcPr.grid_span = value
+
     def iter_block_items(self):
         """
         Generate a reference to each of the block-level content elements in
@@ -345,6 +350,14 @@ def width(self, value):
         tcPr = self.get_or_add_tcPr()
         tcPr.width = value
 
+    def _add_width_of(self, other_tc):
+        """
+        Add the width of *other_tc* to this cell. Does nothing if either this
+        tc or *other_tc* does not have a specified width.
+        """
+        if self.width and other_tc.width:
+            self.width += other_tc.width
+
     @property
     def _grid_col(self):
         """
@@ -414,6 +427,21 @@ def _move_content_to(self, other_tc):
     def _new_tbl(self):
         return CT_Tbl.new()
 
+    @property
+    def _next_tc(self):
+        """
+        The `w:tc` element immediately following this one in this row, or
+        |None| if this is the last `w:tc` element in the row.
+        """
+        following_tcs = self.xpath('./following-sibling::w:tc')
+        return following_tcs[0] if following_tcs else None
+
+    def _remove(self):
+        """
+        Remove this `w:tc` element from the XML tree.
+        """
+        self.getparent().remove(self)
+
     def _remove_trailing_empty_p(self):
         """
         Remove the last content element from this cell if it is an empty
@@ -485,7 +513,18 @@ def _swallow_next_tc(self, grid_width, top_tc):
         |InvalidSpanError| if the width of the resulting cell is greater than
         *grid_width* or if there is no next `<w:tc>` element in the row.
         """
-        raise NotImplementedError
+        def raise_on_invalid_swallow(next_tc):
+            if next_tc is None:
+                raise InvalidSpanError('not enough grid columns')
+            if self.grid_span + next_tc.grid_span > grid_width:
+                raise InvalidSpanError('span is not rectangular')
+
+        next_tc = self._next_tc
+        raise_on_invalid_swallow(next_tc)
+        next_tc._move_content_to(top_tc)
+        self._add_width_of(next_tc)
+        self.grid_span += next_tc.grid_span
+        next_tc._remove()
 
     @property
     def _tbl(self):
@@ -577,6 +616,12 @@ def grid_span(self):
             return 1
         return gridSpan.val
 
+    @grid_span.setter
+    def grid_span(self, value):
+        self._remove_gridSpan()
+        if value > 1:
+            self.get_or_add_gridSpan().val = value
+
     @property
     def vMerge_val(self):
         """

features/tbl-merge-cells.feature

@@ -3,7 +3,6 @@ Feature: Merge table cells
   As a developer using python-docx
   I need a way to merge a range of cells
 
-  @wip
   Scenario Outline: Merge cells
      Given a 3x3 table having only uniform cells
       When I merge from cell <origin> to cell <other>
@@ -16,7 +15,6 @@ Feature: Merge table cells
       |    5   |   9   | 1 2 3 4 5\6\8\9 5\6\8\9 7 5\6\8\9 5\6\8\9 |
 
 
-  @wip
   Scenario Outline: Merge horizontal span with other cell
      Given a 3x3 table having a horizontal span
       When I merge from cell <origin> to cell <other>
@@ -29,7 +27,6 @@ Feature: Merge table cells
       |    2   |   4   | 1\2\4 1\2\4 3 1\2\4 1\2\4 6 7 8 9 |
 
 
-  @wip
   Scenario Outline: Merge vertical span with other cell
      Given a 3x3 table having a vertical span
       When I merge from cell <origin> to cell <other>
@@ -42,7 +39,6 @@ Feature: Merge table cells
       |    7   |   5   | 1 2 3 4\5\7 4\5\7 6 4\5\7 4\5\7 9 |
 
 
-  @wip
   Scenario Outline: Horizontal span adds cell widths
      Given a 3x3 table having <span-state>
       When I merge from cell <origin> to cell <other>

tests/oxml/test_table.py

@@ -73,6 +73,21 @@ def it_can_extend_its_horz_span_to_help_merge(self, span_width_fixture):
         assert tc._swallow_next_tc.call_args_list == expected_calls
         assert tc.vMerge == vMerge
 
+    def it_can_swallow_the_next_tc_help_merge(self, swallow_fixture):
+        tc, grid_width, top_tc, tr, expected_xml = swallow_fixture
+        tc._swallow_next_tc(grid_width, top_tc)
+        assert tr.xml == expected_xml
+
+    def it_adds_cell_widths_on_swallow(self, add_width_fixture):
+        tc, grid_width, top_tc, tr, expected_xml = add_width_fixture
+        tc._swallow_next_tc(grid_width, top_tc)
+        assert tr.xml == expected_xml
+
+    def it_raises_on_invalid_swallow(self, swallow_raise_fixture):
+        tc, grid_width, top_tc, tr = swallow_raise_fixture
+        with pytest.raises(InvalidSpanError):
+            tc._swallow_next_tc(grid_width, top_tc)
+
     def it_can_move_its_content_to_help_merge(self, move_fixture):
         tc, tc_2, expected_tc_xml, expected_tc_2_xml = move_fixture
         tc._move_content_to(tc_2)
@@ -86,6 +101,32 @@ def it_raises_on_tr_above(self, tr_above_raise_fixture):
 
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture(params=[
+        # both cells have a width
+        ('w:tr/(w:tc/(w:tcPr/w:tcW{w:w=1440,w:type=dxa},w:p),'
+         'w:tc/(w:tcPr/w:tcW{w:w=1440,w:type=dxa},w:p))',      0, 2,
+         'w:tr/(w:tc/(w:tcPr/(w:tcW{w:w=2880,w:type=dxa},'
+         'w:gridSpan{w:val=2}),w:p))'),
+        # neither have a width
+        ('w:tr/(w:tc/w:p,w:tc/w:p)',                           0, 2,
+         'w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p))'),
+        # only second one has a width
+        ('w:tr/(w:tc/w:p,'
+         'w:tc/(w:tcPr/w:tcW{w:w=1440,w:type=dxa},w:p))',      0, 2,
+         'w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p))'),
+        # only first one has a width
+        ('w:tr/(w:tc/(w:tcPr/w:tcW{w:w=1440,w:type=dxa},w:p),'
+         'w:tc/w:p)',                                          0, 2,
+         'w:tr/(w:tc/(w:tcPr/(w:tcW{w:w=1440,w:type=dxa},'
+         'w:gridSpan{w:val=2}),w:p))'),
+    ])
+    def add_width_fixture(self, request):
+        tr_cxml, tc_idx, grid_width, expected_tr_cxml = request.param
+        tr = element(tr_cxml)
+        tc = top_tc = tr[tc_idx]
+        expected_tr_xml = xml(expected_tr_cxml)
+        return tc, grid_width, top_tc, tr, expected_tr_xml
+
     @pytest.fixture(params=[
         (0, 0, 0, 'top',    0), (2, 0, 1, 'top',    0),
         (2, 1, 1, 'top',    0), (4, 2, 1, 'top',    1),
@@ -202,6 +243,36 @@ def span_width_fixture(
         ]
         return tc, grid_width, top_tc_, vMerge, expected_calls
 
+    @pytest.fixture(params=[
+        ('w:tr/(w:tc/w:p,w:tc/w:p)',                              0, 2,
+         'w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p))'),
+        ('w:tr/(w:tc/w:p,w:tc/w:p,w:tc/w:p)',                     1, 2,
+         'w:tr/(w:tc/w:p,w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p))'),
+        ('w:tr/(w:tc/w:p/w:r/w:t"a",w:tc/w:p/w:r/w:t"b")',        0, 2,
+         'w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p/w:r/w:t"a",'
+         'w:p/w:r/w:t"b"))'),
+        ('w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p),w:tc/w:p)', 0, 3,
+         'w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=3},w:p))'),
+        ('w:tr/(w:tc/w:p,w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p))', 0, 3,
+         'w:tr/(w:tc/(w:tcPr/w:gridSpan{w:val=3},w:p))'),
+    ])
+    def swallow_fixture(self, request):
+        tr_cxml, tc_idx, grid_width, expected_tr_cxml = request.param
+        tr = element(tr_cxml)
+        tc = top_tc = tr[tc_idx]
+        expected_tr_xml = xml(expected_tr_cxml)
+        return tc, grid_width, top_tc, tr, expected_tr_xml
+
+    @pytest.fixture(params=[
+        ('w:tr/w:tc/w:p', 0, 2),
+        ('w:tr/(w:tc/w:p,w:tc/(w:tcPr/w:gridSpan{w:val=2},w:p))', 0, 2),
+    ])
+    def swallow_raise_fixture(self, request):
+        tr_cxml, tc_idx, grid_width = request.param
+        tr = element(tr_cxml)
+        tc = top_tc = tr[tc_idx]
+        return tc, grid_width, top_tc, tr
+
     @pytest.fixture(params=[(0, 0, 0), (4, 0, 0)])
     def tr_above_raise_fixture(self, request):
         snippet_idx, row_idx, col_idx = request.param