mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-04-04 01:21:19 -04:00
f50ef84c0d
If you’re adding another area to your broadcast it’s likely to be close to one of the areas you’ve already added. But we make you start by choosing a library, then you have to find the local authority again from the long list. This is clunky, and it interrupts the task the user is trying to complete. We thought about redirecting you somewhere deep into the hierarchy, perhaps by sending you to either: - the parent of the last area you’d chosen - the common ancestor of all the areas you’d chosen This approach would however mean you’d need a way to navigate back up the hierarchy if we’d dropped you in the wrong place. And we don’t have a pattern for that at the moment. So instead this commit adds some ‘shortcuts’ to the chose library page, giving you a choice of all the parents of the areas you’ve currently selected. In most cases this will be one (unitary authority) or two (county and district) choices, but it will scale to adding areas from multiple different authorities. It does mean an extra click compared to the redirect approach, but this is still fewer, easier clicks compared to now. This meant a couple of under-the-hood changes: - making `BroadcastArea`s hashable so it’s possible to do `set([BroadcastArea(…), BroadcastArea(…), BroadcastArea(…)])` - making `BroadcastArea`s aware of which library they live in, so we can link to the correct _Choose area_ page
133 lines
3.9 KiB
Python
133 lines
3.9 KiB
Python
from notifications_utils.formatters import formatted_list
|
|
from notifications_utils.serialised_model import SerialisedModelCollection
|
|
from werkzeug.utils import cached_property
|
|
|
|
from .polygons import Polygons
|
|
from .populations import CITY_OF_LONDON
|
|
from .repo import BroadcastAreasRepository
|
|
|
|
|
|
class SortableMixin:
|
|
|
|
def __repr__(self):
|
|
return f'{self.__class__.__name__}(<{self.id}>)'
|
|
|
|
def __lt__(self, other):
|
|
# Implementing __lt__ means any classes inheriting from this
|
|
# method are sortable
|
|
return self.name < other.name
|
|
|
|
def __eq__(self, other):
|
|
return self.id == other.id
|
|
|
|
def __hash__(self):
|
|
return hash(self.id)
|
|
|
|
|
|
class GetItemByIdMixin:
|
|
def get(self, id):
|
|
for item in self:
|
|
if item.id == id:
|
|
return item
|
|
raise KeyError(id)
|
|
|
|
|
|
class BroadcastArea(SortableMixin):
|
|
|
|
def __init__(self, row):
|
|
self.id, self.name, self._count_of_phones, self.library_id = row
|
|
|
|
@cached_property
|
|
def polygons(self):
|
|
return Polygons(
|
|
BroadcastAreasRepository().get_polygons_for_area(self.id)
|
|
)
|
|
|
|
@cached_property
|
|
def simple_polygons(self):
|
|
return Polygons(
|
|
BroadcastAreasRepository().get_simple_polygons_for_area(self.id)
|
|
)
|
|
|
|
@cached_property
|
|
def sub_areas(self):
|
|
return [
|
|
BroadcastArea(row)
|
|
for row in BroadcastAreasRepository().get_all_areas_for_group(self.id)
|
|
]
|
|
|
|
@property
|
|
def count_of_phones(self):
|
|
if self.id.endswith(CITY_OF_LONDON.WARDS):
|
|
return CITY_OF_LONDON.DAYTIME_POPULATION * (
|
|
self.polygons.estimated_area / CITY_OF_LONDON.AREA_SQUARE_MILES
|
|
)
|
|
if self.sub_areas:
|
|
return sum(area.count_of_phones for area in self.sub_areas)
|
|
# TODO: remove the `or 0` once missing data is fixed, see
|
|
# https://www.pivotaltracker.com/story/show/174837293
|
|
return self._count_of_phones or 0
|
|
|
|
@cached_property
|
|
def parents(self):
|
|
return list(filter(None, self._parents_iterator))
|
|
|
|
@property
|
|
def _parents_iterator(self):
|
|
id = self.id
|
|
|
|
while True:
|
|
parent = BroadcastAreasRepository().get_parent_for_area(id)
|
|
|
|
if not parent:
|
|
return None
|
|
|
|
parent_broadcast_area = BroadcastArea(parent)
|
|
|
|
yield parent_broadcast_area
|
|
|
|
id = parent_broadcast_area.id
|
|
|
|
|
|
class BroadcastAreaLibrary(SerialisedModelCollection, SortableMixin, GetItemByIdMixin):
|
|
|
|
model = BroadcastArea
|
|
|
|
def __init__(self, row):
|
|
id, name, name_singular, is_group = row
|
|
self.id = id
|
|
self.name = name
|
|
self.name_singular = name_singular
|
|
self.is_group = bool(is_group)
|
|
self.items = BroadcastAreasRepository().get_all_areas_for_library(self.id)
|
|
|
|
def get_examples(self):
|
|
# we show up to four things. three areas, then either a fourth area if there are exactly four, or "and X more".
|
|
areas_to_show = sorted(area.name for area in self)[:4]
|
|
|
|
count_of_areas_not_named = len(self.items) - 3
|
|
# if there's exactly one area not named, there are exactly four - we should just show all four.
|
|
if count_of_areas_not_named > 1:
|
|
areas_to_show = areas_to_show[:3] + [f'{count_of_areas_not_named} more…']
|
|
|
|
return formatted_list(areas_to_show, before_each='', after_each='')
|
|
|
|
|
|
class BroadcastAreaLibraries(SerialisedModelCollection, GetItemByIdMixin):
|
|
|
|
model = BroadcastAreaLibrary
|
|
|
|
def __init__(self):
|
|
self.items = BroadcastAreasRepository().get_libraries()
|
|
|
|
def get_areas(self, *area_ids):
|
|
# allow people to call `get_areas('a', 'b') or get_areas(['a', 'b'])`
|
|
if len(area_ids) == 1 and isinstance(area_ids[0], list):
|
|
area_ids = area_ids[0]
|
|
|
|
areas = BroadcastAreasRepository().get_areas(area_ids)
|
|
return [BroadcastArea(area) for area in areas]
|
|
|
|
|
|
broadcast_area_libraries = BroadcastAreaLibraries()
|