acpt: add scenarios for TabStop property getters

DKWoods · Steve Canny · commit ff5e5c240f4e · 2016-05-27T12:46:37.000-07:00
diff --git a/docs/api/enum/WdTabAlignment.rst b/docs/api/enum/WdTabAlignment.rst
@@ -0,0 +1,38 @@
+.. _WdTabAlignment:
+
+``WD_TAB_ALIGNMENT``
+====================
+
+Specifies the tab stop alignment to apply.
+
+----
+
+LEFT
+    Left-aligned.
+
+CENTER
+    Center-aligned.
+
+RIGHT
+    Right-aligned.
+
+DECIMAL
+    Decimal-aligned.
+
+BAR
+    Bar-aligned.
+
+LIST
+    List-aligned. (deprecated)
+
+CLEAR
+    Clear an inherited tab stop.
+
+END
+    Right-aligned.  (deprecated)
+
+NUM
+    Left-aligned.  (deprecated)
+
+START
+    Left-aligned.  (deprecated)
diff --git a/docs/api/enum/WdTabLeader.rst b/docs/api/enum/WdTabLeader.rst
@@ -0,0 +1,26 @@
+.. _WdTabLeader:
+
+``WD_TAB_LEADER``
+=================
+
+Specifies the character to use as the leader with formatted tabs.
+
+----
+
+SPACES
+    Spaces. Default.
+
+DOTS
+    Dots.
+
+DASHES
+    Dashes.
+
+LINES
+    Double lines.
+
+HEAVY
+    A heavy line.
+
+MIDDLE_DOT
+    A vertically-centered dot.
diff --git a/docs/api/enum/index.rst b/docs/api/enum/index.rst
@@ -15,8 +15,10 @@ can be found here:
    WdColorIndex
    WdLineSpacing
    WdOrientation
+   WdRowAlignment
    WdSectionStart
    WdStyleType
-   WdRowAlignment
+   WdTabAlignment
+   WdTabLeader
    WdTableDirection
    WdUnderline
diff --git a/docx/enum/text.py b/docx/enum/text.py
@@ -195,6 +195,80 @@ class WD_LINE_SPACING(XmlEnumeration):
     )
 
 
+class WD_TAB_ALIGNMENT(XmlEnumeration):
+    """
+    Specifies the tab stop alignment to apply.
+    """
+
+    __ms_name__ = 'WdTabAlignment'
+
+    __url__ = 'https://msdn.microsoft.com/EN-US/library/office/ff195609.aspx'
+
+    __members__ = (
+        XmlMappedEnumMember(
+            'LEFT', 0, 'left', 'Left-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'CENTER', 1, 'center', 'Center-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'RIGHT', 2, 'right', 'Right-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'DECIMAL', 3, 'decimal', 'Decimal-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'BAR', 4, 'bar', 'Bar-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'LIST', 6, 'list', 'List-aligned. (deprecated)'
+        ),
+        XmlMappedEnumMember(
+            'CLEAR', 101, 'clear', 'Clear an inherited tab stop.'
+        ),
+        XmlMappedEnumMember(
+            'END', 102, 'end', 'Right-aligned.  (deprecated)'
+        ),
+        XmlMappedEnumMember(
+            'NUM', 103, 'num', 'Left-aligned.  (deprecated)'
+        ),
+        XmlMappedEnumMember(
+            'START', 104, 'start', 'Left-aligned.  (deprecated)'
+        ),
+    )
+
+
+class WD_TAB_LEADER(XmlEnumeration):
+    """
+    Specifies the character to use as the leader with formatted tabs.
+    """
+
+    __ms_name__ = 'WdTabLeader'
+
+    __url__ = 'https://msdn.microsoft.com/en-us/library/office/ff845050.aspx'
+
+    __members__ = (
+        XmlMappedEnumMember(
+            'SPACES', 0, 'none', 'Spaces. Default.'
+        ),
+        XmlMappedEnumMember(
+            'DOTS', 1, 'dot', 'Dots.'
+        ),
+        XmlMappedEnumMember(
+            'DASHES', 2, 'hyphen', 'Dashes.'
+        ),
+        XmlMappedEnumMember(
+            'LINES', 3, 'underscore', 'Double lines.'
+        ),
+        XmlMappedEnumMember(
+            'HEAVY', 4, 'heavy', 'A heavy line.'
+        ),
+        XmlMappedEnumMember(
+            'MIDDLE_DOT', 5, 'middleDot', 'A vertically-centered dot.'
+        ),
+    )
+
+
 class WD_UNDERLINE(XmlEnumeration):
     """
     Specifies the style of underline applied to a run of characters.
diff --git a/features/steps/tabstops.py b/features/steps/tabstops.py
@@ -7,6 +7,7 @@
 from behave import given, then
 
 from docx import Document
+from docx.enum.text import WD_TAB_ALIGNMENT, WD_TAB_LEADER
 from docx.text.tabstops import TabStop
 
 from helpers import test_docx
@@ -22,6 +23,30 @@ def given_a_tab_stops_having_count_tab_stops(context, count):
     context.tab_stops = paragraph_format.tab_stops
 
 
+@given('a tab stop 0.5 inches {in_or_out} from the paragraph left edge')
+def given_a_tab_stop_inches_from_paragraph_left_edge(context, in_or_out):
+    tab_idx = {'out': 0, 'in': 1}[in_or_out]
+    document = Document(test_docx('tab-stops'))
+    paragraph_format = document.paragraphs[2].paragraph_format
+    context.tab_stop = paragraph_format.tab_stops[tab_idx]
+
+
+@given('a tab stop having {alignment} alignment')
+def given_a_tab_stop_having_alignment_alignment(context, alignment):
+    tab_idx = {'LEFT': 0, 'CENTER': 1, 'RIGHT': 2}[alignment]
+    document = Document(test_docx('tab-stops'))
+    paragraph_format = document.paragraphs[1].paragraph_format
+    context.tab_stop = paragraph_format.tab_stops[tab_idx]
+
+
+@given('a tab stop having {leader} leader')
+def given_a_tab_stop_having_leader_leader(context, leader):
+    tab_idx = {'no specified': 0, 'a dotted': 2}[leader]
+    document = Document(test_docx('tab-stops'))
+    paragraph_format = document.paragraphs[1].paragraph_format
+    context.tab_stop = paragraph_format.tab_stops[tab_idx]
+
+
 # then =====================================================
 
 @then('I can access a tab stop by index')
@@ -43,3 +68,23 @@ def then_I_can_iterate_the_TabStops_object(context):
 def then_len_tab_stops_is_count(context, count):
     tab_stops = context.tab_stops
     assert len(tab_stops) == int(count)
+
+
+@then('tab_stop.alignment is {alignment}')
+def then_tab_stop_alignment_is_alignment(context, alignment):
+    expected_value = getattr(WD_TAB_ALIGNMENT, alignment)
+    tab_stop = context.tab_stop
+    assert tab_stop.alignment == expected_value
+
+
+@then('tab_stop.leader is {leader}')
+def then_tab_stop_leader_is_leader(context, leader):
+    expected_value = getattr(WD_TAB_LEADER, leader)
+    tab_stop = context.tab_stop
+    assert tab_stop.leader == expected_value
+
+
+@then('tab_stop.position is {position}')
+def then_tab_stop_position_is_position(context, position):
+    tab_stop = context.tab_stop
+    assert tab_stop.position == int(position)
diff --git a/features/steps/test_files/tab-stops.docx b/features/steps/test_files/tab-stops.docx
diff --git a/features/tab-tabstop-props.feature b/features/tab-tabstop-props.feature
@@ -0,0 +1,37 @@
+Feature: Tab stop properties
+  To change the properties of an individual tab stop
+  As a developer using python-docx
+  I need a set of read/write properties on TabStop
+
+
+  @wip
+  Scenario Outline: Get TabStop.position
+    Given a tab stop 0.5 inches <in-or-out> from the paragraph left edge
+     Then tab_stop.position is <position>
+
+    Examples: tab stop positions
+      | in-or-out | position |
+      |    in     |  457200  |
+      |    out    | -457200  |
+
+
+  @wip
+  Scenario Outline: Get TabStop.alignment
+    Given a tab stop having <alignment> alignment
+     Then tab_stop.alignment is <alignment>
+
+    Examples: tab stop alignments
+      | alignment |
+      | LEFT      |
+      | RIGHT     |
+
+
+  @wip
+  Scenario Outline: Get TabStop.leader
+    Given a tab stop having <leader> leader
+     Then tab_stop.leader is <value>
+
+    Examples: tab stop leaders
+      | leader       | value  |
+      | no specified | SPACES |
+      | a dotted     | DOTS   |
