acpt: add scenarios for headers and footers

Author: ondrej-111

features/hdr-header-footer.feature

@@ -0,0 +1,70 @@
+Feature: Header and footer behaviors
+  In order to control the appearance of page headers and footers
+  As a developer using python-docx
+  I need properties and methods on _Header and _Footer objects
+
+
+  @wip
+  Scenario Outline: _Header.is_linked_to_previous getter
+    Given a _Header object <with-or-no> header definition as header
+     Then header.is_linked_to_previous is <value>
+
+    Examples: _Header.is_linked_to_previous states
+      | with-or-no | value |
+      | with a     | False |
+      | with no    | True  |
+
+
+  @wip
+  Scenario Outline: _Header.is_linked_to_previous setter
+    Given a _Header object <with-or-no> header definition as header
+     When I assign <value> to header.is_linked_to_previous
+     Then header.is_linked_to_previous is <value>
+
+    Examples: _Header.is_linked_to_previous state changes
+      | with-or-no | value |
+      | with a     | True  |
+      | with no    | False |
+      | with a     | False |
+      | with no    | True  |
+
+
+  @wip
+  Scenario: _Header inherits content
+    Given a _Header object with a header definition as header
+      And the next _Header object with no header definition as header_2
+     Then header_2.paragraphs[0].text == header.paragraphs[0].text
+      And header_2.is_linked_to_previous is True
+
+
+  @wip
+  Scenario Outline: _Footer.is_linked_to_previous getter
+    Given a _Footer object <with-or-no> footer definition as footer
+     Then footer.is_linked_to_previous is <value>
+
+    Examples: _Footer.is_linked_to_previous states
+      | with-or-no | value |
+      | with a     | False |
+      | with no    | True  |
+
+
+  @wip
+  Scenario Outline: _Footer.is_linked_to_previous setter
+    Given a _Footer object <with-or-no> footer definition as footer
+     When I assign <value> to footer.is_linked_to_previous
+     Then footer.is_linked_to_previous is <value>
+
+    Examples: _Footer.is_linked_to_previous state changes
+      | with-or-no | value |
+      | with a     | True  |
+      | with no    | False |
+      | with a     | False |
+      | with no    | True  |
+
+
+  @wip
+  Scenario: _Footer inherits content
+    Given a _Footer object with a footer definition as footer
+      And the next _Footer object with no footer definition as footer_2
+     Then footer_2.paragraphs[0].text == footer.paragraphs[0].text
+      And footer_2.is_linked_to_previous is True

features/sct-section-props.feature features/sct-section.featurefeatures/sct-section-props.feature renamed to features/sct-section.feature

@@ -4,6 +4,18 @@ Feature: Access and change section properties
   I need a way to get and set the properties of a section
 
 
+  @wip
+  Scenario: Section.footer
+    Given a Section object as section
+     Then section.footer is a _Footer object
+
+
+  @wip
+  Scenario: Section.header
+    Given a Section object as section
+     Then section.header is a _Header object
+
+
   Scenario Outline: Get section start type
     Given a section having start type <start-type>
      Then the reported section start type is <start-type>

features/steps/hdrftr.py

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+"""Step implementations for header and footer-related features"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from behave import given, then, when
+
+from docx import Document
+
+from helpers import test_docx
+
+
+# given ====================================================
+
+@given("a _Footer object {with_or_no} footer definition as footer")
+def given_a_Footer_object_with_or_no_footer_definition(context, with_or_no):
+    section_idx = {"with a": 0, "with no": 1}[with_or_no]
+    context.sections = Document(test_docx("hdr-header-footer")).sections
+    context.footer = context.sections[section_idx].footer
+
+
+@given("a _Header object {with_or_no} header definition as header")
+def given_a_Header_object_with_or_no_header_definition(context, with_or_no):
+    section_idx = {"with a": 0, "with no": 1}[with_or_no]
+    context.sections = Document(test_docx("hdr-header-footer")).sections
+    context.header = context.sections[section_idx].header
+
+
+@given("the next _Footer object with no footer definition as footer_2")
+def given_the_next_Footer_object_with_no_footer_definition(context):
+    context.footer_2 = context.sections[1].footer
+
+
+@given("the next _Header object with no header definition as header_2")
+def given_the_next_Header_object_with_no_header_definition(context):
+    context.header_2 = context.sections[1].header
+
+
+# when =====================================================
+
+@when("I assign {value} to header.is_linked_to_previous")
+def when_I_assign_value_to_header_is_linked_to_previous(context, value):
+    context.header.is_linked_to_previous = eval(value)
+
+
+@when("I assign {value} to footer.is_linked_to_previous")
+def when_I_assign_value_to_footer_is_linked_to_previous(context, value):
+    context.footer.is_linked_to_previous = eval(value)
+
+
+# then =====================================================
+
+@then("footer.is_linked_to_previous is {value}")
+def then_footer_is_linked_to_previous_is_value(context, value):
+    actual = context.footer.is_linked_to_previous
+    expected = eval(value)
+    assert actual == expected, "footer.is_linked_to_previous is %s" % actual
+
+
+@then("footer_2.paragraphs[0].text == footer.paragraphs[0].text")
+def then_footer_2_text_eq_footer_text(context):
+    actual = context.footer_2.paragraphs[0].text
+    expected = context.footer.paragraphs[0].text
+    assert actual == expected, "footer_2.paragraphs[0].text == %s" % actual
+
+
+@then("footer_2.is_linked_to_previous is {value}")
+def then_footer_2_is_linked_to_previous_is_value(context, value):
+    actual = context.footer_2.is_linked_to_previous
+    expected = eval(value)
+    assert actual == expected, "footer_2.is_linked_to_previous is %s" % actual
+
+
+@then("header.is_linked_to_previous is {value}")
+def then_header_is_linked_to_previous_is_value(context, value):
+    actual = context.header.is_linked_to_previous
+    expected = eval(value)
+    assert actual == expected, "header.is_linked_to_previous is %s" % actual
+
+
+@then("header_2.is_linked_to_previous is {value}")
+def then_header_2_is_linked_to_previous_is_value(context, value):
+    actual = context.header_2.is_linked_to_previous
+    expected = eval(value)
+    assert actual == expected, "header_2.is_linked_to_previous is %s" % actual
+
+
+@then("header_2.paragraphs[0].text == header.paragraphs[0].text")
+def then_header_2_text_eq_header_text(context):
+    actual = context.header_2.paragraphs[0].text
+    expected = context.header.paragraphs[0].text
+    assert actual == expected, "header_2.paragraphs[0].text == %s" % actual

features/steps/section.py

@@ -18,6 +18,11 @@
 
 # given ====================================================
 
+@given("a Section object as section")
+def given_a_Section_object_as_section(context):
+    context.section = Document(test_docx("sct-section-props")).sections[-1]
+
+
 @given('a section collection containing 3 sections')
 def given_a_section_collection_containing_3_sections(context):
     document = Document(test_docx('doc-access-sections'))
@@ -137,6 +142,20 @@ def then_len_sections_is_3(context):
     )
 
 
+@then("section.footer is a _Footer object")
+def then_section_footer_is_a_Footer_object(context):
+    actual = type(context.section.footer).__name__
+    expected = "_Footer"
+    assert actual == expected, "section.footer is a %s object" % actual
+
+
+@then("section.header is a _Header object")
+def then_section_header_is_a_Header_object(context):
+    actual = type(context.section.header).__name__
+    expected = "_Header"
+    assert actual == expected, "section.header is a %s object" % actual
+
+
 @then('the reported {margin_side} margin is {inches} inches')
 def then_the_reported_margin_is_inches(context, margin_side, inches):
     prop_name = {