django-spire 0.23.7__py3-none-any.whl → 0.23.8__py3-none-any.whl

django_spire/help_desk/tests/test_services/test_service.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from unittest.mock import MagicMock, patch
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.help_desk.choices import (
+    HelpDeskTicketPriorityChoices,
+    HelpDeskTicketPurposeChoices,
+    HelpDeskTicketStatusChoices,
+)
+from django_spire.help_desk.models import HelpDeskTicket
+from django_spire.help_desk.tests.factories import create_test_helpdesk_ticket
+
+
+class HelpDeskTicketServiceTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.ticket = create_test_helpdesk_ticket()
+
+    def test_save_model_obj_updates_existing(self):
+        self.ticket.services.obj = self.ticket
+        updated_ticket, created = self.ticket.services.save_model_obj(
+            description='Updated description'
+        )
+
+        assert created is False
+        assert updated_ticket.description == 'Updated description'
+
+    def test_save_model_obj_updates_priority(self):
+        self.ticket.services.obj = self.ticket
+        updated_ticket, _ = self.ticket.services.save_model_obj(
+            priority=HelpDeskTicketPriorityChoices.URGENT
+        )
+
+        assert updated_ticket.priority == HelpDeskTicketPriorityChoices.URGENT
+
+    def test_save_model_obj_updates_status(self):
+        self.ticket.services.obj = self.ticket
+        updated_ticket, _ = self.ticket.services.save_model_obj(
+            status=HelpDeskTicketStatusChoices.DONE
+        )
+
+        assert updated_ticket.status == HelpDeskTicketStatusChoices.DONE
+
+    @patch(
+        'django_spire.help_desk.services.notification_service.'
+        'HelpDeskTicketNotificationService.create_new_ticket_notifications'
+    )
+    def test_create_sets_created_by(self, _mock_notifications: MagicMock):
+        ticket = HelpDeskTicket()
+
+        created_ticket = ticket.services.create(
+            created_by=self.super_user,
+            purpose=HelpDeskTicketPurposeChoices.APP,
+            priority=HelpDeskTicketPriorityChoices.LOW,
+            description='Test ticket',
+        )
+
+        assert created_ticket.created_by == self.super_user
+
+    @patch(
+        'django_spire.help_desk.services.notification_service.'
+        'HelpDeskTicketNotificationService.create_new_ticket_notifications'
+    )
+    def test_create_calls_notification_service(self, mock_notifications: MagicMock):
+        ticket = HelpDeskTicket()
+
+        ticket.services.create(
+            created_by=self.super_user,
+            purpose=HelpDeskTicketPurposeChoices.APP,
+            priority=HelpDeskTicketPriorityChoices.LOW,
+            description='Test ticket',
+        )
+
+        mock_notifications.assert_called_once()
+
+    @patch(
+        'django_spire.help_desk.services.notification_service.'
+        'HelpDeskTicketNotificationService.create_new_ticket_notifications'
+    )
+    def test_create_returns_ticket(self, _mock_notifications: MagicMock):
+        ticket = HelpDeskTicket()
+
+        created_ticket = ticket.services.create(
+            created_by=self.super_user,
+            purpose=HelpDeskTicketPurposeChoices.APP,
+            priority=HelpDeskTicketPriorityChoices.LOW,
+            description='Test ticket',
+        )
+
+        assert created_ticket.pk is not None
+        assert created_ticket.purpose == HelpDeskTicketPurposeChoices.APP

django_spire/help_desk/tests/test_urls/test_form_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase
@@ -5,17 +7,15 @@ from django_spire.help_desk.tests.factories import create_test_helpdesk_ticket
 
 
 class HelpDeskFormUrlsTestCase(BaseTestCase):
-    def test_helpdesk_ticket_form_create_url_path(self) -> None:
+    def test_helpdesk_ticket_form_create_url_path(self):
         response = self.client.get(path=reverse('django_spire:help_desk:form:create'))
+        assert response.status_code == 200
 
-        self.assertEqual(response.status_code, 200)
-
-    def test_helpdesk_ticket_form_update_url_path(self) -> None:
+    def test_helpdesk_ticket_form_update_url_path(self):
         response = self.client.get(
             path=reverse(
                 'django_spire:help_desk:form:update',
                 kwargs={'pk': create_test_helpdesk_ticket().pk}
             ),
         )
-
-        self.assertEqual(response.status_code, 200)
+        assert response.status_code == 200

django_spire/help_desk/tests/test_urls/test_page_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase
@@ -10,27 +12,24 @@ class HelpDeskPageUrlsTestCase(BaseTestCase):
 
         self.test_ticket = create_test_helpdesk_ticket()
 
-    def test_ticket_delete_view_url_path(self) -> None:
+    def test_ticket_delete_view_url_path(self):
         response = self.client.get(
             path=reverse(
                 'django_spire:help_desk:page:delete',
                 kwargs={'pk': self.test_ticket.pk}
             ),
         )
+        assert response.status_code == 200
 
-        self.assertEqual(response.status_code, 200)
-
-    def test_ticket_detail_view_url_path(self) -> None:
+    def test_ticket_detail_view_url_path(self):
         response = self.client.get(
             path=reverse(
                 'django_spire:help_desk:page:detail',
                 kwargs={'pk': self.test_ticket.pk}
             ),
         )
+        assert response.status_code == 200
 
-        self.assertEqual(response.status_code, 200)
-
-    def test_ticket_list_view_url_path(self) -> None:
+    def test_ticket_list_view_url_path(self):
         response = self.client.get(path=reverse('django_spire:help_desk:page:list'))
-
-        self.assertEqual(response.status_code, 200)
+        assert response.status_code == 200

django_spire/help_desk/tests/test_views/test_form_views.py

@@ -1,16 +1,17 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase
 from django_spire.help_desk.models import HelpDeskTicket
-from django_spire.help_desk.tests.factories import create_test_helpdesk_ticket, \
-    create_test_helpdesk_ticket_data
+from django_spire.help_desk.tests.factories import (
+    create_test_helpdesk_ticket,
+    create_test_helpdesk_ticket_data,
+)
 
 
 class HelpDeskFormViewsTestCase(BaseTestCase):
-    def setUp(self) -> None:
-        super().setUp()
-
-    def test_helpdesk_ticket_form_create_view(self) -> None:
+    def test_helpdesk_ticket_form_create_view(self):
         ticket_data = create_test_helpdesk_ticket_data()
 
         response = self.client.post(
@@ -20,15 +21,15 @@ class HelpDeskFormViewsTestCase(BaseTestCase):
 
         ticket = HelpDeskTicket.objects.first()
 
-        self.assertEqual(response.status_code, 302)
-        self.assertEqual(response.url, reverse('django_spire:help_desk:page:list'))
+        assert response.status_code == 302
+        assert response.url == reverse('django_spire:help_desk:page:list')
 
-        self.assertEqual(ticket.priority, ticket_data['priority'])
-        self.assertEqual(ticket.purpose, ticket_data['purpose'])
-        self.assertEqual(ticket.status, ticket_data['status'])
-        self.assertEqual(ticket.description, ticket_data['description'])
+        assert ticket.priority == ticket_data['priority']
+        assert ticket.purpose == ticket_data['purpose']
+        assert ticket.status == ticket_data['status']
+        assert ticket.description == ticket_data['description']
 
-    def test_helpdesk_ticket_form_update_view(self) -> None:
+    def test_helpdesk_ticket_form_update_view(self):
         test_ticket = create_test_helpdesk_ticket()
 
         updated_ticket_data = create_test_helpdesk_ticket_data(
@@ -46,11 +47,37 @@ class HelpDeskFormViewsTestCase(BaseTestCase):
             ),
         )
 
-        self.assertEqual(response.status_code, 302)
-        self.assertEqual(response.url, reverse('django_spire:help_desk:page:list'))
+        assert response.status_code == 302
+        assert response.url == reverse('django_spire:help_desk:page:list')
 
         test_ticket.refresh_from_db()
-        self.assertEqual(test_ticket.priority, updated_ticket_data['priority'])
-        self.assertEqual(test_ticket.purpose, updated_ticket_data['purpose'])
-        self.assertEqual(test_ticket.status, updated_ticket_data['status'])
-        self.assertEqual(test_ticket.description, updated_ticket_data['description'])
+        assert test_ticket.priority == updated_ticket_data['priority']
+        assert test_ticket.purpose == updated_ticket_data['purpose']
+        assert test_ticket.status == updated_ticket_data['status']
+        assert test_ticket.description == updated_ticket_data['description']
+
+    def test_helpdesk_ticket_form_create_view_invalid_data(self):
+        invalid_data = {
+            'priority': '',
+            'purpose': '',
+            'description': '',
+        }
+
+        response = self.client.post(
+            reverse('django_spire:help_desk:form:create'),
+            data=invalid_data,
+        )
+
+        assert response.status_code == 200
+        assert HelpDeskTicket.objects.count() == 0
+
+    def test_helpdesk_ticket_form_create_view_sets_created_by(self):
+        ticket_data = create_test_helpdesk_ticket_data()
+
+        self.client.post(
+            reverse('django_spire:help_desk:form:create'),
+            data=ticket_data,
+        )
+
+        ticket = HelpDeskTicket.objects.first()
+        assert ticket.created_by == self.super_user

django_spire/help_desk/tests/test_views/test_page_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase
@@ -10,7 +12,7 @@ class HelpDeskPageViewsTestCase(BaseTestCase):
 
         self.test_ticket = create_test_helpdesk_ticket()
 
-    def test_ticket_delete_view(self) -> None:
+    def test_ticket_delete_view(self):
         response = self.client.post(
             reverse(
                 'django_spire:help_desk:page:delete',
@@ -19,11 +21,11 @@ class HelpDeskPageViewsTestCase(BaseTestCase):
             data={'should_delete': 'on'},
         )
 
-        self.assertEqual(response.status_code, 302)
+        assert response.status_code == 302
         self.test_ticket.refresh_from_db()
-        self.assertTrue(self.test_ticket.is_deleted)
+        assert self.test_ticket.is_deleted is True
 
-    def test_ticket_detail_view(self) -> None:
+    def test_ticket_detail_view(self):
         response = self.client.get(
             reverse(
                 'django_spire:help_desk:page:detail',
@@ -31,16 +33,37 @@ class HelpDeskPageViewsTestCase(BaseTestCase):
             ),
         )
 
-        self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.context_data['ticket'], self.test_ticket)
+        assert response.status_code == 200
+        assert response.context_data['ticket'] == self.test_ticket
 
-    def test_ticket_list_view(self) -> None:
+    def test_ticket_list_view(self):
         tickets = [create_test_helpdesk_ticket() for _ in range(5)]
 
         response = self.client.get(
             reverse('django_spire:help_desk:page:list'),
         )
 
-        self.assertEqual(response.status_code, 200)
+        assert response.status_code == 200
         for ticket in tickets:
-            self.assertIn(ticket, response.context_data['tickets'])
+            assert ticket in response.context_data['tickets']
+
+    def test_ticket_list_view_excludes_deleted(self):
+        deleted_ticket = create_test_helpdesk_ticket()
+        deleted_ticket.is_deleted = True
+        deleted_ticket.save()
+
+        response = self.client.get(
+            reverse('django_spire:help_desk:page:list'),
+        )
+
+        assert deleted_ticket not in response.context_data['tickets']
+
+    def test_ticket_list_view_ordered_by_created_datetime_desc(self):
+        response = self.client.get(
+            reverse('django_spire:help_desk:page:list'),
+        )
+
+        tickets = list(response.context_data['tickets'])
+        if len(tickets) > 1:
+            for i in range(len(tickets) - 1):
+                assert tickets[i].created_datetime >= tickets[i + 1].created_datetime

django_spire/help_desk/urls/__init__.py

@@ -1,8 +1,11 @@
+from __future__ import annotations
+
 from django.urls import include, path
 
+
 app_name = 'help_desk'
 
 urlpatterns = [
     path('page/', include('django_spire.help_desk.urls.page_urls', namespace='page')),
     path('form/', include('django_spire.help_desk.urls.form_urls', namespace='form')),
-]
+]

django_spire/help_desk/urls/form_urls.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.help_desk.views import form_views
 
+
 app_name = 'form'
 
 urlpatterns = [

django_spire/help_desk/urls/page_urls.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.help_desk.views import page_views
 
+
 app_name = 'page'
 
 urlpatterns = [

django_spire/help_desk/views/form_views.py

@@ -1,4 +1,9 @@
+from __future__ import annotations
+
 import django_glue as dg
+
+from typing import TYPE_CHECKING
+
 from django.shortcuts import redirect, get_object_or_404
 from django.urls import reverse
 
@@ -8,9 +13,13 @@ from django_spire.contrib.generic_views import portal_views
 from django_spire.help_desk import forms
 from django_spire.help_desk.models import HelpDeskTicket
 
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
 
 @AppAuthController('help_desk').permission_required('can_add')
-def ticket_create_form_view(request):
+def ticket_create_form_view(request: WSGIRequest) -> TemplateResponse:
     ticket = HelpDeskTicket()
 
     dg.glue_model_object(request, 'ticket', ticket)
@@ -34,7 +43,7 @@ def ticket_create_form_view(request):
         request,
         form=form,
         template='django_spire/help_desk/page/ticket_form_page.html',
-        verb=f'Create',
+        verb='Create',
         obj=ticket,
         context_data={
             'form_action_url': reverse('django_spire:help_desk:form:create'),
@@ -43,7 +52,7 @@ def ticket_create_form_view(request):
 
 
 @AppAuthController('help_desk').permission_required('can_change')
-def ticket_update_form_view(request, pk: int):
+def ticket_update_form_view(request: WSGIRequest, pk: int) -> TemplateResponse:
     ticket = get_object_or_404(HelpDeskTicket, pk=pk)
 
     dg.glue_model_object(request, 'ticket', ticket)
@@ -52,8 +61,7 @@ def ticket_update_form_view(request, pk: int):
         form = forms.HelpDeskTicketUpdateForm(request.POST, instance=ticket)
 
         if form.is_valid():
-            _, _ = ticket.services.save_model_obj(**form.cleaned_data)
-
+            ticket.services.save_model_obj(**form.cleaned_data)
             return redirect(reverse('django_spire:help_desk:page:list'))
 
         show_form_errors(request, form)

django_spire/help_desk/views/page_views.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from django.shortcuts import get_object_or_404
 from django.urls import reverse
 
@@ -5,9 +9,13 @@ from django_spire.auth.controller.controller import AppAuthController
 from django_spire.contrib.generic_views import portal_views
 from django_spire.help_desk.models import HelpDeskTicket
 
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
 
 @AppAuthController('help_desk').permission_required('can_delete')
-def ticket_delete_view(request, pk):
+def ticket_delete_view(request: WSGIRequest, pk: int):
     ticket = get_object_or_404(HelpDeskTicket, pk=pk)
 
     return portal_views.delete_form_view(
@@ -21,7 +29,7 @@ def ticket_delete_view(request, pk):
 
 
 @AppAuthController('help_desk').permission_required('can_view')
-def ticket_detail_view(request, pk):
+def ticket_detail_view(request: WSGIRequest, pk: int):
     ticket = get_object_or_404(HelpDeskTicket, pk=pk)
 
     return portal_views.detail_view(
@@ -35,7 +43,7 @@ def ticket_detail_view(request, pk):
 
 
 @AppAuthController('help_desk').permission_required('can_view')
-def ticket_list_view(request):
+def ticket_list_view(request: WSGIRequest) -> TemplateResponse:
     tickets = HelpDeskTicket.objects.order_by('-created_datetime').active()
 
     return portal_views.list_view(

django_spire/history/activity/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib import admin
 from django.urls.base import reverse
 from django.utils.html import format_html

django_spire/history/activity/apps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.apps import AppConfig
 
 from django_spire.utils import check_required_apps
@@ -11,4 +13,4 @@ class HistoryActivityConfig(AppConfig):
     REQUIRED_APPS = ('django_spire_core', 'django_spire_history')
 
     def ready(self) -> None:
-        check_required_apps(self.label)
+        check_required_apps(self.label)

django_spire/history/activity/mixins.py

@@ -1,9 +1,15 @@
-from django.contrib.auth.models import User
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 
 from django_spire.history.activity.models import Activity, ActivitySubscriber
 
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+
 
 class ActivityMixin(models.Model):
     activities = GenericRelation(
@@ -13,12 +19,12 @@ class ActivityMixin(models.Model):
     )
 
     def add_activity(
-            self,
-            user: User,
-            verb: str,
-            information: str,
-            recipient: User = None,
-            subscribers: list[User] | None = None
+        self,
+        user: User,
+        verb: str,
+        information: str,
+        recipient: User = None,
+        subscribers: list[User] | None = None
     ) -> Activity:
 
         activity = self.activities.create(

django_spire/history/activity/models.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib.auth.models import User
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
@@ -12,9 +14,10 @@ class Activity(models.Model):
         ContentType,
         related_name='activities',
         related_query_name='activity',
-        on_delete=models.CASCADE, 
+        on_delete=models.CASCADE,
         editable=False
     )
+
     object_id = models.PositiveIntegerField(editable=False)
     content_object = GenericForeignKey('content_type', 'object_id')
 
@@ -47,9 +50,7 @@ class Activity(models.Model):
         return f'{self.user} - {self.verb}'
 
     def add_subscriber(self, subscriber: User) -> None:
-        self.subscribers.create(
-            user=subscriber
-        )
+        self.subscribers.create(subscriber=subscriber)
 
     class Meta:
         db_table = 'django_spire_history_activity'
@@ -78,7 +79,7 @@ class ActivitySubscriber(models.Model):
 
     def __str__(self):
         return f'{self.activity} - {self.subscriber}'
-    
+
     class Meta:
         db_table = 'django_spire_history_activity_subscriber'
         verbose_name = 'Activity Subscriber'

django_spire/history/activity/querysets.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db.models import QuerySet