chore: rename mandatory to optional

Author: crosspolar

tapir/accounts/forms.py

@@ -16,11 +16,11 @@
 class TapirUserSelfUpdateForm(forms.ModelForm):
     mandatory_mails = forms.MultipleChoiceField(
         required=False,
-        choices=get_mail_types(enabled_by_default="both", mandatory=True),
+        choices=get_mail_types(enabled_by_default="both", optional=False),
         label=_("Mandatory Emails"),
         widget=CheckboxSelectMultiple(),
         initial=[
-            m[0] for m in get_mail_types(enabled_by_default="both", mandatory=True)
+            m[0] for m in get_mail_types(enabled_by_default="both", optional=False)
         ],
     )
 
@@ -33,7 +33,7 @@ class Meta:
         fields = ["usage_name", "pronouns", "optional_mails"]
         widgets = {
             "optional_mails": forms.widgets.CheckboxSelectMultiple(
-                choices=get_mail_types(enabled_by_default="both", mandatory=False)
+                choices=get_mail_types(enabled_by_default="both", optional=True)
             )
         }
 

tapir/accounts/models.py

@@ -62,7 +62,7 @@ class TapirUserManager(UserManager.from_queryset(TapirUserQuerySet)):
 
 
 def get_optional_mails_enabledbydefault():
-    return [m[0] for m in get_mail_types(mandatory=False, enabled_by_default=True)]
+    return [m[0] for m in get_mail_types(optional=True, enabled_by_default=True)]
 
 
 class TapirUser(AbstractUser):

tapir/core/tapir_email_base.py

@@ -22,7 +22,7 @@
 
 def get_mail_types(
     enabled_by_default: MAIL_OPTIONS_ = True,
-    mandatory: MAIL_OPTIONS_ = True,
+    optional: MAIL_OPTIONS_ = True,
 ) -> List[Tuple[str, str]]:
     """
     default="both" returns both, default and non-default mails.
@@ -33,7 +33,7 @@ def filter_mail(mail):
         return (
             enabled_by_default == "both"
             or mail.enabled_by_default is enabled_by_default
-        ) and (mandatory == "both" or mail.mandatory is mandatory)
+        ) and (optional == "both" or mail.optional is optional)
 
     return [
         (mail.get_unique_id(), mail.get_name())
@@ -43,12 +43,12 @@ def filter_mail(mail):
 
 
 def get_optional_mails() -> List[Tuple[str, str]]:
-    return get_mail_types(mandatory=False, enabled_by_default="both")
+    return get_mail_types(optional=True, enabled_by_default="both")
 
 
 class TapirEmailBase:
     enabled_by_default = True  # mails are opt-out by default
-    mandatory = True  # mails are mandatory by default
+    optional = False  # mails are mandatory by default
 
     class Meta:
         abstract = True
@@ -134,7 +134,7 @@ def send_to_share_owner(self, actor: User | None, recipient: ShareOwner):
 
     def user_wants_to_or_has_to_receive_mail(self, user: TapirUser):
         return (self.get_unique_id() in user.optional_mails) | (
-            self.get_unique_id() in [x[0] for x in get_mail_types(mandatory=True)]
+            self.get_unique_id() in [x[0] for x in get_mail_types(optional=False)]
         )
 
     def send_to_tapir_user(self, actor: User | None, recipient: TapirUser):

tapir/core/tests/test_email_preferences.py

@@ -6,7 +6,7 @@
 
 
 class VoluntaryMail(TapirEmailBase):
-    mandatory = False
+    optional = True
 
     @classmethod
     def get_unique_id(cls) -> str:
@@ -41,8 +41,8 @@ def test_userWantsToOrHasToReceiveMail_mailSubscribedTo_shouldReceiveMail(self):
 
     def test_userWantsToOrHasToReceiveMail_mailIsMandatory_shouldReceiveMail(self):
         tapir_user: TapirUser = TapirUserFactory.create()
-        self.assertTrue(
-            TapirAccountCreatedEmail.mandatory
+        self.assertFalse(
+            TapirAccountCreatedEmail.optional
         )  # change to another mail-type if necessary
 
         self.assertTrue(

tapir/shifts/emails/shift_reminder_email.py

@@ -9,7 +9,7 @@
 
 
 class ShiftReminderEmail(TapirEmailBase):
-    mandatory = False
+    optional = True
     enabled_by_default = True
 
     def __init__(self, shift):