style: add Styles.__iter__()

Steve Canny · Steve Canny · commit d76d47c42558 · 2015-02-08T00:00:54.000-08:00
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -11,6 +11,14 @@
 from ..shared import ElementProxy
 
 
+def StyleFactory(style_elm):
+    """
+    Return a style object of the appropriate |_BaseStyle| subclass, according
+    to it style type.
+    """
+    raise NotImplementedError
+
+
 class BaseStyle(ElementProxy):
     """
     Base class for the various types of style object, paragraph, character,
diff --git a/docx/styles/styles.py b/docx/styles/styles.py
@@ -9,6 +9,7 @@
 )
 
 from ..shared import ElementProxy
+from .style import StyleFactory
 
 
 class Styles(ElementProxy):
@@ -20,5 +21,8 @@ class Styles(ElementProxy):
 
     __slots__ = ()
 
+    def __iter__(self):
+        return (StyleFactory(style) for style in self._element.style_lst)
+
     def __len__(self):
         return len(self._element.style_lst)
diff --git a/tests/styles/test_styles.py b/tests/styles/test_styles.py
@@ -10,9 +10,11 @@
 
 import pytest
 
+from docx.styles.style import BaseStyle
 from docx.styles.styles import Styles
 
 from ..unitutil.cxml import element
+from ..unitutil.mock import call, function_mock, instance_mock
 
 
 class DescribeStyles(object):
@@ -21,8 +23,33 @@ def it_knows_its_length(self, len_fixture):
         styles, expected_value = len_fixture
         assert len(styles) == expected_value
 
+    def it_can_iterate_over_its_styles(self, iter_fixture):
+        styles, expected_count, style_, StyleFactory_, expected_calls = (
+            iter_fixture
+        )
+        count = 0
+        for style in styles:
+            assert style is style_
+            count += 1
+        assert count == expected_count
+        assert StyleFactory_.call_args_list == expected_calls
+
     # fixture --------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:styles',                           0),
+        ('w:styles/w:style',                   1),
+        ('w:styles/(w:style,w:style)',         2),
+        ('w:styles/(w:style,w:style,w:style)', 3),
+    ])
+    def iter_fixture(self, request, StyleFactory_, style_):
+        styles_cxml, expected_count = request.param
+        styles_elm = element(styles_cxml)
+        styles = Styles(styles_elm)
+        expected_calls = [call(style_elm) for style_elm in styles_elm]
+        StyleFactory_.return_value = style_
+        return styles, expected_count, style_, StyleFactory_, expected_calls
+
     @pytest.fixture(params=[
         ('w:styles',                           0),
         ('w:styles/w:style',                   1),
@@ -33,3 +60,13 @@ def len_fixture(self, request):
         styles_cxml, expected_value = request.param
         styles = Styles(element(styles_cxml))
         return styles, expected_value
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def style_(self, request):
+        return instance_mock(request, BaseStyle)
+
+    @pytest.fixture
+    def StyleFactory_(self, request):
+        return function_mock(request, 'docx.styles.styles.StyleFactory')
