acpt: add scenarios for cell access

apteryks · Steve Canny · commit 210d7f124dcf · 2014-11-28T21:21:45.000-05:00
* refactor tbl-item-access to remove cell access scenarios
diff --git a/features/steps/table.py b/features/steps/table.py
@@ -10,9 +10,7 @@
 
 from docx import Document
 from docx.shared import Inches
-from docx.table import (
-    _Cell, _Column, _ColumnCells, _Columns, _Row, _RowCells, _Rows
-)
+from docx.table import _Column, _Columns, _Row, _Rows
 
 from helpers import test_docx
 
@@ -24,11 +22,16 @@ def given_a_2x2_table(context):
     context.table_ = Document().add_table(rows=2, cols=2)
 
 
-@given('a column cell collection having two cells')
-def given_a_column_cell_collection_having_two_cells(context):
-    docx_path = test_docx('blk-containing-table')
-    document = Document(docx_path)
-    context.cells = document.tables[0].columns[0].cells
+@given('a 3x3 table having {span_state}')
+def given_a_3x3_table_having_span_state(context, span_state):
+    table_idx = {
+        'only uniform cells': 0,
+        'a horizontal span':  1,
+        'a vertical span':    2,
+        'a combined span':    3,
+    }[span_state]
+    document = Document(test_docx('tbl-cell-access'))
+    context.table_ = document.tables[table_idx]
 
 
 @given('a column collection having two columns')
@@ -38,13 +41,6 @@ def given_a_column_collection_having_two_columns(context):
     context.columns = document.tables[0].columns
 
 
-@given('a row cell collection having two cells')
-def given_a_row_cell_collection_having_two_cells(context):
-    docx_path = test_docx('blk-containing-table')
-    document = Document(docx_path)
-    context.cells = document.tables[0].rows[0].cells
-
-
 @given('a row collection having two rows')
 def given_a_row_collection_having_two_rows(context):
     docx_path = test_docx('blk-containing-table')
@@ -111,20 +107,6 @@ def given_a_table_having_two_rows(context):
     context.table_ = document.tables[0]
 
 
-@given('a table column having two cells')
-def given_a_table_column_having_two_cells(context):
-    docx_path = test_docx('blk-containing-table')
-    document = Document(docx_path)
-    context.column = document.tables[0].columns[0]
-
-
-@given('a table row having two cells')
-def given_a_table_row_having_two_cells(context):
-    docx_path = test_docx('blk-containing-table')
-    document = Document(docx_path)
-    context.row = document.tables[0].rows[0]
-
-
 # when =====================================================
 
 @when('I add a column to the table')
@@ -166,15 +148,6 @@ def when_I_set_the_table_autofit_to_setting(context, setting):
 
 # then =====================================================
 
-@then('I can access a cell using its row and column indices')
-def then_can_access_cell_using_its_row_and_col_indices(context):
-    table = context.table_
-    for row_idx in range(2):
-        for col_idx in range(2):
-            cell = table.cell(row_idx, col_idx)
-            assert isinstance(cell, _Cell)
-
-
 @then('I can access a collection column by index')
 def then_can_access_collection_column_by_index(context):
     columns = context.columns
@@ -191,36 +164,6 @@ def then_can_access_collection_row_by_index(context):
         assert isinstance(row, _Row)
 
 
-@then('I can access a column cell by index')
-def then_can_access_column_cell_by_index(context):
-    cells = context.cells
-    for idx in range(2):
-        cell = cells[idx]
-        assert isinstance(cell, _Cell)
-
-
-@then('I can access a row cell by index')
-def then_can_access_row_cell_by_index(context):
-    cells = context.cells
-    for idx in range(2):
-        cell = cells[idx]
-        assert isinstance(cell, _Cell)
-
-
-@then('I can access the cell collection of the column')
-def then_can_access_cell_collection_of_column(context):
-    column = context.column
-    cells = column.cells
-    assert isinstance(cells, _ColumnCells)
-
-
-@then('I can access the cell collection of the row')
-def then_can_access_cell_collection_of_row(context):
-    row = context.row
-    cells = row.cells
-    assert isinstance(cells, _RowCells)
-
-
 @then('I can access the column collection of the table')
 def then_can_access_column_collection_of_table(context):
     table = context.table_
@@ -235,37 +178,13 @@ def then_can_access_row_collection_of_table(context):
     assert isinstance(rows, _Rows)
 
 
-@then('I can get the length of the column cell collection')
-def then_can_get_length_of_column_cell_collection(context):
-    column = context.column
-    cells = column.cells
-    assert len(cells) == 2
-
-
-@then('I can get the length of the row cell collection')
-def then_can_get_length_of_row_cell_collection(context):
-    row = context.row
-    cells = row.cells
-    assert len(cells) == 2
-
-
 @then('I can get the table style name')
 def then_can_get_table_style_name(context):
     table = context.table_
     msg = "got '%s'" % table.style
     assert table.style == 'LightShading-Accent1', msg
 
 
-@then('I can iterate over the column cells')
-def then_can_iterate_over_the_column_cells(context):
-    cells = context.cells
-    actual_count = 0
-    for cell in cells:
-        actual_count += 1
-        assert isinstance(cell, _Cell)
-    assert actual_count == 2
-
-
 @then('I can iterate over the column collection')
 def then_can_iterate_over_column_collection(context):
     columns = context.columns
@@ -276,16 +195,6 @@ def then_can_iterate_over_column_collection(context):
     assert actual_count == 2
 
 
-@then('I can iterate over the row cells')
-def then_can_iterate_over_the_row_cells(context):
-    cells = context.cells
-    actual_count = 0
-    for cell in cells:
-        actual_count += 1
-        assert isinstance(cell, _Cell)
-    assert actual_count == 2
-
-
 @then('I can iterate over the row collection')
 def then_can_iterate_over_row_collection(context):
     rows = context.rows
@@ -296,6 +205,21 @@ def then_can_iterate_over_row_collection(context):
     assert actual_count == 2
 
 
+@then('table.cell({row}, {col}).text is {expected_text}')
+def then_table_cell_row_col_text_is_text(context, row, col, expected_text):
+    table = context.table_
+    row_idx, col_idx = int(row), int(col)
+    cell_text = table.cell(row_idx, col_idx).text
+    assert cell_text == expected_text, 'got %s' % cell_text
+
+
+@then('the column cells text is {expected_text}')
+def then_the_column_cells_text_is_expected_text(context, expected_text):
+    table = context.table_
+    cells_text = ' '.join(c.text for col in table.columns for c in col.cells)
+    assert cells_text == expected_text, 'got %s' % cells_text
+
+
 @then('the length of the column collection is 2')
 def then_len_of_column_collection_is_2(context):
     columns = context.table_.columns
@@ -342,6 +266,13 @@ def then_the_reported_width_of_the_cell_is_width(context, width):
     )
 
 
+@then('the row cells text is {expected_text}')
+def then_the_row_cells_text_is_expected_text(context, expected_text):
+    table = context.table_
+    cells_text = ' '.join(c.text for row in table.rows for c in row.cells)
+    assert cells_text == expected_text, 'got %s' % cells_text
+
+
 @then('the table style matches the name I applied')
 def then_table_style_matches_name_applied(context):
     table = context.table_
diff --git a/features/steps/test_files/tbl-cell-access.docx b/features/steps/test_files/tbl-cell-access.docx
diff --git a/features/tbl-cell-access.feature b/features/tbl-cell-access.feature
@@ -0,0 +1,42 @@
+Feature: Access table cells
+  In order to access individual cells in a table
+  As a developer using python-docx
+  I need a way to access a cell from a table, row, or column
+
+  @wip
+  Scenario Outline: Access cell sequence of a row
+     Given a 3x3 table having <span-state>
+      Then the row cells text is <expected-text>
+
+    Examples: Reported row cell contents
+      | span-state         | expected-text     |
+      | only uniform cells | 1 2 3 4 5 6 7 8 9 |
+      | a horizontal span  | 1 2 3 4 4 6 7 8 9 |
+      | a vertical span    | 1 2 3 4 5 6 7 5 9 |
+      | a combined span    | 1 2 3 4 4 6 4 4 9 |
+
+
+  @wip
+  Scenario Outline: Access cell sequence of a column
+     Given a 3x3 table having <span-state>
+      Then the column cells text is <expected-text>
+
+    Examples: Reported column cell contents
+      | span-state         | expected-text     |
+      | only uniform cells | 1 4 7 2 5 8 3 6 9 |
+      | a horizontal span  | 1 4 7 2 4 8 3 6 9 |
+      | a vertical span    | 1 4 7 2 5 5 3 6 9 |
+      | a combined span    | 1 4 4 2 4 4 3 6 9 |
+
+
+  @wip
+  Scenario Outline: Access cell by row and column index
+     Given a 3x3 table having <span-state>
+      Then table.cell(<row>, <col>).text is <expected-text>
+
+    Examples: Reported cell text
+      | span-state         | row | col | expected-text |
+      | only uniform cells |  1  |  1  |       5       |
+      | a horizontal span  |  1  |  1  |       4       |
+      | a vertical span    |  2  |  1  |       5       |
+      | a combined span    |  2  |  1  |       4       |
diff --git a/features/tbl-item-access.feature b/features/tbl-item-access.feature
@@ -1,7 +1,7 @@
-Feature: Access table rows, columns, and cells
+Feature: Access table rows and columns
   In order to query and modify individual table items
-  As an python-docx developer
-  I need the ability to access table rows, columns, and cells
+  As a developer using python-docx
+  I need the ability to access table rows and columns
 
   Scenario: Access table row collection
      Given a table having two rows
@@ -22,27 +22,3 @@ Feature: Access table rows, columns, and cells
      Given a column collection having two columns
       Then I can iterate over the column collection
        And I can access a collection column by index
-
-  Scenario: Access cell collection of table column
-     Given a table column having two cells
-      Then I can access the cell collection of the column
-       And I can get the length of the column cell collection
-
-  Scenario: Access cell collection of table row
-     Given a table row having two cells
-      Then I can access the cell collection of the row
-       And I can get the length of the row cell collection
-
-  Scenario: Access cell in column cell collection
-     Given a column cell collection having two cells
-      Then I can iterate over the column cells
-       And I can access a column cell by index
-
-  Scenario: Access cell in row cell collection
-     Given a row cell collection having two cells
-      Then I can iterate over the row cells
-       And I can access a row cell by index
-
-  Scenario: Access cell in table
-     Given a table having two rows
-      Then I can access a cell using its row and column indices
