django-spire 0.16.13__py3-none-any.whl → 0.17.1__py3-none-any.whl

django_spire/core/management/commands/spire_startapp_pkg/template/app/seeding/seed.py.template

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from ${module_path}.seeding.seeder import ${seeder_class_name}
+
+
+${seeder_class_name}.seed_database(count=10)

django_spire/core/management/commands/spire_startapp_pkg/template/app/seeding/seeder.py.template

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.seeding import DjangoModelSeeder
+
+from ${module_path} import models
+
+if TYPE_CHECKING:
+    from typing import ClassVar
+
+
+class ${seeder_class_name}(DjangoModelSeeder):
+    """https://django-spire.stratusadv.com/app_guides/seeding/overview/"""
+
+    model_class = models.${model_class_name}
+    default_to = 'faker'
+
+    fields: ClassVar = {
+        'id': 'exclude',
+        'created_datetime': 'exclude',
+        'is_active': True,
+        'is_deleted': False,
+        # 'name': ('faker', 'company'),
+        # 'status': ('faker'),
+    }

django_spire/core/management/commands/spire_startapp_pkg/template/app/services/factory_service.py.template

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.service import BaseDjangoModelService
+
+if TYPE_CHECKING:
+    from ${module_path}.models import ${model_class_name}
+
+
+class ${factory_service_class_name}(BaseDjangoModelService['${model_class_name}']):
+    obj: ${model_class_name}

django_spire/core/management/commands/spire_startapp_pkg/template/app/services/intelligence_service.py.template

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.service import BaseDjangoModelService
+
+if TYPE_CHECKING:
+    from ${module_path}.models import ${model_class_name}
+
+
+class ${intelligence_service_class_name}(BaseDjangoModelService['${model_class_name}']):
+    obj: ${model_class_name}

django_spire/core/management/commands/spire_startapp_pkg/template/app/services/processor_service.py.template

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.service import BaseDjangoModelService
+
+if TYPE_CHECKING:
+    from ${module_path}.models import ${model_class_name}
+
+
+class ${processor_service_class_name}(BaseDjangoModelService['${model_class_name}']):
+    obj: ${model_class_name}

django_spire/core/management/commands/spire_startapp_pkg/template/app/services/service.py.template

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.service import BaseDjangoModelService
+
+from ${module_path}.services.factory_service import ${factory_service_class_name}
+from ${module_path}.services.intelligence_service import ${intelligence_service_class_name}
+from ${module_path}.services.processor_service import ${processor_service_class_name}
+from ${module_path}.services.transformation_service import ${transformation_service_class_name}
+
+if TYPE_CHECKING:
+    from ${module_path}.models import ${model_class_name}
+
+
+class ${service_class_name}(BaseDjangoModelService['${model_class_name}']):
+    obj: ${model_class_name}
+
+    intelligence = ${intelligence_service_class_name}()
+    processor = ${processor_service_class_name}()
+    factory = ${factory_service_class_name}()
+    transformation = ${transformation_service_class_name}()

django_spire/core/management/commands/spire_startapp_pkg/template/app/services/transformation_service.py.template

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.service import BaseDjangoModelService
+
+if TYPE_CHECKING:
+    from ${module_path}.models import ${model_class_name}
+
+
+class ${transformation_service_class_name}(BaseDjangoModelService['${model_class_name}']):
+    obj: ${model_class_name}

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_intelligence/test_bots.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${bot_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_models.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${model_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_services/test_factory_service.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${factory_service_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_services/test_intelligence_service.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${intelligence_service_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_services/test_processor_service.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${processor_service_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_services/test_service.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${service_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_services/test_transformation_service.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${transformation_service_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_urls/test_form_urls.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${url_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_urls/test_page_urls.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${url_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_views/test_form_views.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${view_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/tests/test_views/test_page_views.py.template

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class ${view_test_class_name}(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()

django_spire/core/management/commands/spire_startapp_pkg/template/app/urls/__init__.py.template

@@ -0,0 +1,9 @@
+from django.urls.conf import include, path
+
+
+app_name = '${url_namespace}'
+
+urlpatterns = [
+    path('page/', include('${module_path}.urls.page_urls', namespace='page')),
+    path('form/', include('${module_path}.urls.form_urls', namespace='form')),
+]

django_spire/core/management/commands/spire_startapp_pkg/template/app/urls/form_urls.py.template

@@ -0,0 +1,15 @@
+from django.urls import path
+
+from ${module_path}.views import form_views
+
+
+app_name = 'form'
+
+urlpatterns = [
+    path('create/', form_views.${create_form_view_name}, name='create'),
+    path('<int:pk>/update/', form_views.${update_form_view_name}, name='update'),
+    path('<int:pk>/delete/', form_views.${delete_form_view_name}, name='delete'),
+    path('create/modal/', form_views.${create_modal_form_view_name}, name='create_modal'),
+    path('<int:pk>/update/modal/', form_views.${update_modal_form_view_name}, name='update_modal'),
+    path('<int:pk>/delete/modal/', form_views.${delete_modal_form_view_name}, name='delete_modal'),
+]

django_spire/core/management/commands/spire_startapp_pkg/template/app/urls/page_urls.py.template

@@ -0,0 +1,11 @@
+from django.urls import path
+
+from ${module_path}.views import page_views
+
+
+app_name = 'page'
+
+urlpatterns = [
+    path('list/', page_views.${list_page_view_name}, name='list'),
+    path('<int:pk>/detail/', page_views.${detail_page_view_name}, name='detail'),
+]

django_spire/core/management/commands/spire_startapp_pkg/template/app/views/form_views.py.template

@@ -0,0 +1,134 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.decorators import permission_required
+from django.shortcuts import get_object_or_404, redirect
+from django.template.response import TemplateResponse
+from django.urls import reverse
+
+from django_spire.contrib.form.utils import show_form_errors
+from django_spire.contrib.generic_views import modal_views, portal_views
+from django_spire.core.redirect.safe_redirect import safe_redirect_url
+from django_spire.core.shortcuts import get_object_or_null_obj
+from django_spire.history.activity.utils import add_form_activity
+
+import django_glue as dg
+
+from ${module_path} import forms, models
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.http import HttpResponseRedirect
+
+
+@permission_required('${permission_prefix}.delete_${model_instance_name}')
+def ${delete_modal_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    form_action = reverse(
+        '${url_reverse_path}:form:delete_modal',
+        kwargs={'pk': pk}
+    )
+
+    def add_activity() -> None:
+        ${context_single_var}.add_activity(
+            user=request.user,
+            verb='deleted',
+            device=request.device,
+            information=f'{request.user.get_full_name()} deleted a ${model_instance_name}.'
+        )
+
+    fallback = reverse('${url_reverse_path}:page:list')
+    return_url = safe_redirect_url(request, fallback=fallback)
+
+    return modal_views.dispatch_modal_delete_form_content(
+        request,
+        obj=${context_single_var},
+        form_action=form_action,
+        activity_func=add_activity,
+        return_url=return_url,
+    )
+
+
+@permission_required('${permission_prefix}.delete_${model_instance_name}')
+def ${delete_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    return_url = request.GET.get(
+        'return_url',
+        reverse('${url_reverse_path}:page:list')
+    )
+
+    return portal_views.delete_form_view(
+        request,
+        obj=${context_single_var},
+        return_url=return_url
+    )
+
+
+@permission_required('${permission_prefix}.add_${model_instance_name}')
+def ${create_modal_form_view_name}(request: WSGIRequest) -> TemplateResponse:
+    return _modal_form_view(request)
+
+
+@permission_required('${permission_prefix}.change_${model_instance_name}')
+def ${update_modal_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    return _modal_form_view(request, pk)
+
+
+def _modal_form_view(request: WSGIRequest, pk: int = 0) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    dg.glue_model_object(request, '${glue_model_key}', ${context_single_var})
+
+    context_data = {
+        '${context_single_var}': ${context_single_var}
+    }
+
+    return TemplateResponse(
+        request,
+        context=context_data,
+        template='${template_directory_path}/modal/content/${form_template_name}'
+    )
+
+
+@permission_required('${permission_prefix}.add_${model_instance_name}')
+def ${create_form_view_name}(request: WSGIRequest) -> TemplateResponse:
+    return _form_view(request)
+
+
+@permission_required('${permission_prefix}.change_${model_instance_name}')
+def ${update_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    return _form_view(request, pk)
+
+
+def _form_view(request: WSGIRequest, pk: int = 0) -> TemplateResponse|HttpResponseRedirect:
+    ${context_single_var} = get_object_or_null_obj(models.${model_class_name}, pk=pk)
+
+    dg.glue_model_object(request, '${glue_model_key}', ${context_single_var}, 'view')
+
+    if request.method == 'POST':
+        form = forms.${form_class_name}(request.POST, instance=${context_single_var})
+
+        if form.is_valid():
+            ${context_single_var} = form.save()
+            add_form_activity(${context_single_var}, pk, request.user)
+
+            return redirect(
+                request.GET.get(
+                    'return_url',
+                    reverse('${url_reverse_path}:page:list')
+                )
+            )
+
+        show_form_errors(request, form)
+    else:
+        form = forms.${form_class_name}(instance=${context_single_var})
+
+    return portal_views.form_view(
+        request,
+        form=form,
+        obj=${context_single_var},
+        template='${template_directory_path}/page/${form_page_template_name}'
+    )

django_spire/core/management/commands/spire_startapp_pkg/template/app/views/page_views.py.template

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.decorators import permission_required
+from django.shortcuts import get_object_or_404
+
+from django_spire.contrib.generic_views import portal_views
+
+from ${module_path} import models
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
+
+@permission_required('${permission_prefix}.view_${model_instance_name}')
+def ${detail_page_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    context_data = {
+        '${context_single_var}': ${context_single_var},
+    }
+
+    return portal_views.detail_view(
+        request,
+        obj=${context_single_var},
+        context_data=context_data,
+        template='${template_directory_path}/page/${detail_page_template_name}'
+    )
+
+
+@permission_required('${permission_prefix}.view_${model_instance_name}')
+def ${list_page_view_name}(request: WSGIRequest) -> TemplateResponse:
+    context_data = {
+        '${context_plural_var}': models.${model_class_name}.objects.all()
+    }
+
+    return portal_views.list_view(
+        request,
+        model=models.${model_class_name},
+        context_data=context_data,
+        template='${template_directory_path}/page/${list_page_template_name}'
+    )

django_spire/core/management/commands/spire_startapp_pkg/template/templates/card/{spirechildapp_detail_card.html → ${detail_card_template_name}.html.template}

@@ -1,24 +1,24 @@
 {% extends 'django_spire/card/title_card.html' %}
 
 {% block card_title %}
-	spire_model_name
+    ${model_verbose_name}
 {% endblock %}
 
 {% block card_button %}
-	{% if perms.spire_label_path.change_spire_app_name %}
-        {% url 'spire_parent_app:spire_app_name:page:form' pk=spire_app_name.pk as spire_app_name_edit_url %}
-        {% include 'django_spire/button/primary_dark_button.html' with button_text='Edit' button_icon='bi bi-pencil' button_href=spire_app_name_edit_url %}
+    {% if perms.${permission_prefix}.change_${model_instance_name} %}
+        {% url '${url_reverse_path}:form:update' pk=${context_single_var}.pk as ${context_single_var}_edit_url %}
+        {% include 'django_spire/button/primary_dark_button.html' with button_text='Edit' button_icon='bi bi-pencil' button_href=${context_single_var}_edit_url %}
     {% endif %}
 {% endblock %}
 
 {% block card_title_content %}
-	<div class="row g-3">
+    <div class="row g-3">
         <div class="col-12">
-            {% include 'django_spire/element/attribute_element.html' with attribute_title='Name' attribute_value=spire_app_name.name %}
+            {% include 'django_spire/element/attribute_element.html' with attribute_title='Name' attribute_value=${context_single_var}.name %}
         </div>
 
         <div class="col-12">
-            {% include 'django_spire/element/attribute_element.html' with attribute_title='Description' attribute_value=spire_app_name.description|linebreaksbr %}
+            {% include 'django_spire/element/attribute_element.html' with attribute_title='Description' attribute_value=${context_single_var}.description|linebreaksbr %}
         </div>
     </div>
 {% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/card/{spirechildapp_form_card.html → ${form_card_template_name}.html.template}

@@ -1,9 +1,9 @@
 {% extends 'django_spire/card/title_card.html' %}
 
 {% block card_title %}
-	spire_model_name
+    ${model_verbose_name}
 {% endblock %}
 
 {% block card_title_content %}
-	{% include 'spire_parent_app/spire_app_name/form/spire_app_name_form.html' %}
+    {% include '${template_directory_path}/form/${form_template_name}' %}
 {% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/card/${list_card_template_name}.html.template

@@ -0,0 +1,18 @@
+{% extends 'django_spire/card/title_card.html' %}
+
+{% block card_title %}
+    ${model_verbose_name_plural}
+{% endblock %}
+
+{% block card_button %}
+    {% url '${url_reverse_path}:form:create' as new_${context_single_var}_url %}
+    {% include 'django_spire/button/primary_dark_button.html' with button_text='Add' button_icon='bi bi-plus' button_href=new_${context_single_var}_url %}
+{% endblock %}
+
+{% block card_title_content %}
+    {% for ${context_single_var} in ${context_plural_var} %}
+        {% include '${template_directory_path}/item/${item_template_name}' %}
+    {% empty %}
+        {% include 'django_spire/item/no_data_item.html' %}
+    {% endfor %}
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/form/{spirechildapp_form.html → ${form_template_name}.html.template}

@@ -1,20 +1,20 @@
 <div
     x-data="{
         async init() {
-            await this.placeholder.get()
+            await this.${glue_model_key}.get()
         },
-        placeholder: new ModelObjectGlue('placeholder')
+        ${glue_model_key}: new ModelObjectGlue('${glue_model_key}')
     }"
 >
     {% include 'django_spire/element/divider_element.html' with divider_title='Details' %}
 
     <div class="row g-3 mb-3">
         <div class="col-12">
-            {% include 'django_glue/form/field/char_field.html' with glue_model_field='placeholder.name' %}
+            {% include 'django_glue/form/field/char_field.html' with glue_model_field='${glue_model_key}.name' %}
         </div>
 
         <div class="col-12">
-            {% include 'django_glue/form/field/text_field.html' with glue_model_field='placeholder.description' %}
+            {% include 'django_glue/form/field/text_field.html' with glue_model_field='${glue_model_key}.description' %}
         </div>
     </div>
 </div>

django_spire/core/management/commands/spire_startapp_pkg/template/templates/item/${item_template_name}.html.template

@@ -0,0 +1,24 @@
+{% extends 'django_spire/item/item.html' %}
+
+{% block item_title %}
+    {% url '${url_reverse_path}:page:detail' pk=${context_single_var}.pk as ${context_single_var}_view_url %}
+    {% include 'django_spire/element/attribute_element.html' with attribute_title='${model_verbose_name}' attribute_value=${context_single_var}.name attribute_href=${context_single_var}_view_url %}
+{% endblock %}
+
+{% block item_row_content %}
+    {% include 'django_spire/element/attribute_element.html' with attribute_title='Description' attribute_value=${context_single_var}.description %}
+{% endblock %}
+
+{% block item_button %}
+    {% url '${url_reverse_path}:page:detail' pk=${context_single_var}.pk as ${context_single_var}_view_url %}
+
+    {% if perms.${permission_prefix}.change_${model_instance_name} %}
+        {% url '${url_reverse_path}:form:update' pk=${context_single_var}.pk as ${context_single_var}_edit_url %}
+    {% endif %}
+
+    {% if perms.${permission_prefix}.delete_${model_instance_name} %}
+        {% url '${url_reverse_path}:form:delete' pk=${context_single_var}.pk as ${context_single_var}_delete_url %}
+    {% endif %}
+
+    {% include 'django_spire/dropdown/ellipsis_dropdown.html' with view_url=${context_single_var}_view_url edit_url=${context_single_var}_edit_url delete_url=${context_single_var}_delete_url %}
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/page/{spirechildapp_detail_page.html → ${detail_page_template_name}.html.template}

@@ -1,13 +1,13 @@
 {% extends 'django_spire/page/full_page.html' %}
 
 {% block page_content %}
-	<div class="row g-3">
+    <div class="row g-3">
         <div class="col-12">
-            {% include 'spire_parent_app/spire_app_name/card/spire_app_name_detail_card.html' %}
+            {% include '${template_directory_path}/card/${detail_card_template_name}' %}
         </div>
 
         <div class="col-4">
-            {% include 'history/card/activity_list_card.html' with activity_log=spire_app_name.activity_log.prefetch_user %}
+            {% include 'history/card/activity_list_card.html' with activity_log=${context_single_var}.activity_log.prefetch_user %}
         </div>
     </div>
 {% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/page/{spirechildapp_form_page.html → ${form_page_template_name}.html.template}

@@ -6,7 +6,7 @@
 
         <div class="row g-3">
             <div class="col-12">
-                {% include 'placeholder/card/placeholder_form_card.html' %}
+                {% include '${template_directory_path}/card/${form_card_template_name}' %}
             </div>
         </div>
     </form>

django_spire/core/management/commands/spire_startapp_pkg/template/templates/page/{spirechildapp_list_page.html → ${list_page_template_name}.html.template}

@@ -1,9 +1,9 @@
 {% extends 'django_spire/page/full_page.html' %}
 
 {% block page_content %}
-	<div class="row">
+    <div class="row">
         <div class="col-12">
-            {% include 'placeholder/card/placeholder_list_card.html' %}
+            {% include '${template_directory_path}/card/${list_card_template_name}' %}
         </div>
     </div>
 {% endblock %}