refactor(reorg): extract every type of class into modules [10/10]

dojo/announcement/__init__.py

@@ -0,0 +1 @@
+import dojo.announcement.admin  # noqa: F401

dojo/announcement/admin.py

@@ -0,0 +1,6 @@
+from django.contrib import admin
+
+from dojo.announcement.models import Announcement, UserAnnouncement
+
+admin.site.register(Announcement)
+admin.site.register(UserAnnouncement)

dojo/announcement/api/__init__.py

@@ -0,0 +1 @@
+path = "announcements"  # noqa: RUF067

dojo/announcement/api/serializer.py

@@ -0,0 +1,21 @@
+from django.db import IntegrityError
+from rest_framework import serializers
+
+from dojo.announcement.models import Announcement
+
+
+class AnnouncementSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = Announcement
+        fields = "__all__"
+
+    def create(self, validated_data):
+        validated_data["id"] = 1
+        try:
+            return super().create(validated_data)
+        except IntegrityError as e:
+            if 'duplicate key value violates unique constraint "dojo_announcement_pkey"' in str(e):
+                msg = "No more than one Announcement is allowed"
+                raise serializers.ValidationError(msg)
+            raise

dojo/announcement/api/urls.py

@@ -0,0 +1,7 @@
+from dojo.announcement.api import path
+from dojo.announcement.api.views import AnnouncementViewSet
+
+
+def add_announcement_urls(router):
+    router.register(path, AnnouncementViewSet, basename="announcement")
+    return router

dojo/announcement/api/views.py

@@ -0,0 +1,20 @@
+from django_filters.rest_framework import DjangoFilterBackend
+
+from dojo.announcement.api.serializer import AnnouncementSerializer
+from dojo.announcement.models import Announcement
+from dojo.api_v2.views import DojoModelViewSet
+from dojo.authorization import api_permissions as permissions
+
+
+# Authorization: configuration
+class AnnouncementViewSet(
+    DojoModelViewSet,
+):
+    serializer_class = AnnouncementSerializer
+    queryset = Announcement.objects.none()
+    filter_backends = (DjangoFilterBackend,)
+    filterset_fields = "__all__"
+    permission_classes = (permissions.UserHasConfigurationPermissionStaff,)
+
+    def get_queryset(self):
+        return Announcement.objects.all().order_by("id")

dojo/announcement/models.py

@@ -0,0 +1,28 @@
+from django.db import models
+from django.utils.translation import gettext as _
+
+ANNOUNCEMENT_STYLE_CHOICES = (
+    ("info", "Info"),
+    ("success", "Success"),
+    ("warning", "Warning"),
+    ("danger", "Danger"),
+)
+
+
+class Announcement(models.Model):
+    message = models.CharField(max_length=500,
+                                help_text=_("This dismissable message will be displayed on all pages for authenticated users. It can contain basic html tags, for example <a href='https://www.fred.com' style='color: #337ab7;' target='_blank'>https://example.com</a>"),
+                                default="")
+    style = models.CharField(max_length=64, choices=ANNOUNCEMENT_STYLE_CHOICES, default="info",
+                            help_text=_("The style of banner to display. (info, success, warning, danger)"))
+    dismissable = models.BooleanField(default=False,
+                                      null=False,
+                                      blank=True,
+                                      verbose_name=_("Dismissable?"),
+                                      help_text=_("Ticking this box allows users to dismiss the current announcement"),
+                                      )
+
+
+class UserAnnouncement(models.Model):
+    announcement = models.ForeignKey("dojo.Announcement", null=True, editable=False, on_delete=models.CASCADE, related_name="user_announcement")
+    user = models.ForeignKey("dojo.Dojo_User", null=True, editable=False, on_delete=models.CASCADE)

dojo/announcement/signals.py

@@ -1,7 +1,8 @@
 from django.db.models.signals import post_save
 from django.dispatch import receiver
 
-from dojo.models import Announcement, Dojo_User, UserAnnouncement
+from dojo.announcement.models import Announcement, UserAnnouncement
+from dojo.user.models import Dojo_User
 
 
 @receiver(post_save, sender=Dojo_User)

dojo/announcement/ui/forms.py

@@ -0,0 +1,17 @@
+from django import forms
+
+from dojo.announcement.models import Announcement
+
+
+class AnnouncementCreateForm(forms.ModelForm):
+    class Meta:
+        model = Announcement
+        fields = "__all__"
+
+
+class AnnouncementRemoveForm(AnnouncementCreateForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields["dismissable"].disabled = True
+        self.fields["message"].disabled = True
+        self.fields["style"].disabled = True

dojo/announcement/urls.py → dojo/announcement/ui/urls.py

@@ -1,6 +1,6 @@
 from django.urls import re_path
 
-from dojo.announcement import views
+from dojo.announcement.ui import views
 
 urlpatterns = [
     re_path(

dojo/announcement/views.py → dojo/announcement/ui/views.py

@@ -7,8 +7,8 @@
 from django.utils.translation import gettext
 from django.utils.translation import gettext_lazy as _
 
-from dojo.forms import AnnouncementCreateForm, AnnouncementRemoveForm
-from dojo.models import Announcement, UserAnnouncement
+from dojo.announcement.models import Announcement, UserAnnouncement
+from dojo.announcement.ui.forms import AnnouncementCreateForm, AnnouncementRemoveForm
 from dojo.utils import add_breadcrumb
 
 logger = logging.getLogger(__name__)