acpt: migrate scenario for Document.sections

Steve Canny · Steve Canny · commit 900807f47c41 · 2015-02-15T02:54:12.000-08:00
* Migrate Document.sections access to doc-access-collections.feature
* Migrate section access steps to steps/section.py
* Revise doc-access-collections steps for uniformity
diff --git a/features/doc-access-collections.feature b/features/doc-access-collections.feature
@@ -6,9 +6,14 @@ Feature: Access document collections
 
   Scenario: Access the inline shapes collection of a document
      Given a document having inline shapes
-      Then I can access the inline shape collection of the document
+      Then document.inline_shapes is an InlineShapes object
 
 
   Scenario: Access the paragraphs in the document body as a list
      Given a document containing three paragraphs
       Then document.paragraphs is a list containing three paragraphs
+
+
+  Scenario: Access the section collection of a document
+     Given a document having sections
+      Then document.sections is a Sections object
diff --git a/features/doc-access-sections.feature b/features/doc-access-sections.feature
@@ -1,16 +1,11 @@
 Feature: Access document sections
-  In order to discover and apply section-level settings
+  In order to operate on an individual section
   As a developer using python-docx
-  I need a way to access document sections
-
-
-  Scenario: Access section collection of a document
-     Given a document having three sections
-      Then I can access the section collection of the document
-       And the length of the section collection is 3
+  I need access to each section in the section collection
 
 
   Scenario: Access section in section collection
-     Given a section collection
-      Then I can iterate over the sections
+     Given a section collection containing 3 sections
+      Then len(sections) is 3
+       And I can iterate over the sections
        And I can access a section by index
diff --git a/features/steps/document.py b/features/steps/document.py
@@ -11,7 +11,6 @@
 from docx import Document
 from docx.enum.section import WD_ORIENT, WD_SECTION
 from docx.parts.document import InlineShapes, Sections
-from docx.section import Section
 from docx.shared import Inches
 from docx.table import Table
 
@@ -30,17 +29,11 @@ def given_a_document_having_inline_shapes(context):
     context.document = Document(test_docx('shp-inline-shape-access'))
 
 
-@given('a document having three sections')
-def given_a_document_having_three_sections(context):
+@given('a document having sections')
+def given_a_document_having_sections(context):
     context.document = Document(test_docx('doc-access-sections'))
 
 
-@given('a section collection')
-def given_a_section_collection(context):
-    document = Document(test_docx('doc-access-sections'))
-    context.sections = document.sections
-
-
 @given('a single-section document having portrait layout')
 def given_a_single_section_document_having_portrait_layout(context):
     context.document = Document(test_docx('doc-add-section'))
@@ -151,44 +144,26 @@ def when_I_change_the_new_section_layout_to_landscape(context):
 
 # then ====================================================
 
-@then('document.paragraphs is a list containing three paragraphs')
-def then_document_paragraphs_is_a_list_containing_three_paragraphs(context):
-    document = context.document
-    paragraphs = document.paragraphs
-    assert isinstance(paragraphs, list)
-    assert len(paragraphs) == 3
-
-
-@then('I can access a section by index')
-def then_I_can_access_a_section_by_index(context):
-    sections = context.sections
-    for idx in range(3):
-        section = sections[idx]
-        assert isinstance(section, Section)
-
-
-@then('I can access the inline shape collection of the document')
-def then_can_access_inline_shape_collection_of_document(context):
+@then('document.inline_shapes is an InlineShapes object')
+def then_document_inline_shapes_is_an_InlineShapes_object(context):
     document = context.document
     inline_shapes = document.inline_shapes
     assert isinstance(inline_shapes, InlineShapes)
 
 
-@then('I can access the section collection of the document')
-def then_I_can_access_the_section_collection_of_the_document(context):
+@then('document.sections is a Sections object')
+def then_document_sections_is_a_Sections_object(context):
     sections = context.document.sections
     msg = 'document.sections not instance of Sections'
     assert isinstance(sections, Sections), msg
 
 
-@then('I can iterate over the sections')
-def then_I_can_iterate_over_the_sections(context):
-    sections = context.sections
-    actual_count = 0
-    for section in sections:
-        actual_count += 1
-        assert isinstance(section, Section)
-    assert actual_count == 3
+@then('document.paragraphs is a list containing three paragraphs')
+def then_document_paragraphs_is_a_list_containing_three_paragraphs(context):
+    document = context.document
+    paragraphs = document.paragraphs
+    assert isinstance(paragraphs, list)
+    assert len(paragraphs) == 3
 
 
 @then('the document contains a 2 x 2 table')
@@ -232,14 +207,6 @@ def then_last_p_contains_heading_text(context):
     assert paragraph.text == text
 
 
-@then('the length of the section collection is 3')
-def then_the_length_of_the_section_collection_is_3(context):
-    sections = context.document.sections
-    assert len(sections) == 3, (
-        'expected len(sections) of 2, got %s' % len(sections)
-    )
-
-
 @then('the second section is landscape')
 def then_the_second_section_is_landscape(context):
     new_section = context.document.sections[-1]
diff --git a/features/steps/section.py b/features/steps/section.py
@@ -10,13 +10,20 @@
 
 from docx import Document
 from docx.enum.section import WD_ORIENT, WD_SECTION
+from docx.section import Section
 from docx.shared import Inches
 
 from helpers import test_docx
 
 
 # given ====================================================
 
+@given('a section collection containing 3 sections')
+def given_a_section_collection_containing_3_sections(context):
+    document = Document(test_docx('doc-access-sections'))
+    context.sections = document.sections
+
+
 @given('a section having known page dimension')
 def given_a_section_having_known_page_dimension(context):
     document = Document(test_docx('sct-section-props'))
@@ -104,6 +111,32 @@ def when_I_set_the_section_start_type_to_start_type(context, start_type):
 
 # then =====================================================
 
+@then('I can access a section by index')
+def then_I_can_access_a_section_by_index(context):
+    sections = context.sections
+    for idx in range(3):
+        section = sections[idx]
+        assert isinstance(section, Section)
+
+
+@then('I can iterate over the sections')
+def then_I_can_iterate_over_the_sections(context):
+    sections = context.sections
+    actual_count = 0
+    for section in sections:
+        actual_count += 1
+        assert isinstance(section, Section)
+    assert actual_count == 3
+
+
+@then('len(sections) is 3')
+def then_len_sections_is_3(context):
+    sections = context.sections
+    assert len(sections) == 3, (
+        'expected len(sections) of 3, got %s' % len(sections)
+    )
+
+
 @then('the reported {margin_side} margin is {inches} inches')
 def then_the_reported_margin_is_inches(context, margin_side, inches):
     prop_name = {
