clinicedc 2.0.39__py3-none-any.whl → 2.0.41__py3-none-any.whl

edc_review_dashboard/urls.py

@@ -1,6 +1,5 @@
 from django.contrib import admin
 from django.urls import path
-
 from edc_data_manager.views import HomeView
 from edc_protocol.research_protocol_config import ResearchProtocolConfig
 
@@ -10,7 +9,7 @@ app_name = "edc_review_dashboard"
 
 urlpatterns = SubjectReviewListboardView.urls(
     namespace=app_name,
-    label="subject_review_listboard",
+    url_names_key="subject_review_listboard_url",
     identifier_pattern=ResearchProtocolConfig().subject_identifier_pattern,
 )
 
@@ -18,3 +17,5 @@ urlpatterns += [
     path("admin/", admin.site.urls),
     path("", HomeView.as_view(), name="home_url"),
 ]
+
+# aliquot_listboard = ("edc_lab_dashboard:aliquot_listboard_url",)

edc_review_dashboard/views/subject_review_listboard_view.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any
 
 from django.db.models.aggregates import Count
-
 from edc_appointment.view_mixins import AppointmentViewMixin
 from edc_dashboard.url_names import url_names
 from edc_dashboard.view_mixins import EdcViewMixin
@@ -44,6 +43,7 @@ class SubjectReviewListboardView(
 
     listboard_template = "subject_review_listboard_template"
     listboard_url = "subject_review_listboard_url"
+    listboard_back_url = "subject_review_listboard_url"
     listboard_panel_style = "default"
     listboard_panel_title = "Subject Review"
     listboard_view_permission_codename = "edc_review_dashboard.view_subject_review_listboard"
@@ -51,6 +51,7 @@ class SubjectReviewListboardView(
     navbar_selected_item = "subject_review"
     ordering = ("subject_identifier", "visit_code", "visit_code_sequence")
     paginate_by = 25
+    paginator_url = "subject_review_listboard_url"
     search_form_url = "subject_review_listboard_url"
     search_fields = (
         "subject_identifier",
@@ -59,7 +60,8 @@ class SubjectReviewListboardView(
         "user_modified",
     )
 
-    #  attr to call SubjectReviewListboardView.urls in urls.py
+    # Attribute to call SubjectReviewListboardView.urls in urls.py
+    # See UrlRequestContextMixin and UrlConfig
     urlconfig_getattr = "review_listboard_urls"
 
     def get_context_data(self, **kwargs) -> dict[str, Any]:

edc_subject_dashboard/dashboard_templates.py

@@ -2,6 +2,4 @@
 use settings.DASHBOARD_BASE_TEMPLATES.
 """
 
-dashboard_templates = dict(
-    edc_subject_dashboard_template="edc_subject_dashboard/dashboard.html"
-)
+dashboard_templates = dict(subject_dashboard_template="edc_subject_dashboard/dashboard.html")

edc_subject_dashboard/dashboard_urls.py

@@ -0,0 +1,8 @@
+import contextlib
+
+from django.conf import settings
+
+dashboard_urls = dict()
+
+with contextlib.suppress(AttributeError):
+    dashboard_urls.update(**settings.SUBJECT_DASHBOARD_URL_NAMES)

edc_subject_dashboard/middleware.py

@@ -1,25 +1,28 @@
 from django.conf import settings
 
+from edc_dashboard.middleware_mixins import EdcTemplateMiddlewareMixin
+from edc_subject_dashboard.dashboard_urls import dashboard_urls
+
 from .dashboard_templates import dashboard_templates
 
 
-class DashboardMiddleware:
+class DashboardMiddleware(EdcTemplateMiddlewareMixin):
     def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request):
+        self.check_for_required_request_attrs(request)
         return self.get_response(request)
 
-    def process_view(self, request, *args):  # noqa: ARG002
+    def process_view(self, request, *args):
         """Adds/Updates references to templates."""
-        try:
-            template_data = settings.SUBJECT_DASHBOARD_BASE_TEMPLATES
-        except AttributeError:
-            template_data = dashboard_templates
+        request.url_name_data.update(**dashboard_urls)
+        template_data = getattr(settings, "SUBJECT_DASHBOARD_BASE_TEMPLATES", {})
+        template_data.update(**dashboard_templates)
         request.template_data.update(**template_data)
 
     def process_template_response(self, request, response):
-        if response.context_data:
+        if getattr(response, "context_data", None):
             response.context_data.update(**request.url_name_data)
             response.context_data.update(**request.template_data)
         return response

edc_subject_dashboard/templates/edc_subject_dashboard/buttons/refresh_appointments_button.html

@@ -1 +1 @@
-<a {% if url %}href="{{ url }}" {% else %} disabled {% endif %}data-toggle="tooltip" title="Refresh appointments" role="button" class="btn btn-sm btn-default"><i class="fas fa-arrows-rotate fa-1x fa-fw" aria-hidden="true"></i></a>
+<a {% if url %}href="{{ url }}" {% else %} disabled {% endif %}data-toggle="tooltip" title="{{ title|default:"Refresh appointments" }}" role="button" class="btn btn-sm btn-default"><i class="fas fa-arrows-rotate fa-1x fa-fw" aria-hidden="true"></i></a>

edc_subject_dashboard/templates/edc_subject_dashboard/dashboard.html

@@ -1,4 +1,4 @@
-{% extends dashboard_base_template %}
+{% extends dashboard_base_template|default:"edc_dashboard/base.html" %}
 {% load static i18n %}
 {% load edc_visit_schedule_extras edc_subject_dashboard_extras edc_dashboard_extras edc_adverse_event_extras %}
 

edc_subject_dashboard/templatetags/edc_subject_dashboard_extras.py

@@ -481,10 +481,12 @@ def render_refresh_appointments_button(
     visit_schedule_name: str | None = None,
     schedule_name: str | None = None,
 ) -> dict:
+    title = "Refresh appointments"
     if context["request"].user.userprofile.is_multisite_viewer or context[
         "request"
     ].user.userprofile.roles.filter(name=AUDITOR_ROLE):
         url = None
+        title = f"{title} (Disabled for Auditor)"
     else:
         url = reverse(
             "edc_subject_dashboard:refresh_appointments_url",
@@ -494,7 +496,7 @@ def render_refresh_appointments_button(
                 schedule_name=schedule_name,
             ),
         )
-    return dict(url=url)
+    return dict(url=url, title=title)
 
 
 @register.inclusion_tag(

edc_subject_dashboard/urls.py

@@ -1,5 +1,4 @@
 from django.urls.conf import path
-
 from edc_dashboard.url_names import url_names
 from edc_metadata.views import RefreshMetadataActionsView
 
@@ -37,6 +36,16 @@ urlpatterns = [
     ),
 ]
 
-url_names.register(url="requisition_print_actions_url", namespace=app_name)
-url_names.register(url="requisition_verify_actions_url", namespace=app_name)
-url_names.register(url="refresh_metadata_actions_url", namespace=app_name)
+url_names.register(
+    key="requisition_print_actions_url",
+    url="requisition_print_actions_url",
+    namespace=app_name,
+)
+url_names.register(
+    key="requisition_verify_actions_url",
+    url="requisition_verify_actions_url",
+    namespace=app_name,
+)
+url_names.register(
+    key="refresh_metadata_actions_url", url="refresh_metadata_actions_url", namespace=app_name
+)

edc_subject_dashboard/views/base_requisition_view.py

@@ -9,12 +9,13 @@ from edc_label.printers_mixin import PrintersMixin
 
 class BaseRequisitionView(LoginRequiredMixin, PrintersMixin, View):
     success_url_name = "subject_dashboard_url"
+    lab_home_url_name = "requisition_listboard_url"
 
     def get_success_url(self):
         return url_names.get(self.success_url_name)
 
     def get(self, request, *args, **kwargs):  # noqa: ARG002
-        url = reverse("edc_lab_dashboard:home_url")
+        url = reverse(url_names.get(self.lab_home_url_name))
         return HttpResponseRedirect(url)
 
     def head(self, request, *args, **kwargs):

edc_subject_dashboard/views/subject_dashboard_view.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 from typing import Any
 
 from django.core.exceptions import ImproperlyConfigured
-
 from edc_action_item.view_mixins import ActionItemViewMixin
 from edc_appointment.view_mixins import AppointmentViewMixin
 from edc_consent.view_mixins import ConsentViewMixin
@@ -44,7 +43,7 @@ class SubjectDashboardView(
     navbar_selected_item = "consented_subject"
 
     dashboard_url_name = "subject_dashboard_url"
-    dashboard_template = "subject_dashboard_template"
+    dashboard_template_name = "subject_dashboard_template"
 
     default_manager = "on_site"
 

edc_timepoint/__init__.py

@@ -1,2 +0,0 @@
-from .timepoint import Timepoint
-from .timepoint_collection import TimepointCollection

edc_timepoint/model_mixins.py

@@ -32,8 +32,7 @@ class TimepointLookupModelMixin(models.Model):
     timepoint_lookup_cls = TimepointLookup
 
     def save(self, *args, **kwargs):
-        timepoint_lookup_cls = getattr(self, "timepoint_lookup_cls", None)
-        if timepoint_lookup_cls and get_enable_timepoint_checks():
+        if get_enable_timepoint_checks() and getattr(self, "timepoint_lookup_cls", None):
             timepoint_lookup = self.timepoint_lookup_cls()
             if timepoint_lookup.timepoint_model == self._meta.label_lower:
                 raise ImproperlyConfigured(

edc_timepoint/utils.py

@@ -2,4 +2,4 @@ from django.conf import settings
 
 
 def get_enable_timepoint_checks() -> bool:
-    return getattr(settings, "ENABLE_TIMEPOINT_CHECKS", True)
+    return getattr(settings, "EDC_TIMEPOINT_ENABLE_CHECKS", True)

edc_timepoint/visit_timepoint_lookup.py

@@ -0,0 +1,6 @@
+from .timepoint_lookup import TimepointLookup
+
+
+class VisitTimepointLookup(TimepointLookup):
+    timepoint_model = "edc_appointment.appointment"
+    timepoint_related_model_lookup = "appointment"

edc_visit_schedule/admin/subject_schedule_history_admin.py

@@ -3,7 +3,6 @@ from django.template.loader import render_to_string
 from django.urls import NoReverseMatch, reverse
 from django.utils.translation import gettext as _
 from django_audit_fields import audit_fields, audit_fieldset_tuple
-
 from edc_dashboard.url_names import url_names
 from edc_model_admin.dashboard import ModelAdminSubjectDashboardMixin
 from edc_sites.admin import SiteModelAdminMixin
@@ -100,7 +99,7 @@ class SubjectScheduleHistoryAdmin(
     def review(obj=None) -> str:
         try:
             url = (
-                f"{reverse('edc_review_dashboard:subject_review_listboard_url')}?"
+                f"{reverse(url_names.get('subject_review_listboard_url'))}?"
                 f"q={obj.subject_identifier}"
             )
         except NoReverseMatch:

edc_visit_schedule/navbars.py

@@ -8,7 +8,7 @@ navbar.register(
         title="Visit Schedule",
         label="Visit Schedule",
         fa_icon="fa-calendar",
-        url_name="edc_visit_schedule:home_url",
+        url_with_namespace="edc_visit_schedule:home_url",
         codename="edc_navbar.nav_visit_schedule",
     )
 )
@@ -19,9 +19,8 @@ navbar.register(
         title="Subject History",
         label="Subject History",
         fa_icon="fa-history",
-        url_name=(
-            "edc_visit_schedule:edc_visit_schedule_admin:"
-            "edc_visit_schedule_subjectschedulehistory_changelist"
+        url_with_namespace=(
+            "edc_visit_schedule_admin:edc_visit_schedule_subjectschedulehistory_changelist"
         ),
         codename="edc_navbar.nav_visit_schedule",
     )

edc_visit_schedule/visit/visit.py

@@ -217,6 +217,14 @@ class Visit:
 
     @property
     def all_crfs(self) -> CrfCollection:
+        """Return a new collection containing all crfs.
+
+        The new collection contains:
+             * crfs
+             * crfs_unscheduled
+             * crfs_prn
+             * crfs_missed
+        """
         crfs = list(self.crfs) + [
             crf
             for crf in self.crfs_unscheduled
@@ -232,6 +240,13 @@ class Visit:
 
     @property
     def all_requisitions(self) -> RequisitionCollection:
+        """Return a new collection containing all requisitions.
+
+        The new collection contains:
+             * requisitions
+             * requisitions_unscheduled
+             * requisitions_prn
+        """
         names = [r.name for r in self.requisitions]
         requisitions = list(self.requisitions) + [
             r for r in self.requisitions_unscheduled if r.name not in names

edc_visit_tracking/model_mixins/visit_model_mixin/visit_model_mixin.py

@@ -11,6 +11,8 @@ from edc_document_status.model_mixins import DocumentStatusModelMixin
 from edc_identifier.model_mixins import NonUniqueSubjectIdentifierFieldMixin
 from edc_metadata.model_mixins import MetadataHelperModelMixin
 from edc_offstudy.model_mixins import OffstudyNonCrfModelMixin
+from edc_timepoint.model_mixins import TimepointLookupModelMixin
+from edc_timepoint.visit_timepoint_lookup import VisitTimepointLookup
 from edc_visit_schedule.model_mixins import VisitScheduleModelMixin
 
 from ...constants import MISSED_VISIT, NO_FOLLOW_UP_REASONS
@@ -29,6 +31,7 @@ class VisitModelMixin(
     MetadataHelperModelMixin,
     OffstudyNonCrfModelMixin,
     RequiresConsentFieldsModelMixin,
+    TimepointLookupModelMixin,
     models.Model,
 ):
     """
@@ -41,6 +44,8 @@ class VisitModelMixin(
                 app_label = 'my_app'
     """
 
+    timepoint_lookup_cls = VisitTimepointLookup
+
     metadata_helper_instance_attr = None
 
     appointment = models.OneToOneField("edc_appointment.appointment", on_delete=PROTECT)

edc_visit_tracking/models/subject_visit.py

@@ -8,6 +8,8 @@ from edc_metadata.model_mixins.creates import CreatesMetadataModelMixin
 from edc_model.models import BaseUuidModel, HistoricalRecords
 from edc_sites.managers import CurrentSiteManager
 from edc_sites.model_mixins import SiteModelMixin
+from edc_timepoint.model_mixins import TimepointLookupModelMixin
+from edc_timepoint.visit_timepoint_lookup import VisitTimepointLookup
 from edc_visit_tracking.choices import (
     VISIT_INFO_SOURCE,
     VISIT_REASON,
@@ -22,8 +24,11 @@ class SubjectVisit(
     CreatesMetadataModelMixin,
     SiteModelMixin,
     RequiresConsentFieldsModelMixin,
+    TimepointLookupModelMixin,
     BaseUuidModel,
 ):
+    timepoint_lookup_cls = VisitTimepointLookup
+
     appointment = models.OneToOneField(
         get_appointment_model_name(),
         on_delete=PROTECT,

edc_lab_dashboard/model_wrappers/__init__.py

@@ -1,8 +0,0 @@
-# from .aliquot_model_wrapper import AliquotModelWrapper
-# from .box_model_wrapper import BoxModelWrapper
-# from .manage_box_item_model_wrapper import ManageBoxItemModelWrapper
-# from .manifest_item_model_wrapper import ManifestItemModelWrapper
-# from .manifest_model_wrapper import ManifestModelWrapper
-# from .requisition_model_wrapper import RequisitionModelWrapper
-# from .result_model_wrapper import ResultModelWrapper
-# from .verify_box_model_wrapper import VerifyBoxItemModelWrapper

edc_lab_dashboard/model_wrappers/aliquot_model_wrapper.py

@@ -1,31 +0,0 @@
-from edc_model_wrapper import ModelWrapper
-
-from edc_lab.models import Aliquot, BoxItem, ManifestItem
-
-
-class AliquotModelWrapper(ModelWrapper):
-    model_cls = Aliquot
-    next_url_name = "aliquot_listboard_url"
-
-    @property
-    def human_readable_identifier(self):
-        return self.object.human_readable_identifier
-
-    @property
-    def box_item(self):
-        try:
-            return BoxItem.objects.get(identifier=self.aliquot_identifier)
-        except BoxItem.DoesNotExist:
-            return None
-
-    @property
-    def manifest_item(self):
-        manifest_item = None
-        if self.box_item:
-            try:
-                manifest_item = ManifestItem.objects.get(
-                    identifier=self.box_item.box.box_identifier
-                )
-            except ManifestItem.DoesNotExist:
-                pass
-        return manifest_item

edc_lab_dashboard/model_wrappers/base_box_item_model_wrapper.py

@@ -1,21 +0,0 @@
-from django.apps import apps as django_apps
-from edc_model_wrapper import ModelWrapper
-
-from edc_lab.models import BoxItem
-
-edc_lab_app_config = django_apps.get_app_config("edc_lab")
-
-
-class BaseBoxItemModelWrapper(ModelWrapper):
-    model_cls = BoxItem
-    action_name = None
-    next_url_name = None
-    next_url_attrs = ["box_identifier", "action_name"]
-
-    @property
-    def human_readable_identifier(self):
-        return self.object.human_readable_identifier
-
-    @property
-    def box_identifier(self):
-        return self.object.box.box_identifier

edc_lab_dashboard/model_wrappers/box_model_wrapper.py

@@ -1,12 +0,0 @@
-from edc_model_wrapper import ModelWrapper
-
-from edc_lab.models import Box
-
-
-class BoxModelWrapper(ModelWrapper):
-    model_cls = Box
-    next_url_name = "pack_listboard_url"
-
-    @property
-    def human_readable_identifier(self):
-        return self.object.human_readable_identifier

edc_lab_dashboard/model_wrappers/manage_box_item_model_wrapper.py

@@ -1,6 +0,0 @@
-from .base_box_item_model_wrapper import BaseBoxItemModelWrapper
-
-
-class ManageBoxItemModelWrapper(BaseBoxItemModelWrapper):
-    action_name = "manage"
-    next_url_name = "manage_box_listboard_url"

edc_lab_dashboard/model_wrappers/manifest_item_model_wrapper.py

@@ -1,21 +0,0 @@
-from edc_model_wrapper import ModelWrapper
-
-from edc_lab.models import Box, ManifestItem
-
-
-class ManifestItemModelWrapper(ModelWrapper):
-    model_cls = ManifestItem
-    next_url_name = "manage_manifest_listboard_url"
-    action_name = "manage"
-
-    @property
-    def manifest_identifier(self):
-        return self.object.manifest.manifest_identifier
-
-    @property
-    def box_identifier(self):
-        return self.object.identifier
-
-    @property
-    def box(self):
-        return Box.objects.get(box_identifier=self.object.identifier)

edc_lab_dashboard/model_wrappers/manifest_model_wrapper.py

@@ -1,11 +0,0 @@
-from django.apps import apps as django_apps
-from edc_model_wrapper import ModelWrapper
-
-from edc_lab.models import Manifest
-
-edc_lab_app_config = django_apps.get_app_config("edc_lab")
-
-
-class ManifestModelWrapper(ModelWrapper):
-    model_cls = Manifest
-    next_url_name = "manifest_listboard_url"

edc_lab_dashboard/model_wrappers/requisition_model_wrapper.py

@@ -1,25 +0,0 @@
-from django.conf import settings
-from edc_model_wrapper import ModelWrapper
-
-
-class RequisitionModelWrapper(ModelWrapper):
-    model = settings.SUBJECT_REQUISITION_MODEL
-    next_url_name = "requisition_listboard_url"
-    next_url_attrs = ["appointment", "subject_identifier"]
-    querystring_attrs = ["subject_visit", "panel"]
-
-    @property
-    def subject_visit(self):
-        return str(self.object.subject_visit.id)
-
-    @property
-    def appointment(self):
-        return str(self.object.subject_visit.appointment.id)
-
-    @property
-    def subject_identifier(self):
-        return self.object.subject_visit.subject_identifier
-
-    @property
-    def panel(self):
-        return str(self.object.panel.id)

edc_lab_dashboard/model_wrappers/result_model_wrapper.py

@@ -1,8 +0,0 @@
-from edc_model_wrapper import ModelWrapper
-
-from edc_lab.models import Result
-
-
-class ResultModelWrapper(ModelWrapper):
-    model_cls = Result
-    next_url_name = "result_listboard_url"

edc_lab_dashboard/model_wrappers/verify_box_model_wrapper.py

@@ -1,10 +0,0 @@
-from django.apps import apps as django_apps
-
-from .base_box_item_model_wrapper import BaseBoxItemModelWrapper
-
-app_config = django_apps.get_app_config("edc_lab_dashboard")
-
-
-class VerifyBoxItemModelWrapper(BaseBoxItemModelWrapper):
-    next_url_name = "verify_box_listboard_url"
-    action_name = "verify"

edc_navbar/get_default_navbar.py

@@ -1,9 +0,0 @@
-from django.conf import settings
-
-
-def get_default_navbar():
-    """Returns the default navbar name.
-
-    For example: inte_dashboard for project INTE.
-    """
-    return getattr(settings, "EDC_NAVBAR_DEFAULT", f"{settings.APP_NAME}_dashboard".lower())