From 11b4931d27465339926dc6e3882cb0588c241ffe Mon Sep 17 00:00:00 2001 From: Zarino Zappia Date: Mon, 1 Apr 2024 11:53:25 +0100 Subject: [PATCH] Location search now handles all area types MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #504. AreaSearchView no longer artificially limits results to WMC area_types, and area_search.html presents matching areas grouped by area_type. I’ve gone with a custom `grid` layout on the area_search.html (rather than Bootstrap columns) to more gracefully handle a variable number of columns – there might be 1, 2, or 3, depending on the search input. I also fixed a bug in the `highlight` filter, which raised a TypeError when passed a None `search` parameter. `search` is None when the user has used geolocation rather than submitting a search term. --- hub/static/css/_search-results.scss | 17 +++++ hub/static/css/main.scss | 1 + hub/templates/hub/area_search.html | 48 +++++++++---- .../search-results-area-type-intro.html | 25 +++++++ hub/templatetags/hub_filters.py | 10 ++- hub/views/area.py | 71 ++++++++++++++----- 6 files changed, 138 insertions(+), 34 deletions(-) create mode 100644 hub/static/css/_search-results.scss create mode 100644 hub/templates/hub/includes/search-results-area-type-intro.html diff --git a/hub/static/css/_search-results.scss b/hub/static/css/_search-results.scss new file mode 100644 index 000000000..6fb132bef --- /dev/null +++ b/hub/static/css/_search-results.scss @@ -0,0 +1,17 @@ +.search-results { + h2 { + margin-top: 3rem; + } + + @include media-breakpoint-up(lg) { + display: grid; + grid-auto-flow: column; + grid-template-rows: repeat(3, auto); + grid-auto-columns: minmax(auto, 30rem); // constrain col width when less than three in grid + grid-column-gap: 2rem; + } + + @include media-breakpoint-up(xl) { + grid-column-gap: 3rem; + } +} diff --git a/hub/static/css/main.scss b/hub/static/css/main.scss index 82f97b15c..50c61a43c 100644 --- a/hub/static/css/main.scss +++ b/hub/static/css/main.scss @@ -51,6 +51,7 @@ @import "site-footer"; @import "site-feedback"; @import "search-input"; +@import "search-results"; @import "explore"; @import "homepage"; @import "area"; diff --git a/hub/templates/hub/area_search.html b/hub/templates/hub/area_search.html index 896a06ffb..00378e77d 100644 --- a/hub/templates/hub/area_search.html +++ b/hub/templates/hub/area_search.html @@ -7,13 +7,13 @@
-

Search by location

- +

Search for a location

+
{% include 'hub/includes/icons/search.html' %} - +
{% if error %}
@@ -25,24 +25,46 @@

Search by location

- + {% include 'hub/includes/icons/geolocate.html' with classes="me-2" %} Use my current location {% if areas %} -

{{ areas|length }} matching locations

- {% for area in areas %} -
-
-

{{ area.name|highlight:search }}

-
- {% include 'hub/includes/person-photo.html' with person=area.mp width="32" height="32" %} -

{{ area.mp.name|highlight:search }}, MP

+
+ {% for area_type in areas_by_type %} + {% if area_type.areas %} + {% include 'hub/includes/search-results-area-type-intro.html' with type=area_type.type areas=area_type.areas %} +
+ {% for area in area_type.areas %} +
+
+

{{ area.name|highlight:search }}

+ {% if area.mp %} +
+ {% include 'hub/includes/person-photo.html' with person=area.mp width="32" height="32" %} +

{{ area.mp.name|highlight:search }}, MP

+
+ {% elif area.ppcs %} + {% for ppc in area.ppcs %} +
+ {% include 'hub/includes/person-photo.html' with person=ppc width="32" height="32" %} +

{{ ppc.name|highlight:search }} (PPC)

+
+ {% endfor %} + {% endif %} + {% if area.area_type.code == "STC" %} +

Single Tier council

+ {% elif area.area_type.code == "DIS" %} +

District council

+ {% endif %} +
+ {% endfor %}
+ {% endif %} + {% endfor %}
- {% endfor %} {% endif %}
diff --git a/hub/templates/hub/includes/search-results-area-type-intro.html b/hub/templates/hub/includes/search-results-area-type-intro.html new file mode 100644 index 000000000..ba9ecedaa --- /dev/null +++ b/hub/templates/hub/includes/search-results-area-type-intro.html @@ -0,0 +1,25 @@ +{% if type == "current-constituencies" %} + {% if areas|length == 1 %} +

Current constituency

+

This is the constituency currently represented by an MP in UK Parliament.

+ {% else %} +

Current constituencies

+

These constituencies are the areas which MPs currently represent in UK Parliament.

+ {% endif %} +{% elif type == "future-constituencies" %} + {% if areas|length == 1 %} +

Future constituency

+

This is the constituency in which parliamentary candidates will soon be standing for election.

+ {% else %} +

Future constituencies

+

These are the constituencies in which parliamentary candidates will soon be standing for election.

+ {% endif %} +{% elif type == "local-authorities" %} + {% if areas|length == 1 %} +

Local authority

+

The local authority has powers over local services like education, planning, and transport.

+ {% else %} +

Local authorities

+

These bodies have powers over local services like education, planning, and transport.

+ {% endif %} +{% endif %} diff --git a/hub/templatetags/hub_filters.py b/hub/templatetags/hub_filters.py index cf3ad577d..b0a4b83f4 100644 --- a/hub/templatetags/hub_filters.py +++ b/hub/templatetags/hub_filters.py @@ -24,9 +24,13 @@ def splitlines(value): @register.filter(name="highlight") def highlight(text, search): - rgx = re.compile(re.escape(search), re.IGNORECASE) - html = rgx.sub(lambda m: f"{m.group()}", text) - return mark_safe(html) + try: + rgx = re.compile(re.escape(search), re.IGNORECASE) + html = rgx.sub(lambda m: f"{m.group()}", text) + return mark_safe(html) + except TypeError: + # search is probably None + return text @register.filter diff --git a/hub/views/area.py b/hub/views/area.py index 4654e5349..d0f700a50 100644 --- a/hub/views/area.py +++ b/hub/views/area.py @@ -392,7 +392,7 @@ def get_areas_from_mapit(self, **kwargs): elif kwargs.get("pc"): gss_codes = mapit.postcode_point_to_gss_codes(kwargs["pc"]) - areas = Area.objects.filter(gss__in=gss_codes, area_type__code="WMC") + areas = Area.objects.filter(gss__in=gss_codes) areas = list(areas) except ( NotFoundException, @@ -427,29 +427,64 @@ def get_context_data(self, **kwargs): context["areas"] = areas context["error"] = error elif search == "": - context["error"] = "Please enter a constituency name, MP name, or postcode." + context["error"] = "Please enter a postcode, or the name of a constituency, MP, or local authority" else: - areas_raw = Area.objects.filter( - name__icontains=search, area_type__code="WMC" - ) - people_raw = Person.objects.filter(person_type="MP", name__icontains=search) + areas_raw = Area.objects.filter(name__icontains=search) + people_raw = Person.objects.filter(name__icontains=search) - areas = list(areas_raw) + context["areas"] = list(areas_raw) for person in people_raw: - areas.append(person.area) + context["areas"].append(person.area) - if len(areas) == 0: + if len(context["areas"]) == 0: context[ "error" - ] = f"Sorry, we can’t find a UK location matching “{search}”. Try a nearby town or city?" - else: - for area in areas: - try: - area.mp = Person.objects.get(area=area, end_date__isnull=True) - except Person.DoesNotExist: - pass - areas.sort(key=lambda area: area.name) - context["areas"] = areas + ] = f"Sorry, we can’t find any matches for “{search}”. Try a nearby town or city?" + + if len(context["areas"]): + # Add MPs and PPCs to areas + for area in context["areas"]: + try: + area.mp = Person.objects.get( + area=area, + end_date__isnull=True, + person_type="MP" + ) + except Person.DoesNotExist: + pass + + try: + area.ppcs = Person.objects.filter( + area=area, + end_date__isnull=True, + person_type="PPC" + ) + except Person.DoesNotExist: + pass + + # Sort then split by area_type + context["areas"].sort(key=lambda area: area.name) + context["areas_by_type"] = [ + { + "type": "current-constituencies", + "areas": [], + }, + { + "type": "future-constituencies", + "areas": [], + }, + { + "type": "local-authorities", + "areas": [], + }, + ] + for area in context["areas"]: + if area.area_type.code == "WMC": + context["areas_by_type"][0]["areas"].append(area) + elif area.area_type.code == "WMC23": + context["areas_by_type"][1]["areas"].append(area) + else: + context["areas_by_type"][2]["areas"].append(area) return context