From d2784d0d8a823d0d9a6dcafe9a57f3e7876ad363 Mon Sep 17 00:00:00 2001
From: Ben Thorner <ben.thorner@digital.cabinet-office.gov.uk>
Date: Mon, 23 Aug 2021 16:48:21 +0100
Subject: [PATCH] Rename "parents" methods to "ancestors"

Resolves: https://github.com/alphagov/notifications-admin/pull/3980#discussion_r694002952

A grandparent is not a parent, so the return value of these methods
were misleading. This makes it clearer.
---
 app/broadcast_areas/models.py                |  8 +++-----
 app/models/broadcast_message.py              | 10 +++++-----
 app/templates/views/broadcast/libraries.html |  2 +-
 3 files changed, 9 insertions(+), 11 deletions(-)

diff --git a/app/broadcast_areas/models.py b/app/broadcast_areas/models.py
index 6e8785b61..105a456dc 100644
--- a/app/broadcast_areas/models.py
+++ b/app/broadcast_areas/models.py
@@ -124,11 +124,11 @@ class BroadcastArea(BaseBroadcastArea, SortableMixin):
         return self._count_of_phones or 0
 
     @cached_property
-    def parents(self):
-        return list(self._parents_iterator)
+    def ancestors(self):
+        return list(self._ancestors_iterator)
 
     @property
-    def _parents_iterator(self):
+    def _ancestors_iterator(self):
         id = self.id
 
         while True:
@@ -138,9 +138,7 @@ class BroadcastArea(BaseBroadcastArea, SortableMixin):
                 return
 
             parent_broadcast_area = BroadcastArea(parent)
-
             yield parent_broadcast_area
-
             id = parent_broadcast_area.id
 
 
diff --git a/app/models/broadcast_message.py b/app/models/broadcast_message.py
index 14c4c9525..112e234f7 100644
--- a/app/models/broadcast_message.py
+++ b/app/models/broadcast_message.py
@@ -104,14 +104,14 @@ class BroadcastMessage(JSONModel):
         )
 
     @property
-    def parent_areas(self):
-        return sorted(set(self._parent_areas_iterator))
+    def ancestor_areas(self):
+        return sorted(set(self._ancestor_areas_iterator))
 
     @property
-    def _parent_areas_iterator(self):
+    def _ancestor_areas_iterator(self):
         for area in self.areas:
-            for parent in area.parents:
-                yield parent
+            for ancestor in area.ancestors:
+                yield ancestor
 
     @cached_property
     def polygons(self):
diff --git a/app/templates/views/broadcast/libraries.html b/app/templates/views/broadcast/libraries.html
index 502d1d35f..a90b80011 100644
--- a/app/templates/views/broadcast/libraries.html
+++ b/app/templates/views/broadcast/libraries.html
@@ -14,7 +14,7 @@
 
   {{ page_header("Choose where to send this alert") }}
 
-  {% for area in broadcast_message.parent_areas %}
+  {% for area in broadcast_message.ancestor_areas %}
     <a class="govuk-heading-m govuk-link govuk-link--no-visited-state" href="{{ url_for('.choose_broadcast_sub_area', service_id=current_service.id, broadcast_message_id=broadcast_message.id, library_slug=area.library_id, area_slug=area.id) }}">{{ area.name }}</a>
     {% if loop.last %}
       <div class="keyline-block"></div>