tab: add TabStops.add_tab_stop()

DKWoods · Steve Canny · commit 17e7e38b4a8d · 2016-05-27T12:49:56.000-07:00
diff --git a/docx/text/tabstops.py b/docx/text/tabstops.py
@@ -9,6 +9,7 @@
 )
 
 from ..shared import ElementProxy
+from docx.enum.text import WD_TAB_ALIGNMENT, WD_TAB_LEADER
 
 
 class TabStops(ElementProxy):
@@ -51,6 +52,19 @@ def __len__(self):
             return 0
         return len(tabs.tab_lst)
 
+    def add_tab_stop(self, position, alignment=WD_TAB_ALIGNMENT.LEFT,
+                     leader=WD_TAB_LEADER.SPACES):
+        """
+        Add a new tab stop at *position*. Tab alignment defaults to left, but
+        may be specified by passing a member of the :ref:`WdTabAlignment`
+        enumeration as *alignment*. An optional leader character can be
+        specified by passing a member of the :ref:`WdTabLeader` enumeration
+        as *leader*.
+        """
+        tabs = self._pPr.get_or_add_tabs()
+        tab = tabs.insert_tab_in_order(position, alignment, leader)
+        return TabStop(tab)
+
 
 class TabStop(ElementProxy):
     """
diff --git a/features/tab-access-tabs.feature b/features/tab-access-tabs.feature
@@ -20,7 +20,6 @@ Feature: Access TabStop objects
       And I can access a tab stop by index
 
 
-  @wip
   Scenario Outline: TabStops.add_tab_stop()
     Given a tab_stops having <count> tab stops
      When I add a tab stop
diff --git a/tests/text/test_tabstops.py b/tests/text/test_tabstops.py
@@ -159,8 +159,35 @@ def it_raises_on_indexed_access_when_empty(self):
         with pytest.raises(IndexError):
             tab_stops[0]
 
+    def it_can_add_a_tab_stop(self, add_tab_fixture):
+        tab_stops, position, kwargs, expected_xml = add_tab_fixture
+        tab_stops.add_tab_stop(position, **kwargs)
+        assert tab_stops._element.xml == expected_xml
+
     # fixture --------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:pPr', Twips(42), {},
+         'w:pPr/w:tabs/w:tab{w:pos=42,w:val=left}'),
+        ('w:pPr', Twips(72), {'alignment': WD_TAB_ALIGNMENT.RIGHT},
+         'w:pPr/w:tabs/w:tab{w:pos=72,w:val=right}'),
+        ('w:pPr', Twips(24),
+         {'alignment': WD_TAB_ALIGNMENT.CENTER,
+          'leader': WD_TAB_LEADER.DOTS},
+         'w:pPr/w:tabs/w:tab{w:pos=24,w:val=center,w:leader=dot}'),
+        ('w:pPr/w:tabs/w:tab{w:pos=42}', Twips(72), {},
+         'w:pPr/w:tabs/(w:tab{w:pos=42},w:tab{w:pos=72,w:val=left})'),
+        ('w:pPr/w:tabs/w:tab{w:pos=42}', Twips(24), {},
+         'w:pPr/w:tabs/(w:tab{w:pos=24,w:val=left},w:tab{w:pos=42})'),
+        ('w:pPr/w:tabs/w:tab{w:pos=42}', Twips(42), {},
+         'w:pPr/w:tabs/(w:tab{w:pos=42},w:tab{w:pos=42,w:val=left})'),
+    ])
+    def add_tab_fixture(self, request):
+        pPr_cxml, position, kwargs, expected_cxml = request.param
+        tab_stops = TabStops(element(pPr_cxml))
+        expected_xml = xml(expected_cxml)
+        return tab_stops, position, kwargs, expected_xml
+
     @pytest.fixture(params=[
         ('w:pPr/w:tabs/w:tab{w:pos=0}',                                 0),
         ('w:pPr/w:tabs/(w:tab{w:pos=1},w:tab{w:pos=2},w:tab{w:pos=3})', 1),
