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

django_spire/knowledge/collection/tests/test_services/test_services.py

@@ -0,0 +1,160 @@
+from __future__ import annotations
+
+# import json
+
+from django.contrib.sites.models import Site
+# from django.conf import settings
+# from django.test import RequestFactory
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.knowledge.collection.models import Collection
+from django_spire.knowledge.collection.tests.factories import create_test_collection
+
+
+class CollectionServiceTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.collection = create_test_collection()
+
+    def test_save_model_obj_creates_new(self):
+        collection, created = Collection.services.save_model_obj(
+            name='New Collection',
+            description='A new collection'
+        )
+        assert created is True
+        assert collection.name == 'New Collection'
+
+    def test_save_model_obj_updates_existing(self):
+        self.collection.services.obj = self.collection
+        updated_collection, created = self.collection.services.save_model_obj(
+            name='Updated Name'
+        )
+        assert created is False
+        assert updated_collection.name == 'Updated Name'
+
+
+class CollectionOrderingServiceTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.parent = create_test_collection(name='Parent')
+        self.child1 = create_test_collection(parent=self.parent, name='Child 1')
+        self.child2 = create_test_collection(parent=self.parent, name='Child 2')
+
+    def test_reorder_within_same_parent(self):
+        self.child2.services.ordering.reorder(order=0, new_parent_pk=self.parent.pk)
+        self.child1.refresh_from_db()
+        self.child2.refresh_from_db()
+        assert self.child2.order <= self.child1.order
+
+    def test_reorder_to_new_parent(self):
+        new_parent = create_test_collection(name='New Parent')
+        self.child1.services.ordering.reorder(order=0, new_parent_pk=new_parent.pk)
+        self.child1.refresh_from_db()
+        assert self.child1.parent_id == new_parent.pk
+
+    def test_reorder_to_root(self):
+        self.child1.services.ordering.reorder(order=0, new_parent_pk=None)
+        self.child1.refresh_from_db()
+        assert self.child1.parent_id is None
+
+
+class CollectionProcessorServiceTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.parent = create_test_collection(name='Parent')
+        self.child = create_test_collection(parent=self.parent, name='Child')
+
+    def test_set_deleted(self):
+        self.parent.services.processor.set_deleted()
+        self.parent.refresh_from_db()
+        assert self.parent.is_deleted is True
+
+    def test_set_deleted_cascades_to_children(self):
+        self.parent.services.processor.set_deleted()
+        self.child.refresh_from_db()
+        assert self.child.is_deleted is True
+
+
+class CollectionToolServiceTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.parent = create_test_collection(name='Parent')
+        self.child = create_test_collection(parent=self.parent, name='Child')
+        self.grandchild = create_test_collection(parent=self.child, name='Grandchild')
+
+    def test_get_children_ids(self):
+        children_ids = Collection.services.tool.get_children_ids(parent_id=self.parent.pk)
+        assert self.child.pk in children_ids
+        assert self.grandchild.pk in children_ids
+        assert self.parent.pk not in children_ids
+
+    def test_get_root_collection_pk(self):
+        self.grandchild.services.tool.obj = self.grandchild
+        root_pk = self.grandchild.services.tool.get_root_collection_pk()
+        assert root_pk == self.parent.pk
+
+    def test_get_root_collection_pk_when_already_root(self):
+        self.parent.services.tool.obj = self.parent
+        root_pk = self.parent.services.tool.get_root_collection_pk()
+        assert root_pk == self.parent.pk
+
+
+class TestCollectionTransformationService(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.site = Site.objects.create(domain='', name='')
+
+    def _test_collection_urls_json(self, collection_json: dict):
+        response = self.client.get(collection_json['delete_url'].replace(' ', ''))
+        assert response.status_code == 200
+
+        response = self.client.get(collection_json['create_entry_url'].replace(' ', ''))
+        assert response.status_code == 200
+
+        response = self.client.get(collection_json['import_entry_url'].replace(' ', ''))
+        assert response.status_code == 200
+
+    # # TODO(Tyrell): Talk to Chase about this
+    # def test_to_hierarchy_json(self):
+    #     settings.SITE_ID = self.site.id
+
+    #     self.test_collection_1 = Collection.objects.create(name='Grand Parent A', id=1, parent_id=None)
+    #     self.test_collection_2 = Collection.objects.create(name='Parent A1', id=2, parent_id=1)
+    #     self.test_collection_3 = Collection.objects.create(name='Child A1a', id=3, parent_id=2)
+
+    #     request = RequestFactory().get('/')
+    #     request.user = self.super_user
+
+    #     family_tree = Collection.services.transformation.to_hierarchy_json(
+    #         request=request
+    #     )
+
+    #     for collection_json in json.loads(family_tree):
+    #         assert collection_json['id'] is not None
+    #         assert collection_json['name'] == 'Grand Parent A'
+
+    #         assert len(collection_json['entries']) == 0
+
+    #         self._test_collection_urls_json(collection_json=collection_json)
+
+    #         assert len(collection_json['children']) == 1
+
+    #         for child_json in collection_json['children']:
+    #             assert child_json['id'] is not None
+    #             assert child_json['name'] == 'Parent A1'
+
+    #             assert len(child_json['entries']) == 0
+
+    #             self._test_collection_urls_json(collection_json=child_json)
+
+    #             assert len(child_json['children']) == 1
+
+    #             for grand_child_json in child_json['children']:
+    #                 assert grand_child_json['id'] is not None
+    #                 assert grand_child_json['name'] == 'Child A1a'
+
+    #                 assert len(grand_child_json['entries']) == 0
+
+    #                 self._test_collection_urls_json(collection_json=grand_child_json)
+
+    #                 assert len(grand_child_json['children']) == 0

django_spire/knowledge/collection/tests/test_urls/test_form_urls.py

@@ -3,17 +3,35 @@ from __future__ import annotations
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.knowledge.collection.tests.factories import create_test_collection
 
 
 class CollectionFormUrlsTests(BaseTestCase):
     def setUp(self):
         super().setUp()
 
-    def test_form_view_url_path(self):
+        self.collection = create_test_collection()
+
+    def test_create_form_view_url_path(self):
+        response = self.client.get(
+            reverse('django_spire:knowledge:collection:form:create')
+        )
+        assert response.status_code == 200
+
+    def test_create_with_parent_form_view_url_path(self):
         response = self.client.get(
             reverse(
-                'django_spire:knowledge:collection:form:create',
+                'django_spire:knowledge:collection:form:create_with_parent',
+                kwargs={'parent_pk': self.collection.pk}
             )
         )
+        assert response.status_code == 200
 
-        self.assertEqual(response.status_code, 200)
+    def test_update_form_view_url_path(self):
+        response = self.client.get(
+            reverse(
+                'django_spire:knowledge:collection:form:update',
+                kwargs={'pk': self.collection.pk}
+            )
+        )
+        assert response.status_code == 200

django_spire/knowledge/collection/tests/test_urls/test_json_urls.py

@@ -21,5 +21,43 @@ class CollectionJsonUrlsTests(BaseTestCase):
             },
             content_type='application/json',
         )
+        assert response.status_code == 200
 
-        self.assertEqual(response.status_code, 200)
+    def test_reorder_view_with_parent(self):
+        child_collection = create_test_collection(
+            parent=self.test_collection,
+            name='Child Collection'
+        )
+        response = self.client.post(
+            reverse('django_spire:knowledge:collection:json:reorder'),
+            data={
+                'collection_id': child_collection.pk,
+                'order': 0,
+                'parent': self.test_collection.pk
+            },
+            content_type='application/json',
+        )
+        assert response.status_code == 200
+
+    def test_reorder_view_invalid_collection(self):
+        response = self.client.post(
+            reverse('django_spire:knowledge:collection:json:reorder'),
+            data={
+                'collection_id': 99999,
+                'order': 0
+            },
+            content_type='application/json',
+        )
+        assert response.status_code == 200
+        assert response.json()['type'] == 'error'
+
+    def test_reorder_view_missing_order(self):
+        response = self.client.post(
+            reverse('django_spire:knowledge:collection:json:reorder'),
+            data={
+                'collection_id': self.test_collection.pk,
+            },
+            content_type='application/json',
+        )
+        assert response.status_code == 200
+        assert response.json()['type'] == 'error'

django_spire/knowledge/collection/tests/test_urls/test_page_urls.py

@@ -9,8 +9,18 @@ from django_spire.knowledge.collection.tests.factories import create_test_collec
 class CollectionPageUrlsTests(BaseTestCase):
     def setUp(self):
         super().setUp()
+
         self.test_collection = create_test_collection()
 
+    def test_top_level_view_url_path(self):
+        response = self.client.get(
+            reverse(
+                'django_spire:knowledge:collection:page:top_level',
+                kwargs={'pk': self.test_collection.pk}
+            )
+        )
+        assert response.status_code == 200
+
     def test_delete_view_url_path(self):
         response = self.client.get(
             reverse(
@@ -18,12 +28,10 @@ class CollectionPageUrlsTests(BaseTestCase):
                 kwargs={'pk': self.test_collection.pk}
             )
         )
-
-        self.assertEqual(response.status_code, 200)
+        assert response.status_code == 200
 
     def test_list_view_url_path(self):
         response = self.client.get(
             reverse('django_spire:knowledge:page:home')
         )
-
-        self.assertEqual(response.status_code, 200)
+        assert response.status_code == 200

django_spire/knowledge/collection/urls/__init__.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 from django.urls import include, path
 
 from django_spire.knowledge.collection import views
 
+
 app_name = 'collection'
 
 urlpatterns = [

django_spire/knowledge/collection/urls/form_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.knowledge.collection.views import form_views

django_spire/knowledge/collection/urls/json_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.knowledge.collection.views import json_views

django_spire/knowledge/collection/urls/page_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.knowledge.collection.views import page_views

django_spire/knowledge/collection/views/form_views.py

@@ -22,9 +22,9 @@ if TYPE_CHECKING:
 
 @AppAuthController('knowledge').permission_required('can_add')
 def form_view(
-        request: WSGIRequest,
-        pk: int = 0,
-        parent_pk: int = None,
+    request: WSGIRequest,
+    pk: int = 0,
+    parent_pk: int = None
 ) -> TemplateResponse | HttpResponseRedirect:
     collection = get_object_or_null_obj(Collection, pk=pk)
 
@@ -55,7 +55,7 @@ def form_view(
         if form.is_valid():
             collection, _ = collection.services.save_model_obj(**form.cleaned_data)
 
-            _ = CollectionGroup.services.factory.replace_groups(
+            CollectionGroup.services.factory.replace_groups(
                 request=request,
                 group_pks=dict(request.POST).get('groups'),
                 collection=collection,

django_spire/knowledge/collection/views/json_views.py

@@ -2,13 +2,17 @@ from __future__ import annotations
 
 import json
 
-from django.core.handlers.wsgi import WSGIRequest
+from typing import TYPE_CHECKING
+
 from django.http import JsonResponse
 
 from django_spire.core.decorators import valid_ajax_request_required
 from django_spire.core.shortcuts import get_object_or_null_obj
 from django_spire.knowledge.collection.models import Collection
 
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
 
 @valid_ajax_request_required
 def reorder_view(request: WSGIRequest) -> JsonResponse:

django_spire/knowledge/collection/views/page_views.py

@@ -1,14 +1,17 @@
 from __future__ import annotations
 
-from django.core.handlers.wsgi import WSGIRequest
 from django.shortcuts import get_object_or_404
-from django.template.response import TemplateResponse
 from django.urls import reverse
 
 from django_spire.auth.controller.controller import AppAuthController
 from django_spire.contrib import Breadcrumbs
 from django_spire.contrib.generic_views import portal_views
 from django_spire.knowledge.collection.models import Collection
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
 
 
 @AppAuthController('knowledge').permission_required('can_view')

django_spire/knowledge/entry/admin.py

@@ -1,11 +1,17 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from django.contrib import admin, messages
-from django.db.models import QuerySet
 from django.urls import reverse
 from django.utils.html import format_html
 from django.utils.http import urlencode
 
 from django_spire.knowledge.entry.models import Entry
 
+if TYPE_CHECKING:
+    from django.db.models import QuerySet
+
 
 @admin.register(Entry)
 class EntryAdmin(admin.ModelAdmin):

django_spire/knowledge/entry/forms.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django import forms
 
 from django_spire.knowledge.entry.models import Entry

django_spire/knowledge/entry/models.py

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

django_spire/knowledge/entry/seeding/seed.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
 from django_spire.knowledge.entry.seeding.seeder import EntrySeeder
 
+
 EntrySeeder.seed_database(count=50)

django_spire/knowledge/entry/services/automation_service.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
 
 import traceback
-from typing import TYPE_CHECKING
 
-import json
+from typing import TYPE_CHECKING
 
 from django_spire.contrib.service import BaseDjangoModelService
 from django_spire.core.decorators import close_db_connections
 from django_spire.knowledge.entry.version.block.models import EntryVersionBlock
-from django_spire.knowledge.exceptions import KnowledgeBaseConversionException
+from django_spire.knowledge.exceptions import KnowledgeBaseConversionError
 
 if TYPE_CHECKING:
     from django_spire.knowledge.entry.models import Entry
@@ -41,11 +40,13 @@ class EntryAutomationService(BaseDjangoModelService['Entry']):
                 file_object.set_deleted()
 
         message = f'Files Converted: {len(file_objects) - len(errored)}'
+
         if errored:
             error_string = f'\n{message}\nFiles Errored:'
+
             for error in errored:
                 error_string += f'    File Name: {error["file"]}\n    Error: {error["error"]}'
 
-            raise KnowledgeBaseConversionException(error_string)
+            raise KnowledgeBaseConversionError(error_string)
 
         return message

django_spire/knowledge/entry/services/factory_service.py

@@ -4,11 +4,11 @@ from typing import TYPE_CHECKING
 
 from django.contrib.contenttypes.models import ContentType
 
-from django_spire.auth.user.models import AuthUser
 from django_spire.contrib.service import BaseDjangoModelService
 from django_spire.file.models import File
 
 if TYPE_CHECKING:
+    from django_spire.auth.user.models import AuthUser
     from django_spire.knowledge.entry.models import Entry
     from django_spire.knowledge.collection.models import Collection
 
@@ -17,18 +17,20 @@ class EntryFactoryService(BaseDjangoModelService['Entry']):
     obj: Entry
 
     def create_from_files(
-            self,
-            author: AuthUser,
-            collection: Collection,
-            files: list[File],
+        self,
+        author: AuthUser,
+        collection: Collection,
+        files: list[File]
     ) -> list[Entry]:
         entries = []
+
         for file in files:
             entry, _ = self.obj_class.services.save_model_obj(
                 name=file.name,
                 author=author,
                 collection=collection
             )
+
             entries.append(entry)
 
             file.content_type = ContentType.objects.get_for_model(entry.__class__)

django_spire/knowledge/entry/services/service.py

@@ -2,21 +2,18 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from django_spire.auth.user.models import AuthUser
 from django_spire.contrib.ordering.services.service import OrderingService
 from django_spire.contrib.service import BaseDjangoModelService
-from django_spire.knowledge.entry.services.automation_service import \
-    EntryAutomationService
+from django_spire.knowledge.entry.services.automation_service import EntryAutomationService
 from django_spire.knowledge.entry.services.factory_service import EntryFactoryService
-from django_spire.knowledge.entry.services.processor_service import \
-    EntryProcessorService
+from django_spire.knowledge.entry.services.processor_service import EntryProcessorService
 from django_spire.knowledge.entry.services.tag_service import EntryTagService
 from django_spire.knowledge.entry.services.tool_service import EntryToolService
-from django_spire.knowledge.entry.services.transformation_services import \
-    EntryTransformationService
+from django_spire.knowledge.entry.services.transformation_services import EntryTransformationService
 from django_spire.knowledge.entry.version.models import EntryVersion
 
 if TYPE_CHECKING:
+    from django_spire.auth.user.models import AuthUser
     from django_spire.knowledge.entry.models import Entry
 
 

django_spire/knowledge/entry/services/tag_service.py

@@ -11,7 +11,6 @@ if TYPE_CHECKING:
     from django_spire.knowledge.entry.models import Entry
 
 
-
 class EntryTagService(BaseTagService['Entry']):
     obj: Entry
 

django_spire/knowledge/entry/services/tool_service.py

@@ -11,6 +11,7 @@ from django_spire.file.models import File
 
 if TYPE_CHECKING:
     from django.db.models import QuerySet
+
     from django_spire.knowledge.entry.models import Entry
 
 

django_spire/knowledge/entry/services/transformation_services.py

@@ -18,11 +18,7 @@ class EntryTransformationService(BaseDjangoModelService['Entry']):
 
     @staticmethod
     def queryset_to_navigation_list(queryset: QuerySet[Entry]) -> list[dict[str, str]]:
-        json_list = []
-        for entry in queryset:
-            json_list.append(entry.services.transformation.to_dict())
-
-        return json_list
+        return [entry.services.transformation.to_dict() for entry in queryset]
 
     def to_dict(self):
         site = Site.objects.get_current() if not settings.DEBUG else ''

django_spire/knowledge/entry/tests/factories.py

@@ -6,11 +6,10 @@ from django_spire.knowledge.entry.models import Entry
 
 def create_test_entry(**kwargs) -> Entry:
     data = {
-        'collection': create_test_collection(),
+        'collection': kwargs.pop('collection', None) or create_test_collection(),
         'name': 'Video Game Cheat Codes',
         'is_deleted': False,
         'is_active': True
     }
-
     data.update(kwargs)
     return Entry.objects.create(**data)

django_spire/knowledge/entry/tests/test_factory_service.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.knowledge.collection.tests.factories import create_test_collection
+from django_spire.knowledge.entry.models import Entry
+
+
+class EntryFactoryServiceTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.collection = create_test_collection()
+
+    def test_create_from_files_empty_list(self):
+        entries = Entry.services.factory.create_from_files(
+            author=self.super_user,
+            collection=self.collection,
+            files=[]
+        )
+        assert entries == []

django_spire/knowledge/entry/tests/test_models.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.knowledge.collection.tests.factories import create_test_collection
+from django_spire.knowledge.entry.tests.factories import create_test_entry
+
+
+class EntryModelTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.collection = create_test_collection()
+        self.entry = create_test_entry(collection=self.collection)
+
+    def test_str(self):
+        assert str(self.entry) == self.entry.name
+
+    def test_name_short_truncates(self):
+        long_name = 'A' * 100
+        entry = create_test_entry(name=long_name, collection=self.collection)
+        assert len(entry.name_short) <= 35
+
+    def test_name_short_no_truncate(self):
+        short_name = 'Short'
+        entry = create_test_entry(name=short_name, collection=self.collection)
+        assert entry.name_short == short_name
+
+    def test_top_level_collection(self):
+        child_collection = create_test_collection(
+            parent=self.collection,
+            name='Child Collection'
+        )
+        entry = create_test_entry(collection=child_collection)
+        assert entry.top_level_collection == self.collection
+
+    def test_top_level_collection_when_already_top(self):
+        assert self.entry.top_level_collection == self.collection
+
+    def test_base_breadcrumb(self):
+        breadcrumbs = self.entry.base_breadcrumb()
+        assert breadcrumbs is not None