acpt: add scenario for Document.end_bookmark()

scanny · scanny · commit dc793d36ed08 · 2021-05-15T15:32:43.000-07:00
diff --git a/docx/document.py b/docx/document.py
@@ -112,6 +112,10 @@ def core_properties(self):
         """
         return self._part.core_properties
 
+    def end_bookmark(self, bookmark):
+        """Return `bookmark` after closing it at end of this document."""
+        raise NotImplementedError
+
     @property
     def inline_shapes(self):
         """
diff --git a/features/doc-document.feature b/features/doc-document.feature
@@ -8,3 +8,10 @@ Feature: Document properties and methods
      When I assign bookmark = document.start_bookmark("Target")
      Then bookmark.name == "Target"
       And bookmark.id is an int
+
+  @wip
+  Scenario: Document.end_bookmark()
+    Given a Document object as document
+      And an open Bookmark object named "Target" as bookmark
+     Then bookmark == document.end_bookmark(bookmark)
+      And bookmark == document.bookmarks.get("Target")
diff --git a/features/steps/document.py b/features/steps/document.py
@@ -1,10 +1,8 @@
 # encoding: utf-8
 
-"""
-Step implementations for document-related features
-"""
+"""Step implementations for document-related features"""
 
-from __future__ import absolute_import, print_function, unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from behave import given, then, when
 
@@ -70,6 +68,11 @@ def given_a_single_section_Document_object_with_headers_and_footers(context):
     context.document = Document(test_docx("doc-add-section"))
 
 
+@given('an open Bookmark object named "Target" as bookmark')
+def given_an_open_Bookmark_object_named_Target_as_bookmark(context):
+    context.bookmark = context.document.start_bookmark("Target")
+
+
 # when ====================================================
 
 
@@ -182,6 +185,17 @@ def when_I_execute_section_eq_document_add_section(context):
 # then ====================================================
 
 
+@then('bookmark == document.bookmarks.get("Target")')
+def then_bookmark_eq_document_bookmarks_get_Target(context):
+    assert context.bookmark == context.document.bookmarks.get("Target")
+
+
+@then("bookmark == document.end_bookmark(bookmark)")
+def then_bookmark_eq_document_end_bookmark(context):
+    bookmark = context.bookmark
+    assert bookmark == context.document.end_bookmark(bookmark)
+
+
 @then("document.bookmarks is a Bookmarks object")
 def then_document_bookmarks_is_a_Bookmarks_object(context):
     actual = context.document.bookmarks.__class__.__name__
