-
-
Notifications
You must be signed in to change notification settings - Fork 72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement soft validation for member codes in training requests #2549
Merged
elichad
merged 4 commits into
feature/member-codes
from
feature/2535-Member-codes-Implement-soft-validation-for-member-codes
Oct 20, 2023
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,6 +37,7 @@ class Meta: | |
fields = ( | ||
"review_process", | ||
"member_code", | ||
"member_code_override", | ||
"personal", | ||
"family", | ||
"email", | ||
|
@@ -109,6 +110,7 @@ def __init__(self, *args, **kwargs): | |
self.set_other_fields(self.helper.layout) | ||
self.set_fake_required_fields() | ||
self.set_accordion(self.helper.layout) | ||
self.set_display_member_code_override(False) | ||
self.set_hr(self.helper.layout) | ||
|
||
def set_other_field(self, field_name: str, layout: Layout) -> None: | ||
|
@@ -143,6 +145,7 @@ def set_accordion(self, layout: Layout) -> None: | |
self["review_process"].field.widget.subfields = { # type: ignore | ||
"preapproved": [ | ||
self["member_code"], | ||
self["member_code_override"], | ||
], | ||
"open": [], # this option doesn't require any additional fields | ||
} | ||
|
@@ -155,6 +158,7 @@ def set_accordion(self, layout: Layout) -> None: | |
|
||
layout.fields.remove("review_process") | ||
layout.fields.remove("member_code") | ||
layout.fields.remove("member_code_override") | ||
|
||
# insert div+field at previously saved position | ||
layout.insert( | ||
|
@@ -167,6 +171,10 @@ def set_accordion(self, layout: Layout) -> None: | |
), | ||
) | ||
|
||
def set_display_member_code_override(self, visible: bool) -> None: | ||
widget = forms.CheckboxInput() if visible else forms.HiddenInput() | ||
self.fields["member_code_override"].widget = widget | ||
|
||
def set_hr(self, layout: Layout) -> None: | ||
# add <HR> around "underrepresented*" fields | ||
index = layout.fields.index("underrepresented") | ||
|
@@ -202,30 +210,51 @@ def validate_member_code( | |
) -> None | dict[str, ValidationError]: | ||
errors = dict() | ||
member_code = self.cleaned_data.get("member_code", "") | ||
member_code_override = self.cleaned_data.get("member_code_override", False) | ||
error_msg = ( | ||
"This code is invalid. " | ||
"This may be due to a typo, an expired code, " | ||
"or a code that has not yet been activated. " | ||
"Please confirm that you have copied the code correctly, " | ||
"or confirm the code with the Membership Contact for your group." | ||
"or confirm the code with the Membership Contact for your group. " | ||
"If the code seems to be correct, tick the checkbox below to ignore " | ||
"this message." | ||
) | ||
|
||
if not member_code: | ||
return None | ||
|
||
member_code_valid = self.member_code_valid(member_code) | ||
if member_code_valid and member_code_override: | ||
# case where a user corrects their code but ticks the box anyway | ||
# checkbox doesn't need to be ticked, so correct it quietly and continue | ||
self.cleaned_data["member_code_override"] = False | ||
self.set_display_member_code_override(False) | ||
elif not member_code_valid: | ||
self.set_display_member_code_override(True) | ||
if not member_code_override: | ||
# user must either correct the code or tick the override | ||
errors["member_code"] = ValidationError(error_msg) | ||
|
||
return errors | ||
|
||
def member_code_valid(self, code: str) -> bool: | ||
"""Returns True if the code matches an active Membership, | ||
including a grace period of 90 days before and after the Membership dates. | ||
""" | ||
try: | ||
# find relevant membership - may raise Membership.DoesNotExist | ||
membership = Membership.objects.get(registration_code=member_code) | ||
membership = Membership.objects.get(registration_code=code) | ||
# confirm that membership is currently active | ||
# grace period: 90 days before and after | ||
if not membership.active_on_date( | ||
date.today(), grace_before=90, grace_after=90 | ||
): | ||
errors["member_code"] = ValidationError(error_msg) | ||
return False | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd put just the line |
||
except Membership.DoesNotExist: | ||
errors["member_code"] = ValidationError(error_msg) | ||
return False | ||
|
||
return errors | ||
return True | ||
|
||
def clean(self): | ||
super().clean() | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
amy/workshops/migrations/0267_trainingrequest_accept_invalid_member_code.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Generated by Django 3.2.20 on 2023-10-19 07:37 | ||
|
||
from django.db import migrations, models | ||
|
||
|
||
class Migration(migrations.Migration): | ||
dependencies = [ | ||
("workshops", "0266_rename_group_name_trainingrequest_member_code"), | ||
] | ||
|
||
operations = [ | ||
migrations.AddField( | ||
model_name="trainingrequest", | ||
name="member_code_override", | ||
field=models.BooleanField( | ||
blank=True, | ||
default=False, | ||
help_text="A member of our team will check the code and follow up with you if there are any problems that require your attention.", | ||
verbose_name="Continue with registration code marked as invalid", | ||
), | ||
), | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For functions that accept int or boolean arguments I prefer to make them required as keyword by using
*
in the function definition:https://realpython.com/python-asterisk-and-slash-special-parameters/#in-short-the-python-asterisk-and-slash-control-how-to-pass-values-to-functions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh interesting, I've never come across this syntax before. I see the appeal