acpt: add run-enum-props.feature

Steve Canny · Steve Canny · commit 7b40ab329fe3 · 2014-05-09T01:43:01.000-07:00
Add scenario outline to test Run.underline getter at API level.
diff --git a/docx/enum/text.py b/docx/enum/text.py
@@ -25,3 +25,28 @@ class WD_BREAK_TYPE(object):
     TEXT_WRAPPING = 11
 
 WD_BREAK = WD_BREAK_TYPE
+
+
+class WD_UNDERLINE(object):
+    """
+    Corresponds to WdUnderline enumeration
+    http://msdn.microsoft.com/en-us/library/office/ff822388.aspx
+    """
+    NONE = 0
+    SINGLE = 1
+    WORDS = 2
+    DOUBLE = 3
+    DOTTED = 4
+    THICK = 6
+    DASH = 7
+    DOT_DASH = 9
+    DOT_DOT_DASH = 10
+    WAVY = 11
+    DOTTED_HEAVY = 20
+    DASH_HEAVY = 23
+    DOT_DASH_HEAVY = 25
+    DOT_DOT_DASH_HEAVY = 26
+    WAVY_HEAVY = 27
+    DASH_LONG = 39
+    WAVY_DOUBLE = 43
+    DASH_LONG_HEAVY = 55
diff --git a/features/run-enum-props.feature b/features/run-enum-props.feature
@@ -0,0 +1,17 @@
+Feature: Query or apply enumerated run property
+  In order to query or change an enumerated font property of a word or phrase
+  As a python-docx developer
+  I need a way to query and set the enumerated properties on a run
+
+
+  @wip
+  Scenario Outline: Get underline value of a run
+    Given a run having <underline-type> underline
+     Then the run underline property value is <underline-value>
+
+    Examples: underline property values
+      | underline-type | underline-value     |
+      | inherited      | None                |
+      | no             | False               |
+      | single         | True                |
+      | double         | WD_UNDERLINE.DOUBLE |
diff --git a/features/steps/test_files/run-enumerated-props.docx b/features/steps/test_files/run-enumerated-props.docx
diff --git a/features/steps/text.py b/features/steps/text.py
@@ -9,7 +9,7 @@
 from behave import given, then, when
 
 from docx import Document
-from docx.enum.text import WD_BREAK
+from docx.enum.text import WD_BREAK, WD_UNDERLINE
 from docx.oxml.shared import qn
 
 from .helpers import test_docx, test_text
@@ -30,6 +30,15 @@ def given_a_run_having_bool_prop_set_on(context, bool_prop_name):
     context.run = run
 
 
+@given('a run having {underline_type} underline')
+def given_a_run_having_underline_type(context, underline_type):
+    run_idx = {
+        'inherited': 0, 'no': 1, 'single': 2, 'double': 3
+    }[underline_type]
+    document = Document(test_docx('run-enumerated-props'))
+    context.run = document.paragraphs[0].runs[run_idx]
+
+
 @given('a run having style {char_style}')
 def given_a_run_having_style_char_style(context, char_style):
     run_idx = {
@@ -137,6 +146,15 @@ def then_the_run_contains_the_text_I_specified(context):
     assert context.run.text == test_text
 
 
+@then('the run underline property value is {underline_value}')
+def then_the_run_underline_property_value_is(context, underline_value):
+    expected_value = {
+        'None': None, 'False': False, 'True': True,
+        'WD_UNDERLINE.DOUBLE': WD_UNDERLINE.DOUBLE
+    }[underline_value]
+    assert context.run.underline == expected_value
+
+
 @then('the style of the run is {char_style}')
 def then_the_style_of_the_run_is_char_style(context, char_style):
     expected_value = {
