tabs: add TabStops.__iter__()

DKWoods · Steve Canny · commit 1bcdf4aaca37 · 2016-05-25T18:59:32.000-07:00
diff --git a/docx/text/tabstops.py b/docx/text/tabstops.py
@@ -25,6 +25,16 @@ def __init__(self, element):
         super(TabStops, self).__init__(element, None)
         self._pPr = element
 
+    def __iter__(self):
+        """
+        Generate a TabStop object for each of the w:tab elements, in XML
+        document order.
+        """
+        tabs = self._pPr.tabs
+        if tabs is not None:
+            for tab in tabs.tab_lst:
+                yield TabStop(tab)
+
     def __len__(self):
         tabs = self._pPr.tabs
         if tabs is None:
diff --git a/tests/text/test_tabstops.py b/tests/text/test_tabstops.py
@@ -9,11 +9,12 @@
     absolute_import, division, print_function, unicode_literals
 )
 
-from docx.text.tabstops import TabStops
+from docx.text.tabstops import TabStop, TabStops
 
 import pytest
 
 from ..unitutil.cxml import element
+from ..unitutil.mock import call, class_mock, instance_mock
 
 
 class DescribeTabStops(object):
@@ -22,8 +23,32 @@ def it_knows_its_length(self, len_fixture):
         tab_stops, expected_value = len_fixture
         assert len(tab_stops) == expected_value
 
+    def it_can_iterate_over_its_tab_stops(self, iter_fixture):
+        tab_stops, expected_count, tab_stop_, TabStop_, expected_calls = (
+            iter_fixture
+        )
+        count = 0
+        for tab_stop in tab_stops:
+            assert tab_stop is tab_stop_
+            count += 1
+        assert count == expected_count
+        assert TabStop_.call_args_list == expected_calls
+
     # fixture --------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:pPr',                                              0),
+        ('w:pPr/w:tabs/w:tab{w:pos=2880}',                     1),
+        ('w:pPr/w:tabs/(w:tab{w:pos=2880},w:tab{w:pos=5760})', 2),
+    ])
+    def iter_fixture(self, request, TabStop_, tab_stop_):
+        pPr_cxml, expected_count = request.param
+        pPr = element(pPr_cxml)
+        tab_elms = pPr.xpath('//w:tab')
+        tab_stops = TabStops(pPr)
+        expected_calls = [call(tab) for tab in tab_elms]
+        return tab_stops, expected_count, tab_stop_, TabStop_, expected_calls
+
     @pytest.fixture(params=[
         ('w:pPr',                          0),
         ('w:pPr/w:tabs/w:tab{w:pos=2880}', 1),
@@ -32,3 +57,15 @@ def len_fixture(self, request):
         tab_stops_cxml, expected_value = request.param
         tab_stops = TabStops(element(tab_stops_cxml))
         return tab_stops, expected_value
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def TabStop_(self, request, tab_stop_):
+        return class_mock(
+            request, 'docx.text.tabstops.TabStop', return_value=tab_stop_
+        )
+
+    @pytest.fixture
+    def tab_stop_(self, request):
+        return instance_mock(request, TabStop)
