django-spire 0.22.4__py3-none-any.whl → 0.23.2__py3-none-any.whl

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

@@ -3,7 +3,11 @@
         x-data="{
             init() {
                 let table_id = this.$el.closest('[data-table-id]').dataset.tableId;
-                this.$dispatch('total-count-updated', { total_count: {{ total_count }}, batch_size: {{ batch_size|default:25 }}, table_id: table_id });
+                this.$dispatch('table-total-count-updated', {
+                    batch_size: {{ batch_size|default:25 }},
+                    table_id: table_id,
+                    total_count: {{ total_count }}
+                });
             }
         }"
         style="display: none;"
@@ -11,18 +15,22 @@
 {% endif %}
 
 <tr
-    class="align-middle {% block unified_row_background_colour %}{% endblock %}"
+    class="align-middle {% block row_class %}{% endblock %}"
     data-row-id="{{ row.pk }}"
     x-data="{
-        row_id: '{{ row.pk }}',
-        table_id: null,
+        has_children: false,
         is_checked: false,
         is_open: false,
-        has_children: false,
+        row_id: '{{ row.pk }}',
+        table_id: null,
 
         init() {
             this.table_id = this.$el.closest('[data-table-id]').dataset.tableId;
-            this.$dispatch('row-mounted', { row_id: this.row_id, row_element: this.$el, table_id: this.table_id });
+            this.$dispatch('row-mounted', {
+                row_element: this.$el,
+                row_id: this.row_id,
+                table_id: this.table_id
+            });
         },
 
         handle_checkbox_change() {
@@ -84,7 +92,7 @@
         </template>
     </td>
 
-    {% block table_cells %}{% endblock %}
+    {% block table_cell %}{% endblock %}
 </tr>
 
 <tr class="align-middle" data-row-id="{{ row.pk }}">

django_spire/core/templatetags/spire_core_tags.py

@@ -2,9 +2,8 @@ from __future__ import annotations
 
 import random
 import string
-from typing import Any
 
-from typing_extensions import Sequence, TYPE_CHECKING, TypeVar
+from typing import Any, Sequence, TYPE_CHECKING, TypeVar
 
 from django import template
 from django.db.models import Model

django_spire/file/fields.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import json
 
-from typing_extensions import TYPE_CHECKING
+from typing import TYPE_CHECKING
 
 from django import forms
 

django_spire/file/interfaces.py

@@ -2,10 +2,10 @@ from __future__ import annotations
 
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
+from typing import TYPE_CHECKING
 
 from django.conf import settings
 from django.core.files.base import ContentFile
-from typing_extensions import TYPE_CHECKING
 
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist

django_spire/file/views.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing_extensions import TYPE_CHECKING
+from typing import TYPE_CHECKING
 
 from django.contrib.auth.decorators import login_required
 from django.http import JsonResponse

django_spire/history/activity/utils.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing_extensions import TYPE_CHECKING
+from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from django.contrib.auth.models import User

django_spire/history/mixins.py

@@ -3,14 +3,10 @@ from __future__ import annotations
 from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 from django.utils.timezone import localtime
-from typing_extensions import TYPE_CHECKING
 
 from django_spire.history.choices import HistoryEventChoices
 from django_spire.history.models import HistoryEvent
 
-if TYPE_CHECKING:
-    from django.contrib.auth.models import User
-
 
 class HistoryModelMixin(models.Model):
     is_active = models.BooleanField(default=True, editable=False)

django_spire/notification/app/context_data.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
+
 import json
-from typing_extensions import TYPE_CHECKING
+
+from typing import TYPE_CHECKING
 
 from django_spire.notification.app.models import AppNotification
 

django_spire/notification/app/views/json_views.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
-from typing_extensions import TYPE_CHECKING
 
+from typing import TYPE_CHECKING
 
 from django.http import JsonResponse
 from django.contrib.contenttypes.models import ContentType

django_spire/notification/app/views/page_views.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from django.contrib.auth.decorators import login_required
-from typing_extensions import TYPE_CHECKING
 
 from django_spire.contrib.generic_views import portal_views
 

django_spire/notification/app/views/template_views.py

@@ -2,9 +2,9 @@ from __future__ import annotations
 
 import json
 
-from django.contrib.auth.models import AnonymousUser
-from typing_extensions import TYPE_CHECKING
+from typing import TYPE_CHECKING
 
+from django.contrib.auth.models import AnonymousUser
 from django.template.response import TemplateResponse
 
 from django_spire.notification.app.models import AppNotification

django_spire/profiling/middleware/profiling.py

@@ -5,7 +5,7 @@ import threading
 import time
 
 from pathlib import Path
-from typing_extensions import TYPE_CHECKING
+from typing import TYPE_CHECKING
 
 from django.conf import settings
 from django.utils.deprecation import MiddlewareMixin
@@ -18,7 +18,7 @@ except ImportError:
     Profiler = None
 
 if TYPE_CHECKING:
-    from typing_extensions import Any, Callable
+    from typing import Any, Callable
 
     from django.http import HttpRequest, HttpResponse
 

django_spire/profiling/panel.py

@@ -6,7 +6,7 @@ import time
 from dataclasses import asdict, dataclass
 from datetime import datetime
 from pathlib import Path
-from typing_extensions import TYPE_CHECKING
+from typing import TYPE_CHECKING
 
 from debug_toolbar.panels import Panel
 from django.conf import settings
@@ -18,7 +18,7 @@ from django.views.decorators.csrf import csrf_exempt
 from django_spire.profiling import lock
 
 if TYPE_CHECKING:
-    from typing_extensions import Any
+    from typing import Any
 
 
 @dataclass

django_spire/testing/playwright/__init__.py

@@ -0,0 +1,64 @@
+from django_spire.testing.playwright.components import (
+    Accordion,
+    AttributeElement,
+    AttributeList,
+    Breadcrumb,
+    Card,
+    DeleteModal,
+    Dropdown,
+    EllipsisDropdown,
+    EllipsisModalDropdown,
+    EllipsisTableDropdown,
+    FilterForm,
+    FormCard,
+    FormModal,
+    InfiniteScroll,
+    InfiniteScrollCard,
+    InfiniteScrollList,
+    InfiniteScrollTable,
+    LazyTab,
+    Modal,
+    NavAccordion,
+    NotificationBell,
+    SideNavigation,
+    ThemeSelector,
+    TitleCard,
+    TitleModal,
+    Toast,
+    TopNavigation,
+    UserMenu,
+)
+from django_spire.testing.playwright.pages import BasePage
+
+
+__all__ = [
+    'Accordion',
+    'AttributeElement',
+    'AttributeList',
+    'BasePage',
+    'Breadcrumb',
+    'Card',
+    'DeleteModal',
+    'Dropdown',
+    'EllipsisDropdown',
+    'EllipsisModalDropdown',
+    'EllipsisTableDropdown',
+    'FilterForm',
+    'FormCard',
+    'FormModal',
+    'InfiniteScroll',
+    'InfiniteScrollCard',
+    'InfiniteScrollList',
+    'InfiniteScrollTable',
+    'LazyTab',
+    'Modal',
+    'NavAccordion',
+    'NotificationBell',
+    'SideNavigation',
+    'ThemeSelector',
+    'TitleCard',
+    'TitleModal',
+    'Toast',
+    'TopNavigation',
+    'UserMenu',
+]

django_spire/testing/playwright/components/__init__.py

@@ -0,0 +1,45 @@
+from django_spire.testing.playwright.components.accordion import Accordion, NavAccordion
+from django_spire.testing.playwright.components.attribute_element import AttributeElement, AttributeList
+from django_spire.testing.playwright.components.base_session_filter_form import FilterForm
+from django_spire.testing.playwright.components.breadcrumb_element import Breadcrumb
+from django_spire.testing.playwright.components.card import Card, FormCard, InfiniteScrollCard, TitleCard
+from django_spire.testing.playwright.components.dropdown import Dropdown, EllipsisDropdown, EllipsisModalDropdown, EllipsisTableDropdown
+from django_spire.testing.playwright.components.infinite_scroll import InfiniteScroll, InfiniteScrollList, InfiniteScrollTable
+from django_spire.testing.playwright.components.lazy_tab import LazyTab
+from django_spire.testing.playwright.components.modal import DeleteModal, FormModal, Modal, TitleModal
+from django_spire.testing.playwright.components.navigation import SideNavigation, TopNavigation, UserMenu
+from django_spire.testing.playwright.components.notification_bell import NotificationBell
+from django_spire.testing.playwright.components.theme_selector import ThemeSelector
+from django_spire.testing.playwright.components.toast import Toast
+
+
+__all__ = [
+    'Accordion',
+    'AttributeElement',
+    'AttributeList',
+    'Breadcrumb',
+    'Card',
+    'DeleteModal',
+    'Dropdown',
+    'EllipsisDropdown',
+    'EllipsisModalDropdown',
+    'EllipsisTableDropdown',
+    'FilterForm',
+    'FormCard',
+    'FormModal',
+    'InfiniteScroll',
+    'InfiniteScrollCard',
+    'InfiniteScrollList',
+    'InfiniteScrollTable',
+    'LazyTab',
+    'Modal',
+    'NavAccordion',
+    'NotificationBell',
+    'SideNavigation',
+    'ThemeSelector',
+    'TitleCard',
+    'TitleModal',
+    'Toast',
+    'TopNavigation',
+    'UserMenu',
+]

django_spire/testing/playwright/components/accordion.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from playwright.sync_api import Locator
+
+
+class Accordion:
+    """Playwright component for django_spire/accordion/accordion.html"""
+
+    def __init__(self, parent_locator: Locator) -> None:
+        self.parent = parent_locator
+
+    @property
+    def content(self) -> Locator:
+        return self.parent.locator('[x-show="show_accordion"]')
+
+    @property
+    def toggle(self) -> Locator:
+        return self.parent.locator('[\\@click*="toggle"]').first
+
+    def close(self) -> None:
+        if self.is_open():
+            self.toggle.click()
+
+    def is_open(self) -> bool:
+        return self.content.is_visible()
+
+    def open(self) -> None:
+        if not self.is_open():
+            self.toggle.click()
+
+
+class NavAccordion(Accordion):
+    """Playwright component for django_spire/navigation/accordion/nav_accordion.html"""
+
+    @property
+    def chevron(self) -> Locator:
+        return self.parent.locator('.bi-chevron-right, .bi-chevron-down')
+
+    @property
+    def icon(self) -> Locator:
+        return self.parent.locator('i.fs-6').first
+
+    @property
+    def title(self) -> Locator:
+        return self.parent.locator('span.h6')
+
+    def get_title_text(self) -> str:
+        return self.title.inner_text()
+
+    def is_expanded(self) -> bool:
+        chevron_classes = self.chevron.get_attribute('class') or ''
+        return 'bi-chevron-down' in chevron_classes

django_spire/testing/playwright/components/attribute_element.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from playwright.sync_api import Locator, Page
+
+
+class AttributeElement:
+    """Playwright component for django_spire/element/attribute_element.html"""
+
+    def __init__(self, page: Page, container_selector: str = 'body') -> None:
+        self.container_selector = container_selector
+        self.page = page
+
+    @property
+    def container(self) -> Locator:
+        return self.page.locator(self.container_selector)
+
+    def get_attribute_by_title(self, title: str) -> Locator:
+        return self.container.locator(f'.fs-7.text-app-attribute-color:has-text("{title}")').locator('..')
+
+    def get_value_by_title(self, title: str) -> str:
+        attribute = self.get_attribute_by_title(title)
+        return attribute.locator('.fs-6, a').inner_text()
+
+    def get_value_href_by_title(self, title: str) -> str | None:
+        attribute = self.get_attribute_by_title(title)
+        link = attribute.locator('a')
+
+        if link.count() > 0:
+            return link.get_attribute('href')
+
+        return None
+
+    def has_attribute(self, title: str) -> bool:
+        return self.get_attribute_by_title(title).count() > 0
+
+    def is_value_link(self, title: str) -> bool:
+        attribute = self.get_attribute_by_title(title)
+        return attribute.locator('a').count() > 0
+
+
+class AttributeList:
+    """Helper for pages with multiple attribute elements"""
+
+    def __init__(self, page: Page, container_selector: str = 'body') -> None:
+        self.container_selector = container_selector
+        self.page = page
+
+    @property
+    def container(self) -> Locator:
+        return self.page.locator(self.container_selector)
+
+    @property
+    def attributes(self) -> Locator:
+        return self.container.locator('.fs-7.text-app-attribute-color')
+
+    def get_all_titles(self) -> list[str]:
+        count = self.attributes.count()
+        return [self.attributes.nth(i).inner_text() for i in range(count)]
+
+    def get_attribute_count(self) -> int:
+        return self.attributes.count()
+
+    def get_values_dict(self) -> dict[str, str]:
+        result = {}
+        attr_element = AttributeElement(self.page, self.container_selector)
+
+        for title in self.get_all_titles():
+            result[title] = attr_element.get_value_by_title(title)
+
+        return result

django_spire/testing/playwright/components/base_session_filter_form.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from playwright.sync_api import Locator, Page
+
+
+class FilterForm:
+    """Playwright component for django_spire/filtering/form/base_session_filter_form.html"""
+
+    def __init__(self, page: Page, form_selector: str = 'form[action*="filter"], form[action*="search"]') -> None:
+        self.form_selector = form_selector
+        self.page = page
+
+    @property
+    def clear_button(self) -> Locator:
+        return self.form.locator('input[value="Clear"], button:has-text("Clear")')
+
+    @property
+    def filter_button(self) -> Locator:
+        return self.form.locator('input[value="Filter"], button:has-text("Filter")')
+
+    @property
+    def form(self) -> Locator:
+        return self.page.locator(self.form_selector).first
+
+    @property
+    def search_button(self) -> Locator:
+        return self.form.locator('input[value="Search"], button:has-text("Search")')
+
+    @property
+    def search_input(self) -> Locator:
+        return self.form.locator('input[name="search"], input[placeholder*="Search"]')
+
+    def clear(self) -> None:
+        self.clear_button.click()
+
+    def fill_field(self, name: str, value: str) -> None:
+        self.form.locator(f'[name="{name}"]').fill(value)
+
+    def filter(self) -> None:
+        self.filter_button.click()
+
+    def get_field_value(self, name: str) -> str:
+        return self.form.locator(f'[name="{name}"]').input_value()
+
+    def search(self, query: str) -> None:
+        self.search_input.fill(query)
+        self.search_button.click()
+
+    def select_option(self, name: str, value: str) -> None:
+        self.form.locator(f'select[name="{name}"]').select_option(value)
+
+    def submit(self) -> None:
+        submit_btn = self.form.locator('button[type="submit"], input[type="submit"]').first
+        submit_btn.click()

django_spire/testing/playwright/components/breadcrumb_element.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from playwright.sync_api import Locator, Page
+
+
+class Breadcrumb:
+    """Playwright component for django_spire/element/breadcrumb_element.html"""
+
+    def __init__(self, page: Page) -> None:
+        self.page = page
+
+    @property
+    def breadcrumb(self) -> Locator:
+        return self.page.locator('ol.breadcrumb')
+
+    @property
+    def items(self) -> Locator:
+        return self.breadcrumb.locator('.breadcrumb-item')
+
+    def click_item(self, index: int) -> None:
+        link = self.get_item(index).locator('a')
+
+        if link.count() > 0:
+            link.click()
+
+    def get_item(self, index: int) -> Locator:
+        return self.items.nth(index)
+
+    def get_item_count(self) -> int:
+        return self.items.count()
+
+    def get_item_href(self, index: int) -> str | None:
+        link = self.get_item(index).locator('a')
+
+        if link.count() > 0:
+            return link.get_attribute('href')
+
+        return None
+
+    def get_item_text(self, index: int) -> str:
+        return self.get_item(index).inner_text()
+
+    def get_items_text(self) -> list[str]:
+        return [self.get_item_text(i) for i in range(self.get_item_count())]
+
+    def get_last_item_text(self) -> str:
+        return self.items.last.inner_text()
+
+    def is_item_clickable(self, index: int) -> bool:
+        return self.get_item(index).locator('a').count() > 0
+
+    def is_visible(self) -> bool:
+        return self.breadcrumb.is_visible()

django_spire/testing/playwright/components/card.py

@@ -0,0 +1,102 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from playwright.sync_api import Locator, Page
+
+
+class Card:
+    """Playwright component for django_spire/card/card.html"""
+
+    def __init__(self, page: Page, card_selector: str = '.card') -> None:
+        self.card_selector = card_selector
+        self.page = page
+
+    @property
+    def card(self) -> Locator:
+        return self.page.locator(self.card_selector).first
+
+    @property
+    def content(self) -> Locator:
+        return self.card.locator('.card-body, .p-3').first
+
+    def is_visible(self) -> bool:
+        return self.card.is_visible()
+
+
+class TitleCard(Card):
+    """Playwright component for django_spire/card/title_card.html"""
+
+    @property
+    def button(self) -> Locator:
+        return self.card.locator('.col-auto.d-flex').first
+
+    @property
+    def dropdown_content(self) -> Locator:
+        return self.card.locator('[x-show="card_title_dropdown"]')
+
+    @property
+    def title(self) -> Locator:
+        return self.card.locator('.card-title').first
+
+    def click_button(self) -> None:
+        self.button.locator('button, a').first.click()
+
+    def get_title_text(self) -> str:
+        return self.title.inner_text()
+
+    def has_button(self) -> bool:
+        return self.button.locator('button, a').count() > 0
+
+    def is_dropdown_open(self) -> bool:
+        return self.dropdown_content.is_visible()
+
+    def toggle_dropdown(self) -> None:
+        self.card.locator('[\\@click*="toggle_card_title_dropdown"]').click()
+
+
+class FormCard(TitleCard):
+    """Playwright component for django_spire/card/form_card.html"""
+
+    @property
+    def description(self) -> Locator:
+        return self.card.locator('.mb-3').first
+
+    @property
+    def form(self) -> Locator:
+        return self.card.locator('form')
+
+    def fill_field(self, name: str, value: str) -> None:
+        self.form.locator(f'[name="{name}"]').fill(value)
+
+    def get_field_value(self, name: str) -> str:
+        return self.form.locator(f'[name="{name}"]').input_value()
+
+    def submit(self) -> None:
+        self.form.locator('button[type="submit"], input[type="submit"]').click()
+
+
+class InfiniteScrollCard(TitleCard):
+    """Playwright component for django_spire/card/infinite_scroll_card.html"""
+
+    @property
+    def loaded_count_text(self) -> Locator:
+        return self.card.locator('[x-text="loaded_count"]')
+
+    @property
+    def scroll_container(self) -> Locator:
+        return self.card.locator('[x-ref="scroll_container"]')
+
+    @property
+    def total_count_text(self) -> Locator:
+        return self.card.locator('[x-text="total_count"]')
+
+    def get_loaded_count(self) -> int:
+        return int(self.loaded_count_text.inner_text())
+
+    def get_total_count(self) -> int:
+        return int(self.total_count_text.inner_text())
+
+    def scroll_to_bottom(self) -> None:
+        self.scroll_container.evaluate('el => el.scrollTop = el.scrollHeight')