11768643407

Committed 10 Nov 2024 09:28PM UTC coverage: 85.149% (-0.1%) from 85.257%

Build # 11768643407

Build Type

Pull #1413

github

Committed by

web-flow

Commit Message

Merge de6722743 into 79aeff65f

Pull Request Pull Request #1413: Interface customization signals

Run Details

2940 of 3481 branches covered (84.46%)

Branch coverage included in aggregate %.

154 of 172 new or added lines in 20 files covered. (89.53%)

7 existing lines in 3 files now uncovered.

11881 of 13925 relevant lines covered (85.32%)

0.85 hits per line

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

88.0

/ephios/core/signup/structure/base.py

import logging
from argparse import Namespace
from collections import OrderedDict
from operator import attrgetter

from django.template.loader import get_template
from django.urls import reverse

from ephios.core.models import AbstractParticipation
from ephios.core.signup.disposition import BaseDispositionParticipationForm
from ephios.core.signup.forms import BaseSignupForm, SignupConfigurationForm
from ephios.core.signup.stats import SignupStats
from ephios.core.signup.structure.abstract import AbstractShiftStructure
from ephios.extra.utils import format_anything

logger = logging.getLogger(__name__)


class BaseShiftStructure(AbstractShiftStructure):
    """
    Shift structure with some base implementations for common methods.
    """

    @property
    def disposition_participation_form_class(self):
        return BaseDispositionParticipationForm

    @property
    def signup_form_class(self):
        return BaseSignupForm

    @property
    def configuration_form_class(self):
        return SignupConfigurationForm

    @property
    def shift_state_template_name(self):
        raise NotImplementedError()

    def get_participant_count_bounds(self):
        return None, None

    def get_signup_stats(self) -> "SignupStats":
        min_count, max_count = self.get_participant_count_bounds()
        participations = list(self.shift.participations.all())
        confirmed_count = sum(
            p.state == AbstractParticipation.States.CONFIRMED for p in participations
        )
        return SignupStats(
            requested_count=sum(
                p.state == AbstractParticipation.States.REQUESTED for p in participations
            ),
            confirmed_count=confirmed_count,
            missing=max(min_count - confirmed_count, 0) if min_count else 0,
            free=max(max_count - confirmed_count, 0) if max_count else None,
            min_count=min_count,
            max_count=max_count,
        )

    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_checkers(self):
        return []

    def render(self, context):
        try:
            with context.update(self.get_shift_state_context_data(context.request)):
                return get_template(self.shift_state_template_name).template.render(context)
        except Exception as e:  # pylint: disable=broad-except
            logger.exception(f"Shift #{self.shift.pk} state render failed")
            with context.update({"exception_message": getattr(e, "message", None)}):
                return get_template(
                    "core/fragments/shift_structure_render_error.html"
                ).template.render(context)

    def get_shift_state_context_data(self, request, **kwargs):
        """
        Additionally to the context of the event detail view, provide context for rendering `shift_state_template_name`.
        """
        kwargs["shift"] = self.shift
        kwargs["participations"] = [
            p
            for p in sorted(self.shift.participations.all(), key=attrgetter("state"), reverse=True)
            if p.state
            in {AbstractParticipation.States.REQUESTED, AbstractParticipation.States.CONFIRMED}
        ]
        if self.disposition_participation_form_class is not None:
            kwargs["disposition_url"] = (
                reverse("core:shift_disposition", kwargs={"pk": self.shift.pk})
                if request.user.has_perm("core.change_event", obj=self.shift.event)
                else None
            )
        return kwargs

    def get_list_export_data(self):
        return [
            {
                "participation": participation,
                "required_qualifications": [],
                "description": "",
            }
            for participation in self.shift.participations.all()
        ]

    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.structure_configuration.items():
                setattr(self.configuration, key, value)

1	import logging	1✔
2	from argparse import Namespace	1✔
3	from collections import OrderedDict	1✔
4	from operator import attrgetter	1✔
5
6	from django.template.loader import get_template	1✔
7	from django.urls import reverse	1✔
8
9	from ephios.core.models import AbstractParticipation	1✔
10	from ephios.core.signup.disposition import BaseDispositionParticipationForm	1✔
11	from ephios.core.signup.forms import BaseSignupForm, SignupConfigurationForm	1✔
12	from ephios.core.signup.stats import SignupStats	1✔
13	from ephios.core.signup.structure.abstract import AbstractShiftStructure	1✔
14	from ephios.extra.utils import format_anything	1✔
15
16	logger = logging.getLogger(__name__)	1✔
17
18
19	class BaseShiftStructure(AbstractShiftStructure):	1✔
20	"""
21	Shift structure with some base implementations for common methods.
22	"""
23
24	@property	1✔
25	def disposition_participation_form_class(self):	1✔
26	return BaseDispositionParticipationForm	1✔
27
28	@property	1✔
29	def signup_form_class(self):	1✔
30	return BaseSignupForm	1✔
31
32	@property	1✔
33	def configuration_form_class(self):	1✔
34	return SignupConfigurationForm	1✔
35
36	@property	1✔
37	def shift_state_template_name(self):	1✔
38	raise NotImplementedError()	×
39
40	def get_participant_count_bounds(self):	1✔
41	return None, None	×
42
43	def get_signup_stats(self) -> "SignupStats":	1✔
44	min_count, max_count = self.get_participant_count_bounds()	1✔
45	participations = list(self.shift.participations.all())	1✔
46	confirmed_count = sum(	1✔
47	p.state == AbstractParticipation.States.CONFIRMED for p in participations
48	)
49	return SignupStats(	1✔
50	requested_count=sum(
51	p.state == AbstractParticipation.States.REQUESTED for p in participations
52	),
53	confirmed_count=confirmed_count,
54	missing=max(min_count - confirmed_count, 0) if min_count else 0,
55	free=max(max_count - confirmed_count, 0) if max_count else None,
56	min_count=min_count,
57	max_count=max_count,
58	)
59
60	def get_signup_info(self):	1✔
61	"""
62	Return key/value pairs about the configuration to show in exports etc.
63	"""
64	form_class = self.configuration_form_class	1✔
65	return OrderedDict(	1✔
66	{
67	label: getattr(form_class, f"format_{name}", format_anything)(value)
68	for name, field in form_class.base_fields.items()
69	if (label := field.label) and (value := getattr(self.configuration, name))
70	}
71	)
72
73	def get_checkers(self):	1✔
74	return []	1✔
75
76	def render(self, context):	1✔
77	try:	1✔
78	with context.update(self.get_shift_state_context_data(context.request)):	1✔
79	return get_template(self.shift_state_template_name).template.render(context)	1✔
80	except Exception as e: # pylint: disable=broad-except	×
81	logger.exception(f"Shift #{self.shift.pk} state render failed")	×
82	with context.update({"exception_message": getattr(e, "message", None)}):	×
83	return get_template(	×
84	"core/fragments/shift_structure_render_error.html"
85	).template.render(context)
86
87	def get_shift_state_context_data(self, request, **kwargs):	1✔
88	"""
89	Additionally to the context of the event detail view, provide context for rendering `shift_state_template_name`.
90	"""
91	kwargs["shift"] = self.shift	1✔
92	kwargs["participations"] = [	1✔
93	p
94	for p in sorted(self.shift.participations.all(), key=attrgetter("state"), reverse=True)
95	if p.state
96	in {AbstractParticipation.States.REQUESTED, AbstractParticipation.States.CONFIRMED}
97	]
98	if self.disposition_participation_form_class is not None:	1!
99	kwargs["disposition_url"] = (	1✔
100	reverse("core:shift_disposition", kwargs={"pk": self.shift.pk})
101	if request.user.has_perm("core.change_event", obj=self.shift.event)
102	else None
103	)
104	return kwargs	1✔
105
106	def get_list_export_data(self):	1✔
NEW 107	return [	×
108	{
109	"participation": participation,
110	"required_qualifications": [],
111	"description": "",
112	}
113	for participation in self.shift.participations.all()
114	]
115
116	def get_configuration_form(self, args, *kwargs):	1✔
117	if self.shift is not None:	1✔
118	kwargs.setdefault("initial", self.configuration.__dict__)	1✔
119	kwargs.setdefault("event", self.event)	1✔
120	kwargs.setdefault("shift", self.shift)	1✔
121	kwargs.setdefault("description", self.description)	1✔
122	form = self.configuration_form_class(args, *kwargs)	1✔
123	return form	1✔
124
125	def __init__(self, shift, event=None):	1✔
126	super().__init__(shift, event)	1✔
127	self.configuration = Namespace(	1✔
128	**{
129	name: field.initial
130	for name, field in self.configuration_form_class.base_fields.items()
131	}
132	)
133	if shift is not None:	1✔
134	for key, value in shift.structure_configuration.items():	1✔
135	setattr(self.configuration, key, value)	1✔

ephios-dev / ephios / 11768643407

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