Compare commits
24
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0571d1c0ff | ||
|
|
180d6e9b3e | ||
|
|
80f405123e | ||
|
|
077aca6008 | ||
|
|
9dba5ff1ff | ||
|
|
f530a912bc | ||
|
|
029fe8d8a6 | ||
|
|
cd1c5d1e1a | ||
|
|
cd6a45bf7d | ||
|
|
5c0ccc693d | ||
|
|
151cf4bc80 | ||
|
|
83dc5ae5dc | ||
|
|
2175dccb7c | ||
|
|
bd2a6c385b | ||
|
|
4e0d8bcf87 | ||
|
|
91314a80b5 | ||
|
|
52b00ac752 | ||
|
|
b571d9c549 | ||
|
|
8a23e3657d | ||
|
|
e4e8f02599 | ||
|
|
b62dc17532 | ||
|
|
4d7762d796 | ||
|
|
3650f7d8b7 | ||
|
|
dfce308f1f |
No files matched your search
+27
-9
@@ -40,20 +40,13 @@ from .data_loader import (
|
||||
from .data_loader import get_data_info as get_db_info
|
||||
from . import flags
|
||||
from .places import build_place_index, build_place_registry, places_for_urn
|
||||
from .schemas import METRIC_DEFINITIONS, RANKING_COLUMNS, SCHOOL_COLUMNS
|
||||
from .schemas import METRIC_DEFINITIONS, PHASE_GROUPS, RANKING_COLUMNS, SCHOOL_COLUMNS
|
||||
from .nearby_schools import select_nearby
|
||||
from .utils import clean_for_json, convert_to_native
|
||||
|
||||
# Values to exclude from filter dropdowns (empty strings, non-applicable labels)
|
||||
EXCLUDED_FILTER_VALUES = {"", "Not applicable", "Does not apply"}
|
||||
|
||||
# Maps user-facing phase filter values to the GIAS PhaseOfEducation values they include.
|
||||
# All-through schools appear in both primary and secondary results.
|
||||
PHASE_GROUPS: dict[str, set[str]] = {
|
||||
"primary": {"primary", "middle deemed primary", "all-through"},
|
||||
"secondary": {"secondary", "middle deemed secondary", "all-through", "16 plus"},
|
||||
"all-through": {"all-through"},
|
||||
}
|
||||
|
||||
# Must match SITE_URL in nextjs-app/lib/site.ts. The apex 301s to www, and a
|
||||
# sitemap <loc> that redirects wastes a crawl on every URL it lists.
|
||||
BASE_URL = "https://www.schoolcompare.co.uk"
|
||||
@@ -273,6 +266,27 @@ def _places_payload(urn: int) -> list[dict]:
|
||||
return payload
|
||||
|
||||
|
||||
def _nearby_schools_payload(urn: int) -> list[dict]:
|
||||
"""The nearest eligible schools this page may offer, closest first.
|
||||
|
||||
Phase and reach are read from the school's own row inside select_nearby,
|
||||
so nothing here can hand it a phase that disagrees with the data.
|
||||
|
||||
Wrapped: a failure in selection must never 500 a page that is otherwise
|
||||
complete, which is the posture get_supplementary_data already takes. The
|
||||
section simply does not render.
|
||||
"""
|
||||
try:
|
||||
return select_nearby(load_latest_school_data(), int(urn))
|
||||
except Exception:
|
||||
import logging
|
||||
|
||||
logging.getLogger(__name__).exception(
|
||||
"Nearby schools selection failed for urn=%s", urn
|
||||
)
|
||||
return []
|
||||
|
||||
|
||||
def _place_sitemap_rows(kinds: tuple[str, ...], registry=None) -> list[str]:
|
||||
"""A <url> per place, plus a phase variant wherever that phase clears the
|
||||
threshold on its own.
|
||||
@@ -983,6 +997,10 @@ async def get_school_details(request: Request, urn: int):
|
||||
# and authority both fall below the publish threshold has nowhere to
|
||||
# point, and the page renders without the module.
|
||||
"places": _places_payload(urn),
|
||||
# The nearest eligible schools, closest first. Always present on a
|
||||
# build with this code; the frontend treats absent and empty
|
||||
# identically, which is what lets the two images deploy independently.
|
||||
"nearby_schools": _nearby_schools_payload(urn),
|
||||
"yearly_data": clean_for_json(school_data),
|
||||
# Supplementary data (null if not yet populated by Kestra)
|
||||
"ofsted": supplementary.get("ofsted"),
|
||||
|
||||
@@ -0,0 +1,259 @@
|
||||
"""Which nearby schools a detail page may offer as alternatives.
|
||||
|
||||
HARD FILTERS decide eligibility, and encode claims the section is not allowed
|
||||
to make. A selective school is not an alternative to a non-selective one, a
|
||||
special school is not comparable to a mainstream one, and a Girls school is not
|
||||
an option for a Boys school's reader. They never relax, at any distance, even
|
||||
where that means the section does not render at all.
|
||||
|
||||
DISTANCE decides the order, and nothing else does.
|
||||
|
||||
An earlier version ranked by intake similarity first and used distance only as
|
||||
a tiebreak. That put a Catholic school 2.9 miles away above the community
|
||||
school 0.3 miles down the road, and — because the row filled from the best tier
|
||||
before widening — filled all six slots with faith matches while omitting every
|
||||
school a parent could actually walk to. For a primary, a school that far is not
|
||||
a weaker option; it is not an option. Distance is a constraint and intake is a
|
||||
preference, and the ranking now says so.
|
||||
|
||||
Similarity survives as `shared`: what a candidate genuinely has in common with
|
||||
this school, reported on its card, so a reader applies their own weighting
|
||||
instead of having ours applied for them.
|
||||
|
||||
Pure functions over a DataFrame: no I/O, no FastAPI, no database.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
|
||||
from .schemas import PHASE_GROUPS
|
||||
|
||||
# Three fit the row; the rest are behind the carousel arrows.
|
||||
MAX_SCHOOLS = 6
|
||||
MINIMUM = 2
|
||||
|
||||
# How far the section will reach, in miles, when nothing closer exists.
|
||||
#
|
||||
# A sanity bound rather than a target: ordering by distance already handles
|
||||
# density, so a school in a dense area fills all six slots inside a mile and
|
||||
# never sees this. It decides one thing — what happens where the area is
|
||||
# sparse — and the answer differs by phase because catchments do. Primary
|
||||
# catchments are routinely under a mile; beyond two, a primary is not a weaker
|
||||
# option but not an option, and no section is the honest answer.
|
||||
PRIMARY_RADIUS_MILES = 2.0
|
||||
SECONDARY_RADIUS_MILES = 6.0
|
||||
POST16_RADIUS_MILES = 10.0
|
||||
|
||||
EARTH_RADIUS_MILES = 3958.8
|
||||
|
||||
_SPECIAL = re.compile(r"\bspecial\b|pupil referral|alternative provision", re.I)
|
||||
|
||||
# Values that mean "this school has no religious character".
|
||||
_NO_FAITH = {"", "none", "does not apply", "not applicable"}
|
||||
|
||||
|
||||
def is_special_provision(school_type: str | None) -> bool:
|
||||
"""Mirror of isSpecialSchool() in nextjs-app/lib/utils.ts.
|
||||
|
||||
Special schools carry a mainstream phase, so phase alone cannot identify
|
||||
them. The two implementations must agree: a school the frontend treats as
|
||||
special for benchmarking but this treats as mainstream would be dropped
|
||||
from its own England comparison and then offered as a peer to a mainstream
|
||||
school on the next page along.
|
||||
"""
|
||||
return bool(_SPECIAL.search(school_type or ""))
|
||||
|
||||
|
||||
def is_selective(admissions_policy: str | None) -> bool:
|
||||
"""Strictly selective. Unknown counts as non-selective, which is the safe
|
||||
direction: it can only ever exclude a pairing, never invent one."""
|
||||
return (admissions_policy or "").strip().lower() == "selective"
|
||||
|
||||
|
||||
def faith_key(denomination: str | None) -> str:
|
||||
value = (denomination or "").strip().lower()
|
||||
return "" if value in _NO_FAITH else value
|
||||
|
||||
|
||||
def faith_label(denomination: str | None) -> str:
|
||||
return denomination.strip() if faith_key(denomination) else "No religious character"
|
||||
|
||||
|
||||
def genders_compatible(a: str | None, b: str | None) -> bool:
|
||||
single = {"boys", "girls"}
|
||||
left, right = (a or "").strip().lower(), (b or "").strip().lower()
|
||||
return not (left in single and right in single and left != right)
|
||||
|
||||
|
||||
def is_secondary_phase(phase: str | None) -> bool:
|
||||
"""Whether this phase takes the secondary side: secondary group membership,
|
||||
minus all-through.
|
||||
|
||||
Membership is read from PHASE_GROUPS rather than tested with `"secondary" in
|
||||
phase`, because that substring misses "16 plus" — GIAS phase 6, which
|
||||
PHASE_GROUPS deliberately files as secondary. The substring version fails
|
||||
silently rather than loudly: a sixth-form college is simply handed the
|
||||
primary bucket and offered infant schools as peers.
|
||||
|
||||
All-through is the exception. PHASE_GROUPS lists it on both sides because it
|
||||
belongs on both phases' place pages, but the detail page renders it with the
|
||||
primary template, and the metric follows the template.
|
||||
"""
|
||||
text = (phase or "").strip().lower()
|
||||
return text != "all-through" and text in PHASE_GROUPS["secondary"]
|
||||
|
||||
|
||||
def radius_miles(phase: str | None) -> float:
|
||||
"""How far this phase's section will reach when nothing closer exists."""
|
||||
if (phase or "").strip().lower() == "16 plus":
|
||||
return POST16_RADIUS_MILES
|
||||
return SECONDARY_RADIUS_MILES if is_secondary_phase(phase) else PRIMARY_RADIUS_MILES
|
||||
|
||||
|
||||
def _phase_group(is_secondary: bool) -> set[str]:
|
||||
return PHASE_GROUPS["secondary" if is_secondary else "primary"]
|
||||
|
||||
|
||||
def _haversine_miles(lat1: float, lon1: float, lat2, lon2):
|
||||
"""Vectorised, matching the postcode search in app.py."""
|
||||
lat1_r, lon1_r = np.radians(lat1), np.radians(lon1)
|
||||
lat2_r, lon2_r = np.radians(lat2.astype(float)), np.radians(lon2.astype(float))
|
||||
dlat, dlon = lat2_r - lat1_r, lon2_r - lon1_r
|
||||
a = np.sin(dlat / 2) ** 2 + np.cos(lat1_r) * np.cos(lat2_r) * np.sin(dlon / 2) ** 2
|
||||
return 2 * EARTH_RADIUS_MILES * np.arcsin(np.sqrt(a))
|
||||
|
||||
|
||||
def _native(value):
|
||||
"""NaN and numpy scalars both reach JSONResponse badly; normalise here so
|
||||
the caller never has to remember to."""
|
||||
if value is None:
|
||||
return None
|
||||
if isinstance(value, np.generic):
|
||||
value = value.item()
|
||||
if isinstance(value, float) and np.isnan(value):
|
||||
return None
|
||||
return value
|
||||
|
||||
|
||||
def _mask(series: pd.Series, predicate) -> pd.Series:
|
||||
"""A boolean mask that survives an empty frame.
|
||||
|
||||
`Series.apply` on an empty Series returns an empty *DataFrame*, and using
|
||||
that as a mask silently drops every column — so the next column lookup
|
||||
raises KeyError rather than yielding no rows. This is not hypothetical: a
|
||||
special school with no special school near it empties the frame at the
|
||||
provision filter, which is the ordinary case for most special schools.
|
||||
"""
|
||||
return pd.Series([predicate(value) for value in series], index=series.index, dtype=bool)
|
||||
|
||||
|
||||
def _shared(subject: pd.Series, candidate: pd.Series, is_secondary: bool) -> list[str]:
|
||||
"""What this candidate genuinely has in common with the subject.
|
||||
|
||||
Empty is a real answer, and renders no chips at all. A card claiming a
|
||||
shared characteristic it does not have would be worse than a bare one —
|
||||
and since these no longer affect the order, an empty list costs the school
|
||||
nothing but its place in the row, which distance already decided.
|
||||
"""
|
||||
shared: list[str] = []
|
||||
|
||||
gender = str(subject.get("gender") or "").strip()
|
||||
if gender and str(candidate.get("gender") or "").strip().lower() == gender.lower():
|
||||
shared.append(gender)
|
||||
|
||||
if is_secondary:
|
||||
policy = str(candidate.get("admissions_policy") or "").strip()
|
||||
subject_policy = str(subject.get("admissions_policy") or "").strip()
|
||||
if (
|
||||
policy
|
||||
and policy.lower() == subject_policy.lower()
|
||||
and policy.lower() not in {"not applicable", "unknown"}
|
||||
):
|
||||
shared.append(policy)
|
||||
|
||||
if faith_key(candidate.get("religious_denomination")) == faith_key(
|
||||
subject.get("religious_denomination")
|
||||
):
|
||||
shared.append(faith_label(candidate.get("religious_denomination")))
|
||||
|
||||
return shared
|
||||
|
||||
|
||||
def select_nearby(frame: pd.DataFrame, urn: int) -> list[dict]:
|
||||
"""The nearest eligible schools, closest first — at most MAX_SCHOOLS, and
|
||||
none at all below MINIMUM.
|
||||
|
||||
The phase is read from the subject's own row rather than passed in, so a
|
||||
caller cannot hand this a phase that disagrees with the data it selects
|
||||
from.
|
||||
"""
|
||||
subject_rows = frame[frame["urn"] == urn]
|
||||
if subject_rows.empty:
|
||||
return []
|
||||
subject = subject_rows.iloc[0]
|
||||
|
||||
lat, lon = _native(subject.get("latitude")), _native(subject.get("longitude"))
|
||||
if lat is None or lon is None:
|
||||
return []
|
||||
|
||||
phase = subject.get("phase")
|
||||
is_secondary = is_secondary_phase(phase)
|
||||
reach = radius_miles(phase)
|
||||
metric_key = "attainment_8_score" if is_secondary else "rwm_expected_pct"
|
||||
|
||||
candidates = frame[frame["urn"] != urn].copy()
|
||||
for column in ("latitude", "longitude"):
|
||||
candidates = candidates[candidates[column].notna()]
|
||||
if candidates.empty:
|
||||
return []
|
||||
|
||||
# ── Hard filters ────────────────────────────────────────────────────
|
||||
allowed_phases = _phase_group(is_secondary)
|
||||
candidates = candidates[
|
||||
candidates["phase"].fillna("").str.lower().isin(allowed_phases)
|
||||
]
|
||||
candidates = candidates[candidates["status"].fillna("").str.lower().str.startswith("open")]
|
||||
|
||||
subject_special = is_special_provision(subject.get("school_type"))
|
||||
special = _mask(candidates["school_type"], is_special_provision)
|
||||
candidates = candidates[special if subject_special else ~special]
|
||||
|
||||
subject_selective = is_selective(subject.get("admissions_policy"))
|
||||
selective = _mask(candidates["admissions_policy"], is_selective)
|
||||
candidates = candidates[selective if subject_selective else ~selective]
|
||||
|
||||
subject_gender = subject.get("gender")
|
||||
candidates = candidates[
|
||||
_mask(candidates["gender"], lambda g: genders_compatible(subject_gender, g))
|
||||
]
|
||||
if candidates.empty:
|
||||
return []
|
||||
|
||||
candidates["distance_miles"] = _haversine_miles(
|
||||
lat, lon, candidates["latitude"].values, candidates["longitude"].values
|
||||
).round(1)
|
||||
|
||||
# ── Nearest first, and nothing else has a say ───────────────────────
|
||||
within = candidates[candidates["distance_miles"] <= reach]
|
||||
if len(within) < MINIMUM:
|
||||
return []
|
||||
|
||||
selected = within.sort_values(["distance_miles", "urn"]).head(MAX_SCHOOLS)
|
||||
return [
|
||||
{
|
||||
"urn": int(row["urn"]),
|
||||
"school_name": str(row.get("school_name") or ""),
|
||||
"distance_miles": float(row["distance_miles"]),
|
||||
"school_type": _native(row.get("school_type")),
|
||||
"age_range": _native(row.get("age_range")),
|
||||
"shared": _shared(subject, row, is_secondary),
|
||||
"metric_value": _native(row.get(metric_key)),
|
||||
"metric_key": metric_key,
|
||||
"metric_year": _native(row.get("year")),
|
||||
}
|
||||
for _, row in selected.iterrows()
|
||||
]
|
||||
@@ -532,6 +532,18 @@ RANKING_COLUMNS = [
|
||||
"gcse_grade_91_pct",
|
||||
]
|
||||
|
||||
# Maps user-facing phase filter values to the GIAS PhaseOfEducation values they
|
||||
# include. All-through schools appear in both primary and secondary results,
|
||||
# which is why this is a set per phase rather than a single string comparison.
|
||||
#
|
||||
# Lives here rather than in app.py because nearby_schools.py needs it too, and
|
||||
# importing app from there would be a cycle.
|
||||
PHASE_GROUPS: dict[str, set[str]] = {
|
||||
"primary": {"primary", "middle deemed primary", "all-through"},
|
||||
"secondary": {"secondary", "middle deemed secondary", "all-through", "16 plus"},
|
||||
"all-through": {"all-through"},
|
||||
}
|
||||
|
||||
# School listing columns
|
||||
SCHOOL_COLUMNS = [
|
||||
"urn",
|
||||
|
||||
@@ -0,0 +1,383 @@
|
||||
"""Selection rules for the nearby-schools section.
|
||||
|
||||
Hard filters encode claims the section is not allowed to make — that a
|
||||
selective school is an alternative to a non-selective one, that a special
|
||||
school is comparable to a mainstream one, or that a Girls school is an option
|
||||
for a Boys school's reader. They decide who is eligible.
|
||||
|
||||
Distance decides the order, and nothing else does. An earlier version ranked by
|
||||
intake similarity first, which put a Catholic school 2.9 miles away above the
|
||||
community school 0.3 miles down the road — for a primary, a school that far is
|
||||
not a weaker option, it is not an option. Similarity is now reported on the
|
||||
card and never reorders the row.
|
||||
"""
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
|
||||
from backend.nearby_schools import (
|
||||
is_secondary_phase,
|
||||
radius_miles,
|
||||
select_nearby,
|
||||
)
|
||||
|
||||
BASE_LAT, BASE_LON = 51.5000, -0.1000
|
||||
|
||||
|
||||
def _row(urn, name, **overrides):
|
||||
base = {
|
||||
"urn": urn,
|
||||
"school_name": name,
|
||||
"local_authority": "Testshire",
|
||||
"school_type": "Community school",
|
||||
"phase": "Primary",
|
||||
"age_range": "4-11",
|
||||
"status": "Open",
|
||||
"gender": "Mixed",
|
||||
"religious_denomination": "None",
|
||||
"admissions_policy": "Not applicable",
|
||||
"latitude": BASE_LAT,
|
||||
"longitude": BASE_LON,
|
||||
"year": 202425,
|
||||
"rwm_expected_pct": 70.0,
|
||||
"attainment_8_score": np.nan,
|
||||
}
|
||||
base.update(overrides)
|
||||
return base
|
||||
|
||||
|
||||
def _frame(*rows):
|
||||
return pd.DataFrame(list(rows))
|
||||
|
||||
|
||||
def _at(miles):
|
||||
"""A latitude `miles` north of BASE_LAT."""
|
||||
return BASE_LAT + miles / 69.0
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Order: distance, and only distance
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_returns_nearest_first():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "Mid", latitude=_at(1.0)),
|
||||
_row(100003, "Near", latitude=_at(0.4)),
|
||||
_row(100004, "Far", latitude=_at(1.8)),
|
||||
)
|
||||
result = select_nearby(frame, 100001)
|
||||
assert [s["urn"] for s in result] == [100003, 100002, 100004]
|
||||
assert result[0]["distance_miles"] == 0.4
|
||||
|
||||
|
||||
def test_a_faith_match_never_outranks_a_closer_school():
|
||||
"""The reported defect. A Catholic primary surrounded by Catholic primaries
|
||||
showed six of them and omitted the community school down the road."""
|
||||
frame = _frame(
|
||||
_row(100001, "St Jude's RC Primary", religious_denomination="Roman Catholic"),
|
||||
_row(100002, "Elm Grove Primary", religious_denomination="None", latitude=_at(0.3)),
|
||||
_row(100003, "Holy Cross RC", religious_denomination="Roman Catholic", latitude=_at(0.8)),
|
||||
_row(100004, "Sacred Heart RC", religious_denomination="Roman Catholic", latitude=_at(1.2)),
|
||||
_row(100005, "St Peter's RC", religious_denomination="Roman Catholic", latitude=_at(1.6)),
|
||||
)
|
||||
result = select_nearby(frame, 100001)
|
||||
assert result[0]["urn"] == 100002, "the nearest school leads, whatever its intake"
|
||||
assert [s["distance_miles"] for s in result] == sorted(s["distance_miles"] for s in result)
|
||||
|
||||
|
||||
def test_the_nearest_eligible_school_is_always_shown():
|
||||
"""Whatever else changes, a section titled "nearby" cannot omit the nearest
|
||||
school while listing one four times further away."""
|
||||
frame = _frame(
|
||||
_row(100001, "Subject", gender="Boys", religious_denomination="Roman Catholic"),
|
||||
_row(100002, "Nearest", gender="Mixed", religious_denomination="None", latitude=_at(0.2)),
|
||||
*[
|
||||
_row(100010 + n, f"Match {n}", gender="Boys",
|
||||
religious_denomination="Roman Catholic", latitude=_at(0.9 + n * 0.1))
|
||||
for n in range(6)
|
||||
],
|
||||
)
|
||||
assert select_nearby(frame, 100001)[0]["urn"] == 100002
|
||||
|
||||
|
||||
def test_caps_at_six_taking_the_nearest():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
*[_row(100010 + n, f"Peer {n}", latitude=_at(0.1 * (n + 1))) for n in range(7)],
|
||||
)
|
||||
result = select_nearby(frame, 100001)
|
||||
assert len(result) == 6
|
||||
assert 100016 not in {s["urn"] for s in result}, "the seventh-nearest is the one dropped"
|
||||
|
||||
|
||||
def test_fewer_than_two_matches_returns_empty():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "Only neighbour", latitude=_at(0.5)),
|
||||
)
|
||||
assert select_nearby(frame, 100001) == []
|
||||
|
||||
|
||||
def test_excludes_the_subject_school():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "A", latitude=_at(0.5)),
|
||||
_row(100003, "B", latitude=_at(0.6)),
|
||||
)
|
||||
assert 100001 not in {s["urn"] for s in select_nearby(frame, 100001)}
|
||||
|
||||
|
||||
def test_a_school_is_never_listed_twice():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "A", latitude=_at(0.5)),
|
||||
_row(100003, "B", latitude=_at(0.6)),
|
||||
)
|
||||
result = select_nearby(frame, 100001)
|
||||
assert len(result) == len({s["urn"] for s in result})
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Reach: a sanity bound, not a target
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_primary_does_not_reach_past_two_miles():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "Just inside", latitude=_at(1.9)),
|
||||
_row(100003, "Just outside", latitude=_at(2.4)),
|
||||
_row(100004, "Miles away", latitude=_at(4.0)),
|
||||
)
|
||||
# One inside the cap is below the minimum, so nothing renders at all —
|
||||
# a primary with nothing within two miles has no nearby schools.
|
||||
assert select_nearby(frame, 100001) == []
|
||||
|
||||
|
||||
def test_secondary_reaches_further_than_primary():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject", phase="Secondary"),
|
||||
_row(100002, "A", phase="Secondary", latitude=_at(3.0)),
|
||||
_row(100003, "B", phase="Secondary", latitude=_at(5.5)),
|
||||
)
|
||||
assert {s["urn"] for s in select_nearby(frame, 100001)} == {100002, 100003}
|
||||
|
||||
|
||||
def test_the_cap_follows_the_phase():
|
||||
assert radius_miles("Primary") == 2.0
|
||||
assert radius_miles("Middle deemed primary") == 2.0
|
||||
assert radius_miles("All-through") == 2.0
|
||||
assert radius_miles("Secondary") == 6.0
|
||||
assert radius_miles("Middle deemed secondary") == 6.0
|
||||
# Post-16 is the phase people travel furthest for.
|
||||
assert radius_miles("16 plus") == 10.0
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Hard filters: eligibility, never order
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_selective_never_meets_non_selective():
|
||||
frame = _frame(
|
||||
_row(100001, "Grammar", phase="Secondary", admissions_policy="Selective"),
|
||||
_row(100002, "Comp A", phase="Secondary", admissions_policy="Non-selective", latitude=_at(0.5)),
|
||||
_row(100003, "Comp B", phase="Secondary", admissions_policy="Non-selective", latitude=_at(0.6)),
|
||||
)
|
||||
assert select_nearby(frame, 100001) == []
|
||||
assert 100001 not in {s["urn"] for s in select_nearby(frame, 100002)}
|
||||
|
||||
|
||||
def test_special_schools_match_only_each_other():
|
||||
frame = _frame(
|
||||
_row(100001, "Special", school_type="Community special school"),
|
||||
_row(100002, "Mainstream A", latitude=_at(0.5)),
|
||||
_row(100003, "Mainstream B", latitude=_at(0.6)),
|
||||
)
|
||||
assert select_nearby(frame, 100001) == []
|
||||
assert select_nearby(frame, 100002) == []
|
||||
|
||||
|
||||
def test_boys_never_meets_girls():
|
||||
frame = _frame(
|
||||
_row(100001, "Boys School", gender="Boys"),
|
||||
_row(100002, "Girls School", gender="Girls", latitude=_at(0.5)),
|
||||
_row(100003, "Mixed School", gender="Mixed", latitude=_at(0.6)),
|
||||
_row(100004, "Another Mixed", gender="Mixed", latitude=_at(0.7)),
|
||||
)
|
||||
urns = {s["urn"] for s in select_nearby(frame, 100001)}
|
||||
assert 100002 not in urns
|
||||
assert urns == {100003, 100004}
|
||||
|
||||
|
||||
def test_closed_schools_and_missing_coordinates_are_dropped():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "Closed", status="Closed", latitude=_at(0.5)),
|
||||
_row(100003, "No coords", latitude=np.nan, longitude=np.nan),
|
||||
_row(100004, "Good A", latitude=_at(0.6)),
|
||||
_row(100005, "Good B", latitude=_at(0.7)),
|
||||
)
|
||||
assert {s["urn"] for s in select_nearby(frame, 100001)} == {100004, 100005}
|
||||
|
||||
|
||||
def test_all_through_is_offered_on_both_phase_sides():
|
||||
frame = _frame(
|
||||
_row(100001, "Primary subject", phase="Primary"),
|
||||
_row(100002, "All through", phase="All-through", latitude=_at(0.5)),
|
||||
_row(100003, "Primary peer", phase="Primary", latitude=_at(0.6)),
|
||||
)
|
||||
assert 100002 in {s["urn"] for s in select_nearby(frame, 100001)}
|
||||
|
||||
secondary = _frame(
|
||||
_row(100010, "Secondary subject", phase="Secondary"),
|
||||
_row(100002, "All through", phase="All-through", latitude=_at(0.5)),
|
||||
_row(100011, "Secondary peer", phase="Secondary", latitude=_at(0.6)),
|
||||
)
|
||||
assert 100002 in {s["urn"] for s in select_nearby(secondary, 100010)}
|
||||
|
||||
|
||||
def test_sixteen_plus_is_matched_against_secondary_not_primary():
|
||||
"""GIAS phase 6 is "16 plus", and PHASE_GROUPS puts it in the secondary
|
||||
group — a sixth-form college's peers are secondaries and other colleges,
|
||||
never primary schools. A substring test for "secondary" misses it silently:
|
||||
no crash, just a page offering infant schools to a sixth form."""
|
||||
frame = _frame(
|
||||
_row(100001, "Sixth Form College", phase="16 plus", age_range="16-19"),
|
||||
_row(100002, "Nearby Secondary", phase="Secondary", latitude=_at(0.5),
|
||||
attainment_8_score=52.0),
|
||||
_row(100003, "Nearby College", phase="16 plus", latitude=_at(0.6)),
|
||||
_row(100004, "Nearby Primary", phase="Primary", latitude=_at(0.1)),
|
||||
)
|
||||
result = select_nearby(frame, 100001)
|
||||
urns = {s["urn"] for s in result}
|
||||
assert 100004 not in urns, "a primary school is not a peer for a sixth form"
|
||||
assert urns == {100002, 100003}
|
||||
assert all(s["metric_key"] == "attainment_8_score" for s in result)
|
||||
|
||||
|
||||
def test_is_secondary_phase_agrees_with_the_phase_groups_it_selects_from():
|
||||
for phase in ("Secondary", "Middle deemed secondary", "16 plus"):
|
||||
assert is_secondary_phase(phase) is True, phase
|
||||
for phase in ("Primary", "Middle deemed primary", "Nursery", "", None):
|
||||
assert is_secondary_phase(phase) is False, phase
|
||||
# In PHASE_GROUPS an all-through school is on both sides, but it renders
|
||||
# with the primary template, and the metric follows the phase side.
|
||||
assert is_secondary_phase("All-through") is False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# What the card reports
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_shared_lists_only_what_is_actually_shared():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject", phase="Secondary", gender="Mixed",
|
||||
religious_denomination="None", admissions_policy="Non-selective"),
|
||||
_row(100002, "Full match", phase="Secondary", gender="Mixed",
|
||||
religious_denomination="None", admissions_policy="Non-selective", latitude=_at(0.5)),
|
||||
_row(100003, "Faith differs", phase="Secondary", gender="Mixed",
|
||||
religious_denomination="Church of England", admissions_policy="Non-selective", latitude=_at(0.6)),
|
||||
)
|
||||
by_urn = {s["urn"]: s for s in select_nearby(frame, 100001)}
|
||||
assert by_urn[100002]["shared"] == ["Mixed", "Non-selective", "No religious character"]
|
||||
assert by_urn[100003]["shared"] == ["Mixed", "Non-selective"]
|
||||
|
||||
|
||||
def test_a_shared_faith_is_named():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject", religious_denomination="Roman Catholic"),
|
||||
_row(100002, "Also RC", religious_denomination="Roman Catholic", latitude=_at(0.4)),
|
||||
_row(100003, "Secular", religious_denomination="None", latitude=_at(0.5)),
|
||||
)
|
||||
by_urn = {s["urn"]: s for s in select_nearby(frame, 100001)}
|
||||
assert "Roman Catholic" in by_urn[100002]["shared"]
|
||||
assert by_urn[100003]["shared"] == ["Mixed"]
|
||||
|
||||
|
||||
def test_shared_is_empty_when_nothing_is_shared():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject", gender="Boys", religious_denomination="Roman Catholic"),
|
||||
_row(100002, "A", gender="Mixed", religious_denomination="None", latitude=_at(0.4)),
|
||||
_row(100003, "B", gender="Mixed", religious_denomination="Church of England", latitude=_at(0.5)),
|
||||
)
|
||||
assert all(s["shared"] == [] for s in select_nearby(frame, 100001))
|
||||
|
||||
|
||||
def test_no_tier_is_reported_because_there_are_no_tiers():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "A", latitude=_at(0.4)),
|
||||
_row(100003, "B", latitude=_at(0.5)),
|
||||
)
|
||||
assert all("tier" not in s for s in select_nearby(frame, 100001))
|
||||
|
||||
|
||||
def test_metric_follows_the_phase_side_not_the_neighbour():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject", phase="Secondary", attainment_8_score=50.0),
|
||||
_row(100002, "A", phase="Secondary", attainment_8_score=52.8, latitude=_at(0.5)),
|
||||
_row(100003, "B", phase="Secondary", attainment_8_score=np.nan, latitude=_at(0.6)),
|
||||
)
|
||||
by_urn = {s["urn"]: s for s in select_nearby(frame, 100001)}
|
||||
assert by_urn[100002]["metric_key"] == "attainment_8_score"
|
||||
assert by_urn[100002]["metric_value"] == 52.8
|
||||
assert by_urn[100002]["metric_year"] == 202425
|
||||
assert by_urn[100003]["metric_value"] is None
|
||||
|
||||
|
||||
def test_values_are_json_safe_native_types():
|
||||
frame = _frame(
|
||||
_row(100001, "Subject"),
|
||||
_row(100002, "A", latitude=_at(0.5)),
|
||||
_row(100003, "B", latitude=_at(0.6)),
|
||||
)
|
||||
for school in select_nearby(frame, 100001):
|
||||
assert isinstance(school["urn"], int)
|
||||
assert isinstance(school["distance_miles"], float)
|
||||
assert not isinstance(school["metric_value"], np.generic)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# The endpoint
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
|
||||
def _endpoint_frame():
|
||||
return _frame(
|
||||
_row(100001, "Subject Primary"),
|
||||
_row(100002, "Neighbour A", latitude=_at(0.5)),
|
||||
_row(100003, "Neighbour B", latitude=_at(0.6)),
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def client(monkeypatch):
|
||||
from backend import app as app_module
|
||||
|
||||
monkeypatch.setattr(app_module, "load_latest_school_data", _endpoint_frame)
|
||||
monkeypatch.setattr(app_module, "load_school_data", _endpoint_frame)
|
||||
monkeypatch.setattr(app_module, "get_supplementary_data", lambda db, urn: {})
|
||||
return TestClient(app_module.app, raise_server_exceptions=False)
|
||||
|
||||
|
||||
def test_detail_payload_carries_nearby_schools(client):
|
||||
resp = client.get("/api/schools/100001")
|
||||
assert resp.status_code == 200, resp.text
|
||||
similar = resp.json()["nearby_schools"]
|
||||
assert [s["school_name"] for s in similar] == ["Neighbour A", "Neighbour B"]
|
||||
assert similar[0]["metric_key"] == "rwm_expected_pct"
|
||||
|
||||
|
||||
def test_a_failure_in_selection_does_not_break_the_page(client, monkeypatch):
|
||||
from backend import app as app_module
|
||||
|
||||
def _explode(*args, **kwargs):
|
||||
raise ValueError("selection blew up")
|
||||
|
||||
monkeypatch.setattr(app_module, "select_nearby", _explode)
|
||||
resp = client.get("/api/schools/100001")
|
||||
assert resp.status_code == 200, resp.text
|
||||
assert resp.json()["nearby_schools"] == []
|
||||
@@ -73,7 +73,12 @@ There is no SWR dependency. Leaflet maps are loaded through dynamic wrappers;
|
||||
Chart.js renders performance and comparison charts.
|
||||
|
||||
`components/school/` contains detail sections, with section decisions and data
|
||||
preparation in `lib/schoolSections.ts`. `lib/types.ts` contains manually maintained
|
||||
preparation in `lib/schoolSections.ts`. The nearby-schools section is selected in
|
||||
`backend/nearby_schools.py` — hard filters decide eligibility (phase, provision,
|
||||
selectivity, gender) and distance alone decides the order, capped per phase —
|
||||
and served on `/api/schools/{urn}`. Its rules are presentation logic,
|
||||
deliberately kept out of `marts.*` so they can be tuned by deploy rather than by
|
||||
pipeline run. `lib/types.ts` contains manually maintained
|
||||
API types. `payload-types.ts` and the Payload import map are generated artifacts.
|
||||
|
||||
## Publication and caching today
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,432 @@
|
||||
# Other Schools Nearby — Design
|
||||
|
||||
**Date:** 2026-09-21, revised 2026-09-22
|
||||
**Status:** revised after staging review
|
||||
**Scope:** school detail pages, both phase templates
|
||||
|
||||
> **Revision, 2026-09-22.** The first build ranked by intake similarity and used
|
||||
> distance as a tiebreak. On staging a Catholic primary showed six Catholic
|
||||
> primaries, none of them close enough to be a real option, and omitted the
|
||||
> community school down the road. Distance now decides the order and nothing
|
||||
> else does; the tier system is gone. The reasoning is kept below rather than
|
||||
> quietly overwritten, because the mistake is the instructive part.
|
||||
|
||||
## Goal
|
||||
|
||||
Give a school detail page an answer to the question every reader arrives with
|
||||
after the results tables: *and what else is around here?*
|
||||
|
||||
Today a school page links outward to its place pages through
|
||||
`components/school/NearbyPlaces.tsx` and nowhere else. It never links to another
|
||||
school. This section adds that edge — up to six nearby schools of the same phase
|
||||
and a comparable intake, three at a time in a carousel, each a crawlable link and
|
||||
each addable to the comparison basket in one click.
|
||||
|
||||
Mockup, in both themes (drawn against the original tiered design, so its ledes
|
||||
and chip fallbacks are one revision behind the copy specified below):
|
||||
<https://claude.ai/artifact/168KdUMcfkUeGWW2FGjuec>
|
||||
|
||||
Source of the same page in the repo: `mockups/similar-schools-nearby.html`.
|
||||
|
||||
## The constraint that shapes everything
|
||||
|
||||
**A nearby school is not automatically a comparable school.**
|
||||
|
||||
The section's whole value is that a reader treats what it shows as a shortlist.
|
||||
That makes every card an implicit claim that the school is a realistic
|
||||
alternative, and there are three ways that claim goes wrong:
|
||||
|
||||
1. A **selective** school beside a non-selective one. Their intakes are
|
||||
different by construction, so putting their Attainment 8 figures side by side
|
||||
invites a conclusion the data cannot support.
|
||||
2. A **special school, PRU or AP** beside a mainstream school. This is the same
|
||||
error PR #70 fixed for the England benchmark, where Greenmead (URN 101099)
|
||||
rendered "0% — 62 below England".
|
||||
3. A **single-sex** school of the opposite sex. Not a weak match — not an option
|
||||
at all.
|
||||
|
||||
So the design separates two kinds of fact, and never confuses them:
|
||||
|
||||
- **Hard filters** encode the claims above. They decide eligibility, and are
|
||||
never relaxed at any distance, even if that means the section does not render.
|
||||
- **Shared characteristics** — gender, religious character, selectivity —
|
||||
describe how closely an intake resembles this school's. They are *reported on
|
||||
the card and never ranked on*, so the reader weighs them rather than having
|
||||
them weighed for them.
|
||||
|
||||
Everything below follows from that split. The revision at the top of this
|
||||
document is what happens when the second kind is treated as the first.
|
||||
|
||||
## Selection algorithm
|
||||
|
||||
A backend helper, `_nearby_schools_payload(urn)` in `backend/app.py`, modelled
|
||||
on the existing `_places_payload(urn)` and delegating to
|
||||
`backend/nearby_schools.select_nearby(frame, urn)`, which operates on the cached
|
||||
`load_latest_school_data()` frame — one row per URN, already carrying
|
||||
`latitude`, `longitude`, `phase`, `gender`, `religious_denomination`,
|
||||
`admissions_policy`, `school_type` and `status`.
|
||||
|
||||
### Hard filters
|
||||
|
||||
| Filter | Rule |
|
||||
|---|---|
|
||||
| Self | `urn` is excluded |
|
||||
| Status | GIAS status must be open |
|
||||
| Coordinates | both `latitude` and `longitude` present on both schools |
|
||||
| Phase | same phase group via the existing `PHASE_GROUPS` map |
|
||||
| Provision | special/PRU/AP match only each other |
|
||||
| Selectivity | selective matches selective; non-selective matches non-selective |
|
||||
| Gender | Boys never matches Girls; Mixed is compatible with both |
|
||||
|
||||
`PHASE_GROUPS` is reused rather than re-derived so an all-through school is
|
||||
offered correctly on both the primary and secondary sides, exactly as it already
|
||||
behaves in search.
|
||||
|
||||
The provision filter needs a backend counterpart to the frontend's
|
||||
`isSpecialSchool()` in `nextjs-app/lib/utils.ts:897`, reading the same GIAS
|
||||
establishment types through `backend/gias_codes.py`. The two must agree: a
|
||||
school the frontend treats as special for benchmarking but the backend treats as
|
||||
mainstream for matching would be dropped from its own England comparison and
|
||||
then offered as a peer to a mainstream school on the next page along.
|
||||
|
||||
**Up to six cards, three visible.** Three fit the row; the rest are reached with
|
||||
the carousel arrows. Two is the minimum that renders at all.
|
||||
|
||||
### Order: distance, and nothing else
|
||||
|
||||
The nearest eligible schools, closest first. Similarity does not enter the
|
||||
ranking at any point.
|
||||
|
||||
**Why not, having built it the other way first.** The original design ranked by
|
||||
tiers — same gender and faith within 3 miles, then same gender within 5, then
|
||||
anything within 10 — and used distance only to order the result. Two things
|
||||
followed, and both showed up on the first Catholic primary anyone looked at:
|
||||
|
||||
- A faith match at 2.9 miles outranked a community school at 0.3 miles. For a
|
||||
primary, whose catchment is routinely under a mile, the far school is not a
|
||||
weaker option; it is not an option.
|
||||
- Because the row filled from the best tier before widening, three Catholic
|
||||
schools within 3 miles were enough to fill all six slots with Catholic
|
||||
schools. The stopping rule that produced this had been added to prevent the
|
||||
*opposite* failure — padding a row with weak distant matches — and made this
|
||||
one certain.
|
||||
|
||||
The premise was backwards. **Distance is a constraint and intake is a
|
||||
preference.** A parent cannot act on a school outside their reach however well
|
||||
it matches, and they are perfectly capable of noticing a shared denomination
|
||||
for themselves if we show it to them. So similarity moved from the ranking to
|
||||
the card: `shared` reports what a school genuinely has in common, and the reader
|
||||
applies their own weighting.
|
||||
|
||||
The hard filters above were always where the defensibility lived. They are
|
||||
untouched.
|
||||
|
||||
### Reach: a sanity bound, not a target
|
||||
|
||||
| Phase | Reach |
|
||||
|---|---|
|
||||
| Primary, middle deemed primary, all-through | 2 miles |
|
||||
| Secondary, middle deemed secondary | 6 miles |
|
||||
| 16 plus | 10 miles |
|
||||
|
||||
Ordering by distance already handles density — a school in inner London fills
|
||||
all six slots inside a mile and never approaches the cap. The cap decides one
|
||||
thing: what happens where the area is sparse. It differs by phase because
|
||||
catchments do, and because people travel furthest for post-16.
|
||||
|
||||
**A primary with nothing inside two miles renders no section**, and that is the
|
||||
intended answer rather than a gap. The alternative is a section headed "nearby"
|
||||
listing a school four miles from a five-year-old.
|
||||
|
||||
**Past the sixth school, the rest are dropped without a count.** The section
|
||||
does not try to be the list: `NearbyPlaces` sits directly beneath and already
|
||||
leads to the place pages, which are built for browsing a full set and which the
|
||||
school page exists to feed.
|
||||
|
||||
**Fewer than two results renders nothing.** Not an empty state, not a single
|
||||
lonely card. The section is absent, the nav item is absent, and the page is
|
||||
unchanged from before it existed.
|
||||
|
||||
### Distance
|
||||
|
||||
Straight-line, from the vectorised haversine already used for postcode search at
|
||||
`backend/app.py:831`, computed over the ~27k-row frame in numpy. Reported to one
|
||||
decimal place in miles, consistent with the rest of the site.
|
||||
|
||||
Straight-line distance is not road distance and is not measured from the
|
||||
reader's home. The section says so in its disclosure rather than leaving the
|
||||
reader to assume otherwise.
|
||||
|
||||
## API
|
||||
|
||||
`/api/schools/{urn}` gains a `similar_schools` array. Each row:
|
||||
|
||||
| Field | Notes |
|
||||
|---|---|
|
||||
| `urn` | for the link and the compare basket |
|
||||
| `school_name` | link text |
|
||||
| `distance_miles` | one decimal place |
|
||||
| `school_type` | GIAS type, translated, for the card's meta line |
|
||||
| `age_range` | for the meta line |
|
||||
| `shared` | what this school genuinely shares with the subject; may be empty |
|
||||
| `metric_value` | the phase-appropriate headline figure, or null |
|
||||
| `metric_key` | `rwm_expected_pct` or `attainment_8_score` — see below |
|
||||
| `metric_year` | the year the figure is from |
|
||||
|
||||
The metric follows the subject school's phase side, not the neighbour's own
|
||||
phase, so a row of cards never mixes two scales. The secondary
|
||||
side uses `attainment_8_score`; the primary side uses `rwm_expected_pct`. Where
|
||||
the neighbour has no value for that key, the card reads "Not published" rather
|
||||
than falling back to the other key.
|
||||
|
||||
Which side a school takes is decided once, in
|
||||
`similar_schools.is_secondary_phase`, by membership of `PHASE_GROUPS["secondary"]`
|
||||
minus all-through — never by testing for the substring "secondary", which misses
|
||||
`16 plus` (GIAS phase 6) and hands a sixth-form college the primary bucket.
|
||||
All-through is the exception in the other direction: `PHASE_GROUPS` lists it on
|
||||
both sides, but it takes the primary metric.
|
||||
|
||||
This is usually the same thing as "the template the page renders", but not
|
||||
always. `computeSchoolFlags` decides the template with that same substring test,
|
||||
so a `16 plus` school renders `PrimarySchoolSections` while being matched —
|
||||
correctly — against secondaries. The section therefore takes its lede noun from
|
||||
the school's own phase rather than from its template, or it would print "Other
|
||||
primary schools near <sixth form college>" above a row of secondaries.
|
||||
|
||||
Up to six rows of roughly 130 bytes each. It rides in the existing detail payload
|
||||
rather than a new endpoint because the page already makes exactly one server
|
||||
fetch for its data, and `/school/[slug]` regenerates at most weekly
|
||||
(`revalidate = 604800`), so the per-request cost is paid once per school per
|
||||
week.
|
||||
|
||||
**The key is absent, not null, on a backend that does not have this code.** The
|
||||
frontend treats absent and empty identically, which is what allowed
|
||||
`NearbyPlaces` to ship without a lockstep deploy of the two images.
|
||||
|
||||
`shared` is computed on the backend, beside the data it is derived from, not
|
||||
re-derived on the frontend. Deriving it twice is how a card comes to claim
|
||||
something the selection never established. An empty list is a real answer and
|
||||
renders no chips: a bare card costs a school nothing but the likeness it does
|
||||
not have, since the order was already settled by distance.
|
||||
|
||||
## Frontend
|
||||
|
||||
### Components
|
||||
|
||||
`components/school/SimilarSchoolsSection.tsx` — a server component wrapped in
|
||||
the shared `Section` shell from `sectionShared.tsx`. It renders the heading,
|
||||
the lede, the card grid, the footer CTA and one caption line. Every
|
||||
card's title is an `<a>` to the school's canonical slug URL via `schoolUrl()`.
|
||||
|
||||
`components/school/AddToCompareButton.tsx` — calls `addSchool` from
|
||||
`ComparisonProvider` and reports the selection with a `from: 'similar_schools'`
|
||||
attribution, mirroring `addSchoolFromSearch` in `HomeView.tsx:442`.
|
||||
|
||||
`components/school/SimilarSchoolsCarousel.tsx` — the scroller and its arrows. It
|
||||
takes the server-rendered cards as `children` and the server-rendered heading and
|
||||
lede as a `header` prop, so those stay server components while the client
|
||||
component owns only the ref, the scroll handler and the arrows' disabled state.
|
||||
|
||||
The split matters: the links — the part with SEO value and the part that must
|
||||
work without JavaScript — are server-rendered into the initial HTML, and only
|
||||
the basket interaction and the arrows are hydrated.
|
||||
|
||||
### The carousel
|
||||
|
||||
**Every card is in the initial HTML.** The arrows scroll a list; they never swap
|
||||
a view. Six `<a>` elements are in the markup whether or not anything is
|
||||
hydrated, which is the whole reason the section exists — a paginated widget that
|
||||
mounts cards on click would put four of the six links beyond a crawler and
|
||||
beyond a reader with no JavaScript.
|
||||
|
||||
So the scroller is a plain overflowing `<ul>` with `scroll-snap-type: x
|
||||
mandatory`, and the arrows call `scrollBy` on it. With no JavaScript it
|
||||
degrades to a horizontally scrollable row that still works by touch and by
|
||||
trackpad. Three cards are visible at desktop width and two below 820px.
|
||||
|
||||
**Arrows appear only when there is somewhere to go** — that is, only when more
|
||||
than three schools were found. Each disables itself at its own end of the
|
||||
travel.
|
||||
|
||||
#### Below 640px the arrows go away
|
||||
|
||||
This follows [MOBILE.md](../../../MOBILE.md), which makes 360px the design
|
||||
floor and mobile the primary target at ≥55% of traffic.
|
||||
|
||||
Kept in the heading's flex row at 360px, the two arrow buttons take 96px from a
|
||||
328px card and crush the lede into a four-line column — measured, not guessed.
|
||||
And swiping already does what they do. So below 640px the header becomes a
|
||||
single column, the arrows are not rendered, one card shows at 86% width so the
|
||||
next one peeks, and the affordance is carried by the right-edge scroll-fade that
|
||||
MOBILE.md documents for exactly this case:
|
||||
|
||||
```css
|
||||
mask-image: linear-gradient(to right, #000 calc(100% - 28px), transparent);
|
||||
```
|
||||
|
||||
The fade lifts at the end of the travel, where there is nothing left to hint
|
||||
at. That means the at-end state must be computed whether or not an arrow exists
|
||||
to consume it — on mobile it drives the mask alone.
|
||||
|
||||
**Every interactive element clears 44×44px**, per MOBILE.md's iOS HIG check: the
|
||||
arrow buttons and the add-to-compare button are both 44px, up from the 40px they
|
||||
were first drawn at. A card title's own box is shorter than that, but its hit
|
||||
area is the whole card through the `::after` overlay, so it passes on the target
|
||||
that actually receives the tap.
|
||||
|
||||
**The edge test needs a tolerance, and this is not fussiness.** The scroller
|
||||
carries 2px of padding so focus rings are not clipped, and scroll-snap treats
|
||||
that padding as the first card's snap position: a scroller sitting at its start
|
||||
reports `scrollLeft` of 2, not 0. Sub-pixel rounding moves it again at other
|
||||
zoom levels. Testing `scrollLeft === 0` therefore leaves the back arrow live and
|
||||
pointing nowhere on first paint — confirmed in the mockup before it was fixed.
|
||||
Both ends compare against an 8px tolerance.
|
||||
|
||||
**Selecting a school must not move the row.** Adding to the basket re-renders
|
||||
the footer; the scroll offset lives in the DOM rather than in React state, so
|
||||
the carousel must not remount or reset on that render. A reader who ticks the
|
||||
fifth school and is thrown back to the first has been punished for using the
|
||||
feature.
|
||||
|
||||
### Placement and navigation
|
||||
|
||||
Rendered as the last section **inside** `SchoolDetailShell`, from both
|
||||
`PrimarySchoolSections` and `SecondarySchoolSections`. Inside, not after, because
|
||||
the sticky nav's scroll-spy locates sections with `document.getElementById` and
|
||||
can only reach a section that lives in the shell.
|
||||
|
||||
`NearbyPlaces` stays where it is, outside the shell, immediately below. The
|
||||
resulting order — this school, then similar schools, then the places containing
|
||||
them — narrows before it widens, which is the order a reader leaves a page in.
|
||||
|
||||
`buildNavItems` and `buildSecondaryNavItems` both gain
|
||||
`{ id: 'similar', label: 'Similar schools' }`, gated on the section rendering.
|
||||
The id must match the `Section` id or the scroll-spy silently breaks.
|
||||
|
||||
### The comparison CTA
|
||||
|
||||
A plain `<a href="/compare?urns=…">`, built from this school's URN plus the
|
||||
selected ones. `/compare` already parses `urns` from the query string
|
||||
(`app/(frontend)/compare/page.tsx:55`), so this needs no new compare plumbing.
|
||||
With nothing selected the CTA is disabled; the button also adds to the shared
|
||||
basket so the site-wide comparison state stays consistent with what the page
|
||||
shows.
|
||||
|
||||
## Copy, and what the section is allowed to claim
|
||||
|
||||
**The lede never claims an intake.** It reads "Other primary schools near X." —
|
||||
one sentence, no variants. The earlier version varied the wording by tier, which
|
||||
only existed to soften a claim the section should not have been making.
|
||||
|
||||
**The heading is "Other schools nearby", not "Similar schools nearby".** The
|
||||
hard filters do guarantee a comparable set — same phase, same selectivity,
|
||||
mainstream never beside special — but nothing ranks on likeness, so the heading
|
||||
does not say it does. The nav item reads "Nearby schools" and the section id is
|
||||
`nearby`.
|
||||
|
||||
**Chips state only what is shared, and may be absent entirely.** A card with
|
||||
nothing in common renders no chip row rather than falling back to a filler.
|
||||
Since chips no longer affect the order, an empty one costs that school nothing
|
||||
except a claim it cannot support — and a Catholic parent scanning the row still
|
||||
spots "Roman Catholic" on the card that carries it, and weighs it themselves.
|
||||
|
||||
**The neighbour's metric carries no valence colour.** Green and terracotta are
|
||||
reserved site-wide for comparison against the England average. Colouring a
|
||||
neighbour's figure against this school's would read as ranking the neighbours
|
||||
against each other, which is precisely the endorsement this section must not
|
||||
make. The figure sits in neutral ink above a plain "72% at this school"
|
||||
reference line, and the reader draws their own conclusion.
|
||||
|
||||
**A missing figure reads "Not published".** Never 0, never blank, never an
|
||||
em dash. This follows the same rule the rest of the detail page uses: a school
|
||||
with no published result has not scored zero.
|
||||
|
||||
**There is no "how these are chosen" disclosure.** The method is visible in what
|
||||
the section already shows — the phase in the lede, the shared characteristics on
|
||||
each card, the distance above each name — and a collapsed panel restating it
|
||||
earns less than the space it costs.
|
||||
|
||||
**One caption line survives, and only one:** that distances are straight-line
|
||||
from the school and not road distance. This is not a method note. A reader who
|
||||
sees "0.6 miles away" and takes it for the walk has been misled by us, and no
|
||||
other element on the card corrects that. The remaining notes — that listing is
|
||||
not a recommendation, that special schools only meet special schools — are
|
||||
statements the selection rules already keep true without being narrated.
|
||||
|
||||
## Degradation
|
||||
|
||||
| Condition | Behaviour |
|
||||
|---|---|
|
||||
| `similar_schools` absent (older backend image) | no section, no nav item |
|
||||
| fewer than 2 qualifying schools | no section, no nav item |
|
||||
| this school has no coordinates | no section |
|
||||
| the helper raises | returns `[]`; the page renders without the section |
|
||||
|
||||
The helper is wrapped so a failure inside it never 500s a page that is otherwise
|
||||
complete — the posture `get_supplementary_data` already takes for its own
|
||||
queries.
|
||||
|
||||
## Testing
|
||||
|
||||
**Backend**, in a new `backend/tests/test_similar_schools.py`, against a
|
||||
synthetic frame rather than live marts:
|
||||
|
||||
- a selective school never returns a non-selective one, and vice versa
|
||||
- a special school returns only special schools; a mainstream school returns none
|
||||
- a Boys school never returns a Girls school; Mixed matches both
|
||||
- closed schools and schools without coordinates are never returned
|
||||
- results are ordered by distance ascending, always
|
||||
- a faith match never outranks a closer school (the staging defect, pinned)
|
||||
- the nearest eligible school is always present
|
||||
- more than six qualifying schools returns the six nearest
|
||||
- reach is capped per phase, and a primary beyond two miles returns `[]`
|
||||
- an all-through school is offered on both phase sides
|
||||
- a `16 plus` school is matched against secondaries and colleges, never primaries
|
||||
- `is_secondary_phase` and `PHASE_GROUPS` agree on every GIAS phase value
|
||||
- fewer than two qualifying schools returns `[]`
|
||||
- distances match a hand-computed haversine for a known pair
|
||||
|
||||
**Frontend**, in `nextjs-app/__tests__`:
|
||||
|
||||
- the section renders nothing for absent, empty and single-row inputs
|
||||
- the lede never claims a similar intake
|
||||
- an empty `shared` renders no chips rather than a filler
|
||||
- a null metric renders "Not published"
|
||||
- the nav item appears only alongside the section
|
||||
- every card is in the DOM, including the ones scrolled out of view
|
||||
- arrows render only when more than three schools were found
|
||||
|
||||
jsdom has no layout, so `scrollWidth` and `clientWidth` are both 0 there and the
|
||||
arrows' disabled state cannot be meaningfully asserted in Jest. That behaviour is
|
||||
covered in the journey instead, against a real engine, rather than by a unit test
|
||||
that would pass on a measurement that does not exist.
|
||||
|
||||
**E2E**, added to the existing journeys in `e2e/tests` in the same PR, per the
|
||||
repository's rule on user-facing behaviour:
|
||||
|
||||
- the section renders on a known staging URN, with resolving links
|
||||
- where arrows are present, the back arrow starts disabled and the forward arrow
|
||||
moves the row
|
||||
- selecting a school does not reset the scroll position
|
||||
- add-to-compare reaches `/compare` with the expected `urns`
|
||||
- at 360, 390 and 430px: no horizontal overflow, every interactive element in the
|
||||
section clears 44×44px, and no arrows are rendered
|
||||
|
||||
The E2E gate runs after merge on this project, so these journeys are not
|
||||
provable in the PR checks; the PR is verified on the unit tests, and the
|
||||
journeys are confirmed on the post-merge staging run.
|
||||
|
||||
## Out of scope
|
||||
|
||||
- A map of the nearby schools. The section is a list; the page already has a map.
|
||||
- Autoplay, dots, or an infinite loop on the carousel. It is a short list a
|
||||
reader scans deliberately, not a banner competing for attention, and a row
|
||||
that moves on its own is a row that moves while someone is reading it.
|
||||
- Statistical neighbours on deprivation, size or cohort profile. If plain
|
||||
distance proves too blunt, that is the trigger to move this computation into a
|
||||
dbt mart — `select_nearby` is a deliberate seam for exactly that swap.
|
||||
- Precomputing neighbours in `marts.*`. Rejected for now: a new mart is inert
|
||||
until Airflow runs, so the feature would ship dark, and every tuning change to
|
||||
the rules would become a pipeline round-trip instead of a deploy. The revision
|
||||
at the top of this document is the argument for keeping that loop short.
|
||||
- Any change to `/api/compare`, the compare page, or the comparison basket.
|
||||
+189
-1
@@ -1,4 +1,4 @@
|
||||
import { test, expect, Page } from '@playwright/test';
|
||||
import { test, expect, Locator, Page } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Journey tests for SchoolCompare, run against the staging environment as the
|
||||
@@ -19,6 +19,31 @@ function schoolLinks(page: Page) {
|
||||
return page.locator('a[href^="/school/"]');
|
||||
}
|
||||
|
||||
/**
|
||||
* A scroll offset that has stopped moving.
|
||||
*
|
||||
* The carousel arrows scroll with `behavior: 'smooth'`, so a reading taken
|
||||
* straight after a click lands mid-animation. Measured against staging: the
|
||||
* animation runs ~700ms, and a poll for "has it moved at all" is satisfied
|
||||
* 50ms in, at 13px of a 1300px journey. A test that then records an offset,
|
||||
* does something, and records again is measuring the tail of the arrow's
|
||||
* animation rather than the effect of whatever it did in between.
|
||||
*
|
||||
* Two identical readings in a row is the cheapest sound definition of settled.
|
||||
*/
|
||||
async function settledScrollLeft(scroller: Locator): Promise<number> {
|
||||
let previous = -1;
|
||||
await expect
|
||||
.poll(async () => {
|
||||
const current = await scroller.evaluate((node: HTMLElement) => Math.round(node.scrollLeft));
|
||||
const settled = current === previous;
|
||||
previous = current;
|
||||
return settled;
|
||||
}, { timeout: 10_000 })
|
||||
.toBe(true);
|
||||
return previous;
|
||||
}
|
||||
|
||||
/**
|
||||
* Two URNs guaranteed to be pure-primary (same phase). The compare page's
|
||||
* phase tabs split all-through schools (which carry KS4 data) onto the
|
||||
@@ -2734,3 +2759,166 @@ test('the content sitemap lists the about page and is advertised in robots', asy
|
||||
expect(body).toContain('/sitemap.xml');
|
||||
expect(body).toContain('/content-sitemap.xml');
|
||||
});
|
||||
|
||||
/**
|
||||
* Other schools nearby.
|
||||
*
|
||||
* The section is absent by design where fewer than two schools qualify, and the
|
||||
* arrows are absent where three cards fit, so this asserts each part of the
|
||||
* contract only where it applies.
|
||||
*
|
||||
* Two things here cannot be tested anywhere else: the arrows' disabled state,
|
||||
* which jsdom cannot measure because it has no layout, and the scroll position
|
||||
* surviving a selection, which is DOM state rather than React state.
|
||||
*/
|
||||
test('nearby schools link on to other schools and into compare', async ({ page }) => {
|
||||
await searchByName(page, 'Primary');
|
||||
await schoolLinks(page).first().click();
|
||||
await page.waitForURL(/\/school\//);
|
||||
|
||||
const section = page.locator('#nearby');
|
||||
if ((await section.count()) === 0) {
|
||||
test.skip(true, 'No qualifying similar schools for this school');
|
||||
}
|
||||
|
||||
// Every card is a real link to another school page — including the ones
|
||||
// behind the arrows, which is the whole reason this is a scroller and not a
|
||||
// paginated widget.
|
||||
const links = section.locator('a[href^="/school/"]');
|
||||
const linkCount = await links.count();
|
||||
expect(linkCount).toBeGreaterThanOrEqual(2);
|
||||
expect(linkCount).toBeLessThanOrEqual(6);
|
||||
expect(await links.first().getAttribute('href')).toMatch(/^\/school\/\d{6}-/);
|
||||
|
||||
await expect(section.getByText(/miles away/).first()).toBeVisible();
|
||||
|
||||
const scroller = section.locator('ul').first();
|
||||
|
||||
// The carousel, where this school had more than three matches.
|
||||
const forward = section.getByRole('button', { name: 'More schools' });
|
||||
if (await forward.count()) {
|
||||
const back = section.getByRole('button', { name: 'Previous schools' });
|
||||
await expect(back).toBeDisabled();
|
||||
|
||||
await forward.click();
|
||||
expect(await settledScrollLeft(scroller)).toBeGreaterThan(8);
|
||||
await expect(back).toBeEnabled();
|
||||
}
|
||||
|
||||
// The compare hand-off, and the row must not jump back to the start when the
|
||||
// footer re-renders underneath it.
|
||||
//
|
||||
// Click the LAST card's button, not the first. Playwright scrolls a target
|
||||
// into view before clicking it, so clicking card one while the row is paged
|
||||
// to the end scrolls the container back to the start — and the assertion
|
||||
// below then measures Playwright's own scrolling rather than the app's.
|
||||
// That is what this test did on its first staging run: 537 → 2, reproduced
|
||||
// afterwards on a static page with no React on it at all.
|
||||
//
|
||||
// A few pixels of snap or sub-pixel adjustment are fine; a reset to the
|
||||
// start is not, which is the whole point of the check.
|
||||
const offsetBefore = await settledScrollLeft(scroller);
|
||||
await section.getByRole('button', { name: /Add to compare/ }).last().click();
|
||||
await expect(
|
||||
section.getByRole('button', { name: /Added to compare/ }).first(),
|
||||
).toBeVisible();
|
||||
const offsetAfter = await settledScrollLeft(scroller);
|
||||
expect(Math.abs(offsetAfter - offsetBefore)).toBeLessThanOrEqual(8);
|
||||
});
|
||||
|
||||
/**
|
||||
* Every section in the mobile jump sheet can actually be reached.
|
||||
*
|
||||
* The sheet is a fixed bottom sheet, and the app has a fixed bottom tab bar.
|
||||
* `position: sticky` with a z-index on the sticky nav makes it a stacking
|
||||
* context, so the sheet's own z-index orders it only within that context —
|
||||
* against the tab bar, the nav's value is what counts. The last item in the
|
||||
* sheet was therefore painted over and untappable as soon as the list grew
|
||||
* long enough to reach the bar, which adding "Nearby schools" is what did.
|
||||
*
|
||||
* Bounding boxes are not enough to catch this: the item is in the viewport and
|
||||
* the right size, it is simply underneath something. So this asks the question
|
||||
* a thumb asks — what is on top at this point.
|
||||
*/
|
||||
test('every section in the mobile jump sheet is tappable, not under the tab bar', async ({ page }) => {
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await searchByName(page, 'Primary');
|
||||
await schoolLinks(page).first().click();
|
||||
await page.waitForURL(/\/school\//);
|
||||
|
||||
// Scroll down so the sticky nav is docked and the sheet has somewhere to open.
|
||||
await page.evaluate(() => window.scrollTo({ top: 1200 }));
|
||||
// Two controls carry aria-haspopup: the mobile "Section" button and the
|
||||
// desktop "All" one, which is display:none here but still in the DOM.
|
||||
await page.locator('[aria-haspopup="menu"]:visible').click();
|
||||
|
||||
const sheet = page.locator('[role="menu"]');
|
||||
await expect(sheet).toBeVisible();
|
||||
|
||||
const covered = await sheet.evaluate((panel: HTMLElement) =>
|
||||
Array.from(panel.querySelectorAll('[role="menuitem"]'))
|
||||
.map((el) => {
|
||||
const box = el.getBoundingClientRect();
|
||||
const hit = document.elementFromPoint(
|
||||
Math.round(box.left + box.width / 2),
|
||||
Math.round(box.top + box.height / 2),
|
||||
);
|
||||
return { label: (el as HTMLElement).innerText.trim().replace(/\s+/g, ' '), reachable: !!(hit && hit.closest('[role="menuitem"]')) };
|
||||
})
|
||||
.filter((item) => !item.reachable)
|
||||
.map((item) => item.label),
|
||||
);
|
||||
|
||||
expect(covered).toEqual([]);
|
||||
});
|
||||
|
||||
/**
|
||||
* The nearby-schools section at MOBILE.md's three reference widths.
|
||||
*
|
||||
* MOBILE.md asks for exactly this check and records that it was not written
|
||||
* because "Playwright isn't currently in the project dependency set". That is
|
||||
* no longer true — this suite is Playwright — so the check exists now, scoped
|
||||
* to the page this feature touches.
|
||||
*/
|
||||
for (const width of [360, 390, 430]) {
|
||||
test(`nearby schools survives a ${width}px viewport`, async ({ page }) => {
|
||||
await page.setViewportSize({ width, height: 800 });
|
||||
await searchByName(page, 'Primary');
|
||||
await schoolLinks(page).first().click();
|
||||
await page.waitForURL(/\/school\//);
|
||||
|
||||
const section = page.locator('#nearby');
|
||||
if ((await section.count()) === 0) {
|
||||
test.skip(true, 'No qualifying similar schools for this school');
|
||||
}
|
||||
|
||||
// 1. Nothing bleeds past the right edge.
|
||||
expect(
|
||||
await page.evaluate(() => document.documentElement.scrollWidth - window.innerWidth),
|
||||
).toBe(0);
|
||||
|
||||
// 2. No arrows on touch widths — swiping does the job, and they would take
|
||||
// 96px from a 328px card.
|
||||
await expect(section.getByRole('button', { name: 'More schools' })).toHaveCount(0);
|
||||
|
||||
// 3. Every tap target in the section clears 44px. A card title's own box is
|
||||
// shorter, but its hit area is the whole card via ::after.
|
||||
const failing = await section.evaluate((root: HTMLElement) =>
|
||||
Array.from(root.querySelectorAll('a, button'))
|
||||
.filter((el) => (el as HTMLElement).offsetParent)
|
||||
.map((el) => {
|
||||
const card = el.closest('li');
|
||||
const box = el.matches('h3 a') && card
|
||||
? card.getBoundingClientRect()
|
||||
: el.getBoundingClientRect();
|
||||
return {
|
||||
text: (el as HTMLElement).innerText.trim().slice(0, 24),
|
||||
w: box.width,
|
||||
h: box.height,
|
||||
};
|
||||
})
|
||||
.filter((o) => o.w < 44 || o.h < 44),
|
||||
);
|
||||
expect(failing).toEqual([]);
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,373 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Similar Schools Nearby</title>
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600&family=Manrope:wght@500;600;700&display=swap" rel="stylesheet">
|
||||
<style>
|
||||
/* Tokens copied verbatim from nextjs-app/app/(frontend)/globals.css so this
|
||||
mockup cannot drift from the shipped palette. Light values first, dark
|
||||
under prefers-color-scheme, both overridable by the theme switch. */
|
||||
:root {
|
||||
color-scheme: light;
|
||||
--bg-primary:#FAFAF8; --bg-secondary:#F5EFE6; --bg-card:#FFFFFF;
|
||||
--text-primary:#1C2731; --text-secondary:#4A5560; --text-muted:#5F6A75;
|
||||
--border:#E5E7EB; --border-strong:#D3D7DD;
|
||||
--brand:#0F766E; --brand-strong:#0C5F58; --brand-bg:rgba(15,118,110,.10); --brand-on:#FFFFFF;
|
||||
--action:#BE3C27; --action-strong:#A33320; --action-on:#FFFFFF;
|
||||
--sand:#F5EFE6;
|
||||
--font-display:Manrope,-apple-system,BlinkMacSystemFont,sans-serif;
|
||||
--font-ui:Inter,-apple-system,BlinkMacSystemFont,sans-serif;
|
||||
--radius-md:8px; --radius-lg:16px;
|
||||
--shadow:0 1px 2px rgba(28,39,49,.06),0 1px 3px rgba(28,39,49,.05);
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root:not([data-theme="light"]) {
|
||||
color-scheme: dark;
|
||||
--bg-primary:#111A20; --bg-secondary:#16222A; --bg-card:#18242C;
|
||||
--text-primary:#E9EEF0; --text-secondary:#B4C2C7; --text-muted:#8B9AA1;
|
||||
--border:#26343D; --border-strong:#35454F;
|
||||
--brand:#5FC7BB; --brand-strong:#7BD6CC; --brand-bg:rgba(95,199,187,.14); --brand-on:#0A1418;
|
||||
--action:#F08A72; --action-strong:#F5A492; --action-on:#241009;
|
||||
--sand:#1B2730;
|
||||
--shadow:0 1px 2px rgba(0,0,0,.3),0 1px 3px rgba(0,0,0,.25);
|
||||
}
|
||||
}
|
||||
:root[data-theme="dark"] {
|
||||
color-scheme: dark;
|
||||
--bg-primary:#111A20; --bg-secondary:#16222A; --bg-card:#18242C;
|
||||
--text-primary:#E9EEF0; --text-secondary:#B4C2C7; --text-muted:#8B9AA1;
|
||||
--border:#26343D; --border-strong:#35454F;
|
||||
--brand:#5FC7BB; --brand-strong:#7BD6CC; --brand-bg:rgba(95,199,187,.14); --brand-on:#0A1418;
|
||||
--action:#F08A72; --action-strong:#F5A492; --action-on:#241009;
|
||||
--sand:#1B2730;
|
||||
--shadow:0 1px 2px rgba(0,0,0,.3),0 1px 3px rgba(0,0,0,.25);
|
||||
}
|
||||
* { box-sizing:border-box; }
|
||||
body {
|
||||
margin:0; padding:32px 16px 80px; background:var(--bg-primary);
|
||||
color:var(--text-primary); font:15px/1.55 var(--font-ui);
|
||||
-webkit-font-smoothing:antialiased;
|
||||
}
|
||||
.page { max-width:960px; margin:0 auto; }
|
||||
.page > header { margin-bottom:28px; display:flex; flex-wrap:wrap; gap:16px; align-items:flex-start; justify-content:space-between; }
|
||||
.page > header h1 { font:700 25px/1.25 var(--font-display); letter-spacing:-.6px; margin:0 0 6px; }
|
||||
.page > header p { margin:0; color:var(--text-muted); font-size:14px; max-width:60ch; }
|
||||
.theme-switch { border:1px solid var(--border-strong); background:var(--bg-card); color:var(--text-secondary); border-radius:999px; padding:8px 14px; font:500 13px var(--font-ui); cursor:pointer; min-height:44px; }
|
||||
.theme-switch:hover { border-color:var(--brand); color:var(--brand); }
|
||||
|
||||
/* ── The page context each variant is shown inside ─────────────────── */
|
||||
.variant { margin-bottom:40px; }
|
||||
.variant > .context { padding:0 4px 12px; }
|
||||
.variant .eyebrow { margin:0 0 4px; font-size:12px; letter-spacing:.04em; text-transform:uppercase; color:var(--text-muted); }
|
||||
.variant .context h2 { font:600 18px/1.35 var(--font-display); margin:0; color:var(--text-secondary); }
|
||||
.variant .note { margin:10px 4px 0; font-size:12.5px; color:var(--text-muted); }
|
||||
.variant .note b { color:var(--text-secondary); font-weight:600; }
|
||||
|
||||
/* ── The section itself — mirrors components/school/Section ────────── */
|
||||
.card {
|
||||
background:var(--bg-card); border:1px solid var(--border);
|
||||
border-radius:var(--radius-lg); padding:28px; box-shadow:var(--shadow);
|
||||
}
|
||||
.top { display:flex; align-items:flex-start; justify-content:space-between; gap:16px; }
|
||||
.top h2 { font:700 22px/1.25 var(--font-display); letter-spacing:-.4px; margin:0; }
|
||||
.lede { margin:8px 0 20px; color:var(--text-secondary); font-size:14.5px; max-width:64ch; }
|
||||
|
||||
/* ── Carousel ───────────────────────────────────────────────────────
|
||||
Every card is in the DOM and in the initial HTML — the arrows scroll a
|
||||
list, they do not swap a view. That keeps all six links crawlable and
|
||||
keeps the section usable with no JavaScript, where it degrades to a
|
||||
plain horizontally scrollable row. */
|
||||
.arrows { display:flex; gap:8px; flex:none; }
|
||||
.arrow {
|
||||
width:44px; height:44px; display:grid; place-items:center; cursor:pointer;
|
||||
border:1px solid var(--border-strong); border-radius:999px;
|
||||
background:var(--bg-card); color:var(--brand);
|
||||
}
|
||||
.arrow:hover:not(:disabled) { border-color:var(--brand); background:var(--brand-bg); }
|
||||
.arrow:disabled { opacity:.35; cursor:default; }
|
||||
.arrow:focus-visible { outline:2px solid var(--brand); outline-offset:2px; }
|
||||
.arrow svg { width:17px; height:17px; }
|
||||
|
||||
.scroller {
|
||||
display:grid; grid-auto-flow:column;
|
||||
grid-auto-columns:calc((100% - 28px) / 3);
|
||||
gap:14px; overflow-x:auto; scroll-snap-type:x mandatory;
|
||||
padding:2px; margin:-2px; /* room for focus rings */
|
||||
scrollbar-width:none; -ms-overflow-style:none;
|
||||
list-style:none;
|
||||
}
|
||||
.scroller::-webkit-scrollbar { display:none; }
|
||||
.scroller:focus-visible { outline:2px solid var(--brand); outline-offset:4px; border-radius:var(--radius-md); }
|
||||
@media (max-width:820px) { .scroller { grid-auto-columns:calc((100% - 14px) / 2); } }
|
||||
/* Touch widths: the arrows would squeeze the lede into a four-line column for a
|
||||
control that swiping already provides, so they go and the documented
|
||||
right-edge fade carries the affordance instead (MOBILE.md). The fade lifts at
|
||||
the end of the travel, where there is nothing more to hint at. */
|
||||
@media (max-width:640px) {
|
||||
.top { display:block; }
|
||||
.arrows { display:none; }
|
||||
.scroller { grid-auto-columns:86%; mask-image:linear-gradient(to right, #000 calc(100% - 28px), transparent); }
|
||||
.scroller[data-at-end=true] { mask-image:none; }
|
||||
.card { padding:20px; }
|
||||
}
|
||||
|
||||
.school {
|
||||
position:relative; display:flex; flex-direction:column; scroll-snap-align:start;
|
||||
border:1px solid var(--border); border-radius:var(--radius-md);
|
||||
padding:16px; background:var(--bg-card);
|
||||
}
|
||||
.school:has(.add[aria-pressed=true]) { border-color:var(--brand); background:var(--brand-bg); }
|
||||
.distance { display:flex; align-items:center; gap:5px; font-size:12px; color:var(--text-muted); margin:0 0 10px; }
|
||||
.distance svg { width:13px; height:13px; flex:none; }
|
||||
.school h3 { font:600 16px/1.35 var(--font-display); margin:0 0 6px; }
|
||||
/* The whole card is the link target; the button sits above it on z-index so
|
||||
it stays independently clickable. */
|
||||
.school h3 a { color:var(--text-primary); text-decoration:none; }
|
||||
.school h3 a::after { content:""; position:absolute; inset:0; border-radius:var(--radius-md); }
|
||||
.school:hover { border-color:var(--border-strong); }
|
||||
.school h3 a:hover { color:var(--brand); text-decoration:underline; }
|
||||
.school h3 a:focus-visible { outline:none; }
|
||||
.school:has(h3 a:focus-visible) { outline:2px solid var(--brand); outline-offset:2px; }
|
||||
.meta { margin:0 0 12px; font-size:12.5px; color:var(--text-muted); }
|
||||
.shared { display:flex; flex-wrap:wrap; gap:6px; margin:0 0 14px; padding:0; list-style:none; }
|
||||
.shared li { font-size:11.5px; line-height:1.4; padding:4px 8px; border-radius:999px; background:var(--brand-bg); color:var(--brand); border:1px solid transparent; }
|
||||
.shared li.loose { background:transparent; color:var(--text-muted); border-color:var(--border); }
|
||||
.metric { margin-top:auto; padding-top:13px; border-top:1px solid var(--border); }
|
||||
.value { font:700 26px/1.1 var(--font-display); letter-spacing:-.6px; margin:0; }
|
||||
.value.absent { font-size:15px; font-weight:600; color:var(--text-muted); letter-spacing:0; }
|
||||
.metric .label { margin:4px 0 0; font-size:12px; color:var(--text-secondary); }
|
||||
.metric .ref { margin:2px 0 0; font-size:12px; color:var(--text-muted); }
|
||||
.add {
|
||||
position:relative; z-index:1; margin-top:14px; width:100%; min-height:44px;
|
||||
font:500 13px var(--font-ui); cursor:pointer; border-radius:var(--radius-md);
|
||||
border:1px solid var(--border-strong); background:var(--bg-card); color:var(--brand);
|
||||
}
|
||||
.add:hover { border-color:var(--brand); background:var(--brand-bg); }
|
||||
.add[aria-pressed=true] { border-color:var(--brand); background:var(--brand-bg); font-weight:600; }
|
||||
.add:focus-visible { outline:2px solid var(--brand); outline-offset:2px; }
|
||||
|
||||
.footer {
|
||||
display:flex; flex-wrap:wrap; align-items:center; justify-content:space-between;
|
||||
gap:14px; margin-top:20px; padding-top:18px; border-top:1px solid var(--border);
|
||||
}
|
||||
.footer p { margin:0; font-size:12.5px; color:var(--text-muted); }
|
||||
.footer strong { display:block; font:600 14px var(--font-ui); color:var(--text-primary); }
|
||||
/* Coral: the one decisive action in this section, and there is only one. */
|
||||
.compare {
|
||||
min-height:44px; padding:0 20px; border-radius:var(--radius-md); cursor:pointer;
|
||||
font:600 14px var(--font-ui); background:var(--action); color:var(--action-on);
|
||||
border:1px solid var(--action); text-decoration:none; display:inline-flex; align-items:center; gap:8px;
|
||||
}
|
||||
.compare:hover { background:var(--action-strong); border-color:var(--action-strong); }
|
||||
.compare[aria-disabled=true] { opacity:.45; pointer-events:none; }
|
||||
.caption { margin:16px 0 0; font-size:11.5px; color:var(--text-muted); }
|
||||
.sr { position:absolute; width:1px; height:1px; padding:0; margin:-1px; overflow:hidden; clip:rect(0 0 0 0); white-space:nowrap; border:0; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page">
|
||||
<header>
|
||||
<div>
|
||||
<h1>Similar schools nearby</h1>
|
||||
<p>A new section on the school detail page. Fictional schools and figures; shipped
|
||||
colour, type and section shell taken from <code>globals.css</code>.</p>
|
||||
</div>
|
||||
<button class="theme-switch" type="button" id="theme">Dark theme</button>
|
||||
</header>
|
||||
<div id="variants"></div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
const PIN = '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M20 10c0 6-8 12-8 12s-8-6-8-12a8 8 0 0 1 16 0Z"/><circle cx="12" cy="10" r="3"/></svg>';
|
||||
const CHEV = (dir) => `<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="${dir === 'prev' ? 'M15 18l-6-6 6-6' : 'M9 18l6-6-6-6'}"/></svg>`;
|
||||
|
||||
const variants = [
|
||||
{
|
||||
id: 'dense',
|
||||
eyebrow: 'Variant 1 · Dense urban primary — six matches, carousel active',
|
||||
context: 'Meadowbrook Primary School — Ages 4–11 · Mixed · No religious character · Community school',
|
||||
lede: 'Other primary schools near Meadowbrook Primary School, with a similar intake.',
|
||||
metric: 'Reading, writing & maths',
|
||||
caption: 'Meeting the expected standard at key stage 2, 2025.',
|
||||
thisValue: '72%',
|
||||
note: 'Fourteen schools cleared <b>tier 1</b> within three miles, so the section takes the six nearest and stops there. The arrows scroll a list that is entirely in the HTML — all six links are crawlable, and with JavaScript off the row still scrolls.',
|
||||
schools: [
|
||||
{ name:'Willow Lane Primary School', distance:'0.4', meta:'Community school · Ages 4–11', shared:['Mixed','No religious character'], value:'74%' },
|
||||
{ name:'Oakfield Primary School', distance:'0.6', meta:'Academy converter · Ages 3–11', shared:['Mixed','No religious character'], value:'69%' },
|
||||
{ name:'Brookside Primary School', distance:'0.9', meta:'Community school · Ages 4–11', shared:['Mixed','No religious character'], value:'Not published' },
|
||||
{ name:'Hollytree Primary School', distance:'1.3', meta:'Academy converter · Ages 4–11', shared:['Mixed','No religious character'], value:'81%' },
|
||||
{ name:'Marsh Green Primary School', distance:'1.8', meta:'Community school · Ages 3–11', shared:['Mixed','No religious character'], value:'64%' },
|
||||
{ name:'Kingsway Primary School', distance:'2.2', meta:'Foundation school · Ages 4–11', shared:['Mixed','No religious character'], value:'77%' },
|
||||
],
|
||||
},
|
||||
{
|
||||
id: 'secondary',
|
||||
eyebrow: 'Variant 2 · Secondary — four matches, mixed tiers',
|
||||
context: 'Meadowbrook High School — Ages 11–18 · Mixed · Non-selective · Academy',
|
||||
lede: 'Other secondary schools near Meadowbrook High School, with a similar intake.',
|
||||
metric: 'Attainment 8',
|
||||
caption: 'Average GCSE attainment score across eight qualifications, 2025.',
|
||||
thisValue: '51.2',
|
||||
note: 'Only two schools cleared tier 1, so the search widened to <b>tier 2</b> and found two more. It stops there rather than widening again to reach six — tiers relax to reach a usable set, never to fill the last slots. Selectivity never relaxes, so no grammar school can appear here.',
|
||||
schools: [
|
||||
{ name:'Rivermead High School', distance:'0.9', meta:'Academy converter · Ages 11–18', shared:['Mixed','Non-selective','No religious character'], value:'52.8' },
|
||||
{ name:'Oakfield Academy', distance:'1.7', meta:'Academy sponsor led · Ages 11–16', shared:['Mixed','Non-selective','No religious character'], value:'49.6' },
|
||||
{ name:'St Aidan’s Catholic High School', distance:'2.4', meta:'Voluntary aided · Ages 11–18', shared:['Mixed','Non-selective'], value:'53.4' },
|
||||
{ name:'Parkside Community School', distance:'3.8', meta:'Community school · Ages 11–16', shared:['Mixed','Non-selective'], value:'50.9' },
|
||||
],
|
||||
},
|
||||
{
|
||||
id: 'sparse',
|
||||
eyebrow: 'Variant 3 · Rural — two matches, no arrows',
|
||||
context: 'Little Ashby Church of England Primary School — Ages 4–11 · Mixed · Church of England · Voluntary controlled',
|
||||
lede: 'Other primary schools near Little Ashby Church of England Primary School.',
|
||||
metric: 'Reading, writing & maths',
|
||||
caption: 'Meeting the expected standard at key stage 2, 2025.',
|
||||
thisValue: '66%',
|
||||
note: 'Nothing matched on religious character within range. At <b>tier 3</b> the lede drops the phrase “with a similar intake” and the chips fall back to the plain phase. Two cards fit the row, so the arrows are not rendered at all. One school fewer and the section would not render either.',
|
||||
schools: [
|
||||
{ name:'Great Marden Primary School', distance:'4.2', meta:'Community school · Ages 4–11', shared:['Primary school'], loose:true, value:'71%' },
|
||||
{ name:'Ashby Vale Academy', distance:'7.8', meta:'Academy converter · Ages 4–11', shared:['Primary school'], loose:true, value:'58%' },
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
const selected = Object.fromEntries(variants.map((v) => [v.id, new Set()]));
|
||||
|
||||
function card(v, s, i) {
|
||||
const on = selected[v.id].has(i);
|
||||
const absent = s.value === 'Not published';
|
||||
return `
|
||||
<li class="school">
|
||||
<p class="distance">${PIN}${s.distance} miles away</p>
|
||||
<h3><a href="#">${s.name}</a></h3>
|
||||
<p class="meta">${s.meta}</p>
|
||||
<ul class="shared">${s.shared.map((c) => `<li class="${s.loose ? 'loose' : ''}">${c}</li>`).join('')}</ul>
|
||||
<div class="metric">
|
||||
<p class="value ${absent ? 'absent' : ''}">${s.value}</p>
|
||||
<p class="label">${v.metric}</p>
|
||||
<p class="ref">${v.thisValue} at this school</p>
|
||||
</div>
|
||||
<button class="add" type="button" data-variant="${v.id}" data-index="${i}" aria-pressed="${on}">
|
||||
${on ? '✓ Added to compare' : '+ Add to compare'}<span class="sr"> — ${s.name}</span>
|
||||
</button>
|
||||
</li>`;
|
||||
}
|
||||
|
||||
function render() {
|
||||
document.getElementById('variants').innerHTML = variants.map((v) => {
|
||||
const count = selected[v.id].size;
|
||||
// Three fit the row, so anything more is what the arrows are for.
|
||||
const scrollable = v.schools.length > 3;
|
||||
return `
|
||||
<section class="variant">
|
||||
<div class="context">
|
||||
<p class="eyebrow">${v.eyebrow}</p>
|
||||
<h2>${v.context}</h2>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="top">
|
||||
<div>
|
||||
<h2 id="h-${v.id}">Similar schools nearby</h2>
|
||||
<p class="lede">${v.lede}</p>
|
||||
</div>
|
||||
${scrollable ? `<div class="arrows">
|
||||
<button class="arrow" type="button" data-scroll="prev" data-variant="${v.id}" aria-label="Previous schools" aria-controls="sc-${v.id}">${CHEV('prev')}</button>
|
||||
<button class="arrow" type="button" data-scroll="next" data-variant="${v.id}" aria-label="More schools" aria-controls="sc-${v.id}">${CHEV('next')}</button>
|
||||
</div>` : ''}
|
||||
</div>
|
||||
|
||||
<ul class="scroller" id="sc-${v.id}" ${scrollable ? `tabindex="0" role="group" aria-labelledby="h-${v.id}"` : ''}>
|
||||
${v.schools.map((s, i) => card(v, s, i)).join('')}
|
||||
</ul>
|
||||
|
||||
<div class="footer">
|
||||
<p aria-live="polite">
|
||||
<strong>${count ? `${count} school${count === 1 ? '' : 's'} selected` : 'Compare side by side'}</strong>
|
||||
${count ? 'This school is included automatically.' : 'Add a school to compare it with this one.'}
|
||||
</p>
|
||||
<a class="compare" href="#" aria-disabled="${count ? 'false' : 'true'}">
|
||||
${count ? `Compare ${count + 1} schools` : 'Compare'} →
|
||||
</a>
|
||||
</div>
|
||||
<p class="caption">Distances are straight-line from this school, not road distance.
|
||||
${v.caption} Fictional schools and figures for this mockup.</p>
|
||||
</div>
|
||||
<p class="note">${v.note}</p>
|
||||
</section>`;
|
||||
}).join('');
|
||||
|
||||
variants.forEach((v) => {
|
||||
const scroller = document.getElementById(`sc-${v.id}`);
|
||||
if (scroller) syncArrows(v.id, scroller);
|
||||
});
|
||||
}
|
||||
|
||||
/** An arrow that scrolls nowhere is a dead control, so each end disables its own.
|
||||
*
|
||||
* EDGE is not paranoia. The scroller carries 2px of padding so focus rings are
|
||||
* not clipped, and scroll-snap treats that padding as the first card's snap
|
||||
* position — so a scroller sitting at its start reports scrollLeft 2, not 0.
|
||||
* Sub-pixel rounding at other zoom levels moves it again. Testing against an
|
||||
* exact 0 leaves the back arrow live at the start, pointing nowhere. */
|
||||
const EDGE = 8;
|
||||
|
||||
function syncArrows(id, scroller) {
|
||||
const max = scroller.scrollWidth - scroller.clientWidth;
|
||||
const atStart = scroller.scrollLeft <= EDGE;
|
||||
const atEnd = scroller.scrollLeft >= max - EDGE;
|
||||
|
||||
// Drives the mobile scroll-fade, so it is computed even where no arrow is
|
||||
// rendered to consume it.
|
||||
scroller.dataset.atEnd = String(atEnd);
|
||||
|
||||
const prev = document.querySelector(`.arrow[data-scroll="prev"][data-variant="${id}"]`);
|
||||
const next = document.querySelector(`.arrow[data-scroll="next"][data-variant="${id}"]`);
|
||||
if (!prev || !next) return;
|
||||
prev.disabled = atStart;
|
||||
next.disabled = atEnd;
|
||||
}
|
||||
|
||||
document.getElementById('variants').addEventListener('click', (event) => {
|
||||
const arrow = event.target.closest('.arrow');
|
||||
if (arrow) {
|
||||
const scroller = document.getElementById(`sc-${arrow.dataset.variant}`);
|
||||
// A page is what the reader can see, so the viewport is the step.
|
||||
scroller.scrollBy({ left: (arrow.dataset.scroll === 'next' ? 1 : -1) * scroller.clientWidth, behavior: 'smooth' });
|
||||
return;
|
||||
}
|
||||
const button = event.target.closest('.add');
|
||||
if (!button) return;
|
||||
const { variant, index } = button.dataset;
|
||||
const set = selected[variant];
|
||||
const i = Number(index);
|
||||
// Scroll position is DOM state, not React state; keep it across the re-render.
|
||||
const offset = document.getElementById(`sc-${variant}`).scrollLeft;
|
||||
set.has(i) ? set.delete(i) : set.add(i);
|
||||
render();
|
||||
const scroller = document.getElementById(`sc-${variant}`);
|
||||
scroller.scrollLeft = offset;
|
||||
syncArrows(variant, scroller);
|
||||
document.querySelector(`.add[data-variant="${variant}"][data-index="${index}"]`).focus();
|
||||
}, true);
|
||||
|
||||
document.getElementById('variants').addEventListener('scroll', (event) => {
|
||||
const scroller = event.target.closest('.scroller');
|
||||
if (scroller) syncArrows(scroller.id.replace('sc-', ''), scroller);
|
||||
}, true);
|
||||
|
||||
const themeButton = document.getElementById('theme');
|
||||
themeButton.addEventListener('click', () => {
|
||||
const dark = document.documentElement.dataset.theme === 'dark';
|
||||
document.documentElement.dataset.theme = dark ? 'light' : 'dark';
|
||||
themeButton.textContent = dark ? 'Dark theme' : 'Light theme';
|
||||
});
|
||||
|
||||
render();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,192 @@
|
||||
/**
|
||||
* The section's job is to be honest about what it is showing. These tests pin
|
||||
* the ways it could mislead: rendering below the minimum, claiming a likeness
|
||||
* it does not rank on, showing a missing figure as a number, or hiding a card
|
||||
* behind an arrow where a crawler cannot reach it.
|
||||
*/
|
||||
|
||||
import { render, screen } from '@testing-library/react';
|
||||
|
||||
import {
|
||||
nearbyNoun,
|
||||
NearbySchoolsSection,
|
||||
shouldRenderNearby,
|
||||
} from '@/components/school/NearbySchoolsSection';
|
||||
import type { NearbySchool } from '@/lib/types';
|
||||
|
||||
jest.mock('@/components/school/AddToCompareButton', () => ({
|
||||
AddToCompareButton: ({ school }: { school: NearbySchool }) => (
|
||||
<button type="button">Add {school.school_name} to compare</button>
|
||||
),
|
||||
}));
|
||||
|
||||
jest.mock('@/components/school/NearbySchoolsCompareBar', () => ({
|
||||
NearbySchoolsCompareBar: ({ thisUrn }: { thisUrn: number }) => (
|
||||
<div data-testid="compare-bar">bar for {thisUrn}</div>
|
||||
),
|
||||
}));
|
||||
|
||||
function school(overrides: Partial<NearbySchool> = {}): NearbySchool {
|
||||
return {
|
||||
urn: 100002,
|
||||
school_name: 'Willow Lane Primary School',
|
||||
distance_miles: 0.6,
|
||||
school_type: 'Community school',
|
||||
age_range: '4-11',
|
||||
shared: ['Mixed', 'No religious character'],
|
||||
metric_value: 74,
|
||||
metric_key: 'rwm_expected_pct',
|
||||
metric_year: 202425,
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
function renderSection(nearby: NearbySchool[]) {
|
||||
return render(
|
||||
<NearbySchoolsSection
|
||||
urn={100001}
|
||||
schoolName="Meadowbrook Primary School"
|
||||
phase="Primary"
|
||||
thisMetricValue={72}
|
||||
nearby={nearby}
|
||||
/>,
|
||||
);
|
||||
}
|
||||
|
||||
describe('render gates', () => {
|
||||
it.each([
|
||||
['undefined', undefined],
|
||||
['null', null],
|
||||
['empty', []],
|
||||
['a single school', [school()]],
|
||||
])('renders nothing for %s', (_label, value) => {
|
||||
expect(shouldRenderNearby(value as NearbySchool[] | null | undefined)).toBe(false);
|
||||
});
|
||||
|
||||
it('renders for two or more schools', () => {
|
||||
expect(shouldRenderNearby([school(), school({ urn: 100003 })])).toBe(true);
|
||||
});
|
||||
|
||||
it('returns null rather than an empty shell below the minimum', () => {
|
||||
const { container } = renderSection([school()]);
|
||||
expect(container).toBeEmptyDOMElement();
|
||||
});
|
||||
});
|
||||
|
||||
describe('what the section claims', () => {
|
||||
it('never claims a similar intake, because it does not rank on one', () => {
|
||||
renderSection([school(), school({ urn: 100003, shared: [] })]);
|
||||
expect(screen.queryByText(/similar intake/i)).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('is headed "Other schools nearby", not "similar"', () => {
|
||||
renderSection([school(), school({ urn: 100003 })]);
|
||||
expect(screen.getByRole('heading', { name: 'Other schools nearby' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('shows chips for what is shared', () => {
|
||||
renderSection([school({ shared: ['Mixed', 'Roman Catholic'] }), school({ urn: 100003 })]);
|
||||
expect(screen.getAllByText('Roman Catholic').length).toBe(1);
|
||||
});
|
||||
|
||||
it('shows no chips at all when nothing is shared, rather than inventing one', () => {
|
||||
const { container } = render(
|
||||
<NearbySchoolsSection
|
||||
urn={100001}
|
||||
schoolName="Meadowbrook Primary School"
|
||||
phase="Primary"
|
||||
thisMetricValue={72}
|
||||
nearby={[school({ shared: [] }), school({ urn: 100003, shared: [] })]}
|
||||
/>,
|
||||
);
|
||||
// The card still carries its distance, name, type and figure — just no
|
||||
// claim of likeness.
|
||||
expect(container.querySelectorAll('li ul').length).toBe(0);
|
||||
expect(screen.getAllByText(/miles away/).length).toBe(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe('what the lede calls the set', () => {
|
||||
it.each([
|
||||
['Primary', 'primary schools'],
|
||||
['Middle deemed primary', 'primary schools'],
|
||||
['Secondary', 'secondary schools'],
|
||||
['Middle deemed secondary', 'secondary schools'],
|
||||
['All-through', 'all-through schools'],
|
||||
// GIAS phase 6. Its candidates span the whole secondary group, so no
|
||||
// single noun fits and it takes the honest general one.
|
||||
['16 plus', 'schools and colleges'],
|
||||
['', 'schools'],
|
||||
[null, 'schools'],
|
||||
])('calls a %s school\'s neighbours "%s"', (phase, expected) => {
|
||||
expect(nearbyNoun(phase)).toBe(expected);
|
||||
});
|
||||
|
||||
it('never calls a sixth form college\'s neighbours primary schools', () => {
|
||||
render(
|
||||
<NearbySchoolsSection
|
||||
urn={100001}
|
||||
schoolName="Barnet Sixth Form College"
|
||||
phase="16 plus"
|
||||
thisMetricValue={null}
|
||||
nearby={[school(), school({ urn: 100003 })]}
|
||||
/>,
|
||||
);
|
||||
expect(screen.getByText(/Other schools and colleges near Barnet Sixth Form College/)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/primary schools/)).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('cards', () => {
|
||||
it('links each school to its canonical slug', () => {
|
||||
renderSection([school(), school({ urn: 100003, school_name: 'Oakfield Primary School' })]);
|
||||
const link = screen.getByRole('link', { name: /Willow Lane Primary School/ });
|
||||
expect(link).toHaveAttribute('href', '/school/100002-willow-lane-primary-school');
|
||||
});
|
||||
|
||||
it('shows the distance and the shared characteristics', () => {
|
||||
renderSection([school(), school({ urn: 100003 })]);
|
||||
expect(screen.getAllByText('0.6 miles away').length).toBeGreaterThan(0);
|
||||
expect(screen.getAllByText('Mixed').length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it('renders a missing figure as "Not published", never as a number', () => {
|
||||
renderSection([school({ metric_value: null }), school({ urn: 100003 })]);
|
||||
expect(screen.getByText('Not published')).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('anchors each figure against this school', () => {
|
||||
renderSection([school(), school({ urn: 100003 })]);
|
||||
expect(screen.getAllByText('72% at this school').length).toBe(2);
|
||||
});
|
||||
|
||||
it('offers the compare bar once, for this school', () => {
|
||||
renderSection([school(), school({ urn: 100003 })]);
|
||||
expect(screen.getByTestId('compare-bar')).toHaveTextContent('bar for 100001');
|
||||
});
|
||||
|
||||
it('keeps every card in the DOM, including the ones scrolled out of view', () => {
|
||||
const six = Array.from({ length: 6 }, (_, n) =>
|
||||
school({ urn: 100002 + n, school_name: `Peer ${n} School` }),
|
||||
);
|
||||
renderSection(six);
|
||||
expect(screen.getAllByRole('link', { name: /Peer \d School/ })).toHaveLength(6);
|
||||
});
|
||||
|
||||
it('offers no arrows when three cards fit the row', () => {
|
||||
renderSection([school(), school({ urn: 100003 }), school({ urn: 100004 })]);
|
||||
expect(screen.queryByRole('button', { name: /More schools/ })).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('offers arrows once there is a fourth school', () => {
|
||||
renderSection(Array.from({ length: 4 }, (_, n) => school({ urn: 100002 + n })));
|
||||
expect(screen.getByRole('button', { name: /More schools/ })).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: /Previous schools/ })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('says distances are straight-line, and offers no method panel', () => {
|
||||
const { container } = renderSection([school(), school({ urn: 100003 })]);
|
||||
expect(screen.getByText(/straight-line from this school/i)).toBeInTheDocument();
|
||||
expect(container.querySelector('details')).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -172,3 +172,39 @@ describe('buildSecondaryNavItems', () => {
|
||||
expect(ids).not.toContain('history');
|
||||
});
|
||||
});
|
||||
|
||||
describe('the nearby-schools nav item', () => {
|
||||
const navInput = {
|
||||
ofsted: null, admissions: null, admissionDistance: null,
|
||||
hasLocation: true, yearlyDataLength: 1,
|
||||
};
|
||||
|
||||
it('appears on both templates when the section renders', () => {
|
||||
const primary = computeSchoolFlags(primaryFixture);
|
||||
const secondary = computeSecondaryFlags(secondaryFixture);
|
||||
const input = { ...navInput, hasNearbySchools: true };
|
||||
|
||||
expect(buildNavItems(primary, input).map((i) => i.id)).toContain('nearby');
|
||||
expect(buildSecondaryNavItems(secondary, input).map((i) => i.id)).toContain('nearby');
|
||||
});
|
||||
|
||||
it('is absent when the section does not render', () => {
|
||||
const primary = computeSchoolFlags(primaryFixture);
|
||||
const secondary = computeSecondaryFlags(secondaryFixture);
|
||||
const input = { ...navInput, hasNearbySchools: false };
|
||||
|
||||
expect(buildNavItems(primary, input).map((i) => i.id)).not.toContain('nearby');
|
||||
expect(buildSecondaryNavItems(secondary, input).map((i) => i.id)).not.toContain('nearby');
|
||||
});
|
||||
|
||||
it('is absent when nothing says either way', () => {
|
||||
const primary = computeSchoolFlags(primaryFixture);
|
||||
expect(buildNavItems(primary, navInput).map((i) => i.id)).not.toContain('nearby');
|
||||
});
|
||||
|
||||
it('comes last, because the section renders last', () => {
|
||||
const primary = computeSchoolFlags(primaryFixture);
|
||||
const ids = buildNavItems(primary, { ...navInput, hasNearbySchools: true }).map((i) => i.id);
|
||||
expect(ids[ids.length - 1]).toBe('nearby');
|
||||
});
|
||||
});
|
||||
@@ -8,6 +8,7 @@ import { APIFetchError, fetchSchoolDetails, fetchSchools, fetchNationalAverages
|
||||
import { notFound, redirect } from 'next/navigation';
|
||||
import { SchoolDetailShell } from '@/components/school/SchoolDetailShell';
|
||||
import { NearbyPlaces } from '@/components/school/NearbyPlaces';
|
||||
import { shouldRenderNearby } from '@/components/school/NearbySchoolsSection';
|
||||
import { schoolBreadcrumbJsonLd, type SchoolPlace } from '@/lib/jsonld';
|
||||
import { PrimarySchoolSections } from '@/components/school/PrimarySchoolSections';
|
||||
import { SecondarySchoolSections } from '@/components/school/SecondarySchoolSections';
|
||||
@@ -155,6 +156,8 @@ export default async function SchoolPage({ params }: SchoolPageProps) {
|
||||
// nothing rather than throwing, which is how this shipped without a
|
||||
// lockstep deploy of the two images.
|
||||
const places: SchoolPlace[] = data.places ?? [];
|
||||
// Absent on an older API build, exactly like `places` above.
|
||||
const nearbySchools = data.nearby_schools ?? [];
|
||||
|
||||
// Redirect bare URN to canonical slug URL
|
||||
const canonicalSlug = schoolUrl(urn, school_info.school_name).replace('/school/', '');
|
||||
@@ -186,6 +189,7 @@ export default async function SchoolPage({ params }: SchoolPageProps) {
|
||||
admissions: admissions ?? null,
|
||||
admissionDistance: admission_distance ?? null,
|
||||
hasLocation: school_info.latitude != null && school_info.longitude != null,
|
||||
hasNearbySchools: shouldRenderNearby(nearbySchools),
|
||||
yearlyDataLength: yearly_data.length,
|
||||
};
|
||||
const primaryNavItems = buildNavItems(primaryFlags, navInput);
|
||||
@@ -262,6 +266,7 @@ export default async function SchoolPage({ params }: SchoolPageProps) {
|
||||
finance={finance ?? null}
|
||||
nationalAvg={nationalAvg}
|
||||
destinations={destinations ?? null}
|
||||
nearbySchools={nearbySchools}
|
||||
flags={secondaryFlags}
|
||||
/>
|
||||
</SchoolDetailShell>
|
||||
@@ -284,6 +289,7 @@ export default async function SchoolPage({ params }: SchoolPageProps) {
|
||||
deprivation={deprivation ?? null}
|
||||
finance={finance ?? null}
|
||||
nationalAvg={nationalAvg}
|
||||
nearbySchools={nearbySchools}
|
||||
flags={primaryFlags}
|
||||
/>
|
||||
</SchoolDetailShell>
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
'use client';
|
||||
|
||||
/**
|
||||
* The per-card basket toggle.
|
||||
*
|
||||
* The links around it are server-rendered, so the section works with JS off;
|
||||
* this adds the basket interaction on top rather than being what makes the
|
||||
* section function.
|
||||
*/
|
||||
|
||||
import { useComparisonContext } from '@/context/ComparisonContext';
|
||||
import type { School, NearbySchool } from '@/lib/types';
|
||||
import styles from './NearbySchools.module.css';
|
||||
|
||||
export function AddToCompareButton({ school }: { school: NearbySchool }) {
|
||||
const { addSchool, removeSchool, selectedSchools } = useComparisonContext();
|
||||
const selected = selectedSchools.some((s) => s.urn === school.urn);
|
||||
|
||||
const toggle = () => {
|
||||
if (selected) {
|
||||
removeSchool(school.urn);
|
||||
return;
|
||||
}
|
||||
// The basket only needs identity and display fields; the compare page
|
||||
// fetches everything it renders by URN.
|
||||
addSchool({
|
||||
urn: school.urn,
|
||||
school_name: school.school_name,
|
||||
school_type: school.school_type,
|
||||
age_range: school.age_range,
|
||||
} as School);
|
||||
};
|
||||
|
||||
return (
|
||||
<button
|
||||
type="button"
|
||||
className={styles.add}
|
||||
onClick={toggle}
|
||||
aria-pressed={selected}
|
||||
>
|
||||
{selected ? '✓ Added to compare' : '+ Add to compare'}
|
||||
<span className={styles.srOnly}> — {school.school_name}</span>
|
||||
</button>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
.heading { font-family: var(--font-display); font-size: 1.4rem; letter-spacing: -0.4px; margin: 0; }
|
||||
.lede { margin: 0.5rem 0 1.25rem; color: var(--text-secondary); max-width: 64ch; }
|
||||
.caption { margin: 1rem 0 0; font-size: 0.72rem; color: var(--text-muted); }
|
||||
|
||||
.top { display: flex; align-items: flex-start; justify-content: space-between; gap: 1rem; }
|
||||
.arrows { display: flex; gap: 0.5rem; flex: none; }
|
||||
.arrow { width: 44px; height: 44px; display: grid; place-items: center; cursor: pointer; border: 1px solid var(--border-strong); border-radius: 999px; background: var(--bg-card); color: var(--brand); }
|
||||
.arrow:hover:not(:disabled) { border-color: var(--brand); background: var(--brand-bg); }
|
||||
.arrow:disabled { opacity: 0.35; cursor: default; }
|
||||
.arrow svg { width: 17px; height: 17px; }
|
||||
|
||||
/* A scroller, not a paginated view: every card is in the DOM and the arrows
|
||||
only move the viewport across them. The 2px padding keeps focus rings from
|
||||
being clipped — and is why the arrows' edge test needs a tolerance. */
|
||||
.scroller { display: grid; grid-auto-flow: column; grid-auto-columns: calc((100% - 1.8rem) / 3); gap: 0.9rem; overflow-x: auto; scroll-snap-type: x mandatory; padding: 2px; margin: -2px; list-style: none; scrollbar-width: none; -ms-overflow-style: none; }
|
||||
.scroller::-webkit-scrollbar { display: none; }
|
||||
@media (max-width: 820px) { .scroller { grid-auto-columns: calc((100% - 0.9rem) / 2); } }
|
||||
/* Touch widths (MOBILE.md): the arrows would take 96px from a 328px card and
|
||||
crush the lede into four lines, for a control swiping already provides. They
|
||||
go, and the documented right-edge fade carries the affordance — lifting at
|
||||
the end of the travel, where there is nothing more to hint at. */
|
||||
@media (max-width: 640px) {
|
||||
.top { display: block; }
|
||||
.arrows { display: none; }
|
||||
.scroller { grid-auto-columns: 86%; mask-image: linear-gradient(to right, #000 calc(100% - 28px), transparent); }
|
||||
.scroller[data-at-end="true"] { mask-image: none; }
|
||||
}
|
||||
|
||||
.school { position: relative; display: flex; flex-direction: column; scroll-snap-align: start; border: 1px solid var(--border); border-radius: 8px; padding: 1rem; background: var(--bg-card); }
|
||||
.school:hover { border-color: var(--border-strong); }
|
||||
|
||||
.distance { margin: 0 0 0.6rem; font-size: 0.75rem; color: var(--text-muted); }
|
||||
.name { font-family: var(--font-display); font-size: 1rem; line-height: 1.35; margin: 0 0 0.35rem; }
|
||||
.name a { color: var(--text-primary); text-decoration: none; }
|
||||
/* The whole card is the link target; the button sits above it on z-index. */
|
||||
.name a::after { content: ""; position: absolute; inset: 0; border-radius: 8px; }
|
||||
.name a:hover { color: var(--brand); text-decoration: underline; }
|
||||
.meta { margin: 0 0 0.75rem; font-size: 0.78rem; color: var(--text-muted); }
|
||||
|
||||
.shared { display: flex; flex-wrap: wrap; gap: 0.35rem; list-style: none; margin: 0 0 0.85rem; padding: 0; }
|
||||
.chip { font-size: 0.72rem; line-height: 1.4; padding: 0.25rem 0.5rem; border-radius: 999px; background: var(--brand-bg); color: var(--brand); border: 1px solid transparent; }
|
||||
|
||||
.metric { margin-top: auto; padding-top: 0.8rem; border-top: 1px solid var(--border); }
|
||||
/* No valence colour here, deliberately: green and terracotta mean "against the
|
||||
England average" everywhere else on the site, and colouring a neighbour
|
||||
against this school would read as ranking the neighbours. */
|
||||
.value { font-family: var(--font-display); font-size: 1.6rem; font-weight: 700; letter-spacing: -0.6px; margin: 0; color: var(--text-primary); }
|
||||
.valueAbsent { font-size: 0.95rem; font-weight: 600; margin: 0; color: var(--text-muted); }
|
||||
.metricLabel { margin: 0.25rem 0 0; font-size: 0.75rem; color: var(--text-secondary); }
|
||||
.metricRef { margin: 0.1rem 0 0; font-size: 0.75rem; color: var(--text-muted); }
|
||||
|
||||
.add { position: relative; z-index: 1; margin-top: 0.85rem; width: 100%; min-height: 44px; font: inherit; font-size: 0.82rem; font-weight: 500; cursor: pointer; border-radius: 8px; border: 1px solid var(--border-strong); background: var(--bg-card); color: var(--brand); }
|
||||
.add:hover { border-color: var(--brand); background: var(--brand-bg); }
|
||||
.add[aria-pressed="true"] { border-color: var(--brand); background: var(--brand-bg); font-weight: 600; }
|
||||
|
||||
.footer { display: flex; flex-wrap: wrap; align-items: center; justify-content: space-between; gap: 0.85rem; margin-top: 1.25rem; padding-top: 1.1rem; border-top: 1px solid var(--border); }
|
||||
.footer p { margin: 0; font-size: 0.78rem; color: var(--text-muted); }
|
||||
.footer strong { display: block; font-size: 0.88rem; font-weight: 600; color: var(--text-primary); }
|
||||
/* Coral is the one decisive action per screen, and in this section this is it. */
|
||||
.compare { min-height: 44px; padding: 0 1.25rem; border-radius: 8px; font-size: 0.88rem; font-weight: 600; background: var(--action); color: var(--action-on); border: 1px solid var(--action); text-decoration: none; display: inline-flex; align-items: center; }
|
||||
.compare:hover { background: var(--action-strong); border-color: var(--action-strong); }
|
||||
.compare[aria-disabled="true"] { opacity: 0.45; pointer-events: none; }
|
||||
|
||||
.srOnly { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0 0 0 0); white-space: nowrap; border: 0; }
|
||||
@@ -0,0 +1,127 @@
|
||||
'use client';
|
||||
|
||||
/**
|
||||
* The scroller and its arrows.
|
||||
*
|
||||
* `children` are the server-rendered cards and `header` the server-rendered
|
||||
* heading and lede: both stay server components, passed through, so this file
|
||||
* owns a DOM ref and nothing else. That is what keeps all six links in the
|
||||
* initial HTML — a carousel that mounted cards on click would put four of the
|
||||
* six beyond a crawler and beyond a reader with no JavaScript.
|
||||
*
|
||||
* With JavaScript off this degrades to a horizontally scrollable row, which is
|
||||
* still usable by touch and trackpad.
|
||||
*/
|
||||
|
||||
import { useCallback, useEffect, useRef, useState, type ReactNode } from 'react';
|
||||
import styles from './NearbySchools.module.css';
|
||||
|
||||
/** Three cards fit the row, so fewer than four has nowhere to scroll to.
|
||||
* Below 640px the arrows are not rendered at all — see the stylesheet. */
|
||||
const VISIBLE = 3;
|
||||
|
||||
/**
|
||||
* Why a tolerance rather than `=== 0`.
|
||||
*
|
||||
* The scroller carries 2px of padding so focus rings are not clipped, and
|
||||
* scroll-snap treats that padding as the first card's snap position — a row at
|
||||
* rest reports scrollLeft 2, not 0. Sub-pixel rounding moves it again at other
|
||||
* zoom levels. An exact test leaves the back arrow live on first paint,
|
||||
* pointing nowhere.
|
||||
*/
|
||||
const EDGE = 8;
|
||||
|
||||
export function NearbySchoolsCarousel({
|
||||
count,
|
||||
labelledBy,
|
||||
header,
|
||||
children,
|
||||
}: {
|
||||
count: number;
|
||||
labelledBy: string;
|
||||
header: ReactNode;
|
||||
children: ReactNode;
|
||||
}) {
|
||||
const scroller = useRef<HTMLUListElement>(null);
|
||||
const [atStart, setAtStart] = useState(true);
|
||||
const [atEnd, setAtEnd] = useState(false);
|
||||
const scrollable = count > VISIBLE;
|
||||
|
||||
const sync = useCallback(() => {
|
||||
const node = scroller.current;
|
||||
if (!node) return;
|
||||
const max = node.scrollWidth - node.clientWidth;
|
||||
setAtStart(node.scrollLeft <= EDGE);
|
||||
setAtEnd(node.scrollLeft >= max - EDGE);
|
||||
}, []);
|
||||
// `atEnd` is not only the forward arrow's disabled state: below 640px, where
|
||||
// no arrow is rendered, it is the only thing driving the scroll-fade.
|
||||
|
||||
// Also on mount: the first measurement can only happen once there is layout.
|
||||
useEffect(sync, [sync]);
|
||||
|
||||
const page = (direction: 1 | -1) => {
|
||||
const node = scroller.current;
|
||||
if (!node) return;
|
||||
// A page is what the reader can see, so the viewport is the step.
|
||||
node.scrollBy({ left: direction * node.clientWidth, behavior: 'smooth' });
|
||||
};
|
||||
|
||||
return (
|
||||
<>
|
||||
<div className={styles.top}>
|
||||
{header}
|
||||
{scrollable && (
|
||||
<div className={styles.arrows}>
|
||||
<button
|
||||
type="button"
|
||||
className={styles.arrow}
|
||||
onClick={() => page(-1)}
|
||||
disabled={atStart}
|
||||
aria-label="Previous schools"
|
||||
>
|
||||
<Chevron direction="prev" />
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
className={styles.arrow}
|
||||
onClick={() => page(1)}
|
||||
disabled={atEnd}
|
||||
aria-label="More schools"
|
||||
>
|
||||
<Chevron direction="next" />
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
|
||||
<ul
|
||||
ref={scroller}
|
||||
className={styles.scroller}
|
||||
onScroll={sync}
|
||||
data-at-end={atEnd}
|
||||
{...(scrollable
|
||||
? { tabIndex: 0, role: 'group', 'aria-labelledby': labelledBy }
|
||||
: {})}
|
||||
>
|
||||
{children}
|
||||
</ul>
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
function Chevron({ direction }: { direction: 'prev' | 'next' }) {
|
||||
return (
|
||||
<svg
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<path d={direction === 'prev' ? 'M15 18l-6-6 6-6' : 'M9 18l6-6-6-6'} />
|
||||
</svg>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
'use client';
|
||||
|
||||
/**
|
||||
* The selection count and the one decisive action in the section.
|
||||
*
|
||||
* The CTA is a real link, not a handler: /compare already parses `urns` from
|
||||
* the query string, so the hand-off needs no new compare plumbing. It counts
|
||||
* this school plus whatever the reader ticked, because comparing a shortlist
|
||||
* without the school they are looking at is not what they asked for.
|
||||
*/
|
||||
|
||||
import Link from 'next/link';
|
||||
import { useComparisonContext } from '@/context/ComparisonContext';
|
||||
import type { NearbySchool } from '@/lib/types';
|
||||
import styles from './NearbySchools.module.css';
|
||||
|
||||
export function NearbySchoolsCompareBar({
|
||||
thisUrn,
|
||||
candidates,
|
||||
}: {
|
||||
thisUrn: number;
|
||||
candidates: NearbySchool[];
|
||||
}) {
|
||||
const { selectedSchools } = useComparisonContext();
|
||||
|
||||
// Only the schools this section offers, in the order the cards show them —
|
||||
// the basket may hold schools picked up elsewhere on the site, and this bar
|
||||
// speaks for this section.
|
||||
const offered = candidates
|
||||
.map((c) => c.urn)
|
||||
.filter((urn) => selectedSchools.some((s) => s.urn === urn));
|
||||
|
||||
const count = offered.length;
|
||||
const href = `/compare?urns=${[thisUrn, ...offered].join(',')}`;
|
||||
|
||||
return (
|
||||
<div className={styles.footer}>
|
||||
<p aria-live="polite">
|
||||
<strong>
|
||||
{count
|
||||
? `${count} school${count === 1 ? '' : 's'} selected`
|
||||
: 'Compare side by side'}
|
||||
</strong>
|
||||
{count
|
||||
? 'This school is included automatically.'
|
||||
: 'Add a school to compare it with this one.'}
|
||||
</p>
|
||||
{count ? (
|
||||
<Link className={styles.compare} href={href}>
|
||||
Compare {count + 1} schools →
|
||||
</Link>
|
||||
) : (
|
||||
<span className={styles.compare} aria-disabled="true">
|
||||
Compare →
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,152 @@
|
||||
/**
|
||||
* NearbySchoolsSection — the nearest eligible schools, closest first. Server
|
||||
* component; only the carousel, the compare bar and the add-to-compare button
|
||||
* are client-side.
|
||||
*
|
||||
* "Other schools nearby", not "similar" ones: the order is distance and only
|
||||
* distance. The hard filters upstream still guarantee the set is comparable —
|
||||
* same phase, same selectivity, mainstream never beside special — but nothing
|
||||
* here ranks by how alike two schools are, so the heading does not say it does.
|
||||
*
|
||||
* The chips report what a school shares, and may be absent entirely. That is
|
||||
* information for the reader to weigh, not a verdict this section has already
|
||||
* reached on their behalf.
|
||||
*
|
||||
* There is deliberately no "how these are chosen" panel: the method is already
|
||||
* visible in the lede, the chips and the distances. The single caption line is
|
||||
* not a method note — it is the one thing a card cannot self-correct.
|
||||
*/
|
||||
|
||||
import Link from 'next/link';
|
||||
import type { NearbySchool } from '@/lib/types';
|
||||
import { schoolUrl } from '@/lib/utils';
|
||||
import { AddToCompareButton } from './AddToCompareButton';
|
||||
import { NearbySchoolsCarousel } from './NearbySchoolsCarousel';
|
||||
import { NearbySchoolsCompareBar } from './NearbySchoolsCompareBar';
|
||||
import { Section } from './sectionShared';
|
||||
import styles from './NearbySchools.module.css';
|
||||
|
||||
const MINIMUM = 2;
|
||||
|
||||
export function shouldRenderNearby(nearby?: NearbySchool[] | null): boolean {
|
||||
return (nearby?.length ?? 0) >= MINIMUM;
|
||||
}
|
||||
|
||||
/**
|
||||
* What the lede calls the set of schools it is showing.
|
||||
*
|
||||
* Derived from the school's own GIAS phase rather than the template it renders
|
||||
* with, because those disagree for "16 plus" (GIAS phase 6): a sixth-form
|
||||
* college renders the primary template — computeSchoolFlags tests for the
|
||||
* substring "secondary" — while the backend correctly matches it against the
|
||||
* secondary group. Taking the noun from the template would print "Other primary
|
||||
* schools near <sixth form college>" above a row of secondaries.
|
||||
*
|
||||
* A 16-plus school's candidates span the whole secondary group, so no single
|
||||
* noun fits and it gets the honest general one.
|
||||
*/
|
||||
export function nearbyNoun(phase: string | null | undefined): string {
|
||||
const text = (phase ?? '').trim().toLowerCase();
|
||||
if (text === 'all-through') return 'all-through schools';
|
||||
if (text === '16 plus') return 'schools and colleges';
|
||||
if (text.includes('secondary')) return 'secondary schools';
|
||||
if (text.includes('primary')) return 'primary schools';
|
||||
return 'schools';
|
||||
}
|
||||
|
||||
function metricLabel(key: string): string {
|
||||
return key === 'attainment_8_score' ? 'Attainment 8' : 'Reading, writing & maths';
|
||||
}
|
||||
|
||||
function formatMetric(value: number | null, key: string): string {
|
||||
if (value == null) return 'Not published';
|
||||
return key === 'attainment_8_score' ? value.toFixed(1) : `${Math.round(value)}%`;
|
||||
}
|
||||
|
||||
export function NearbySchoolsSection({
|
||||
urn,
|
||||
schoolName,
|
||||
phase,
|
||||
thisMetricValue,
|
||||
nearby,
|
||||
}: {
|
||||
urn: number;
|
||||
schoolName: string;
|
||||
/** The school's own GIAS phase, not the template it renders with. */
|
||||
phase: string | null | undefined;
|
||||
thisMetricValue: number | null;
|
||||
nearby?: NearbySchool[] | null;
|
||||
}) {
|
||||
if (!shouldRenderNearby(nearby)) return null;
|
||||
const schools = nearby as NearbySchool[];
|
||||
|
||||
// One card matched on phase alone, so the section may not claim the set
|
||||
// shares an intake with this school.
|
||||
const metricKey = schools[0].metric_key;
|
||||
const noun = nearbyNoun(phase);
|
||||
|
||||
return (
|
||||
<Section id="nearby">
|
||||
<NearbySchoolsCarousel
|
||||
count={schools.length}
|
||||
labelledBy="nearby-schools-heading"
|
||||
header={
|
||||
<div>
|
||||
<h2 id="nearby-schools-heading" className={styles.heading}>
|
||||
Other schools nearby
|
||||
</h2>
|
||||
<p className={styles.lede}>{`Other ${noun} near ${schoolName}.`}</p>
|
||||
</div>
|
||||
}
|
||||
>
|
||||
{schools.map((school) => (
|
||||
<li key={school.urn} className={styles.school}>
|
||||
<p className={styles.distance}>{school.distance_miles} miles away</p>
|
||||
<h3 className={styles.name}>
|
||||
<Link href={schoolUrl(school.urn, school.school_name)}>
|
||||
{school.school_name}
|
||||
</Link>
|
||||
</h3>
|
||||
<p className={styles.meta}>
|
||||
{[school.school_type, school.age_range && `Ages ${school.age_range}`]
|
||||
.filter(Boolean)
|
||||
.join(' · ')}
|
||||
</p>
|
||||
{school.shared.length > 0 && (
|
||||
<ul className={styles.shared}>
|
||||
{school.shared.map((label) => (
|
||||
<li key={label} className={styles.chip}>{label}</li>
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
<div className={styles.metric}>
|
||||
<p
|
||||
className={
|
||||
school.metric_value == null ? styles.valueAbsent : styles.value
|
||||
}
|
||||
>
|
||||
{formatMetric(school.metric_value, school.metric_key)}
|
||||
</p>
|
||||
<p className={styles.metricLabel}>{metricLabel(school.metric_key)}</p>
|
||||
{thisMetricValue != null && (
|
||||
<p className={styles.metricRef}>
|
||||
{formatMetric(thisMetricValue, metricKey)} at this school
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
<AddToCompareButton school={school} />
|
||||
</li>
|
||||
))}
|
||||
</NearbySchoolsCarousel>
|
||||
|
||||
<NearbySchoolsCompareBar thisUrn={urn} candidates={schools} />
|
||||
|
||||
{/* The one caveat the cards cannot make on their own: a reader who takes
|
||||
"0.6 miles away" for the walk has been misled, and nothing else here
|
||||
corrects that. */}
|
||||
<p className={styles.caption}>
|
||||
Distances are straight-line from this school, not road distance.
|
||||
</p>
|
||||
</Section>
|
||||
);
|
||||
}
|
||||
@@ -14,6 +14,7 @@
|
||||
import type {
|
||||
School, SchoolResult, AbsenceData, OfstedInspection, SchoolCensus,
|
||||
SchoolAdmissions, SchoolAdmissionDistance, SchoolDeprivation, SchoolFinance, NationalAverages,
|
||||
NearbySchool,
|
||||
} from '@/lib/types';
|
||||
import { ofstedLegacyAreas } from '@/lib/utils';
|
||||
import type { SchoolFlags } from '@/lib/schoolSections';
|
||||
@@ -26,6 +27,7 @@ import { HistorySection } from './HistorySection';
|
||||
import { SchoolLifeSection } from './SchoolLifeSection';
|
||||
import { LocalAreaSection } from './LocalAreaSection';
|
||||
import { FinancesSection } from './FinancesSection';
|
||||
import { NearbySchoolsSection } from './NearbySchoolsSection';
|
||||
|
||||
export interface PrimarySchoolSectionsProps {
|
||||
schoolInfo: School;
|
||||
@@ -39,13 +41,15 @@ export interface PrimarySchoolSectionsProps {
|
||||
deprivation: SchoolDeprivation | null;
|
||||
finance: SchoolFinance | null;
|
||||
nationalAvg: NationalAverages | null;
|
||||
/** Nearby schools of a comparable intake. Absent on an older API build. */
|
||||
nearbySchools?: NearbySchool[];
|
||||
flags: SchoolFlags;
|
||||
}
|
||||
|
||||
export function PrimarySchoolSections({
|
||||
schoolInfo, yearlyData, absenceData, ofsted, census,
|
||||
admissions, admissionsHistory, admissionDistance,
|
||||
deprivation, finance, nationalAvg, flags,
|
||||
deprivation, finance, nationalAvg, nearbySchools, flags,
|
||||
}: PrimarySchoolSectionsProps) {
|
||||
const primaryAvg = nationalAvg?.primary ?? {};
|
||||
const secondaryAvg = nationalAvg?.secondary ?? {};
|
||||
@@ -146,6 +150,15 @@ export function PrimarySchoolSections({
|
||||
)}
|
||||
|
||||
{flags.hasFinance && finance && <FinancesSection finance={finance} />}
|
||||
|
||||
{/* Last: it is where the reader goes next, not part of this school. */}
|
||||
<NearbySchoolsSection
|
||||
urn={schoolInfo.urn}
|
||||
schoolName={schoolInfo.school_name}
|
||||
phase={schoolInfo.phase}
|
||||
thisMetricValue={flags.latestResults?.rwm_expected_pct ?? null}
|
||||
nearby={nearbySchools}
|
||||
/>
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -283,6 +283,21 @@
|
||||
}
|
||||
|
||||
|
||||
/* `position: sticky` with a z-index makes .sectionNav a stacking context, so
|
||||
the jump sheet's own z-index only orders it INSIDE that context. Against the
|
||||
fixed bottom tab bar (Navigation.module.css, z-index 1000) what counts is
|
||||
.sectionNav's 10 — which is why the sheet's last item was painted over, and
|
||||
untappable, once the list grew long enough to reach the bar.
|
||||
|
||||
Lifted only while the sheet is open, and only to 1100: above the bar, below
|
||||
the comparison toast (2000), the fullscreen map (5000) and the info popover
|
||||
(9999). This rule carries the z-index and nothing else; every other
|
||||
declaration belongs to .sectionNav in both states. */
|
||||
.sectionNavSheetOpen {
|
||||
z-index: 1100;
|
||||
}
|
||||
|
||||
|
||||
.sectionNavBack {
|
||||
flex: none;
|
||||
display: inline-flex;
|
||||
|
||||
@@ -344,7 +344,10 @@ export function SchoolDetailShell({
|
||||
</header>
|
||||
|
||||
{/* Sticky Section Navigation — docks under the global header */}
|
||||
<nav className={styles.sectionNav} aria-label="Page sections">
|
||||
<nav
|
||||
className={`${styles.sectionNav}${sectionsOpen ? ` ${styles.sectionNavSheetOpen}` : ''}`}
|
||||
aria-label="Page sections"
|
||||
>
|
||||
<button onClick={scrollToTop} className={styles.sectionNavBack} aria-label="Back to top">
|
||||
<span aria-hidden="true">↑</span>
|
||||
<span className={styles.sectionNavBackLabel}>Top</span>
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
import type {
|
||||
School, SchoolResult, AbsenceData, OfstedInspection, SchoolCensus,
|
||||
SchoolAdmissions, SchoolAdmissionDistance, SchoolDeprivation, SchoolFinance, NationalAverages,
|
||||
SchoolDestinations,
|
||||
SchoolDestinations, NearbySchool,
|
||||
} from '@/lib/types';
|
||||
import { ofstedLegacyAreas } from '@/lib/utils';
|
||||
import type { SecondaryFlags } from '@/lib/schoolSections';
|
||||
@@ -27,6 +27,7 @@ import { DistanceSection } from './DistanceSection';
|
||||
import { SecondaryHistorySection } from './SecondaryHistorySection';
|
||||
import { WellbeingSection } from './WellbeingSection';
|
||||
import { FinancesSection } from './FinancesSection';
|
||||
import { NearbySchoolsSection } from './NearbySchoolsSection';
|
||||
import styles from './schoolSections.module.css';
|
||||
|
||||
export interface SecondarySchoolSectionsProps {
|
||||
@@ -47,13 +48,15 @@ export interface SecondarySchoolSectionsProps {
|
||||
finance: SchoolFinance | null;
|
||||
nationalAvg: NationalAverages | null;
|
||||
destinations: SchoolDestinations | null;
|
||||
/** Nearby schools of a comparable intake. Absent on an older API build. */
|
||||
nearbySchools?: NearbySchool[];
|
||||
flags: SecondaryFlags;
|
||||
}
|
||||
|
||||
export function SecondarySchoolSections({
|
||||
schoolInfo, yearlyData, ofsted, census,
|
||||
admissions, admissionsHistory, admissionDistance,
|
||||
deprivation, finance, nationalAvg, destinations, flags,
|
||||
deprivation, finance, nationalAvg, destinations, nearbySchools, flags,
|
||||
}: SecondarySchoolSectionsProps) {
|
||||
const secondaryAvg = nationalAvg?.secondary ?? {};
|
||||
|
||||
@@ -141,6 +144,15 @@ export function SecondarySchoolSections({
|
||||
{flags.hasFinance && finance && (
|
||||
<FinancesSection finance={finance} showPremises />
|
||||
)}
|
||||
|
||||
{/* Last: it is where the reader goes next, not part of this school. */}
|
||||
<NearbySchoolsSection
|
||||
urn={schoolInfo.urn}
|
||||
schoolName={schoolInfo.school_name}
|
||||
phase={schoolInfo.phase}
|
||||
thisMetricValue={flags.latestResults?.attainment_8_score ?? null}
|
||||
nearby={nearbySchools}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -128,6 +128,10 @@ export interface NavItemsInput {
|
||||
* measure a postcode, so the nav must gate on them too or it will link to an
|
||||
* anchor that was never rendered. */
|
||||
hasLocation?: boolean;
|
||||
/** Whether the nearby-schools section will render. Optional for the same
|
||||
* reason hasLocation is: the nav must never link to an anchor that was not
|
||||
* rendered, and absent has to mean "no section". */
|
||||
hasNearbySchools?: boolean;
|
||||
yearlyDataLength: number;
|
||||
}
|
||||
|
||||
@@ -142,7 +146,10 @@ export interface NavItemsInput {
|
||||
*/
|
||||
export function buildNavItems(
|
||||
flags: SchoolFlags,
|
||||
{ ofsted, admissions, admissionDistance, hasLocation, yearlyDataLength }: NavItemsInput,
|
||||
{
|
||||
ofsted, admissions, admissionDistance, hasLocation,
|
||||
hasNearbySchools, yearlyDataLength,
|
||||
}: NavItemsInput,
|
||||
): NavItem[] {
|
||||
const navItems: NavItem[] = [];
|
||||
if (ofsted) navItems.push({ id: 'ofsted', label: 'Ofsted' });
|
||||
@@ -161,6 +168,8 @@ export function buildNavItems(
|
||||
if (flags.hasSchoolLife) navItems.push({ id: 'school-life', label: 'School Life' });
|
||||
if (flags.hasDeprivation) navItems.push({ id: 'local-area', label: 'Local Area' });
|
||||
if (flags.hasFinance) navItems.push({ id: 'finances', label: 'Finances' });
|
||||
// Last, because the section renders last — the scroll-spy reads this order.
|
||||
if (hasNearbySchools) navItems.push({ id: 'nearby', label: 'Nearby schools' });
|
||||
return navItems;
|
||||
}
|
||||
|
||||
@@ -239,7 +248,10 @@ export function computeSecondaryFlags({
|
||||
*/
|
||||
export function buildSecondaryNavItems(
|
||||
flags: SecondaryFlags,
|
||||
{ ofsted, admissions, admissionDistance, hasLocation, yearlyDataLength }: NavItemsInput,
|
||||
{
|
||||
ofsted, admissions, admissionDistance, hasLocation,
|
||||
hasNearbySchools, yearlyDataLength,
|
||||
}: NavItemsInput,
|
||||
): NavItem[] {
|
||||
const navItems: NavItem[] = [];
|
||||
if (ofsted) navItems.push({ id: 'ofsted', label: 'Ofsted' });
|
||||
@@ -257,5 +269,7 @@ export function buildSecondaryNavItems(
|
||||
if (yearlyDataLength > 1) navItems.push({ id: 'history', label: 'History' });
|
||||
if (flags.hasWellbeing) navItems.push({ id: 'wellbeing', label: 'Wellbeing' });
|
||||
if (flags.hasFinance) navItems.push({ id: 'finances', label: 'Finances' });
|
||||
// Last, because the section renders last — the scroll-spy reads this order.
|
||||
if (hasNearbySchools) navItems.push({ id: 'nearby', label: 'Nearby schools' });
|
||||
return navItems;
|
||||
}
|
||||
@@ -346,6 +346,26 @@ export interface SchoolsResponse {
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* A nearby school, from the nearest-first set the detail page shows.
|
||||
*
|
||||
* `shared` is what this school genuinely has in common with the one being
|
||||
* viewed, and may be empty. It is reported, never ranked on: an earlier
|
||||
* version ordered by it and buried the school down the road under faith
|
||||
* matches three times further away.
|
||||
*/
|
||||
export interface NearbySchool {
|
||||
urn: number;
|
||||
school_name: string;
|
||||
distance_miles: number;
|
||||
school_type: string | null;
|
||||
age_range: string | null;
|
||||
shared: string[];
|
||||
metric_value: number | null;
|
||||
metric_key: string;
|
||||
metric_year: number | null;
|
||||
}
|
||||
|
||||
export interface SchoolDetailsResponse {
|
||||
school_info: School;
|
||||
/**
|
||||
@@ -357,6 +377,14 @@ export interface SchoolDetailsResponse {
|
||||
* authority both fall below the publish threshold has nowhere to link.
|
||||
*/
|
||||
places?: SchoolPlace[];
|
||||
/**
|
||||
* Up to six nearby eligible schools, nearest first.
|
||||
*
|
||||
* Optional for the same reason as `places`: a frontend deployed ahead of the
|
||||
* API that serves this must render without it. Absent and empty mean the
|
||||
* same thing here — no section.
|
||||
*/
|
||||
nearby_schools?: NearbySchool[];
|
||||
yearly_data: SchoolResult[];
|
||||
absence_data: AbsenceData | null;
|
||||
// Supplementary data (null until Kestra populates)
|
||||
|
||||
Reference in new issue
Block a user