acpt: add scenarios for tab stop access

DKWoods · Steve Canny · commit a72300617f12 · 2016-05-25T18:50:14.000-07:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -169,6 +169,10 @@
 
 .. |_TableStyle| replace:: :class:`._TableStyle`
 
+.. |TabStop| replace:: :class:`.TabStop`
+
+.. |TabStops| replace:: :class:`.TabStops`
+
 .. |_Text| replace:: :class:`._Text`
 
 .. |True| replace:: :class:`True`
diff --git a/docx/text/tabstops.py b/docx/text/tabstops.py
@@ -24,3 +24,16 @@ class TabStops(ElementProxy):
     def __init__(self, element):
         super(TabStops, self).__init__(element, None)
         self._pPr = element
+
+
+class TabStop(ElementProxy):
+    """
+    An individual tab stop applying to a paragraph or style. Each of these is
+    a member of a set held in a |TabStops| object.
+    """
+
+    __slots__ = ('_tab')
+
+    def __init__(self, element):
+        super(TabStop, self).__init__(element, None)
+        self._tab = element
diff --git a/features/steps/tabstops.py b/features/steps/tabstops.py
@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+"""
+Step implementations for paragraph-related features
+"""
+
+from behave import given, then
+
+from docx import Document
+from docx.text.tabstops import TabStop
+
+from helpers import test_docx
+
+
+# given ===================================================
+
+@given('a tab_stops having {count} tab stops')
+def given_a_tab_stops_having_count_tab_stops(context, count):
+    paragraph_idx = {'0': 0, '3': 1}[count]
+    document = Document(test_docx('tab-stops'))
+    paragraph_format = document.paragraphs[paragraph_idx].paragraph_format
+    context.tab_stops = paragraph_format.tab_stops
+
+
+# then =====================================================
+
+@then('I can access a tab stop by index')
+def then_I_can_access_a_tab_stop_by_index(context):
+    tab_stops = context.tab_stops
+    for idx in range(3):
+        tab_stop = tab_stops[idx]
+        assert isinstance(tab_stop, TabStop)
+
+
+@then('I can iterate the TabStops object')
+def then_I_can_iterate_the_TabStops_object(context):
+    items = [ts for ts in context.tab_stops]
+    assert len(items) == 3
+    assert all(isinstance(item, TabStop) for item in items)
+
+
+@then('len(tab_stops) is {count}')
+def then_len_tab_stops_is_count(context, count):
+    tab_stops = context.tab_stops
+    assert len(tab_stops) == int(count)
diff --git a/features/tab-access-tabs.feature b/features/tab-access-tabs.feature
@@ -0,0 +1,22 @@
+Feature: Access TabStop objects
+  In order to interact with an individual tab stop for a paragraph or style
+  As a developer using python-docx
+  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>
+
+    Examples: tab_stop counts
+      | count |
+      |   0   |
+      |   3   |
+
+
+  @wip
+  Scenario: Access an existing TabStop object
+    Given a tab_stops having 3 tab stops
+     Then I can iterate the TabStops object
+      And I can access a tab stop by index
