django-spire 0.23.12__py3-none-any.whl → 0.23.13__py3-none-any.whl

django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.23.12'
+__VERSION__ = '0.23.13'
 
 MAINTENANCE_MODE_SETTINGS_NAME = 'MAINTENANCE_MODE'
 

django_spire/contrib/generic_views/modal_views.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from django.contrib import messages
 from django.http import HttpResponseRedirect
 from django.template.response import TemplateResponse
 
@@ -26,7 +27,8 @@ def dispatch_modal_delete_form_content(
     # Present and past tense of verb
     verbs: tuple[str, str] = ('delete', 'deleted'),
     return_url: str | None = None,
-    template: str = 'django_spire/modal/content/dispatch_modal_delete_confirmation_content.html'
+    template: str = 'django_spire/modal/content/dispatch_modal_delete_confirmation_content.html',
+    show_success_message: bool = False
 ) -> HttpResponseRedirect | TemplateResponse:
     if context_data is None:
         context_data = {}
@@ -45,6 +47,9 @@ def dispatch_modal_delete_form_content(
                 auto_add_activity=auto_add_activity
             )
 
+            if show_success_message:
+                messages.success(request, f'Successfully deleted {model_name}.')
+
         else:
             show_form_errors(request, form)
 

django_spire/core/static/django_spire/css/app-import.css

@@ -10,4 +10,9 @@
 @import url('app-side-panel.css');
 @import url('app-text.css');
 @import url('app-template.css');
+
+/* Must be Second to Last */
 @import url('app-override.css');
+
+/* Must be at the Bottom */
+@import url('app-printing.css');

django_spire/core/static/django_spire/css/app-printing.css

@@ -0,0 +1,31 @@
+@media print {
+    .hide-on-print {
+        display: none !important;
+    }
+
+    @page {
+        margin: 1cm !important;
+    }
+
+    div {
+        page-break-inside: auto !important;
+    }
+
+    .page-break-before {
+        page-break-before: always !important;
+        display: block;
+        height: 1px;
+        clear: both;
+    }
+
+    .table-hover > tbody > tr:hover > * {
+        --bs-table-bg-state: var(--app-table-row-color) !important;
+        background-color: var(--app-table-row-color) !important;
+        color: var(--app-default-text-color) !important;
+    }
+
+}
+
+.table-print {
+    font-family: monospace !important;
+}

django_spire/core/static/django_spire/css/bootstrap-extension.css

@@ -188,11 +188,23 @@ h1, h2, h3, h4, h5, h6 {
 }
 
 .fs--2 {
-    font-size: .75rem !important;
+    font-size: .70rem !important;
+}
+
+.fs--3 {
+    font-size: .55rem !important;
 }
 
 .fs-7 {
-    font-size: .85rem !important;
+    font-size: .80rem !important;
+}
+
+.fs-8 {
+    font-size: .70rem !important;
+}
+
+.fs-8 {
+    font-size: .55rem !important;
 }
 
 .fw-400 {

django_spire/core/tag/mixins.py

@@ -7,7 +7,7 @@ from django_spire.core.tag.tools import simplify_and_weight_tag_set_to_dict, sim
 
 
 class TagModelMixin(models.Model):
-    tags = models.ManyToManyField(Tag, related_name='+', null=True, blank=True, editable=False)
+    tags = models.ManyToManyField(Tag, related_name='+', blank=True, editable=False)
 
     class Meta:
         abstract = True

django_spire/core/templates/django_spire/page/full_page.html

@@ -149,14 +149,14 @@
             }
         }"
     >
-        <div class="d-none d-lg-block pe-1 side-navigation">
+        <div class="d-none d-lg-block pe-1 side-navigation hide-on-print">
             {% block full_page_side_navigation %}
                 {% include 'django_spire/navigation/side_navigation.html' %}
             {% endblock %}
         </div>
 
         <div class="container-fluid d-flex flex-column">
-            <div class="row sticky-top">
+            <div class="row sticky-top hide-on-print">
                 <div class="col-12">
                     {% block full_page_top_navigation %}
                         {% include 'django_spire/navigation/top_navigation.html' %}

django_spire/core/templates/django_spire/table/base.html

@@ -141,7 +141,7 @@
 {% block scroll_container %}
     <div
         class="position-relative table-container flex-grow-1"
-        style="min-height: 200px; overflow-x: auto; overflow-y: auto; overscroll-behavior: contain; -webkit-overflow-scrolling: touch;"
+        style="min-height: {{ table_height|default:'200px;' }} overflow-x: auto; overflow-y: auto; overscroll-behavior: contain; -webkit-overflow-scrolling: touch;"
         x-ref="scroll_container"
         :data-table-id="table_id"
     >

django_spire/core/templates/django_spire/table/element/row.html

@@ -74,23 +74,27 @@
     @select-all-rows.window="handle_select_all_rows($event)"
     @toggle-row-state.window="handle_toggle_row_state($event)"
 >
-    <td>
-        <input
-            :checked="is_checked"
-            @change="handle_checkbox_change()"
-            type="checkbox"
-        >
-    </td>
+    {% block table_checkbox %}
+        <td>
+            <input
+                :checked="is_checked"
+                @change="handle_checkbox_change()"
+                type="checkbox"
+            >
+        </td>
+    {% endblock %}
 
-    <td>
-        <template x-if="has_children">
-            <i
-                :class="is_open ? 'bi-chevron-down' : 'bi-chevron-right'"
-                @click="$dispatch('toggle-row', { row_id: row_id, table_id: table_id })"
-                class="bi cursor-pointer"
-            ></i>
-        </template>
-    </td>
+    {% block table_child_toggle %}
+        <td>
+            <template x-if="has_children">
+                <i
+                    :class="is_open ? 'bi-chevron-down' : 'bi-chevron-right'"
+                    @click="$dispatch('toggle-row', { row_id: row_id, table_id: table_id })"
+                    class="bi cursor-pointer"
+                ></i>
+            </template>
+        </td>
+    {% endblock %}
 
     {% block table_cell %}{% endblock %}
 </tr>

django_spire/knowledge/migrations/0009_alter_collection_tags_alter_entry_tags.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.2.8 on 2026-01-11 18:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_core', '0001_initial'),
+        ('django_spire_knowledge', '0008_collection_tags_entry_tags'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='collection',
+            name='tags',
+            field=models.ManyToManyField(blank=True, editable=False, related_name='+', to='django_spire_core.tag'),
+        ),
+        migrations.AlterField(
+            model_name='entry',
+            name='tags',
+            field=models.ManyToManyField(blank=True, editable=False, related_name='+', to='django_spire_core.tag'),
+        ),
+    ]

django_spire/metric/apps.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+from django_spire.utils import check_required_apps
+
+
+class MetricConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'metric'
+    name = 'django_spire.metric'
+
+    REQUIRED_APPS = ('django_spire_core',)
+
+    URLPATTERNS_INCLUDE = 'django_spire.metric.urls'
+    URLPATTERNS_NAMESPACE = 'metric'
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire/metric/report/admin.py

@@ -0,0 +1,8 @@
+from django_spire.metric.report.models import ReportRun
+from django.contrib import admin
+
+
+@admin.register(ReportRun)
+class ReportRunAdmin(admin.ModelAdmin):
+    list_display = ('id', 'report_key_stack_verbose', 'datetime')
+    ordering = ('-datetime',)

django_spire/metric/report/apps.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+from django_spire.utils import check_required_apps
+
+
+class ReportConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'django_spire_metric_report'
+    name = 'django_spire.metric.report'
+
+    MODEL_PERMISSIONS = (
+        {
+            'name': 'report',
+            'verbose_name': 'Report',
+            'model_class_path': 'django_spire.metric.report.models.ReportRun',
+            'is_proxy_model': False,
+        },
+    )
+
+    REQUIRED_APPS = ('django_spire_core',)
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire/metric/report/auth/controller.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from django_spire.auth.controller.controller import BaseAuthController
+
+
+class BaseReportAuthController(BaseAuthController):
+    def can_add(self):
+        return self.request.user.has_perm('django_spire_metric_report.add_reportrun')
+
+    def can_change(self):
+        return self.request.user.has_perm('django_spire_metric_report.change_reportrun')
+
+    def can_delete(self):
+        return self.request.user.has_perm('django_spire_metric_report.delete_reportrun')
+
+    def can_view(self):
+        return self.request.user.has_perm('django_spire_metric_report.view_reportrun')

django_spire/metric/report/auth/tests/test_controller.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+from django.contrib.auth.models import Permission
+from django.contrib.contenttypes.models import ContentType
+from django.test import RequestFactory
+
+from django_spire.auth.user.tests.factories import create_user
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.metric.report.auth.controller import BaseReportAuthController
+from django_spire.metric.report.models import ReportRun
+
+
+class BaseReportAuthControllerTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.factory = RequestFactory()
+        self.user = create_user(username='test_auth_user')
+        self.request = self.factory.get('/')
+        self.request.user = self.user
+
+        content_type = ContentType.objects.get_for_model(ReportRun)
+
+        self.view_permission = Permission.objects.get(
+            codename='view_reportrun',
+            content_type=content_type
+        )
+        self.add_permission = Permission.objects.get(
+            codename='add_reportrun',
+            content_type=content_type
+        )
+        self.change_permission = Permission.objects.get(
+            codename='change_reportrun',
+            content_type=content_type
+        )
+        self.delete_permission = Permission.objects.get(
+            codename='delete_reportrun',
+            content_type=content_type
+        )
+
+    def _refresh_user_and_request(self):
+        self.user = type(self.user).objects.get(pk=self.user.pk)
+        self.request.user = self.user
+
+    def test_can_view_without_permission(self):
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_view() is False
+
+    def test_can_view_with_permission(self):
+        self.user.user_permissions.add(self.view_permission)
+        self._refresh_user_and_request()
+
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_view() is True
+
+    def test_can_add_without_permission(self):
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_add() is False
+
+    def test_can_add_with_permission(self):
+        self.user.user_permissions.add(self.add_permission)
+        self._refresh_user_and_request()
+
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_add() is True
+
+    def test_can_change_without_permission(self):
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_change() is False
+
+    def test_can_change_with_permission(self):
+        self.user.user_permissions.add(self.change_permission)
+        self._refresh_user_and_request()
+
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_change() is True
+
+    def test_can_delete_without_permission(self):
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_delete() is False
+
+    def test_can_delete_with_permission(self):
+        self.user.user_permissions.add(self.delete_permission)
+        self._refresh_user_and_request()
+
+        controller = BaseReportAuthController(self.request)
+        assert controller.can_delete() is True

django_spire/metric/report/enums.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class ColumnType(str, Enum):
+    TEXT = 'text'
+    CHOICE = 'choice'
+    NUMBER = 'number'
+    DECIMAL_1 = 'decimal_1'
+    DECIMAL_2 = 'decimal_2'
+    DECIMAL_3 = 'decimal_3'
+    DOLLAR = 'dollar'
+    PERCENT = 'percent'
+
+

django_spire/metric/report/migrations/0001_initial.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.10 on 2026-01-08 20:41
+
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ReportRun',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('report_key_stack', models.TextField()),
+                ('datetime', models.DateTimeField(default=django.utils.timezone.now)),
+            ],
+            options={
+                'verbose_name': 'Report Run',
+                'verbose_name_plural': 'Report Runs',
+                'db_table': 'django_spire_metric_report_run',
+            },
+        ),
+    ]

django_spire/metric/report/models.py

@@ -0,0 +1,24 @@
+from django.db import models
+from django.utils.timezone import now
+
+from django_spire.metric.report.querysets import ReportRunQuerySet
+
+
+class ReportRun(models.Model):
+    report_key_stack = models.TextField()
+    datetime = models.DateTimeField(default=now)
+
+    objects = ReportRunQuerySet.as_manager()
+
+    @property
+    def report_button_text(self) -> str:
+        return self.report_key_stack.split('|')[-1]
+
+    @property
+    def report_key_stack_verbose(self):
+        return self.report_key_stack.replace('|', ' > ')
+
+    class Meta:
+        verbose_name = 'Report Run'
+        verbose_name_plural = 'Report Runs'
+        db_table = 'django_spire_metric_report_run'

django_spire/metric/report/querysets.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.db.models import QuerySet, Count
+
+if TYPE_CHECKING:
+    pass
+
+
+class ReportRunQuerySet(QuerySet):
+    def by_popular(self):
+        return (
+            self
+            .values('report_key_stack')
+            .annotate(
+                run_count=Count('report_key_stack')
+            )
+            .order_by('-run_count')
+        )
+
+    def by_top_ten(self):
+        return self.by_popular()[:10]
+
+    def run_count(self, report_key_stack: str) -> int:
+        return self.filter(report_key_stack=report_key_stack).count()

django_spire/metric/report/registry.py

@@ -0,0 +1,38 @@
+from typing import Self
+
+from django_spire.metric.report.report import BaseReport
+
+
+class ReportRegistry:
+    category: str | None = None
+    report_names_classes: dict[str, BaseReport] = {}
+    report_registries: list[Self] = []
+
+    def __init__(self):
+        for report_registry in self.report_registries:
+            self.add_registry(report_registry)
+
+    def add_registry(
+            self,
+            report_registry: Self
+    ):
+        if report_registry.category is None:
+            message = 'Report Registry category is required'
+            raise ValueError(message)
+
+        # if report_registry.category in self.report_names_classes:
+        #     message = f'Report Registry category "{report_registry.category}" already exists'
+        #     raise ValueError(message)
+
+        self.report_names_classes[report_registry.category] = report_registry.report_names_classes
+
+    def get_report_from_key_stack(self, report_key_stack: str) -> BaseReport | None:
+        current = self.report_names_classes
+
+        for key in report_key_stack.split('|'):
+            if isinstance(current, dict) and key in current:
+                current = current[key]
+            else:
+                return None
+
+        return current()