Admin: Eligibility View #2317

machikoyasuda · 2024-08-22T21:35:48Z

closes #2269

http://localhost:11369/in_person/eligibility/

Light mode

Dark mode

How to test

Follow Feat: automatically associate user to agency #2325 (comment) to get into the dashboard
Click New Enrollment button
Test clicking submit without choosing anything
Test clicking submit with only checkbox
Test clicking submit with only radio button
Use enter or spacebar and tab for form completion and submission
Use tab to skip to main content correctly
Accessibility: Passes WCAG AA (except for 1 known ARIA form issue coming from form.html - which isn't going to be changed in this PR)
Check that the Console warning area is empty

What this PR does

Known issues/questions

The log out user tools area does not get rendered.

Form

Has jQuery library loaded
Does not have recaptcha
Uses Django base form inputs (RadioSelect and BooleanField) on top of form.html from core
Uses HTML5 validation and Django default back-end validation
Has some hacky CSS written for styles, instead of adding utility classes through Django or adding logic to the Django template.
This PR aims to not make any changes to forms.html and just go with defaults. The required * is black because the forms.html utility classes make it so, and overriding a style that already has an !important style declaration is kinda messy. So we're keeping it black for now.

Copy

Is not internationalized.

Tests

Write tests for form submission

CSS

Adds an Outline Button style, use with "btn btn-lg btn-outline-primary" (On view and hover)

github-actions · 2024-08-22T21:36:17Z

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
benefits
routes.py
benefits/in_person
forms.py
views.py
Project Total

_{This report was generated by python-coverage-comment-action}

machikoyasuda · 2024-08-29T20:49:05Z

benefits/static/css/admin/styles.css

+.checkbox-parent .form-group:last-of-type .col-12 {
+  display: flex;
+  flex-direction: row-reverse;
+  justify-content: start;
+  column-gap: 0.5rem;
+  margin-top: 2rem;
+}
+
+.checkbox-parent,
+.checkbox-parent .form-group .col-12,
+.checkbox-parent .form-group .col-12 #id_flow {
+  display: flex;
+  flex-direction: column;
+  row-gap: 1rem;
+}


As utility classes: d-flex flex-row-reverse justify-content-start gap-0 row-gap-1 mt-4

d-flex flex-column gap-0 row-gap-3 - adds equal spacing between the radio buttons and checkboxes.

But just decided to do it like this for now. Named checkbox-parent because the main thing this does is flip the checkbox rendering to show the checkbox input first, then label, which is the opposite of the rest of the pages.

machikoyasuda · 2024-08-29T21:02:33Z

benefits/eligibility/forms.py

+
+        self.classes = "checkbox-parent"
+        flow_field = self.fields["flow"]
+        flow_field.choices = [(f.id, f.label) for f in flows]


This sets the form field's label as the label, which are currently named like this:

(CST) Senior Discount CalFresh (CST) Veteran Discount (CST) Agency Card Discount

It's slightly different from what we want (Older adult, CalFresh card holder, Courtesy Card holder, etc.) - which are specified in these files for the Benefits app: https://github.com/cal-itp/benefits/blob/1e2ff89cfcdbcddc6895701399aaf1702b3b2fc1/benefits/eligibility/templates/eligibility/includes/selection-label--senior.html

But didn't want to bog down this PR with implementing all of that.

Created separate issue #2336 to cover this

machikoyasuda · 2024-08-29T21:48:26Z

benefits/eligibility/forms.py

+    method = "POST"
+
+    flow = forms.ChoiceField(label="Choose an eligibility type to qualify this rider.", widget=forms.widgets.RadioSelect)
+    verified = forms.BooleanField(label="I have verified this person’s eligibility for a transit benefit.", required=True)


Adding required=True will add a validation check

Documentation: https://docs.djangoproject.com/en/5.1/ref/forms/fields/#booleanfield

Code: https://github.com/django/django/blob/stable/5.1.x/django/forms/fields.py#L838

machikoyasuda · 2024-08-29T23:40:55Z

Status update: Everything in this PR is finished, commented/documented and tested except I have not yet written specs for the form. The one other "unknown" I haven't yet gotten around to figuring out is why the admin user's name and the sign out link doesn't appear, as noted above.

angela-tran · 2024-08-30T00:43:41Z

@machikoyasuda You can do something similar to e9614fe to get the usertools to show up.

The Django base template expects to have has_permission in the context to decide if it will show the usertools, and we can see that Django admin's view functions follow this pattern of adding each_context to their own contexts - e.g.index, login.

angela-tran · 2024-08-30T00:51:37Z

I think another unknown is why the custom validity messages are not working

benefits/eligibility/forms.py

angela-tran · 2024-09-05T17:00:10Z

I think another unknown is why the custom validity messages are not working

Created separate issue #2337 to cover this

angela-tran

This looks great @machikoyasuda! I think we can remove an unused fixture, so after that, this is ready to merge

tests/pytest/in_person/test_views.py

angela-tran

🎉

github-actions bot added deployment-dev [auto] Changes that will trigger a deploy if merged to dev front-end HTML/CSS/JavaScript and Django templates labels Aug 22, 2024

machikoyasuda self-assigned this Aug 22, 2024

machikoyasuda force-pushed the feat/2269-admin-elig-form branch from 1fb5427 to 05249a2 Compare August 28, 2024 20:22

machikoyasuda mentioned this pull request Aug 29, 2024

Add jQuery to Agency Base #2328

Closed

machikoyasuda commented Aug 29, 2024

View reviewed changes

machikoyasuda force-pushed the feat/2269-admin-elig-form branch from 7412a21 to 20fc8fc Compare August 29, 2024 22:28

machikoyasuda mentioned this pull request Aug 29, 2024

Secondary button component #1786

Closed

angela-tran reviewed Sep 4, 2024

View reviewed changes

benefits/eligibility/forms.py Outdated Show resolved Hide resolved

machikoyasuda force-pushed the feat/2269-admin-elig-form branch from 0386826 to 369ca99 Compare September 5, 2024 15:40

This was referenced Sep 5, 2024

Refactor EnrollmentFlow model so in-person eligibility view can use copy from the selection label template #2336

Closed

Custom validation messages not working in in-person eligibility form #2337

Closed

machikoyasuda force-pushed the feat/2269-admin-elig-form branch from 15ad6d2 to 428d63d Compare September 10, 2024 03:43

machikoyasuda marked this pull request as ready for review September 10, 2024 03:44

machikoyasuda requested a review from a team as a code owner September 10, 2024 03:44

machikoyasuda force-pushed the feat/2269-admin-elig-form branch from 428d63d to 40048cb Compare September 10, 2024 03:46

angela-tran reviewed Sep 10, 2024

View reviewed changes

tests/pytest/in_person/test_views.py Outdated Show resolved Hide resolved

machikoyasuda added 4 commits September 10, 2024 11:13

feat(admin): add in-person eligibility route, form, template

6547686

feat(admin): styling for form - primary outline button, checkbox

7ec487d

test(admin): add tests for verified and unverified eligibility form

9332c4e

fix(tests): remove unnecessary fixture

19cc65b

machikoyasuda force-pushed the feat/2269-admin-elig-form branch from b6043eb to 19cc65b Compare September 10, 2024 18:13

angela-tran approved these changes Sep 10, 2024

View reviewed changes

machikoyasuda merged commit 977dfd4 into main Sep 10, 2024
15 checks passed

machikoyasuda deleted the feat/2269-admin-elig-form branch September 10, 2024 18:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Admin: Eligibility View #2317

Admin: Eligibility View #2317

machikoyasuda commented Aug 22, 2024 •

edited

Loading

github-actions bot commented Aug 22, 2024 •

edited

Loading

machikoyasuda Aug 29, 2024 •

edited

Loading

machikoyasuda Aug 29, 2024

angela-tran Sep 5, 2024

machikoyasuda Aug 29, 2024

machikoyasuda commented Aug 29, 2024

angela-tran commented Aug 30, 2024 •

edited

Loading

angela-tran commented Aug 30, 2024

angela-tran commented Sep 5, 2024

angela-tran left a comment

angela-tran left a comment

Admin: Eligibility View #2317

Admin: Eligibility View #2317

Conversation

machikoyasuda commented Aug 22, 2024 • edited Loading

How to test

What this PR does

Known issues/questions

Form

Copy

Tests

CSS

github-actions bot commented Aug 22, 2024 • edited Loading

Coverage report

machikoyasuda Aug 29, 2024 • edited Loading

Choose a reason for hiding this comment

machikoyasuda Aug 29, 2024

Choose a reason for hiding this comment

angela-tran Sep 5, 2024

Choose a reason for hiding this comment

machikoyasuda Aug 29, 2024

Choose a reason for hiding this comment

machikoyasuda commented Aug 29, 2024

angela-tran commented Aug 30, 2024 • edited Loading

angela-tran commented Aug 30, 2024

angela-tran commented Sep 5, 2024

angela-tran left a comment

Choose a reason for hiding this comment

angela-tran left a comment

Choose a reason for hiding this comment

machikoyasuda commented Aug 22, 2024 •

edited

Loading

github-actions bot commented Aug 22, 2024 •

edited

Loading

machikoyasuda Aug 29, 2024 •

edited

Loading

angela-tran commented Aug 30, 2024 •

edited

Loading