Update birth ref index and death ref index when updating person (#252)

Author: DavidMStraub

gramps_webapi/api/resources/util.py

@@ -126,7 +126,9 @@ def get_sex_profile(person: Person) -> str:
 
 
 def get_event_participants_for_handle(
-    db_handle: DbReadBase, handle: Handle, locale: GrampsLocale = glocale,
+    db_handle: DbReadBase,
+    handle: Handle,
+    locale: GrampsLocale = glocale,
 ) -> Dict:
     """Get event participants given a handle."""
     result = {"people": [], "families": []}
@@ -674,7 +676,9 @@ def get_soundex(
 
 
 def get_reference_profile_for_object(
-    db_handle: DbReadBase, obj: GrampsObject, locale: GrampsLocale = glocale,
+    db_handle: DbReadBase,
+    obj: GrampsObject,
+    locale: GrampsLocale = glocale,
 ) -> Dict:
     """Return reference profiles for an object."""
     profile = {}
@@ -735,14 +739,20 @@ def get_rating(db_handle: DbReadBase, obj: GrampsObject) -> Tuple[int, int]:
     return count, confidence
 
 
-def has_handle(db_handle: DbWriteBase, obj: GrampsObject,) -> bool:
+def has_handle(
+    db_handle: DbWriteBase,
+    obj: GrampsObject,
+) -> bool:
     """Check if an object with the same class and handle exists in the DB."""
     obj_class = obj.__class__.__name__.lower()
     method = db_handle.method("has_%s_handle", obj_class)
     return method(obj.handle)
 
 
-def has_gramps_id(db_handle: DbWriteBase, obj: GrampsObject,) -> bool:
+def has_gramps_id(
+    db_handle: DbWriteBase,
+    obj: GrampsObject,
+) -> bool:
     """Check if an object with the same class and handle exists in the DB."""
     if not hasattr(obj, "gramps_id"):  # needed for tags
         return False
@@ -786,7 +796,11 @@ def add_object(
         raise ValueError("Database does not support writing.")
 
 
-def add_family_update_refs(db_handle: DbWriteBase, obj: Family, trans: DbTxn,) -> None:
+def add_family_update_refs(
+    db_handle: DbWriteBase,
+    obj: Family,
+    trans: DbTxn,
+) -> None:
     """Update the `family_list` and `parent_family_list` of family members.
 
     Case where the family is new.
@@ -942,7 +956,9 @@ def _get_class_name(super_name, key_name) -> str:
 
 
 def update_object(
-    db_handle: DbWriteBase, obj: GrampsObject, trans: DbTxn,
+    db_handle: DbWriteBase,
+    obj: GrampsObject,
+    trans: DbTxn,
 ):
     """Commit a modified Gramps object to the database.
 
@@ -969,13 +985,18 @@ def update_object(
             update_family_update_refs(
                 db_handle=db_handle, obj_old=obj_old, obj=obj, trans=trans
             )
+        elif obj_class == "person":
+            db_handle.set_birth_death_index(obj)
         return commit_method(obj, trans)
     except AttributeError:
         raise ValueError("Database does not support writing.")
 
 
 def update_family_update_refs(
-    db_handle: DbWriteBase, obj_old: Family, obj: Family, trans: DbTxn,
+    db_handle: DbWriteBase,
+    obj_old: Family,
+    obj: Family,
+    trans: DbTxn,
 ) -> None:
     """Update the `family_list` and `parent_family_list` of family members.
 

tests/test_endpoints/test_post.py

@@ -27,6 +27,7 @@
 from unittest.mock import patch
 
 from gramps.cli.clidbman import CLIDbManager
+from gramps.gen.const import GRAMPS_LOCALE as glocale
 from gramps.gen.dbstate import DbState
 
 from gramps_webapi.app import create_app
@@ -38,6 +39,8 @@
 )
 from gramps_webapi.const import ENV_CONFIG_FILE, TEST_AUTH_CONFIG
 
+_ = glocale.translation.gettext
+
 
 def get_headers(client, user: str, password: str) -> Dict[str, str]:
     """Get the auth headers for a specific user."""
@@ -125,7 +128,12 @@ def test_objects_add_person(self):
             "handle": handle_person,
             "primary_name": {
                 "_class": "Name",
-                "surname_list": [{"_class": "Surname", "surname": "Doe",}],
+                "surname_list": [
+                    {
+                        "_class": "Surname",
+                        "surname": "Doe",
+                    }
+                ],
                 "first_name": "John",
             },
             "event_ref_list": [
@@ -141,7 +149,10 @@ def test_objects_add_person(self):
         birth = {
             "_class": "Event",
             "handle": handle_birth,
-            "date": {"_class": "Date", "dateval": [2, 10, 1764, False],},
+            "date": {
+                "_class": "Date",
+                "dateval": [2, 10, 1764, False],
+            },
             "type": {"_class": "EventType", "string": "Birth"},
         }
         objects = [person, birth]
@@ -167,6 +178,82 @@ def test_objects_add_person(self):
             [2, 10, 1764, False],
         )
 
+    def test_objects_add_person_seperate(self):
+        """Add a person, then a birth event, check birth ref index."""
+        handle_person = make_handle()
+        handle_birth = make_handle()
+        person = {
+            "_class": "Person",
+            "handle": handle_person,
+            "primary_name": {
+                "_class": "Name",
+                "surname_list": [
+                    {
+                        "_class": "Surname",
+                        "surname": "Doe",
+                    }
+                ],
+                "first_name": "John",
+            },
+            # "event_ref_list": [
+            #     {
+            #         "_class": "EventRef",
+            #         "ref": handle_birth,
+            #         "role": {"_class": "EventRoleType", "string": "Primary"},
+            #     },
+            # ],
+            # "birth_ref_index": 0,
+            "gender": 1,
+        }
+        birth = {
+            "_class": "Event",
+            "handle": handle_birth,
+            "date": {
+                "_class": "Date",
+                "dateval": [2, 10, 1764, False],
+            },
+            "type": {"_class": "EventType", "string": _("Birth")},
+        }
+        person_birth = {
+            "_class": "Person",
+            "handle": handle_person,
+            "primary_name": {
+                "_class": "Name",
+                "surname_list": [
+                    {
+                        "_class": "Surname",
+                        "surname": "Doe",
+                    }
+                ],
+                "first_name": "John",
+            },
+            "event_ref_list": [
+                {
+                    "_class": "EventRef",
+                    "ref": handle_birth,
+                    "role": {"_class": "EventRoleType", "string": _("Primary")},
+                },
+            ],
+            "gender": 1,
+        }
+        headers = get_headers(self.client, "admin", "123")
+        rv = self.client.post("/api/people/", json=person, headers=headers)
+        self.assertEqual(rv.status_code, 201)
+        rv = self.client.post("/api/events/", json=birth, headers=headers)
+        self.assertEqual(rv.status_code, 201)
+        rv = self.client.get(f"/api/people/{handle_person}", headers=headers)
+        self.assertEqual(rv.status_code, 200)
+        person_dict = rv.json
+        self.assertEqual(person_dict["birth_ref_index"], -1)
+        rv = self.client.put(
+            f"/api/people/{handle_person}", json=person_birth, headers=headers
+        )
+        self.assertEqual(rv.status_code, 200)
+        rv = self.client.get(f"/api/people/{handle_person}", headers=headers)
+        self.assertEqual(rv.status_code, 200)
+        person_dict = rv.json
+        self.assertEqual(person_dict["birth_ref_index"], 0)
+
     def test_objects_add_family(self):
         """Add three people and then create a new family."""
         handle_father = make_handle()
@@ -275,7 +362,12 @@ def test_objects_errors(self):
             "handle": handle_person,
             "primary_name": {
                 "_class": "Name",
-                "surname_list": [{"_class": "Surname", "surname": "Doe",}],
+                "surname_list": [
+                    {
+                        "_class": "Surname",
+                        "surname": "Doe",
+                    }
+                ],
                 "first_name": "John",
             },
             "event_ref_list": [
@@ -291,7 +383,10 @@ def test_objects_errors(self):
         birth = {
             "_class": "Event",
             "handle": handle_birth,
-            "date": {"_class": "Date", "dateval": [2, 10, 1764, False],},
+            "date": {
+                "_class": "Date",
+                "dateval": [2, 10, 1764, False],
+            },
             "type": {"_class": "EventType", "string": "Birth"},
         }
         # erroneously use string as date
@@ -314,7 +409,12 @@ def test_people_add_person(self):
             "handle": handle_person,
             "primary_name": {
                 "_class": "Name",
-                "surname_list": [{"_class": "Surname", "surname": "Doe",}],
+                "surname_list": [
+                    {
+                        "_class": "Surname",
+                        "surname": "Doe",
+                    }
+                ],
                 "first_name": "John",
             },
             "gender": 1,
@@ -432,7 +532,12 @@ def test_search_add_person(self):
             "handle": handle_person,
             "primary_name": {
                 "_class": "Name",
-                "surname_list": [{"_class": "Surname", "surname": "Doe",}],
+                "surname_list": [
+                    {
+                        "_class": "Surname",
+                        "surname": "Doe",
+                    }
+                ],
                 "first_name": "John",
             },
             "event_ref_list": [
@@ -448,7 +553,10 @@ def test_search_add_person(self):
         birth = {
             "_class": "Event",
             "handle": handle_birth,
-            "date": {"_class": "Date", "dateval": [2, 10, 1764, False],},
+            "date": {
+                "_class": "Date",
+                "dateval": [2, 10, 1764, False],
+            },
             "type": {"_class": "EventType", "string": "Birth"},
         }
         objects = [person, birth]
@@ -482,7 +590,11 @@ def test_search_locked(self):
         with indexer.index(overwrite=False).writer() as writer:
             for _ in range(10):
                 # write 10 objects while index is locked
-                rv = self.client.post("/api/notes/", json=content, headers=headers,)
+                rv = self.client.post(
+                    "/api/notes/",
+                    json=content,
+                    headers=headers,
+                )
                 self.assertEqual(rv.status_code, 201)
         sleep(2)  # give the async writer time to flush
         rv = self.client.get(f"/api/search/?query={label}", headers=headers)