bmk: add _Bookmark.is_closed

scanny · scanny · commit 9be433be9eb2 · 2021-05-15T15:32:43.000-07:00
diff --git a/docx/bookmark.py b/docx/bookmark.py
@@ -92,7 +92,7 @@ def id(self):
     @property
     def is_closed(self):
         """True if this bookmark has both a start and end element."""
-        raise NotImplementedError
+        return self._bookmarkEnd is not None
 
     @property
     def name(self):
diff --git a/tests/test_bookmark.py b/tests/test_bookmark.py
@@ -214,6 +214,14 @@ def it_knows_its_id(self):
 
         assert bookmark.id == 42
 
+    def it_knows_whether_it_is_closed(self, is_closed_fixture):
+        bookmarkStart, bookmarkEnd, expected_value = is_closed_fixture
+        bookmark = _Bookmark((bookmarkStart, bookmarkEnd))
+
+        is_closed = bookmark.is_closed
+
+        assert is_closed == expected_value
+
     def it_knows_its_name(self):
         bookmarkStart = element("w:bookmarkStart{w:name=bmk-0}")
         bookmarkEnd = element("w:bookmarkEnd")
@@ -222,6 +230,21 @@ def it_knows_its_name(self):
 
         assert bookmark.name == "bmk-0"
 
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture(
+        params=[
+            (None, None, False),  # ---not expected---
+            ("w:bookmarkStart", None, False),
+            ("w:bookmarkStart", "w:bookmarkEnd", True),
+        ]
+    )
+    def is_closed_fixture(self, request):
+        bookmarkStart_cxml, bookmarkEnd_cxml, expected_value = request.param
+        bookmarkStart = element(bookmarkStart_cxml) if bookmarkStart_cxml else None
+        bookmarkEnd = element(bookmarkEnd_cxml) if bookmarkEnd_cxml else None
+        return bookmarkStart, bookmarkEnd, expected_value
+
 
 class Describe_DocumentBookmarkFinder(object):
     def it_finds_all_the_bookmark_pairs_in_the_document(
