♻️ [#502] Make data more readable

Author: SilviaAmAm

backend/src/openarchiefbeheer/accounts/models.py

@@ -5,6 +5,7 @@
 from django.utils.translation import gettext_lazy as _
 
 from .managers import UserManager
+from .utils import format_user
 
 
 class User(AbstractBaseUser, PermissionsMixin):
@@ -68,9 +69,4 @@ def get_short_name(self):
         return self.first_name
 
     def get_name_with_username(self):
-        username = self.get_username()
-        if self.first_name or self.last_name:
-            full_name = self.get_full_name()
-            return f"{full_name} ({username})"
-
-        return username
+        return format_user(self)

backend/src/openarchiefbeheer/accounts/utils.py

@@ -1,11 +1,15 @@
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Union
+
 from django.core.exceptions import ValidationError
 from django.utils.translation import gettext_lazy as _
 
-from .models import User
+if TYPE_CHECKING:
+    from .models import User
 
 
 def validate_max_permissions(
-    current_user: User, permissions=None, groups=None, is_superuser=None
+    current_user: "User", permissions=None, groups=None, is_superuser=None
 ):
     """
     Validate that the ``permissions``, ``groups`` and ``superuser``-flag are
@@ -45,7 +49,7 @@ def validate_max_permissions(
         )
 
 
-def validate_max_user_permissions(current_user: User, target_user: User):
+def validate_max_user_permissions(current_user: "User", target_user: "User") -> None:
     """
     Validate that the ``target_user`` permissions are never more than the
     permissions of the ``current_user``.
@@ -56,3 +60,31 @@ def validate_max_user_permissions(current_user: User, target_user: User):
         target_user.groups,
         target_user.is_superuser,
     )
+
+
+@dataclass
+class UserData:
+    username: str
+    first_name: str = ""
+    last_name: str = ""
+
+
+def format_user(user: Union[dict, "User"]) -> str:
+    if isinstance(user, dict):
+        user = UserData(
+            **{
+                "username": user["username"],
+                "first_name": user.get("first_name"),
+                "last_name": user.get("last_name"),
+            }
+        )
+
+    if user.first_name or user.last_name:
+        full_name = "%s %s" % (user.first_name, user.last_name)
+        return f"{full_name.strip()} ({user.username})"
+
+    return user.username
+
+
+def format_user_groups(groups: list[str]) -> str:
+    return ", ".join(groups)

backend/src/openarchiefbeheer/destruction/destruction_report.py

@@ -1,18 +1,16 @@
 from dataclasses import dataclass
 from typing import IO
 
-from django.utils import timezone
 from django.utils.translation import gettext as _
 
 import xlsxwriter
 from glom import glom
 from timeline_logger.models import TimelineLog
 from xlsxwriter.worksheet import Worksheet
 
-from openarchiefbeheer.logging.logevent import (
-    destruction_list_reviewed,
-    get_event_template,
-)
+from openarchiefbeheer.accounts.utils import format_user, format_user_groups
+from openarchiefbeheer.logging.logevent import destruction_list_reviewed
+from openarchiefbeheer.logging.utils import get_event_template, get_readable_timestamp
 from openarchiefbeheer.zaken.api.constants import ZAAK_METADATA_FIELDS_MAPPINGS
 
 from .constants import InternalStatus
@@ -34,20 +32,16 @@ def add_review_process_table(
         ]
         worksheet.write_row(start_row, 0, column_names)
 
-        logs = TimelineLog.objects.for_object(self).filter(
+        logs = TimelineLog.objects.for_object(self.destruction_list).filter(
             template=get_event_template(destruction_list_reviewed),
             extra_data__approved=True,
         )
         for row_count, log in enumerate(logs):
-            user_data = log.extra_data["user"]
             # Not using the FK because the user might have been deleted in the mean time
-            formatted_user = f"{user_data["first_name"]} {user_data["last_name"]} ({user_data["username"]})"
             data = [
-                ", ".join(log.extra_data["user_groups"]),
-                formatted_user,
-                log.timestamp.astimezone(tz=timezone.get_default_timezone()).isoformat(
-                    sep=" ", timespec="minutes"
-                ),
+                format_user_groups(log.extra_data["user_groups"]),
+                format_user(log.extra_data["user"]),
+                get_readable_timestamp(log),
                 # This column is not useful, since we are filtering on approved reviews.
                 # But it was specifically requested.
                 _("Has approved"),

backend/src/openarchiefbeheer/logging/logevent.py

@@ -1,5 +1,4 @@
 import traceback
-from typing import Callable
 
 from django.db.models import Max, Min, Model
 
@@ -260,7 +259,3 @@ def resync_failed(exc: Exception) -> None:
     return TimelineLog.objects.create(
         template="logging/resync_failed.txt", extra_data={"error": error}
     )
-
-
-def get_event_template(logging_func: Callable) -> str:
-    return TEMPLATE_FORMAT % {"event": logging_func.__name__}

backend/src/openarchiefbeheer/logging/utils.py

@@ -0,0 +1,19 @@
+from typing import Callable
+
+from django.utils import timezone
+
+from timeline_logger.models import TimelineLog
+
+from .logevent import TEMPLATE_FORMAT
+
+
+def get_event_template(logging_func: Callable) -> str:
+    return TEMPLATE_FORMAT % {"event": logging_func.__name__}
+
+
+def get_readable_timestamp(
+    log: TimelineLog, separator: str = " ", timespec: str = "minutes"
+) -> str:
+    return log.timestamp.astimezone(tz=timezone.get_default_timezone()).isoformat(
+        sep=separator, timespec=timespec
+    )