9634676702

Committed 23 Jun 2024 03:51PM UTC coverage: 87.365% (-0.5%) from 87.828%

Build # 9634676702

Build Type

Pull #1202

github

Committed by

web-flow

Commit Message

Merge 86503015f into 355949326

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

Run Details

2909 of 3299 branches covered (88.18%)

Branch coverage included in aggregate %.

1185 of 1438 new or added lines in 53 files covered. (82.41%)

1 existing line in 1 file now uncovered.

11362 of 13036 relevant lines covered (87.16%)

0.87 hits per line

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

77.44

/ephios/core/views/shift.py

from django.contrib import messages
from django.core.exceptions import ValidationError
from django.shortcuts import get_object_or_404, redirect, render
from django.urls import reverse
from django.utils.datastructures import MultiValueDictKeyError
from django.utils.timezone import get_default_timezone
from django.utils.translation import gettext as _
from django.views import View
from django.views.generic import DeleteView, TemplateView
from django.views.generic.detail import SingleObjectMixin

from ephios.core.forms.events import ShiftForm
from ephios.core.models import Event, Shift
from ephios.core.signals import shift_forms
from ephios.core.signup.flow import enabled_signup_flows, signup_flow_from_slug
from ephios.core.signup.structure import enabled_shift_structures, shift_structure_from_slug
from ephios.extra.mixins import CustomPermissionRequiredMixin, PluginFormMixin


class ShiftCreateView(CustomPermissionRequiredMixin, PluginFormMixin, TemplateView):
    permission_required = "core.change_event"
    template_name = "core/shift_form.html"

    def setup(self, request, *args, **kwargs):
        super().setup(request, *args, **kwargs)
        self.event = get_object_or_404(Event.all_objects, pk=self.kwargs.get("pk"))

    def get_permission_object(self):
        return self.event

    def get_shift_form(self):
        return ShiftForm(self.request.POST or None)

    def get_context_data(self, **kwargs):
        kwargs.setdefault("event", self.event)
        kwargs.setdefault("form", self.get_shift_form())
        kwargs.setdefault("flow_configuration_form", "")
        kwargs.setdefault("structure_configuration_form", "")
        return super().get_context_data(**kwargs)

    def get_plugin_forms(self):
        return shift_forms.send(
            sender=None, shift=getattr(self, "object", None), request=self.request
        )

    def post(self, *args, **kwargs):
        form = self.get_shift_form()
        self.object = form.instance

        try:
            signup_flow = signup_flow_from_slug(
                self.request.POST.get("signup_flow_slug"), event=self.event
            )
            structure = shift_structure_from_slug(
                self.request.POST.get("structure_slug"),
                event=self.event,
            )
        except KeyError:
            if not list(enabled_signup_flows()):
                form.add_error(
                    "signup_flow_slug",
                    _("You must enable plugins providing signup flows to continue."),
                )
            if not list(enabled_shift_structures()):
                form.add_error(
                    "structure_slug",
                    _("You must enable plugins providing shift structures to continue."),
                )
            return self.render_to_response(
                self.get_context_data(
                    form=form,
                )
            )
        except ValueError as e:
            form.add_error(None, ValidationError(e))
            return self.render_to_response(
                self.get_context_data(
                    form=form,
                )
            )

        flow_configuration_form = signup_flow.get_configuration_form(
            self.request.POST, event=self.event
        )
        structure_configuration_form = structure.get_configuration_form(
            self.request.POST, event=self.event
        )
        if not all(
            [
                self.is_valid(form),
                flow_configuration_form.is_valid(),
                structure_configuration_form.is_valid(),
            ]
        ):
            return self.render_to_response(
                self.get_context_data(
                    form=form,
                    flow_configuration_form=flow_configuration_form,
                    structure_configuration_form=structure_configuration_form,
                )
            )

        shift = form.save(commit=False)
        shift.event = self.event
        shift.signup_flow_configuration = flow_configuration_form.cleaned_data
        shift.structure_configuration = structure_configuration_form.cleaned_data
        shift.save()
        self.save_plugin_forms()
        if "addAnother" in self.request.POST:
            return redirect(reverse("core:event_createshift", kwargs={"pk": self.kwargs.get("pk")}))
        try:
            self.event.activate()
            messages.success(
                self.request,
                _("The event {title} has been saved.").format(title=self.event.title),
            )
        except ValidationError as e:
            messages.error(self.request, e)
        return redirect(self.event.get_absolute_url())


class AbstractShiftConfigurationFormView(CustomPermissionRequiredMixin, SingleObjectMixin, View):
    queryset = Event.all_objects
    permission_required = "core.change_event"
    pk_url_kwarg = "event_id"

    def get(self, request, *args, **kwargs):
        try:
            shift = self.get_object().shifts.get(pk=request.GET.get("shift_id") or None)
        except Shift.DoesNotExist:
            shift = None
        form = self.get_form(self.get_object(), shift)
        return render(
            request,
            "core/fragments/shift_signup_config_form.html",
            {
                "form": form,
            },
        )

    def get_form(self, event, shift=None):
        raise NotImplementedError


class SignupFlowConfigurationFormView(AbstractShiftConfigurationFormView):
    def get_form(self, event, shift=None):
        return signup_flow_from_slug(
            self.kwargs.get("slug"), event=event, shift=shift
        ).get_configuration_form()


class ShiftStructureConfigurationFormView(AbstractShiftConfigurationFormView):
    def get_form(self, event, shift=None):
        return shift_structure_from_slug(
            self.kwargs.get("slug"), event=event, shift=shift
        ).get_configuration_form()


class ShiftUpdateView(
    CustomPermissionRequiredMixin, PluginFormMixin, SingleObjectMixin, TemplateView
):
    model = Shift
    template_name = "core/shift_form.html"
    permission_required = "core.change_event"

    def get_permission_object(self):
        return self.get_object().event

    def get_shift_form(self):
        return ShiftForm(
            self.request.POST or None,
            instance=self.object,
            initial={
                "date": self.object.meeting_time.date(),
                "meeting_time": self.object.meeting_time.astimezone(get_default_timezone()).time(),
                "start_time": self.object.start_time.astimezone(get_default_timezone()).time(),
                "end_time": self.object.end_time.astimezone(get_default_timezone()).time(),
            },
        )

    def get_flow_configuration_form(self):
        return self.object.signup_flow.get_configuration_form(data=self.request.POST or None)

    def get_structure_configuration_form(self):
        return self.object.structure.get_configuration_form(data=self.request.POST or None)

    def get_context_data(self, **kwargs):
        self.object = self.get_object()
        kwargs.setdefault("event", self.object.event)
        kwargs.setdefault("form", self.get_shift_form())
        kwargs.setdefault("flow_configuration_form", self.get_flow_configuration_form())
        kwargs.setdefault("structure_configuration_form", self.get_structure_configuration_form())
        return super().get_context_data(**kwargs)

    def get_plugin_forms(self):
        return shift_forms.send(sender=None, shift=self.object, request=self.request)

    def post(self, *args, **kwargs):
        self.object = self.get_object()
        form = self.get_shift_form()
        flow_configuration_form = self.get_flow_configuration_form()
        structure_configuration_form = self.get_structure_configuration_form()
        try:
            signup_flow = signup_flow_from_slug(
                self.request.POST["signup_flow_slug"], shift=self.object
            )
            flow_configuration_form = signup_flow.get_configuration_form(
                self.request.POST, event=self.object.event
            )
            structure = shift_structure_from_slug(
                self.request.POST["structure_slug"], shift=self.object
            )
            structure_configuration_form = structure.get_configuration_form(
                self.request.POST, event=self.object.event
            )
        except (ValueError, MultiValueDictKeyError):
            pass
        else:
            if all(
                [
                    self.is_valid(form),
                    flow_configuration_form.is_valid(),
                    structure_configuration_form.is_valid(),
                ]
            ):
                shift = form.save(commit=False)
                shift.signup_flow_configuration = flow_configuration_form.cleaned_data
                shift.structure_configuration = structure_configuration_form.cleaned_data
                shift.save()
                self.save_plugin_forms()
                if "addAnother" in self.request.POST:
                    return redirect(
                        reverse("core:event_createshift", kwargs={"pk": shift.event.pk})
                    )
                messages.success(
                    self.request, _("The shift {shift} has been saved.").format(shift=shift)
                )
                return redirect(self.object.event.get_absolute_url())

        return self.render_to_response(
            self.get_context_data(
                form=form,
                flow_configuration_form=flow_configuration_form,
                structure_configuration_form=structure_configuration_form,
            )
        )


class ShiftDeleteView(CustomPermissionRequiredMixin, DeleteView):
    permission_required = "core.change_event"
    model = Shift

    def setup(self, request, *args, **kwargs):
        super().setup(request, *args, **kwargs)
        self.object = self.get_object()

    def form_valid(self, form):
        if self.object.event.shifts.count() == 1:
            messages.error(self.request, _("You cannot delete the last shift!"))
            return redirect(self.object.event.get_absolute_url())
        return super().form_valid(form)

    def get_success_url(self):
        messages.success(self.request, _("The shift has been deleted."))
        return self.object.event.get_absolute_url()

    def get_permission_object(self):
        return self.object.event

1	from django.contrib import messages	1✔
2	from django.core.exceptions import ValidationError	1✔
3	from django.shortcuts import get_object_or_404, redirect, render	1✔
4	from django.urls import reverse	1✔
5	from django.utils.datastructures import MultiValueDictKeyError	1✔
6	from django.utils.timezone import get_default_timezone	1✔
7	from django.utils.translation import gettext as _	1✔
8	from django.views import View	1✔
9	from django.views.generic import DeleteView, TemplateView	1✔
10	from django.views.generic.detail import SingleObjectMixin	1✔
11
12	from ephios.core.forms.events import ShiftForm	1✔
13	from ephios.core.models import Event, Shift	1✔
14	from ephios.core.signals import shift_forms	1✔
15	from ephios.core.signup.flow import enabled_signup_flows, signup_flow_from_slug	1✔
16	from ephios.core.signup.structure import enabled_shift_structures, shift_structure_from_slug	1✔
17	from ephios.extra.mixins import CustomPermissionRequiredMixin, PluginFormMixin	1✔
18
19
20	class ShiftCreateView(CustomPermissionRequiredMixin, PluginFormMixin, TemplateView):	1✔
21	permission_required = "core.change_event"	1✔
22	template_name = "core/shift_form.html"	1✔
23
24	def setup(self, request, args, *kwargs):	1✔
25	super().setup(request, args, *kwargs)	1✔
26	self.event = get_object_or_404(Event.all_objects, pk=self.kwargs.get("pk"))	1✔
27
28	def get_permission_object(self):	1✔
29	return self.event	1✔
30
31	def get_shift_form(self):	1✔
32	return ShiftForm(self.request.POST or None)	1✔
33
34	def get_context_data(self, **kwargs):	1✔
35	kwargs.setdefault("event", self.event)	1✔
36	kwargs.setdefault("form", self.get_shift_form())	1✔
37	kwargs.setdefault("flow_configuration_form", "")	1✔
38	kwargs.setdefault("structure_configuration_form", "")	1✔
39	return super().get_context_data(**kwargs)	1✔
40
41	def get_plugin_forms(self):	1✔
42	return shift_forms.send(	1✔
43	sender=None, shift=getattr(self, "object", None), request=self.request
44	)
45
46	def post(self, args, *kwargs):	1✔
47	form = self.get_shift_form()	1✔
48	self.object = form.instance	1✔
49
50	try:	1✔
51	signup_flow = signup_flow_from_slug(	1✔
52	self.request.POST.get("signup_flow_slug"), event=self.event
53	)
54	structure = shift_structure_from_slug(	1✔
55	self.request.POST.get("structure_slug"),
56	event=self.event,
57	)
58	except KeyError:	×
NEW 59	if not list(enabled_signup_flows()):	×
NEW 60	form.add_error(	×
61	"signup_flow_slug",
62	_("You must enable plugins providing signup flows to continue."),
63	)
NEW 64	if not list(enabled_shift_structures()):	×
UNCOV 65	form.add_error(	×
66	"structure_slug",
67	_("You must enable plugins providing shift structures to continue."),
68	)
69	return self.render_to_response(	×
70	self.get_context_data(
71	form=form,
72	)
73	)
74	except ValueError as e:	×
NEW 75	form.add_error(None, ValidationError(e))	×
NEW 76	return self.render_to_response(	×
77	self.get_context_data(
78	form=form,
79	)
80	)
81
82	flow_configuration_form = signup_flow.get_configuration_form(	1✔
83	self.request.POST, event=self.event
84	)
85	structure_configuration_form = structure.get_configuration_form(	1✔
86	self.request.POST, event=self.event
87	)
88	if not all(	1!
89	[
90	self.is_valid(form),
91	flow_configuration_form.is_valid(),
92	structure_configuration_form.is_valid(),
93	]
94	):
NEW 95	return self.render_to_response(	×
96	self.get_context_data(
97	form=form,
98	flow_configuration_form=flow_configuration_form,
99	structure_configuration_form=structure_configuration_form,
100	)
101	)
102
103	shift = form.save(commit=False)	1✔
104	shift.event = self.event	1✔
105	shift.signup_flow_configuration = flow_configuration_form.cleaned_data	1✔
106	shift.structure_configuration = structure_configuration_form.cleaned_data	1✔
107	shift.save()	1✔
108	self.save_plugin_forms()	1✔
109	if "addAnother" in self.request.POST:	1!
NEW 110	return redirect(reverse("core:event_createshift", kwargs={"pk": self.kwargs.get("pk")}))	×
111	try:	1✔
112	self.event.activate()	1✔
113	messages.success(	1✔
114	self.request,
115	_("The event {title} has been saved.").format(title=self.event.title),
116	)
NEW 117	except ValidationError as e:	×
NEW 118	messages.error(self.request, e)	×
119	return redirect(self.event.get_absolute_url())	1✔
120
121
122	class AbstractShiftConfigurationFormView(CustomPermissionRequiredMixin, SingleObjectMixin, View):	1✔
123	queryset = Event.all_objects	1✔
124	permission_required = "core.change_event"	1✔
125	pk_url_kwarg = "event_id"	1✔
126
127	def get(self, request, args, *kwargs):	1✔
128	try:	×
129	shift = self.get_object().shifts.get(pk=request.GET.get("shift_id") or None)	×
130	except Shift.DoesNotExist:	×
131	shift = None	×
NEW 132	form = self.get_form(self.get_object(), shift)	×
NEW 133	return render(	×
134	request,
135	"core/fragments/shift_signup_config_form.html",
136	{
137	"form": form,
138	},
139	)
140
141	def get_form(self, event, shift=None):	1✔
NEW 142	raise NotImplementedError	×
143
144
145	class SignupFlowConfigurationFormView(AbstractShiftConfigurationFormView):	1✔
146	def get_form(self, event, shift=None):	1✔
NEW 147	return signup_flow_from_slug(	×
148	self.kwargs.get("slug"), event=event, shift=shift
149	).get_configuration_form()
150
151
152	class ShiftStructureConfigurationFormView(AbstractShiftConfigurationFormView):	1✔
153	def get_form(self, event, shift=None):	1✔
NEW 154	return shift_structure_from_slug(	×
155	self.kwargs.get("slug"), event=event, shift=shift
156	).get_configuration_form()
157
158
159	class ShiftUpdateView(	1✔
160	CustomPermissionRequiredMixin, PluginFormMixin, SingleObjectMixin, TemplateView
161	):
162	model = Shift	1✔
163	template_name = "core/shift_form.html"	1✔
164	permission_required = "core.change_event"	1✔
165
166	def get_permission_object(self):	1✔
167	return self.get_object().event	1✔
168
169	def get_shift_form(self):	1✔
170	return ShiftForm(	1✔
171	self.request.POST or None,
172	instance=self.object,
173	initial={
174	"date": self.object.meeting_time.date(),
175	"meeting_time": self.object.meeting_time.astimezone(get_default_timezone()).time(),
176	"start_time": self.object.start_time.astimezone(get_default_timezone()).time(),
177	"end_time": self.object.end_time.astimezone(get_default_timezone()).time(),
178	},
179	)
180
181	def get_flow_configuration_form(self):	1✔
182	return self.object.signup_flow.get_configuration_form(data=self.request.POST or None)	1✔
183
184	def get_structure_configuration_form(self):	1✔
185	return self.object.structure.get_configuration_form(data=self.request.POST or None)	1✔
186
187	def get_context_data(self, **kwargs):	1✔
188	self.object = self.get_object()	1✔
189	kwargs.setdefault("event", self.object.event)	1✔
190	kwargs.setdefault("form", self.get_shift_form())	1✔
191	kwargs.setdefault("flow_configuration_form", self.get_flow_configuration_form())	1✔
192	kwargs.setdefault("structure_configuration_form", self.get_structure_configuration_form())	1✔
193	return super().get_context_data(**kwargs)	1✔
194
195	def get_plugin_forms(self):	1✔
196	return shift_forms.send(sender=None, shift=self.object, request=self.request)	1✔
197
198	def post(self, args, *kwargs):	1✔
199	self.object = self.get_object()	1✔
200	form = self.get_shift_form()	1✔
201	flow_configuration_form = self.get_flow_configuration_form()	1✔
202	structure_configuration_form = self.get_structure_configuration_form()	1✔
203	try:	1✔
204	signup_flow = signup_flow_from_slug(	1✔
205	self.request.POST["signup_flow_slug"], shift=self.object
206	)
207	flow_configuration_form = signup_flow.get_configuration_form(	1✔
208	self.request.POST, event=self.object.event
209	)
210	structure = shift_structure_from_slug(	1✔
211	self.request.POST["structure_slug"], shift=self.object
212	)
213	structure_configuration_form = structure.get_configuration_form(	1✔
214	self.request.POST, event=self.object.event
215	)
NEW 216	except (ValueError, MultiValueDictKeyError):	×
NEW 217	pass	×
218	else:
219	if all(	1✔
220	[
221	self.is_valid(form),
222	flow_configuration_form.is_valid(),
223	structure_configuration_form.is_valid(),
224	]
225	):
226	shift = form.save(commit=False)	1✔
227	shift.signup_flow_configuration = flow_configuration_form.cleaned_data	1✔
228	shift.structure_configuration = structure_configuration_form.cleaned_data	1✔
229	shift.save()	1✔
230	self.save_plugin_forms()	1✔
231	if "addAnother" in self.request.POST:	1!
NEW 232	return redirect(	×
233	reverse("core:event_createshift", kwargs={"pk": shift.event.pk})
234	)
235	messages.success(	1✔
236	self.request, _("The shift {shift} has been saved.").format(shift=shift)
237	)
238	return redirect(self.object.event.get_absolute_url())	1✔
239
240	return self.render_to_response(	1✔
241	self.get_context_data(
242	form=form,
243	flow_configuration_form=flow_configuration_form,
244	structure_configuration_form=structure_configuration_form,
245	)
246	)
247
248
249	class ShiftDeleteView(CustomPermissionRequiredMixin, DeleteView):	1✔
250	permission_required = "core.change_event"	1✔
251	model = Shift	1✔
252
253	def setup(self, request, args, *kwargs):	1✔
254	super().setup(request, args, *kwargs)	1✔
255	self.object = self.get_object()	1✔
256
257	def form_valid(self, form):	1✔
258	if self.object.event.shifts.count() == 1:	1!
259	messages.error(self.request, _("You cannot delete the last shift!"))	×
260	return redirect(self.object.event.get_absolute_url())	×
261	return super().form_valid(form)	1✔
262
263	def get_success_url(self):	1✔
264	messages.success(self.request, _("The shift has been deleted."))	1✔
265	return self.object.event.get_absolute_url()	1✔
266
267	def get_permission_object(self):	1✔
268	return self.object.event	1✔

ephios-dev / ephios / 9634676702

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