bmk: add _Bookmark.close()

scanny · scanny · commit e65ec0df0949 · 2021-05-15T15:32:43.000-07:00
diff --git a/docx/bookmark.py b/docx/bookmark.py
@@ -82,7 +82,12 @@ def close(self, bookmarkEnd):
         Raises ValueError if this bookmark is already closed or if `id` attribute of
         `bookmarkEnd` does not match that of the `bookmarkStart` element.
         """
-        raise NotImplementedError
+        if self._bookmarkEnd is not None:
+            raise ValueError("bookmark already closed")
+        if bookmarkEnd.id != self._bookmarkStart.id:
+            raise ValueError("end id does not match start id")
+        self._bookmarkEnd = bookmarkEnd
+        return self
 
     @property
     def id(self):
diff --git a/tests/test_bookmark.py b/tests/test_bookmark.py
@@ -206,6 +206,33 @@ def _iter_(self, request):
 class Describe_Bookmark(object):
     """Unit-test suite for `docx.bookmark._Bookmark` object."""
 
+    def it_can_close_itself_when_open(self):
+        bookmarkStart = element("w:bookmarkStart{w:id=42}")
+        bookmarkEnd = element("w:bookmarkEnd{w:id=42}")
+        bookmark = _Bookmark((bookmarkStart, None))
+
+        return_value = bookmark.close(bookmarkEnd)
+
+        assert bookmark._bookmarkEnd == bookmarkEnd
+        assert return_value is bookmark
+
+    def but_it_raises_if_it_is_already_closed(self):
+        bookmarkEnd = element("w:bookmarkEnd")
+        bookmark = _Bookmark((None, bookmarkEnd))
+
+        with pytest.raises(ValueError) as e:
+            bookmark.close(bookmarkEnd)
+        assert "bookmark already closed" in str(e.value)
+
+    def and_it_raises_if_the_ids_dont_match(self):
+        bookmarkStart = element("w:bookmarkStart{w:id=42}")
+        bookmarkEnd = element("w:bookmarkEnd{w:id=24}")
+        bookmark = _Bookmark((bookmarkStart, None))
+
+        with pytest.raises(ValueError) as e:
+            bookmark.close(bookmarkEnd)
+        assert "end id does not match start id" in str(e.value)
+
     def it_knows_its_id(self):
         bookmarkStart = element("w:bookmarkStart{w:id=42}")
         bookmarkEnd = element("w:bookmarkEnd")
