django-spire 0.25.2__tar.gz → 0.26.0__tar.gz

{django_spire-0.25.2 → django_spire-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-spire
-Version: 0.25.2
+Version: 0.26.0
 Summary: A project for Django Spire
 Author-email: Brayden Carlson <braydenc@stratusadv.com>, Nathan Johnson <nathanj@stratusadv.com>
 License: Copyright (c) 2025 Stratus Advanced Technologies and Contributors.

django_spire-0.26.0/django_spire/auth/templates/django_spire/auth/element/android_and_chrome_app_install_element.html

@@ -0,0 +1,33 @@
+<div class="text-center">
+    <button id="android-install-button" class="btn btn-app-primary fs-4 mt-3" hidden>
+        Install App <i class="bi bi-file-arrow-down"></i>
+    </button>
+</div>
+
+<script type="application/javascript">
+    let android_install_prompt = null;
+    let android_install_button = document.querySelector("#android-install-button");
+
+    window.addEventListener("beforeinstallprompt", (event) => {
+        event.preventDefault();
+        android_install_prompt = event;
+        android_install_button.removeAttribute("hidden");
+    });
+
+    android_install_button.addEventListener("click", async () => {
+        if (!android_install_prompt) {
+            return;
+        }
+        const result = await android_install_prompt.prompt();
+        disableInAppInstallPrompt();
+    });
+
+    window.addEventListener("appinstalled", () => {
+        disableInAppInstallPrompt();
+    });
+
+    function disableInAppInstallPrompt() {
+        android_install_prompt = null;
+        android_install_button.setAttribute("hidden", "");
+    }
+</script>

django_spire-0.26.0/django_spire/auth/templates/django_spire/auth/element/ios_app_install_element.html

@@ -0,0 +1,48 @@
+{% load static %}
+
+<div class="text-center">
+    <button id="ios-install-button" class="btn btn-app-primary fs-4 mt-3" data-bs-toggle="modal" data-bs-target="#ios-install-app-modal" hidden>
+        Install App <i class="bi bi-file-arrow-down"></i>
+    </button>
+</div>
+
+<div class="modal fade" id="ios-install-app-modal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true" data-bs-theme="{{ theme.mode }}">
+    <div class="modal-dialog">
+        <div class="modal-content bg-app-layer-one">
+            <div class="modal-header">
+                <img
+                    src="{% block app_icon %}{% endblock %}"
+                    alt="No Image"
+                    class="border rounded-3 me-3 shadow"
+                    style=" height: 3.0rem; "
+                >
+                <span class="fs-5 fw-semibold">{% block app_title %}{% endblock %}</span>
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+            </div>
+            <div class="modal-body">
+                <p>Install the app on your Apple device to easily access it anytime by following the instructions below in the Safari Web Browser.</p>
+                <ol>
+                    <li class="p-2">Tap on the <span class="border border-2 p-1 rounded-3"><i class="bi bi-box-arrow-up"></i></span> in your browser bar</li>
+                    <li class="p-2">Select <span class="border border-2 p-1 rounded-3">Add to Home Screen</span></li>
+                    <li class="p-2">Click <span class="border border-2 p-1 rounded-3">Add</span> When Prompted</li>
+                </ol>
+                <p class="m-0">You will need to close this popup to complete the installation process</p>
+            </div>
+        </div>
+    </div>
+</div>
+
+<script type="application/javascript">
+    let ios_install_button = document.querySelector("#ios-install-button");
+
+    const isIos = () => {
+        const userAgent = window.navigator.userAgent.toLowerCase();
+        return /iphone|ipad|ipod/.test(userAgent);
+    }
+
+    const isInStandaloneMode = () => ('standalone' in window.navigator) && (window.navigator.standalone);
+
+    if (isIos() && !isInStandaloneMode()) {
+        ios_install_button.removeAttribute("hidden");
+    }
+</script>

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/auth/templates/django_spire/auth/page/auth_page.html

@@ -10,7 +10,8 @@
                     <div class="text-center pb-5">
                         <a href="/">
                             {% block authentication_page_img %}
-                                <img height="120px" class="ms-1" src="{% static 'img/django_spire.png' %}" alt="">
+                                <img height="120px" class="ms-1" src="{% static 'django_spire/img/django_spire.svg' %}"
+                                     alt="">
                             {% endblock %}
                         </a>
                     </div>

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/auth/templates/django_spire/auth/page/login_page.html

@@ -9,4 +9,6 @@
             Forgot my password
         </a>
     </div>
+    {% include 'django_spire/auth/element/android_and_chrome_app_install_element.html' %}
+    {% include 'django_spire/auth/element/ios_app_install_element.html' %}
 {% endblock %}

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/comment/mixins.py

@@ -3,17 +3,17 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 from django.contrib.contenttypes.fields import GenericRelation
-from django.db import models
 
 from django_spire.comment.models import Comment
+from django_spire.history.activity.mixins import ActivityMixin
 
 if TYPE_CHECKING:
     from django.contrib.auth.models import User
 
 
-class CommentModelMixin(models.Model):
+class CommentModelMixin(ActivityMixin):
     comments = GenericRelation(
-        'comment.Comment',
+        Comment,
         related_query_name='comment',
         editable=False
     )

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/comment/templates/django_spire/comment/card/comment_list_card.html

@@ -1,30 +1,33 @@
 {% extends 'django_spire/card/title_card.html' %}
 
 {% load permission_tags %}
+{% load model_tags %}
 
 {% block card_title %}
     Comments
 {% endblock %}
 
 {% block card_button %}
+    {% with app_label=obj|model_app_label model_name=obj|model_name %}
         {% check_permission user app_label model_name 'change' as has_access %}
         {% if has_access %}
             <span
-                @click="dispatch_modal_view('{% url "comment:form_content" obj_pk=obj.pk comment_pk=0 app_label=app_label model_name=model_name %}')"
+                    @click="dispatch_modal_view('{% url "django_spire:comment:form_content" obj_pk=obj.pk comment_pk=0 app_label=app_label model_name=model_name %}')"
             >
-                {% include 'button/primary_dark_button.html' with button_logo_only='bi bi-plus' %}
-            </span>
+                    {% include 'django_spire/button/primary_button.html' with button_text='Add' button_icon='bi bi-plus' %}
+                </span>
         {% endif %}
+    {% endwith %}
 {% endblock %}
 
 {% block card_title_content %}
     {% with obj.comments.active.prefetch_user as comments %}
         {% if comments %}
             {% for comment in comments %}
-                {% include 'comment/item/comment_item.html' %}
+                {% include 'django_spire/comment/item/comment_item.html' %}
             {% endfor %}
         {% else %}
-            {% include 'item/no_data_item.html' %}
+            {% include 'django_spire/item/no_data_item.html' %}
         {% endif %}
     {% endwith %}
 {% endblock %}

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/comment/templates/django_spire/comment/form/comment_form.html

@@ -1,18 +1,18 @@
 {% extends 'django_spire/modal/content/modal_title_content.html' %}
 
 {% block modal_content_title %}
-    Comment
+    {{ model_name }} Comment
 {% endblock %}
 
 {% block modal_content_content %}
     <form
-        action="{% url 'comment:form' comment_pk=comment.pk|default:0 obj_pk=obj_pk app_label=app_label model_name=model_name %}"
+            action="{% url 'django_spire:comment:form' comment_pk=comment.pk|default:0 obj_pk=obj_pk app_label=app_label model_name=model_name %}"
         method="post"
     >
         {% csrf_token %}
         {% include 'django_spire/comment/form/content/comment_form_content.html' %}
         <div class="pt-3">
-            {% include 'django_spire/contrib/form/form_submit_button.html' %}
+            {% include 'django_spire/contrib/form/button/form_submit_button.html' %}
         </div>
     </form>
 {% endblock %}

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/comment/templates/django_spire/comment/form/content/comment_form_content.html

@@ -4,6 +4,7 @@
             comment: new ModelObjectGlue('comment'),
             async init() {
                 await this.comment.get()
+                this.comment.glue_fields.information.label = 'Message'
             }
         }"
 >

django_spire-0.26.0/django_spire/comment/templates/django_spire/comment/item/comment_item_ellipsis.html

@@ -0,0 +1,26 @@
+{% extends 'django_spire/dropdown/ellipsis_dropdown.html' %}
+{% load spire_core_tags %}
+{% load model_tags %}
+
+{% block dropdown_content %}
+{#    {% include 'django_spire/comment/element/comment_edit_link.html' %}#}
+{#    {% if not is_child %}#}
+{#        {% include 'django_spire/comment/element/comment_reply_link.html' %}#}
+{#    {% endif %}#}
+
+    {#    {% url 'comment:delete_form' pk=comment.pk as delete_url %}#}
+
+    {% with app_label=obj|model_app_label model_name=obj|model_name %}
+        {% if comment.user_id == user.id %}
+            {% url 'django_spire:comment:form_content' comment_pk=comment.pk obj_pk=obj.pk app_label=app_label model_name=model_name as edit_url %}
+            {% include 'django_spire/dropdown/element/ellipsis_dropdown_modal_link_element.html' with link_text='Edit' view_url=edit_url %}
+        {% endif %}
+        {% if comment.user_id == user.id %}
+            {% url 'django_spire:comment:delete_form' comment_pk=comment.pk obj_pk=obj.pk app_label=app_label model_name=model_name as delete_url %}
+            {% include 'django_spire/dropdown/element/ellipsis_dropdown_modal_link_element.html' with link_text='Delete' link_css='text-danger' view_url=delete_url %}
+        {% endif %}
+    {% endwith %}
+{#    {% if comment.user_id == user.id %}#}
+{#        {% include 'django_spire/dropdown/element/dropdown_link_element.html' with link_text='Delete' link_css='text-danger' link_href=delete_url %}#}
+{#    {% endif %}#}
+{% endblock %}

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/comment/views.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+import django_glue as dg
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponseRedirect
@@ -9,15 +10,14 @@ from django.shortcuts import get_object_or_404
 from django.template.response import TemplateResponse
 from django.urls import reverse
 
+from django_spire.auth.group.utils import has_app_permission_or_404
 from django_spire.comment import models
 from django_spire.comment.forms import CommentForm
-from django_spire.core.redirect import safe_redirect_url
-from django_spire.core.shortcuts import get_object_or_null_obj, model_object_from_app_label
 from django_spire.contrib.form.utils import show_form_errors
-from django_spire.auth.group.utils import has_app_permission_or_404
 from django_spire.contrib.generic_views import dispatch_modal_delete_form_content
-
-import django_glue as dg
+from django_spire.core.redirect import safe_redirect_url
+from django_spire.core.shortcuts import get_object_or_null_obj, \
+    model_object_from_app_label
 
 if TYPE_CHECKING:
     from django.core.handlers.wsgi import WSGIRequest
@@ -112,7 +112,7 @@ def comment_modal_delete_form_view(
         messages.warning(request, 'You can only delete your comments.')
         return HttpResponseRedirect(return_url)
 
-    form_action = reverse('comment:delete_form', kwargs={
+    form_action = reverse('django_spire:comment:delete_form', kwargs={
         'comment_pk': comment_pk,
         'obj_pk': obj_pk,
         'app_label': app_label,
@@ -123,8 +123,7 @@ def comment_modal_delete_form_view(
         obj.add_activity(
             user=request.user,
             verb='deleted',
-            device=request.device,
-            information=f'{request.user.get_full_name()} deleted a comment on "{obj}".'
+            information=f'{request.user.get_full_name()} deleted a comment on "{obj}".',
         )
 
     return dispatch_modal_delete_form_content(
@@ -133,4 +132,5 @@ def comment_modal_delete_form_view(
         form_action=form_action,
         activity_func=add_activity,
         return_url=return_url,
+        show_success_message=True
     )

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.25.2'
+__VERSION__ = '0.26.0'
 
 MAINTENANCE_MODE_SETTINGS_NAME = 'MAINTENANCE_MODE'
 

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/contrib/form/utils.py

@@ -6,10 +6,10 @@ from django.contrib import messages
 
 if TYPE_CHECKING:
     from django.core.handlers.wsgi import WSGIRequest
-    from django.forms import Form
+    from django.forms import BaseForm
 
 
-def form_errors_as_list(form: Form) -> list[str]:
+def form_errors_as_list(form: BaseForm) -> list[str]:
     form_errors = []
 
     for field_name, error_list in form.errors.items():
@@ -34,7 +34,7 @@ def form_errors_as_list(form: Form) -> list[str]:
     return form_errors
 
 
-def show_form_errors(request: WSGIRequest, *forms: Form) -> None:
+def show_form_errors(request: WSGIRequest, *forms: BaseForm) -> None:
     for form in forms:
         for error in form_errors_as_list(form):
             messages.error(request=request, message=error)

django_spire-0.26.0/django_spire/contrib/queryset/filter_tools.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import Any
+
+from django.contrib.contenttypes.fields import GenericForeignKey
+from django.db.models import QuerySet, Field, ForeignObjectRel, ForeignKey
+
+
+def filter_by_lookup_map(
+    queryset: QuerySet,
+    lookup_map: dict,
+    data: dict,
+    extra_filters: dict | None = None
+):
+    """
+    Filters a given queryset based on a lookup map and provided data. Additional filters
+    can also be applied if provided.
+
+    :param queryset (QuerySet): The queryset to be filtered.
+    :param lookup_map (dict): A dictionary mapping input data keys to filtering fields in
+        the queryset.
+    :param data (dict): A dictionary containing key-value pairs to filter the queryset.
+    :param extra_filters (list | None): Optional. A list of extra positional filter
+        arguments to be applied. Defaults to None.
+
+    :returns: QuerySet: The filtered queryset.
+    """
+    if extra_filters is None:
+        extra_filters = {}
+
+    lookup_kwargs = {
+        lookup_map[k]: v
+        for k, v in data.items()
+        if k in lookup_map and v not in (None, "", [])
+    } | extra_filters
+
+    return queryset.filter(**lookup_kwargs)
+
+
+def _get_kwarg_name_for_filter_field(
+    field: Field[Any, Any] | ForeignObjectRel | GenericForeignKey,
+    val: Any
+) -> str:
+    """
+    Determines the appropriate keyword argument name for filtering based on the field type
+    and value type.
+
+    :param field (Field | ForeignObjectRel | GenericForeignKey): The model field to generate
+        the filter keyword argument for.
+    :param val (Any): The value to be used for filtering.
+
+    :returns: str: The keyword argument string suitable for filtering.
+    """
+    if isinstance(val, Sequence):
+        if isinstance(field, ForeignKey):
+            return f'{field.name}_id__in'
+        return f'{field.name}__in'
+    else:
+        return field.name
+
+
+def filter_by_model_fields(queryset: QuerySet, data: dict) -> QuerySet:
+    """
+    Filters a given queryset based on the queryset's model fields and provided data.
+
+    :param queryset (QuerySet): The queryset to be filtered.
+    :param data (dict): A dictionary containing key-value pairs to filter the queryset.
+
+    :returns: QuerySet: The filtered queryset.
+    """
+    model_fields = [f for f in queryset.model._meta.get_fields()]
+
+    lookup_kwargs = {
+        _get_kwarg_name_for_filter_field(
+            field=model_field,
+            val=data[model_field.name]
+        ): data[model_field.name]
+        for model_field in model_fields
+        if model_field.name in data and data[model_field.name] not in (None, "", [])
+    }
+
+    return queryset.filter(**lookup_kwargs)

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/contrib/queryset/mixins.py

@@ -5,7 +5,7 @@ import json
 from abc import abstractmethod
 from typing import TYPE_CHECKING
 
-from django.db.models import QuerySet
+from django.db.models import QuerySet, Q
 from django_spire.contrib.form.utils import show_form_errors
 from django_spire.contrib.queryset.enums import SessionFilterActionEnum
 from django_spire.contrib.session.controller import SessionController
@@ -67,6 +67,27 @@ class SessionFilterQuerySetMixin(QuerySet):
 
 
 class SearchQuerySetMixin(QuerySet):
-    @abstractmethod
     def search(self, value: str | None) -> QuerySet:
-        pass
+        words = value.split(' ')
+
+        filtered_query = self
+
+        char_fields = [
+            field.name for field in self.model._meta.fields
+            if field.get_internal_type() == 'CharField'
+        ]
+
+        for word in words:
+            or_conditions = Q()
+            for field in char_fields:
+                or_conditions |= Q(**{f"{field}__icontains": word})
+            filtered_query = filtered_query.filter(or_conditions)
+
+        return filtered_query
+
+
+class ChoicesQueryMixin(QuerySet):
+    def to_choices(self):
+        return [
+            (obj.pk, str(obj)) for obj in self
+        ]

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/contrib/service/django_model_service.py

@@ -1,20 +1,19 @@
 from __future__ import annotations
 
 import logging
-
 from abc import ABC
 from itertools import chain
 from typing import Generic, TypeVar
 
-from django.contrib.contenttypes.fields import GenericForeignKey
+from django.contrib.auth.models import User
 from django.db import transaction
-from django.db.models import Model, Field, AutoField, ForeignObjectRel, FileField
+from django.db.models import Model, AutoField, FileField
 
-from django_spire.contrib.constructor.django_model_constructor import BaseDjangoModelConstructor
+from django_spire.contrib.constructor.django_model_constructor import \
+    BaseDjangoModelConstructor
 from django_spire.contrib.service.exceptions import ServiceError
 
 
-
 log = logging.getLogger(__name__)
 
 TypeDjangoModel_co = TypeVar('TypeDjangoModel_co', bound=Model, covariant=True)
@@ -82,7 +81,7 @@ class BaseDjangoModelService(
         then it calls self.obj.save(), then updates the m2m fields on the object instance
         using logic similar to django's `BaseModelForm._save_m2m()` method. In all cases,
         it treats the incoming `field_data` exactly the same as `cleaned_data` is treated
-        in the django code that it is emulating, and therefore does not perform any validation 
+        in the django code that it is emulating, and therefore does not perform any validation
         on the data or the model instance as it is assumed that field_data has already been validated upstream.
 
         Args:

{django_spire-0.25.2 → django_spire-0.26.0}/django_spire/core/management/commands/spire_startapp.py

@@ -11,8 +11,7 @@ from django_spire.core.management.commands.spire_startapp_pkg.config import (
 )
 from django_spire.core.management.commands.spire_startapp_pkg.filesystem import FileSystem
 from django_spire.core.management.commands.spire_startapp_pkg.generator import (
-    AppGenerator,
-    # TemplateGenerator,
+    AppGenerator, TemplateGenerator,
 )
 from django_spire.core.management.commands.spire_startapp_pkg.processor import (
     TemplateEngine,
@@ -70,11 +69,19 @@ class Command(BaseCommand):
         template_builder = TemplateBuilder(reporter)
 
         app_generator = AppGenerator(filesystem, template_processor, reporter, path_config)
-        # template_generator = TemplateGenerator(filesystem, template_processor, reporter, path_config)
+        template_generator = TemplateGenerator(filesystem, template_processor, reporter,
+                                               path_config)
 
         user_inputs = user_input_collector.collect_all_inputs()
         app_path = user_inputs['app_path']
 
+        skip_app_generation = user_inputs['skip_app_generation']
+        skip_template_generation = user_inputs['skip_template_generation']
+
+        if skip_app_generation and skip_template_generation:
+            reporter.write('Skipped file generation.', reporter.style_notice)
+            return
+
         validator.validate_app_format(app_path)
 
         config = config_factory.create_config(app_path, user_inputs)
@@ -85,34 +92,44 @@ class Command(BaseCommand):
             reporter.style_notice
         )
 
-        missing = registry.get_missing_components(config.components)
+        if not skip_app_generation:
+            missing = registry.get_missing_components(config.components)
+
+            if missing:
+                reporter.report_missing_components(missing)
+
+                template_builder.build_app_tree_structure(
+                    path_resolver.get_base_dir(),
+                    config.components,
+                    registry.get_installed_apps(),
+                    path_config.app_template
+                )
+
+                if reporter.prompt_confirmation('\nProceed with app creation? (y/n): '):
+                    for module in [missing[-1]]:
+                        module_config = config_factory.create_config(module,
+                                                                     user_inputs)
 
-        if missing:
-            reporter.report_missing_components(missing)
+                    app_generator.generate(module_config)
 
-            template_builder.build_app_tree_structure(
+                    reporter.report_installed_apps_suggestion(missing)
+                else:
+                    reporter.write('Skipping app creation.', reporter.style_notice)
+
+            else:
+                reporter.write('All component(s) exist.', reporter.style_success)
+
+        if not skip_template_generation:
+            template_builder.build_html_tree_structure(
                 path_resolver.get_base_dir(),
                 config.components,
                 registry.get_installed_apps(),
-                path_config.app_template
+                path_config.html_template
             )
 
-            # template_builder.build_html_tree_structure(
-            #     path_resolver.get_base_dir(),
-            #     config.components,
-            #     registry.get_installed_apps(),
-            #     path_config.html_template
-            # )
-
-            if not reporter.prompt_confirmation('\nProceed with app creation? (y/n): '):
-                reporter.write('App creation aborted.', reporter.style_error)
+            if not reporter.prompt_confirmation(
+                    '\nProceed with template creation? (y/n): '):
+                reporter.write('Skipping template creation.', reporter.style_notice)
                 return
 
-            for module in [missing[-1]]:
-                module_config = config_factory.create_config(module, user_inputs)
-                app_generator.generate(module_config)
-                # template_generator.generate(module_config)
-
-            reporter.report_installed_apps_suggestion(missing)
-        else:
-            reporter.write('All component(s) exist.', reporter.style_success)
+            template_generator.generate(config)

django_spire-0.26.0/django_spire/core/management/commands/spire_startapp_pkg/exceptions.py

@@ -0,0 +1,5 @@
+from django.core.management import CommandError
+
+
+class AppExistsError(CommandError):
+    pass