run: add Run.add_tab()

Frank Battaglia · Steve Canny · commit 0fc52d4d64c0 · 2014-06-25T01:31:42.000-07:00
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -125,6 +125,7 @@ class CT_R(BaseOxmlElement):
     rPr = ZeroOrOne('w:rPr')
     t = ZeroOrMore('w:t')
     br = ZeroOrMore('w:br')
+    tab = ZeroOrMore('w:tab')
     drawing = ZeroOrMore('w:drawing')
 
     def _insert_rPr(self, rPr):
diff --git a/docx/text.py b/docx/text.py
@@ -151,6 +151,13 @@ def add_break(self, break_type=WD_BREAK.LINE):
         if clear is not None:
             br.clear = clear
 
+    def add_tab(self):
+        """
+        Add a ``<w:tab/>`` element at the end of the run, which Word
+        interprets as a tab character.
+        """
+        self._r._add_tab()
+
     def add_text(self, text):
         """
         Add a text element to this run.
diff --git a/features/run-add-content.feature b/features/run-add-content.feature
@@ -4,7 +4,6 @@ Feature: Add content to a run
   I need a way to add each of the run content elements to a run
 
 
-  @wip
   Scenario: Add a tab
     Given a run
      When I add a tab
diff --git a/tests/oxml/unitdata/text.py b/tests/oxml/unitdata/text.py
@@ -14,6 +14,15 @@ class CT_BrBuilder(BaseBuilder):
     __attrs__ = ('w:type', 'w:clear')
 
 
+class CT_EmptyBuilder(BaseBuilder):
+    __nspfxs__ = ('w',)
+    __attrs__ = ()
+
+    def __init__(self, tag):
+        self.__tag__ = tag
+        super(CT_EmptyBuilder, self).__init__()
+
+
 class CT_PBuilder(BaseBuilder):
     __tag__ = 'w:p'
     __nspfxs__ = ('w',)
@@ -110,6 +119,10 @@ def a_strike():
     return CT_OnOffBuilder('w:strike')
 
 
+def a_tab():
+    return CT_EmptyBuilder('w:tab')
+
+
 def a_vanish():
     return CT_OnOffBuilder('w:vanish')
 
diff --git a/tests/test_text.py b/tests/test_text.py
@@ -19,9 +19,9 @@
 from .oxml.parts.unitdata.document import a_body
 from .oxml.unitdata.text import (
     a_b, a_bCs, a_br, a_caps, a_cs, a_dstrike, a_p, a_pPr, a_pStyle,
-    a_shadow, a_smallCaps, a_snapToGrid, a_specVanish, a_strike, a_t, a_u,
-    a_vanish, a_webHidden, an_emboss, an_i, an_iCs, an_imprint, an_oMath,
-    a_noProof, an_outline, an_r, an_rPr, an_rStyle, an_rtl
+    a_shadow, a_smallCaps, a_snapToGrid, a_specVanish, a_strike, a_t, a_tab,
+    a_u, a_vanish, a_webHidden, an_emboss, an_i, an_iCs, an_imprint,
+    an_oMath, a_noProof, an_outline, an_r, an_rPr, an_rStyle, an_rtl
 )
 from .unitutil import call, class_mock, instance_mock, Mock
 
@@ -207,6 +207,11 @@ def it_can_add_a_break(self, add_break_fixture):
         run.add_break(break_type)
         assert run._r.xml == expected_xml
 
+    def it_can_add_a_tab(self, add_tab_fixture):
+        run, expected_xml = add_tab_fixture
+        run.add_tab()
+        assert run._r.xml == expected_xml
+
     def it_knows_the_text_it_contains(self, text_prop_fixture):
         run, expected_text = text_prop_fixture
         assert run.text == expected_text
@@ -241,6 +246,11 @@ def add_break_fixture(self, request, run):
         expected_xml = an_r().with_nsdecls().with_child(br_bldr).xml()
         return run, break_type, expected_xml
 
+    @pytest.fixture
+    def add_tab_fixture(self, run):
+        expected_xml = an_r().with_nsdecls().with_child(a_tab()).xml()
+        return run, expected_xml
+
     @pytest.fixture(params=['foobar', ' foo bar', 'bar foo '])
     def add_text_fixture(self, request, run, Text_):
         text_str = request.param
