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

django_spire/core/templatetags/string_formating.py

@@ -1,23 +1,26 @@
+from __future__ import annotations
+
 from django import template
 
+
 register = template.Library()
 
 
 @register.filter
-def dashes_to_underscore(value):
+def dashes_to_underscore(value: str) -> str:
     return value.replace('-', '_')
 
 
 @register.filter
-def spaces_to_underscore(value):
+def spaces_to_underscore(value: str) -> str:
     return value.replace(' ', '_')
 
 
 @register.filter
-def dashes_and_spaces_to_underscore(value):
+def dashes_and_spaces_to_underscore(value: str) -> str:
     return spaces_to_underscore(dashes_to_underscore(value))
 
 
 @register.filter
-def underscores_to_spaces(value):
-    return value.replace('_', ' ')
+def underscores_to_spaces(value: str) -> str:
+    return value.replace('_', ' ')

django_spire/core/templatetags/tests/test_templatetags.py

@@ -0,0 +1,427 @@
+from __future__ import annotations
+
+import json
+import string
+
+from unittest.mock import MagicMock, patch
+
+from django.template import Context, RequestContext, Template
+from django.test import RequestFactory, TestCase
+
+from django_spire.core.templatetags.json import to_json
+from django_spire.core.templatetags.message import django_messages_to_json
+from django_spire.core.templatetags.spire_core_tags import (
+    add_str,
+    content_type_url,
+    generate_id,
+    in_list,
+    index,
+    is_path,
+    not_in_list,
+    query_param_url,
+    safe_dict_items,
+    to_snake_case,
+)
+from django_spire.core.templatetags.string_formating import (
+    dashes_and_spaces_to_underscore,
+    dashes_to_underscore,
+    spaces_to_underscore,
+    underscores_to_spaces,
+)
+from django_spire.core.templatetags.variable_types import (
+    is_dict,
+    is_list,
+    is_list_or_tuple,
+    is_not_dict,
+    is_not_list,
+    is_not_list_or_tuple,
+    is_not_tuple,
+    is_tuple,
+)
+
+
+class TestAddStr(TestCase):
+    def test_concatenates_strings(self) -> None:
+        assert add_str('Hello', 'World') == 'HelloWorld'
+
+    def test_empty_strings(self) -> None:
+        assert add_str('', '') == ''
+
+    def test_with_spaces(self) -> None:
+        assert add_str('Hello ', 'World') == 'Hello World'
+
+
+class TestContentTypeUrl(TestCase):
+    def test_constructs_url_with_metadata(self) -> None:
+        class Dummy:
+            pass
+
+        dummy = Dummy()
+        dummy._meta = type(
+            'meta',
+            (),
+            {'app_label': 'myapp', 'model_name': 'dummy'}
+        )
+
+        func = 'django_spire.core.templatetags.spire_core_tags.reverse'
+        return_value = 'http://example.com/dummy'
+
+        with patch(func, return_value=return_value) as mock_reverse:
+            url = content_type_url('dummy_url', dummy)
+
+            mock_reverse.assert_called_once_with(
+                'dummy_url',
+                kwargs={'app_label': 'myapp', 'model_name': 'dummy'}
+            )
+
+            assert url == 'http://example.com/dummy'
+
+
+class TestDashesAndSpacesToUnderscore(TestCase):
+    def test_dashes_and_spaces(self) -> None:
+        assert dashes_and_spaces_to_underscore('hello-world test') == 'hello_world_test'
+
+    def test_no_changes_needed(self) -> None:
+        assert dashes_and_spaces_to_underscore('hello_world') == 'hello_world'
+
+    def test_only_dashes(self) -> None:
+        assert dashes_and_spaces_to_underscore('hello-world') == 'hello_world'
+
+    def test_only_spaces(self) -> None:
+        assert dashes_and_spaces_to_underscore('hello world') == 'hello_world'
+
+
+class TestDashesToUnderscore(TestCase):
+    def test_multiple_dashes(self) -> None:
+        assert dashes_to_underscore('hello-world-test') == 'hello_world_test'
+
+    def test_no_dashes(self) -> None:
+        assert dashes_to_underscore('hello') == 'hello'
+
+    def test_single_dash(self) -> None:
+        assert dashes_to_underscore('hello-world') == 'hello_world'
+
+
+class TestDjangoMessagesToJson(TestCase):
+    def test_empty_messages(self) -> None:
+        result = django_messages_to_json([])
+        assert json.loads(result) == []
+
+    def test_multiple_messages(self) -> None:
+        messages = [
+            MagicMock(message='First', level_tag='info'),
+            MagicMock(message='Second', level_tag='error'),
+        ]
+
+        result = django_messages_to_json(messages)
+        parsed = json.loads(result)
+
+        assert len(parsed) == 2
+        assert parsed[0]['message'] == 'First'
+        assert parsed[0]['type'] == 'info'
+        assert parsed[1]['message'] == 'Second'
+        assert parsed[1]['type'] == 'error'
+
+    def test_single_message(self) -> None:
+        messages = [MagicMock(message='Test message', level_tag='success')]
+
+        result = django_messages_to_json(messages)
+        parsed = json.loads(result)
+
+        assert len(parsed) == 1
+        assert parsed[0]['message'] == 'Test message'
+        assert parsed[0]['type'] == 'success'
+        assert len(parsed[0]['id']) == 8
+
+
+class TestGenerateId(TestCase):
+    def test_generates_8_characters(self) -> None:
+        identifier = generate_id()
+        assert len(identifier) == 8
+
+    def test_only_ascii_letters(self) -> None:
+        identifier = generate_id()
+        assert all(ch in string.ascii_letters for ch in identifier)
+
+    def test_unique_ids(self) -> None:
+        ids = {generate_id() for _ in range(100)}
+        assert len(ids) == 100
+
+
+class TestInList(TestCase):
+    def test_empty_list(self) -> None:
+        assert in_list('a', '') is False
+
+    def test_value_in_list(self) -> None:
+        assert in_list('a', 'a,b,c') is True
+
+    def test_value_not_in_list(self) -> None:
+        assert in_list('d', 'a,b,c') is False
+
+
+class TestIndex(TestCase):
+    def test_index_out_of_bounds(self) -> None:
+        items = [10, 20, 30]
+        assert index(items, 5) == items
+
+    def test_negative_index(self) -> None:
+        items = [10, 20, 30]
+        assert index(items, -1) == 30
+
+    def test_valid_index(self) -> None:
+        items = [10, 20, 30]
+        assert index(items, 1) == 20
+
+
+class TestIsDict(TestCase):
+    def test_dict(self) -> None:
+        assert is_dict({'key': 'value'}) is True
+
+    def test_empty_dict(self) -> None:
+        assert is_dict({}) is True
+
+    def test_list(self) -> None:
+        assert is_dict([]) is False
+
+    def test_string(self) -> None:
+        assert is_dict('string') is False
+
+
+class TestIsList(TestCase):
+    def test_dict(self) -> None:
+        assert is_list({}) is False
+
+    def test_empty_list(self) -> None:
+        assert is_list([]) is True
+
+    def test_list(self) -> None:
+        assert is_list([1, 2, 3]) is True
+
+    def test_tuple(self) -> None:
+        assert is_list((1, 2, 3)) is False
+
+
+class TestIsListOrTuple(TestCase):
+    def test_dict(self) -> None:
+        assert is_list_or_tuple({}) is False
+
+    def test_list(self) -> None:
+        assert is_list_or_tuple([1, 2, 3]) is True
+
+    def test_string(self) -> None:
+        assert is_list_or_tuple('string') is False
+
+    def test_tuple(self) -> None:
+        assert is_list_or_tuple((1, 2, 3)) is True
+
+
+class TestIsNotDict(TestCase):
+    def test_dict(self) -> None:
+        assert is_not_dict({'key': 'value'}) is False
+
+    def test_list(self) -> None:
+        assert is_not_dict([]) is True
+
+    def test_string(self) -> None:
+        assert is_not_dict('string') is True
+
+
+class TestIsNotList(TestCase):
+    def test_dict(self) -> None:
+        assert is_not_list({}) is True
+
+    def test_list(self) -> None:
+        assert is_not_list([1, 2, 3]) is False
+
+    def test_tuple(self) -> None:
+        assert is_not_list((1, 2, 3)) is True
+
+
+class TestIsNotListOrTuple(TestCase):
+    def test_dict(self) -> None:
+        assert is_not_list_or_tuple({}) is True
+
+    def test_list(self) -> None:
+        assert is_not_list_or_tuple([1, 2, 3]) is False
+
+    def test_string(self) -> None:
+        assert is_not_list_or_tuple('string') is True
+
+    def test_tuple(self) -> None:
+        assert is_not_list_or_tuple((1, 2, 3)) is False
+
+
+class TestIsNotTuple(TestCase):
+    def test_list(self) -> None:
+        assert is_not_tuple([1, 2, 3]) is True
+
+    def test_tuple(self) -> None:
+        assert is_not_tuple((1, 2, 3)) is False
+
+
+class TestIsPath(TestCase):
+    def test_empty_current(self) -> None:
+        assert is_path('', '/test') is False
+
+    def test_empty_url(self) -> None:
+        assert is_path('/test', '') is False
+
+    def test_exact_match(self) -> None:
+        assert is_path('/test', '/test') is True
+
+    def test_root_url(self) -> None:
+        assert is_path('/test', '/') is False
+
+    def test_starts_with(self) -> None:
+        assert is_path('/test/page', '/test') is True
+
+
+class TestIsTuple(TestCase):
+    def test_list(self) -> None:
+        assert is_tuple([1, 2, 3]) is False
+
+    def test_tuple(self) -> None:
+        assert is_tuple((1, 2, 3)) is True
+
+
+class TestNotInList(TestCase):
+    def test_empty_list(self) -> None:
+        assert not_in_list('a', '') is True
+
+    def test_value_in_list(self) -> None:
+        assert not_in_list('a', 'a,b,c') is False
+
+    def test_value_not_in_list(self) -> None:
+        assert not_in_list('x', 'a,b,c') is True
+
+
+class TestQueryParamUrl(TestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.factory = RequestFactory()
+
+    def test_multiple_params(self) -> None:
+        request = self.factory.get('/some_path', {'foo': 'bar', 'baz': 'qux'})
+        context = RequestContext(request, {})
+
+        func = 'django_spire.core.templatetags.spire_core_tags.reverse'
+        return_value = 'http://example.com/dummy'
+
+        with patch(func, return_value=return_value) as mock_reverse:
+            url = query_param_url(context, 'dummy_url')
+            mock_reverse.assert_called_once_with('dummy_url', kwargs={})
+
+            assert url.startswith('http://example.com/dummy?')
+            assert 'foo=bar' in url
+            assert 'baz=qux' in url
+
+    def test_no_params(self) -> None:
+        request = self.factory.get('/some_path')
+        context = RequestContext(request, {})
+
+        func = 'django_spire.core.templatetags.spire_core_tags.reverse'
+        return_value = 'http://example.com/dummy'
+
+        with patch(func, return_value=return_value):
+            url = query_param_url(context, 'dummy_url')
+
+            assert url == 'http://example.com/dummy?'
+
+
+class TestSafeDictItems(TestCase):
+    def test_dict_with_items_key(self) -> None:
+        d = {'items': 'value', 'other': 'data'}
+        result = list(safe_dict_items(d))
+
+        assert ('items', 'value') in result
+        assert ('other', 'data') in result
+
+    def test_no_items_attribute(self) -> None:
+        result = safe_dict_items('not a dict')
+        assert result == []
+
+    def test_normal_dict(self) -> None:
+        d = {'key': 'value'}
+        result = list(safe_dict_items(d))
+
+        assert result == [('key', 'value')]
+
+
+class TestSpacesToUnderscore(TestCase):
+    def test_multiple_spaces(self) -> None:
+        assert spaces_to_underscore('hello world test') == 'hello_world_test'
+
+    def test_no_spaces(self) -> None:
+        assert spaces_to_underscore('hello') == 'hello'
+
+    def test_single_space(self) -> None:
+        assert spaces_to_underscore('hello world') == 'hello_world'
+
+
+class TestToJson(TestCase):
+    def test_dict(self) -> None:
+        result = to_json({'key': 'value'})
+        assert result == '{"key": "value"}'
+
+    def test_invalid_value(self) -> None:
+        result = to_json(object())
+        assert result == ''
+
+    def test_list(self) -> None:
+        result = to_json([1, 2, 3])
+        assert result == '[1, 2, 3]'
+
+    def test_nested_structure(self) -> None:
+        result = to_json({'list': [1, 2, 3], 'nested': {'key': 'value'}})
+        parsed = json.loads(result)
+
+        assert parsed['list'] == [1, 2, 3]
+        assert parsed['nested'] == {'key': 'value'}
+
+
+class TestToSnakeCase(TestCase):
+    def test_already_snake_case(self) -> None:
+        assert to_snake_case('hello_world') == 'hello_world'
+
+    def test_multiple_spaces(self) -> None:
+        assert to_snake_case('Hello World Test') == 'hello_world_test'
+
+    def test_simple_conversion(self) -> None:
+        assert to_snake_case('Hello World') == 'hello_world'
+
+
+class TestUnderscoresToSpaces(TestCase):
+    def test_multiple_underscores(self) -> None:
+        assert underscores_to_spaces('hello_world_test') == 'hello world test'
+
+    def test_no_underscores(self) -> None:
+        assert underscores_to_spaces('hello') == 'hello'
+
+    def test_single_underscore(self) -> None:
+        assert underscores_to_spaces('hello_world') == 'hello world'
+
+
+class TemplateRenderingTests(TestCase):
+    def test_render_add_str_filter(self) -> None:
+        template_code = """
+            {% load spire_core_tags %}
+
+            {{ "Hello" | add_str:" World" }}
+        """
+
+        tmpl = Template(template_code)
+        rendered = tmpl.render(Context())
+        assert 'Hello World' in rendered
+
+    def test_render_to_snake_case_tag(self) -> None:
+        template_code = """
+            {% load spire_core_tags %}
+
+            {% to_snake_case "Hello World" as snake_case %}
+            {{ snake_case }}
+        """
+
+        tmpl = Template(template_code)
+        rendered = tmpl.render(Context())
+        assert 'hello_world' in rendered

django_spire/core/templatetags/variable_types.py

@@ -1,43 +1,51 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from django import template
 
+if TYPE_CHECKING:
+    from typing import Any
+
+
 register = template.Library()
 
 
 @register.filter
-def is_dict(value):
+def is_dict(value: Any) -> bool:
     return isinstance(value, dict)
 
 
 @register.filter
-def is_not_dict(value):
+def is_not_dict(value: Any) -> bool:
     return not is_dict(value)
 
 
 @register.filter
-def is_list(value):
+def is_list(value: Any) -> bool:
     return isinstance(value, list)
 
 
 @register.filter
-def is_not_list(value):
+def is_not_list(value: Any) -> bool:
     return not is_list(value)
 
 
 @register.filter
-def is_list_or_tuple(value):
+def is_list_or_tuple(value: Any) -> bool:
     return isinstance(value, (list, tuple))
 
 
 @register.filter
-def is_not_list_or_tuple(value):
+def is_not_list_or_tuple(value: Any) -> bool:
     return not is_list_or_tuple(value)
 
 
 @register.filter
-def is_tuple(value):
+def is_tuple(value: Any) -> bool:
     return isinstance(value, tuple)
 
 
 @register.filter
-def is_not_tuple(value):
-    return not is_tuple(value)
+def is_not_tuple(value: Any) -> bool:
+    return not is_tuple(value)

django_spire/core/tests/test_cases.py

@@ -5,7 +5,6 @@ import tempfile
 from django.test import Client, override_settings, TestCase
 
 from django_spire.auth.user.models import AuthUser
-from django_spire.auth.user.tests.factories import create_super_user
 
 
 TEMP_MEDIA_ROOT = tempfile.mkdtemp()
@@ -19,4 +18,5 @@ class BaseTestCase(TestCase):
         self.super_user = AuthUser.objects.create_superuser(
             username='stratus',
         )
+
         self.client.force_login(self.super_user)

django_spire/core/tests/test_conf.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from django.test import TestCase, override_settings
+
+from django_spire.conf import Settings, settings
+
+
+class TestSettings(TestCase):
+    def test_getattr_returns_django_setting(self) -> None:
+        assert settings.DEBUG is not None
+
+    def test_getattr_returns_django_spire_default(self) -> None:
+        result = settings.DJANGO_SPIRE_DEFAULT_THEME
+
+        assert result == 'default-light'
+
+    def test_getattr_returns_none_for_unknown_setting(self) -> None:
+        result = settings.NONEXISTENT_SETTING_NAME
+
+        assert result is None
+
+    @override_settings(DJANGO_SPIRE_DEFAULT_THEME='custom-dark')
+    def test_django_setting_overrides_default(self) -> None:
+        fresh_settings = Settings()
+
+        result = fresh_settings.DJANGO_SPIRE_DEFAULT_THEME
+
+        assert result == 'custom-dark'
+
+    @override_settings(
+        DJANGO_SPIRE_AUTH_CONTROLLERS={'custom_app': 'custom.path.Controller'}
+    )
+    def test_auth_controllers_merges_dicts(self) -> None:
+        fresh_settings = Settings()
+
+        result = fresh_settings.DJANGO_SPIRE_AUTH_CONTROLLERS
+
+        assert 'custom_app' in result
+        assert 'ai_chat' in result
+
+    def test_settings_instance_exists(self) -> None:
+        assert settings is not None
+        assert isinstance(settings, Settings)

django_spire/core/tests/test_consts.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from django.test import TestCase
+
+from django_spire.consts import (
+    __VERSION__,
+    MAINTENANCE_MODE_SETTINGS_NAME,
+    NOTIFICATION_THROTTLE_RATE_PER_MINUTE_SETTINGS_NAME,
+)
+
+
+class TestConsts(TestCase):
+    def test_maintenance_mode_settings_name(self) -> None:
+        assert MAINTENANCE_MODE_SETTINGS_NAME == 'MAINTENANCE_MODE'
+
+    def test_notification_throttle_rate_settings_name(self) -> None:
+        assert NOTIFICATION_THROTTLE_RATE_PER_MINUTE_SETTINGS_NAME == 'NOTIFICATION_THROTTLE_RATE_PER_MINUTE'
+
+    def test_version_is_string(self) -> None:
+        assert isinstance(__VERSION__, str)
+
+    def test_version_format(self) -> None:
+        parts = __VERSION__.split('.')
+
+        assert len(parts) == 3
+
+        for part in parts:
+            assert part.isdigit()

django_spire/core/tests/test_context_processors.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+from unittest.mock import MagicMock, patch
+
+from django.test import RequestFactory, TestCase, override_settings
+
+from django_spire.core.context_processors import django_spire, theme_context
+
+
+class TestDjangoSpireContextProcessor(TestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.factory = RequestFactory()
+
+    @override_settings(DJANGO_SPIRE_AUTH_CONTROLLERS=[])
+    def test_empty_auth_controllers(self) -> None:
+        request = self.factory.get('/')
+        result = django_spire(request)
+
+        assert 'DJANGO_SPIRE_VERSION' in result
+        assert 'AuthController' in result
+        assert result['AuthController'] == {}
+
+    @override_settings(DJANGO_SPIRE_AUTH_CONTROLLERS=['test_app'])
+    @patch('django_spire.core.context_processors.AppAuthController')
+    def test_with_auth_controllers(self, mock_controller: MagicMock) -> None:
+        mock_instance = MagicMock()
+        mock_controller.return_value = mock_instance
+
+        request = self.factory.get('/')
+        result = django_spire(request)
+
+        assert 'AuthController' in result
+        assert 'test_app' in result['AuthController']
+        mock_controller.assert_called_once_with('test_app', request=request)
+
+
+class TestThemeContextProcessor(TestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.factory = RequestFactory()
+
+    def test_default_theme_applied(self) -> None:
+        request = self.factory.get('/')
+        request.COOKIES = {}
+        result = theme_context(request)
+
+        assert 'DJANGO_SPIRE_DEFAULT_THEME' in result
+        assert 'DJANGO_SPIRE_THEME_COOKIE_NAME' in result
+        assert 'DJANGO_SPIRE_THEME_PATH' in result
+        assert 'theme' in result
+
+    @override_settings(DJANGO_SPIRE_DEFAULT_THEME='default-dark')
+    def test_custom_default_theme(self) -> None:
+        request = self.factory.get('/')
+        request.COOKIES = {}
+        result = theme_context(request)
+
+        assert result['DJANGO_SPIRE_DEFAULT_THEME'] == 'default-dark'
+
+    @override_settings(DJANGO_SPIRE_THEME_PATH='/custom/path/{family}/app-{mode}.css')
+    def test_custom_theme_path(self) -> None:
+        request = self.factory.get('/')
+        request.COOKIES = {}
+        result = theme_context(request)
+
+        assert result['DJANGO_SPIRE_THEME_PATH'] == '/custom/path/{family}/app-{mode}.css'
+
+    @patch('django_spire.core.context_processors.get_theme_cookie_name')
+    @patch('django_spire.core.context_processors.Theme')
+    def test_theme_from_cookie(self, mock_theme: MagicMock, mock_cookie_name: MagicMock) -> None:
+        mock_cookie_name.return_value = 'theme_cookie'
+        mock_theme_instance = MagicMock()
+        mock_theme_instance.value = 'custom-dark'
+        mock_theme_instance.to_dict.return_value = {'family': 'custom', 'mode': 'dark'}
+        mock_theme.from_string.return_value = mock_theme_instance
+        mock_theme.get_default.return_value = mock_theme_instance
+
+        request = self.factory.get('/')
+        request.COOKIES = {'theme_cookie': 'custom-dark'}
+        result = theme_context(request)
+
+        assert result['theme'] == {'family': 'custom', 'mode': 'dark'}
+
+    def test_theme_result_contains_required_keys(self) -> None:
+        request = self.factory.get('/')
+        request.COOKIES = {}
+        result = theme_context(request)
+
+        assert 'theme' in result
+        assert isinstance(result['theme'], dict)