refactor: replace template name property with context property

use a single template that will be given each agency's specific context.

no need for the template override field on `TransitAgency` or
the individual templates anymore.

Author: angela-tran

benefits/core/admin/transit.py

@@ -30,7 +30,6 @@ def get_readonly_fields(self, request, obj=None):
         if not request.user.is_superuser:
             fields.extend(
                 [
-                    "eligibility_index_template_override",
                     "eligibility_api_id",
                     "transit_processor",
                 ]

benefits/core/migrations/0037_remove_transitagency_eligibility_index_template_override.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.1.5 on 2025-02-27 02:32
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0036_in_person_enrollmentflows"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="transitagency",
+            name="eligibility_index_template_override",
+        ),
+    ]

benefits/core/models/transit.py

@@ -8,7 +8,7 @@
 
 from benefits.core import context as core_context
 from benefits.routes import routes
-from .common import PemData, SecretNameField, template_path
+from .common import PemData, SecretNameField
 
 logger = logging.getLogger(__name__)
 
@@ -72,11 +72,6 @@ class TransitAgency(models.Model):
         help_text="URL of a website/page with more information about the agency's discounts",
     )
     phone = models.TextField(default="", blank=True, help_text="Agency customer support phone number")
-    eligibility_index_template_override = models.TextField(
-        help_text="Override the default template used for this agency's eligibility landing page",
-        blank=True,
-        default="",
-    )
     eligibility_api_id = models.TextField(
         help_text="The identifier for this agency used in Eligibility API calls.",
         blank=True,
@@ -168,8 +163,8 @@ def index_url(self):
         return reverse(routes.AGENCY_INDEX, args=[self.slug])
 
     @property
-    def eligibility_index_template(self):
-        return self.eligibility_index_template_override or f"eligibility/index--{self.slug}.html"
+    def eligibility_index_context(self):
+        return core_context.eligibility_index[self.slug].dict()
 
     @property
     def eligibility_index_url(self):
@@ -197,7 +192,6 @@ def enrollment_flows(self):
 
     def clean(self):
         field_errors = {}
-        template_errors = []
 
         if self.active:
             message = "This field is required for active transit agencies."
@@ -219,17 +213,8 @@ def clean(self):
                 )
             field_errors.update({k: ValidationError(message) for k, v in needed.items() if not v})
 
-            # since templates are calculated from the pattern or the override field
-            # we can't add a field-level validation error
-            # so just create directly for a missing template
-            for t in [self.eligibility_index_template]:
-                if not template_path(t):
-                    template_errors.append(ValidationError(f"Template not found: {t}"))
-
         if field_errors:
             raise ValidationError(field_errors)
-        if template_errors:
-            raise ValidationError(template_errors)
 
     @staticmethod
     def by_id(id):

benefits/eligibility/templates/eligibility/index--cst.html

@@ -19,8 +19,14 @@ <h1>{% translate "Choose the transit benefit you would like to enroll in" %}</h1
 {% endblock headline %}
 
 {% block inner-content %}
-  {% block form-text %}
-  {% endblock form-text %}
+  {% for text in form_text %}
+    {% if not forloop.last %}
+      <p class="pt-4">{% translate text %}</p>
+    {% else %}
+      <p class="pt-4 pb-4">{% translate text %}</p>
+    {% endif %}
+  {% endfor %}
+
   {% include "core/includes/form.html" with form=form %}
   <script nonce="{{ request.csp_nonce }}">
     document.querySelectorAll(".modal").forEach((modal) => {

benefits/eligibility/templates/eligibility/index--mst.html

@@ -49,7 +49,8 @@ def index(request):
             context["form"] = form
             response = TemplateResponse(request, agency.eligibility_index_template, context)
     else:
-        response = TemplateResponse(request, agency.eligibility_index_template, context)
+        context.update(agency.eligibility_index_context)
+        response = TemplateResponse(request, "eligibility/index.html", context)
 
     return response
 

benefits/eligibility/templates/eligibility/index--nevco.html

@@ -176,7 +176,6 @@ def model_TransitAgency(model_PemData, model_TransitProcessor):
         eligibility_api_id="test123",
         eligibility_api_private_key=model_PemData,
         eligibility_api_public_key=model_PemData,
-        eligibility_index_template_override="eligibility/index.html",
         logo_large="agencies/cst-lg.png",
         logo_small="agencies/cst-sm.png",
     )

benefits/eligibility/templates/eligibility/index--sacrt.html

@@ -52,7 +52,7 @@ def test_get_exclude(self, admin_user_request, agency_admin_model, user_type, ex
         [
             (
                 "staff",
-                ["eligibility_index_template_override", "eligibility_api_id", "transit_processor"],
+                ["eligibility_api_id", "transit_processor"],
             ),
             ("super", ()),
         ],

benefits/eligibility/templates/eligibility/index--sbmtd.html

@@ -32,16 +32,6 @@ def test_TransitAgency_str(model_TransitAgency):
     assert str(model_TransitAgency) == model_TransitAgency.long_name
 
 
-@pytest.mark.django_db
-def test_TransitAgency_template_overrides(model_TransitAgency):
-    assert model_TransitAgency.eligibility_index_template == model_TransitAgency.eligibility_index_template_override
-
-    model_TransitAgency.eligibility_index_template_override = ""
-    model_TransitAgency.save()
-
-    assert model_TransitAgency.eligibility_index_template == f"eligibility/index--{model_TransitAgency.slug}.html"
-
-
 @pytest.mark.django_db
 def test_TransitAgency_index_url(model_TransitAgency):
     result = model_TransitAgency.index_url
@@ -176,16 +166,3 @@ def test_TransitAgency_clean(model_TransitAgency_inactive, model_TransitProcesso
     assert "transit_processor_audience" in errors
     assert "transit_processor_client_id" in errors
     assert "transit_processor_client_secret_name" in errors
-
-
-@pytest.mark.django_db
-@pytest.mark.parametrize("template_attribute", ["eligibility_index_template_override"])
-def test_TransitAgency_clean_templates(model_TransitAgency_inactive, template_attribute):
-    setattr(model_TransitAgency_inactive, template_attribute, "does/not/exist.html")
-    # agency is inactive, OK to have missing template
-    model_TransitAgency_inactive.clean()
-
-    # now mark it active and expect failure on clean()
-    model_TransitAgency_inactive.active = True
-    with pytest.raises(ValidationError, match="Template not found: does/not/exist.html"):
-        model_TransitAgency_inactive.clean()