tabs: add TabStops.__len__()

DKWoods · Steve Canny · commit d0bd28edb58e · 2016-05-25T18:53:12.000-07:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -181,7 +181,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 from .text.paragraph import CT_P
 register_element_cls('w:p', CT_P)
 
-from .text.parfmt import CT_Ind, CT_Jc, CT_PPr, CT_Spacing
+from .text.parfmt import CT_Ind, CT_Jc, CT_PPr, CT_Spacing, CT_TabStops
 register_element_cls('w:ind',             CT_Ind)
 register_element_cls('w:jc',              CT_Jc)
 register_element_cls('w:keepLines',       CT_OnOff)
@@ -190,6 +190,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:pPr',             CT_PPr)
 register_element_cls('w:pStyle',          CT_String)
 register_element_cls('w:spacing',         CT_Spacing)
+register_element_cls('w:tabs',            CT_TabStops)
 register_element_cls('w:widowControl',    CT_OnOff)
 
 from .text.run import CT_Br, CT_R, CT_Text
diff --git a/docx/oxml/text/parfmt.py b/docx/oxml/text/parfmt.py
@@ -8,7 +8,8 @@
 from ...shared import Length
 from ..simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
 from ..xmlchemy import (
-    BaseOxmlElement, OptionalAttribute, RequiredAttribute, ZeroOrOne
+    BaseOxmlElement, OneOrMore, OptionalAttribute, RequiredAttribute,
+    ZeroOrOne
 )
 
 
@@ -50,6 +51,7 @@ class CT_PPr(BaseOxmlElement):
     pageBreakBefore = ZeroOrOne('w:pageBreakBefore', successors=_tag_seq[4:])
     widowControl = ZeroOrOne('w:widowControl', successors=_tag_seq[6:])
     numPr = ZeroOrOne('w:numPr', successors=_tag_seq[7:])
+    tabs = ZeroOrOne('w:tabs', successors=_tag_seq[11:])
     spacing = ZeroOrOne('w:spacing', successors=_tag_seq[22:])
     ind = ZeroOrOne('w:ind', successors=_tag_seq[23:])
     jc = ZeroOrOne('w:jc', successors=_tag_seq[27:])
@@ -311,3 +313,10 @@ class CT_Spacing(BaseOxmlElement):
     before = OptionalAttribute('w:before', ST_TwipsMeasure)
     line = OptionalAttribute('w:line', ST_SignedTwipsMeasure)
     lineRule = OptionalAttribute('w:lineRule', WD_LINE_SPACING)
+
+
+class CT_TabStops(BaseOxmlElement):
+    """
+    ``<w:tabs>`` element, container for a sorted sequence of tab stops.
+    """
+    tab = OneOrMore('w:tab', successors=())
diff --git a/docx/text/tabstops.py b/docx/text/tabstops.py
@@ -25,6 +25,12 @@ def __init__(self, element):
         super(TabStops, self).__init__(element, None)
         self._pPr = element
 
+    def __len__(self):
+        tabs = self._pPr.tabs
+        if tabs is None:
+            return 0
+        return len(tabs.tab_lst)
+
 
 class TabStop(ElementProxy):
     """
diff --git a/features/tab-access-tabs.feature b/features/tab-access-tabs.feature
@@ -4,7 +4,6 @@ Feature: Access TabStop objects
   I need methods to create, access, and remove a tab stop
 
 
-  @wip
   Scenario Outline: TabStops.__len__
     Given a tab_stops having <count> tab stops
      Then len(tab_stops) is <count>
diff --git a/tests/text/test_tabstops.py b/tests/text/test_tabstops.py
@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+"""
+Test suite for the docx.text.tabstops module, containing the TabStops and
+TabStop objects.
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from docx.text.tabstops import TabStops
+
+import pytest
+
+from ..unitutil.cxml import element
+
+
+class DescribeTabStops(object):
+
+    def it_knows_its_length(self, len_fixture):
+        tab_stops, expected_value = len_fixture
+        assert len(tab_stops) == expected_value
+
+    # fixture --------------------------------------------------------
+
+    @pytest.fixture(params=[
+        ('w:pPr',                          0),
+        ('w:pPr/w:tabs/w:tab{w:pos=2880}', 1),
+    ])
+    def len_fixture(self, request):
+        tab_stops_cxml, expected_value = request.param
+        tab_stops = TabStops(element(tab_stops_cxml))
+        return tab_stops, expected_value
