acpt: add scenarios for _Row.height, .height_rule

revossen-asml · Steve Canny · commit 4d930576658c · 2016-10-29T09:11:16.000-07:00
diff --git a/docx/enum/table.py b/docx/enum/table.py
@@ -9,10 +9,42 @@
 )
 
 from .base import (
-    Enumeration, EnumMember, XmlEnumeration, XmlMappedEnumMember
+    alias, Enumeration, EnumMember, XmlEnumeration, XmlMappedEnumMember
 )
 
 
+@alias('WD_ROW_HEIGHT')
+class WD_ROW_HEIGHT_RULE(XmlEnumeration):
+    """
+    Specifies the rule for determining the height or a table row
+
+    Example::
+
+        from docx.enum.table import WD_ROW_HEIGHT_RULE
+
+        table = document.add_table(3, 3)
+        table.rows[0].height_rule = WD_ROW_HEIGHT_RULE.EXACTLY
+    """
+
+    __ms_name__ = "WdRowHeightRule"
+
+    __url__ = 'https://msdn.microsoft.com/en-us/library/office/ff193620.aspx'
+
+    __members__ = (
+        XmlMappedEnumMember(
+            'AUTO', 0, 'auto', 'The row height is adjusted to accommodate th'
+            'e tallest value in the row.'
+        ),
+        XmlMappedEnumMember(
+            'AT_LEAST', 1, 'atLeast', 'The row height is at least a minimum '
+            'specified value.'
+        ),
+        XmlMappedEnumMember(
+            'EXACTLY', 2, 'exact', 'The row height is an exact value.'
+        ),
+    )
+
+
 class WD_TABLE_ALIGNMENT(XmlEnumeration):
     """
     Specifies table justification type.
diff --git a/features/steps/table.py b/features/steps/table.py
@@ -11,7 +11,9 @@
 from behave import given, then, when
 
 from docx import Document
-from docx.enum.table import WD_TABLE_ALIGNMENT, WD_TABLE_DIRECTION
+from docx.enum.table import (
+    WD_ROW_HEIGHT_RULE, WD_TABLE_ALIGNMENT, WD_TABLE_DIRECTION
+)
 from docx.shared import Inches
 from docx.table import _Column, _Columns, _Row, _Rows
 
@@ -139,6 +141,31 @@ def given_a_table_having_two_rows(context):
     context.table_ = document.tables[0]
 
 
+@given('a table row having height of {state}')
+def given_a_table_row_having_height_of_state(context, state):
+    table_idx = {
+        'no explicit setting': 0,
+        '2 inches':            2,
+        '3 inches':            3
+    }[state]
+    document = Document(test_docx('tbl-props'))
+    table = document.tables[table_idx]
+    context.row = table.rows[0]
+
+
+@given('a table row having height rule {state}')
+def given_a_table_row_having_height_rule_state(context, state):
+    table_idx = {
+        'no explicit setting': 0,
+        'automatic':           1,
+        'at least':            2,
+        'exactly':             3
+    }[state]
+    document = Document(test_docx('tbl-props'))
+    table = document.tables[table_idx]
+    context.row = table.rows[0]
+
+
 # when =====================================================
 
 @when('I add a 1.0 inch column to the table')
@@ -152,6 +179,20 @@ def when_add_row_to_table(context):
     context.row = table.add_row()
 
 
+@when('I assign {value} to row.height')
+def when_I_assign_value_to_row_height(context, value):
+    new_value = None if value == 'None' else int(value)
+    context.row.height = new_value
+
+
+@when('I assign {value} to row.height_rule')
+def when_I_assign_value_to_row_height_rule(context, value):
+    new_value = (
+        None if value == 'None' else getattr(WD_ROW_HEIGHT_RULE, value)
+    )
+    context.row.height_rule = new_value
+
+
 @when('I assign {value_str} to table.alignment')
 def when_I_assign_value_to_table_alignment(context, value_str):
     value = {
@@ -266,6 +307,26 @@ def then_can_iterate_over_row_collection(context):
     assert actual_count == 2
 
 
+@then('row.height is {value}')
+def then_row_height_is_value(context, value):
+    expected_height = None if value == 'None' else int(value)
+    actual_height = context.row.height
+    assert actual_height == expected_height, (
+        'expected %s, got %s' % (expected_height, actual_height)
+    )
+
+
+@then('row.height_rule is {value}')
+def then_row_height_rule_is_value(context, value):
+    expected_rule = (
+        None if value == 'None' else getattr(WD_ROW_HEIGHT_RULE, value)
+    )
+    actual_rule = context.row.height_rule
+    assert actual_rule == expected_rule, (
+        'expected %s, got %s' % (expected_rule, actual_rule)
+    )
+
+
 @then('table.alignment is {value_str}')
 def then_table_alignment_is_value(context, value_str):
     value = {
diff --git a/features/steps/test_files/tbl-props.docx b/features/steps/test_files/tbl-props.docx
diff --git a/features/tbl-row-props.feature b/features/tbl-row-props.feature
@@ -0,0 +1,56 @@
+Feature: Get and set table row properties
+  In order to format a table row to my requirements
+  As a developer using python-docx
+  I need a way to get and set the properties of a table row
+
+
+  @wip
+  Scenario Outline: Get Row.height_rule
+    Given a table row having height rule <state>
+     Then row.height_rule is <value>
+
+    Examples: Row.height_rule value cases
+      | state               | value    |
+      | no explicit setting | None     |
+      | automatic           | AUTO     |
+      | at least            | AT_LEAST |
+
+
+  @wip
+  Scenario Outline: Set Row.height_rule
+    Given a table row having height rule <state>
+     When I assign <value> to row.height_rule
+     Then row.height_rule is <value>
+
+    Examples: Row.height_rule assignment cases
+      | state               | value    |
+      | no explicit setting | AUTO     |
+      | automatic           | AT_LEAST |
+      | at least            | None     |
+      | no explicit setting | None     |
+
+
+  @wip
+  Scenario Outline: Get Row.height
+    Given a table row having height of <state>
+     Then row.height is <value>
+
+    Examples: Row.height value cases
+      | state               | value   |
+      | no explicit setting | None    |
+      | 2 inches            | 1828800 |
+      | 3 inches            | 2743200 |
+
+
+  @wip
+  Scenario Outline: Set row height
+    Given a table row having height of <state>
+     When I assign <value> to row.height
+     Then row.height is <value>
+
+    Examples: Row.height assignment cases
+      | state               | value   |
+      | no explicit setting | 1828800 |
+      | 2 inches            | 2743200 |
+      | 3 inches            | None    |
+      | no explicit setting | None    |
