aa-intel-tool 2.6.2__py3-none-any.whl → 2.7.0__py3-none-any.whl

aa_intel_tool/templatetags/aa_intel_tool.py

@@ -1,88 +0,0 @@
-"""
-Versioned static URLs to break browser caches when changing the app version
-"""
-
-# Standard Library
-import os
-
-# Django
-from django.template.defaulttags import register
-from django.templatetags.static import static
-from django.utils.safestring import mark_safe
-
-# Alliance Auth
-from allianceauth.services.hooks import get_extension_logger
-
-# Alliance Auth (External Libs)
-from app_utils.logging import LoggerAddTag
-
-# AA Intel Tool
-from aa_intel_tool import __title__, __version__
-from aa_intel_tool.app_settings import debug_enabled
-from aa_intel_tool.constants import PACKAGE_NAME
-from aa_intel_tool.helper.static_files import calculate_integrity_hash
-
-logger = LoggerAddTag(my_logger=get_extension_logger(__name__), prefix=__title__)
-
-
-@register.simple_tag
-def aa_intel_tool_static(
-    relative_file_path: str, script_type: str = None
-) -> str | None:
-    """
-    Versioned static URL
-
-    :param relative_file_path: The file path relative to the `{APP_NAME}/{PACKAGE_NAME}/static/{PACKAGE_NAME}` folder
-    :type relative_file_path: str
-    :param script_type: The script type
-    :type script_type: str
-    :return: Versioned static URL
-    :rtype: str
-    """
-
-    logger.debug(f"Getting versioned static URL for: {relative_file_path}")
-
-    file_type = os.path.splitext(relative_file_path)[1][1:]
-
-    logger.debug(f"File extension: {file_type}")
-
-    # Only support CSS and JS files
-    if file_type not in ["css", "js"]:
-        raise ValueError(f"Unsupported file type: {file_type}")
-
-    static_file_path = os.path.join(PACKAGE_NAME, relative_file_path)
-    static_url = static(static_file_path)
-
-    # Integrity hash calculation only for non-debug mode
-    sri_string = (
-        f' integrity="{calculate_integrity_hash(relative_file_path)}" crossorigin="anonymous"'
-        if not debug_enabled()
-        else ""
-    )
-
-    # Versioned URL for CSS and JS files
-    # Add version query parameter to break browser caches when changing the app version
-    # Do not add version query parameter for libs as they are already versioned through their file path
-    versioned_url = (
-        static_url
-        if relative_file_path.startswith("libs/")
-        else static_url + "?v=" + __version__
-    )
-
-    return_value = None
-
-    # Return the versioned URL with integrity hash for CSS
-    if file_type == "css":
-        return_value = mark_safe(
-            f'<link rel="stylesheet" href="{versioned_url}"{sri_string}>'
-        )
-
-    # Return the versioned URL with integrity hash for JS files
-    if file_type == "js":
-        js_type = f' type="{script_type}"' if script_type else ""
-
-        return_value = mark_safe(
-            f'<script{js_type} src="{versioned_url}"{sri_string}></script>'
-        )
-
-    return return_value

aa_intel_tool/tests/test_templatetags.py

@@ -1,103 +0,0 @@
-"""
-Tests for the template tags
-"""
-
-# Django
-from django.template import Context, Template
-from django.test import TestCase, override_settings
-
-# AA Intel Tool
-from aa_intel_tool import __version__
-from aa_intel_tool.constants import PACKAGE_NAME
-from aa_intel_tool.helper.static_files import calculate_integrity_hash
-
-
-class TestVersionedStatic(TestCase):
-    """
-    Tests for aa_intel_tool template tag
-    """
-
-    @override_settings(DEBUG=False)
-    def test_versioned_static(self):
-        """
-        Test should return static URL string with a version
-        :return:
-        """
-
-        context = Context(dict_={"version": __version__})
-
-        template_to_render = Template(
-            template_string=(
-                "{% load aa_intel_tool %}"
-                "{% aa_intel_tool_static 'css/aa-intel-tool.min.css' %}"
-                "{% aa_intel_tool_static 'javascript/aa-intel-tool.min.js' %}"
-            )
-        )
-
-        rendered_template = template_to_render.render(context=context)
-
-        expected_static_css_src = (
-            f'/static/{PACKAGE_NAME}/css/aa-intel-tool.min.css?v={context["version"]}'
-        )
-        expected_static_css_src_integrity = calculate_integrity_hash(
-            "css/aa-intel-tool.min.css"
-        )
-        expected_static_js_src = f'/static/{PACKAGE_NAME}/javascript/aa-intel-tool.min.js?v={context["version"]}'
-        expected_static_js_src_integrity = calculate_integrity_hash(
-            "javascript/aa-intel-tool.min.js"
-        )
-
-        self.assertIn(member=expected_static_css_src, container=rendered_template)
-        self.assertIn(
-            member=expected_static_css_src_integrity, container=rendered_template
-        )
-        self.assertIn(member=expected_static_js_src, container=rendered_template)
-        self.assertIn(
-            member=expected_static_js_src_integrity, container=rendered_template
-        )
-
-    @override_settings(DEBUG=True)
-    def test_versioned_static_with_debug_enabled(self) -> None:
-        """
-        Test versioned static template tag with DEBUG enabled
-
-        :return:
-        :rtype:
-        """
-
-        context = Context({"version": __version__})
-        template_to_render = Template(
-            template_string=(
-                "{% load aa_intel_tool %}"
-                "{% aa_intel_tool_static 'css/aa-intel-tool.min.css' %}"
-            )
-        )
-
-        rendered_template = template_to_render.render(context=context)
-
-        expected_static_css_src = (
-            f'/static/{PACKAGE_NAME}/css/aa-intel-tool.min.css?v={context["version"]}'
-        )
-
-        self.assertIn(member=expected_static_css_src, container=rendered_template)
-        self.assertNotIn(member="integrity=", container=rendered_template)
-
-    @override_settings(DEBUG=False)
-    def test_invalid_file_type(self) -> None:
-        """
-        Test should raise a ValueError for an invalid file type
-
-        :return:
-        :rtype:
-        """
-
-        context = Context({"version": __version__})
-        template_to_render = Template(
-            template_string=(
-                "{% load aa_intel_tool %}"
-                "{% aa_intel_tool_static 'invalid/invalid.txt' %}"
-            )
-        )
-
-        with self.assertRaises(ValueError):
-            template_to_render.render(context=context)