8848524104

Committed 26 Apr 2024 12:49PM UTC coverage: 87.316% (-0.5%) from 87.828%

Build # 8848524104

Build Type

Pull #1202

github

Committed by

web-flow

Commit Message

Merge fd6b5273f into d0ae64b20

Pull Request Pull Request #1202: Refactor Signup Method: Signup Flow and Shift Structure

Run Details

2897 of 3293 branches covered (87.97%)

Branch coverage included in aggregate %.

1144 of 1393 new or added lines in 52 files covered. (82.12%)

1 existing line in 1 file now uncovered.

11346 of 13019 relevant lines covered (87.15%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.12

/ephios/core/signup/flow/base.py

import functools
import logging
from argparse import Namespace
from collections import OrderedDict

from django import forms
from django.utils.translation import gettext_lazy as _

from ephios.core.models import AbstractParticipation
from ephios.core.services.notifications.types import (
    ResponsibleConfirmedParticipationDeclinedNotification,
    ResponsibleParticipationStateChangeNotification,
)
from ephios.core.signup.flow.abstract import AbstractSignupFlow
from ephios.core.signup.flow.participant_validation import BaseSignupActionValidator
from ephios.core.signup.forms import SignupConfigurationForm
from ephios.core.signup.participants import AbstractParticipant
from ephios.extra.utils import format_anything
from ephios.extra.widgets import CustomSplitDateTimeWidget

logger = logging.getLogger(__name__)


class BaseSignupFlowConfigurationForm(SignupConfigurationForm):
    """
    Base class for signup flow configuration forms. Has no fields.
    """


class BasicSignupFlowConfigurationForm(BaseSignupFlowConfigurationForm):
    """
    Configuration form with basic fields relevant for most signup flows.
    """

    signup_until = forms.SplitDateTimeField(
        required=False,
        widget=CustomSplitDateTimeWidget,
        initial=None,
        label=_("Signup until"),
    )
    user_can_decline_confirmed = forms.BooleanField(
        label=_("Confirmed users can decline by themselves"),
        required=False,
        help_text=_("only if the signup timeframe has not ended"),
    )
    user_can_customize_signup_times = forms.BooleanField(
        label=_("Users can provide individual start and end times"),
        required=False,
        initial=True,
    )


class BaseSignupFlow(AbstractSignupFlow):
    """
    Signup flow with some base implementations for common methods.
    """

    @property
    def configuration_form_class(self):
        return BasicSignupFlowConfigurationForm

    @property
    def signup_action_validator_class(self):
        return BaseSignupActionValidator

    @functools.lru_cache(1)
    def get_validator(self, participant):
        return self.signup_action_validator_class(self.shift, participant)

    def perform_signup(
        self, participant: AbstractParticipant, participation=None, acting_user=None, **kwargs
    ) -> AbstractParticipation:
        """
        Creates and/or configures a participation object for a given participant and sends out notifications.
        Passes the participation and kwargs to configure_participation to do configuration specific to the signup method.
        """
        from ephios.core.services.notifications.types import (
            ResponsibleParticipationAwaitsDispositionNotification,
        )

        participation = participation or self.get_or_create_participation_for(participant)
        participation = self._configure_participation(participation, **kwargs)
        participation.save()
        if participation.state == AbstractParticipation.States.REQUESTED:
            ResponsibleParticipationAwaitsDispositionNotification.send(
                participation, acting_user=acting_user
            )
        else:
            ResponsibleParticipationStateChangeNotification.send(
                participation, acting_user=acting_user
            )
        return participation

    def perform_decline(self, participant, participation=None, **kwargs):
        """Create and configure a declining participation object for the given participant. `kwargs` may contain further instructions from a e.g. a form."""
        participation = participation or self.get_or_create_participation_for(participant)
        participation.state = AbstractParticipation.States.USER_DECLINED
        participation.save()
        ResponsibleConfirmedParticipationDeclinedNotification.send(participation)
        return participation

    def _configure_participation(
        self, participation: AbstractParticipation, **kwargs
    ) -> AbstractParticipation:
        """
        Configure the given participation object for signup according to the method's configuration.
        You need at least to set the participations state, as that is not done with the participation form.
        `kwargs` contains the signup form's cleaned_data. The participation object will be saved after this method.
        Return the participation.
        """
        raise NotImplementedError

    def get_signup_info(self):
        """
        Return key/value pairs about the configuration to show in exports etc.
        """
        form_class = self.configuration_form_class
        return OrderedDict(
            {
                label: getattr(form_class, f"format_{name}", format_anything)(value)
                for name, field in form_class.base_fields.items()
                if (label := field.label) and (value := getattr(self.configuration, name))
            }
        )

    def get_configuration_form(self, *args, **kwargs):
        if self.shift is not None:
            kwargs.setdefault("initial", self.configuration.__dict__)
        kwargs.setdefault("event", self.event)
        kwargs.setdefault("shift", self.shift)
        kwargs.setdefault("description", self.description)
        form = self.configuration_form_class(*args, **kwargs)
        return form

    def __init__(self, shift, event=None):
        super().__init__(shift, event)
        self.configuration = Namespace(
            **{
                name: field.initial
                for name, field in self.configuration_form_class.base_fields.items()
            }
        )
        if shift is not None:
            for key, value in shift.signup_flow_configuration.items():
                setattr(self.configuration, key, value)

1	import functools	1✔
2	import logging	1✔
3	from argparse import Namespace	1✔
4	from collections import OrderedDict	1✔
5
6	from django import forms	1✔
7	from django.utils.translation import gettext_lazy as _	1✔
8
9	from ephios.core.models import AbstractParticipation	1✔
10	from ephios.core.services.notifications.types import (	1✔
11	ResponsibleConfirmedParticipationDeclinedNotification,
12	ResponsibleParticipationStateChangeNotification,
13	)
14	from ephios.core.signup.flow.abstract import AbstractSignupFlow	1✔
15	from ephios.core.signup.flow.participant_validation import BaseSignupActionValidator	1✔
16	from ephios.core.signup.forms import SignupConfigurationForm	1✔
17	from ephios.core.signup.participants import AbstractParticipant	1✔
18	from ephios.extra.utils import format_anything	1✔
19	from ephios.extra.widgets import CustomSplitDateTimeWidget	1✔
20
21	logger = logging.getLogger(__name__)	1✔
22
23
24	class BaseSignupFlowConfigurationForm(SignupConfigurationForm):	1✔
25	"""
26	Base class for signup flow configuration forms. Has no fields.
27	"""
28
29
30	class BasicSignupFlowConfigurationForm(BaseSignupFlowConfigurationForm):	1✔
31	"""
32	Configuration form with basic fields relevant for most signup flows.
33	"""
34
35	signup_until = forms.SplitDateTimeField(	1✔
36	required=False,
37	widget=CustomSplitDateTimeWidget,
38	initial=None,
39	label=_("Signup until"),
40	)
41	user_can_decline_confirmed = forms.BooleanField(	1✔
42	label=_("Confirmed users can decline by themselves"),
43	required=False,
44	help_text=_("only if the signup timeframe has not ended"),
45	)
46	user_can_customize_signup_times = forms.BooleanField(	1✔
47	label=_("Users can provide individual start and end times"),
48	required=False,
49	initial=True,
50	)
51
52
53	class BaseSignupFlow(AbstractSignupFlow):	1✔
54	"""
55	Signup flow with some base implementations for common methods.
56	"""
57
58	@property	1✔
59	def configuration_form_class(self):	1✔
60	return BasicSignupFlowConfigurationForm	1✔
61
62	@property	1✔
63	def signup_action_validator_class(self):	1✔
NEW 64	return BaseSignupActionValidator	×
65
66	@functools.lru_cache(1)	1✔
67	def get_validator(self, participant):	1✔
68	return self.signup_action_validator_class(self.shift, participant)	1✔
69
70	def perform_signup(	1✔
71	self, participant: AbstractParticipant, participation=None, acting_user=None, **kwargs
72	) -> AbstractParticipation:
73	"""
74	Creates and/or configures a participation object for a given participant and sends out notifications.
75	Passes the participation and kwargs to configure_participation to do configuration specific to the signup method.
76	"""
77	from ephios.core.services.notifications.types import (	1✔
78	ResponsibleParticipationAwaitsDispositionNotification,
79	)
80
81	participation = participation or self.get_or_create_participation_for(participant)	1✔
82	participation = self._configure_participation(participation, **kwargs)	1✔
83	participation.save()	1✔
84	if participation.state == AbstractParticipation.States.REQUESTED:	1!
85	ResponsibleParticipationAwaitsDispositionNotification.send(	1✔
86	participation, acting_user=acting_user
87	)
88	else:
NEW 89	ResponsibleParticipationStateChangeNotification.send(	×
90	participation, acting_user=acting_user
91	)
92	return participation	1✔
93
94	def perform_decline(self, participant, participation=None, **kwargs):	1✔
95	"""Create and configure a declining participation object for the given participant. `kwargs` may contain further instructions from a e.g. a form."""
96	participation = participation or self.get_or_create_participation_for(participant)	1✔
97	participation.state = AbstractParticipation.States.USER_DECLINED	1✔
98	participation.save()	1✔
99	ResponsibleConfirmedParticipationDeclinedNotification.send(participation)	1✔
100	return participation	1✔
101
102	def _configure_participation(	1✔
103	self, participation: AbstractParticipation, **kwargs
104	) -> AbstractParticipation:
105	"""
106	Configure the given participation object for signup according to the method's configuration.
107	You need at least to set the participations state, as that is not done with the participation form.
108	`kwargs` contains the signup form's cleaned_data. The participation object will be saved after this method.
109	Return the participation.
110	"""
NEW 111	raise NotImplementedError	×
112
113	def get_signup_info(self):	1✔
114	"""
115	Return key/value pairs about the configuration to show in exports etc.
116	"""
117	form_class = self.configuration_form_class	1✔
118	return OrderedDict(	1✔
119	{
120	label: getattr(form_class, f"format_{name}", format_anything)(value)
121	for name, field in form_class.base_fields.items()
122	if (label := field.label) and (value := getattr(self.configuration, name))
123	}
124	)
125
126	def get_configuration_form(self, args, *kwargs):	1✔
127	if self.shift is not None:	1✔
128	kwargs.setdefault("initial", self.configuration.__dict__)	1✔
129	kwargs.setdefault("event", self.event)	1✔
130	kwargs.setdefault("shift", self.shift)	1✔
131	kwargs.setdefault("description", self.description)	1✔
132	form = self.configuration_form_class(args, *kwargs)	1✔
133	return form	1✔
134
135	def __init__(self, shift, event=None):	1✔
136	super().__init__(shift, event)	1✔
137	self.configuration = Namespace(	1✔
138	**{
139	name: field.initial
140	for name, field in self.configuration_form_class.base_fields.items()
141	}
142	)
143	if shift is not None:	1✔
144	for key, value in shift.signup_flow_configuration.items():	1✔
145	setattr(self.configuration, key, value)	1✔

ephios-dev / ephios / 8848524104

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous