Merge pull request #150 from ppfeufer/improve-templatetag

[CHANGE] Improve templatetag code

Author: ppfeufer

CHANGELOG.md

@@ -37,6 +37,7 @@ Section Order:
 
 ### Changed
 
+- Improve templatetag code
 - Use DataTables native translations instead of our own
 
 ## [2.6.0] - 2025-01-31

Makefile

@@ -64,7 +64,7 @@ prepare-release: graph_models pot
 #			fi; \
 #		done; \
 #	fi;
-	echo "Updated version in $(TEXT_BOLD)$(package)/__init__.py$(TEXT_BOLD_END)"
+	@echo "Updated version in $(TEXT_BOLD)$(package)/__init__.py$(TEXT_BOLD_END)"
 
 # Help
 .PHONY: help

aa_intel_tool/app_settings.py

@@ -4,6 +4,10 @@
 
 # Standard Library
 from enum import IntEnum
+from re import RegexFlag
+
+# Django
+from django.conf import settings
 
 # Alliance Auth
 from allianceauth.services.hooks import get_extension_logger
@@ -81,3 +85,14 @@ class UpwellStructureId(IntEnum):
     """
 
     ANSIBLEX_JUMP_GATE = 35841
+
+
+def debug_enabled() -> RegexFlag:
+    """
+    Check if DEBUG is enabled
+
+    :return:
+    :rtype:
+    """
+
+    return settings.DEBUG

aa_intel_tool/constants.py

@@ -80,10 +80,11 @@
 
 # Building our user agent for ESI calls
 APP_NAME = "aa-intel-tool"
+PACKAGE_NAME = "aa_intel_tool"
+APP_VERBOSE_NAME = "AA Intel Tool"
+APP_VERBOSE_NAME_USERAGENT = "AA-Intel-Tool"
 GITHUB_URL = f"https://github.com/ppfeufer/{APP_NAME}"
-USER_AGENT = f"{APP_NAME}/{__version__} ({GITHUB_URL}) via django-esi/{esi_version}"
+USER_AGENT = f"{APP_VERBOSE_NAME_USERAGENT}/{__version__} (+{GITHUB_URL}) Django-ESI/{esi_version}"
 
-AA_INTEL_TOOL_BASE_DIR = os.path.join(os.path.dirname(__file__))
-AA_INTEL_TOOL_STATIC_DIR = os.path.join(
-    AA_INTEL_TOOL_BASE_DIR, "static", "aa_intel_tool"
-)
+APP_BASE_DIR = os.path.join(os.path.dirname(__file__))
+APP_STATIC_DIR = os.path.join(APP_BASE_DIR, "static", PACKAGE_NAME)

aa_intel_tool/helper/static_files.py

@@ -17,23 +17,24 @@
 
 # AA Intel Tool
 from aa_intel_tool import __title__
-from aa_intel_tool.constants import AA_INTEL_TOOL_STATIC_DIR
+from aa_intel_tool.constants import APP_STATIC_DIR
 
 logger = LoggerAddTag(my_logger=get_extension_logger(__name__), prefix=__title__)
 
 
 def calculate_integrity_hash(relative_file_path: str) -> str:
     """
     Calculates the integrity hash for a given static file
+
     :param self:
     :type self:
-    :param relative_file_path: The file path relative to the `aa-intel-tool/aa_intel_tool/static/aa_intel_tool` folder
+    :param relative_file_path: The file path relative to the `{APP_NAME}/{PACKAGE_NAME}/static/{PACKAGE_NAME}` folder
     :type relative_file_path: str
     :return: The integrity hash
     :rtype: str
     """
 
-    file_path = os.path.join(AA_INTEL_TOOL_STATIC_DIR, relative_file_path)
+    file_path = os.path.join(APP_STATIC_DIR, relative_file_path)
     integrity_hash = calculate_integrity(
         path=Path(file_path), algorithm=Algorithm.SHA512
     )

aa_intel_tool/templatetags/aa_intel_tool.py

@@ -6,7 +6,6 @@
 import os
 
 # Django
-from django.conf import settings
 from django.template.defaulttags import register
 from django.templatetags.static import static
 from django.utils.safestring import mark_safe
@@ -19,6 +18,8 @@
 
 # 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__)
@@ -31,7 +32,7 @@ def aa_intel_tool_static(
     """
     Versioned static URL
 
-    :param relative_file_path: The file path relative to the `aa-intel-tool/aa_intel_tool/static/aa_intel_tool folder
+    :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
@@ -49,13 +50,13 @@ def aa_intel_tool_static(
     if file_type not in ["css", "js"]:
         raise ValueError(f"Unsupported file type: {file_type}")
 
-    static_file_path = os.path.join("aa_intel_tool", relative_file_path)
+    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 settings.DEBUG
+        if not debug_enabled()
         else ""
     )
 
@@ -68,16 +69,20 @@ def aa_intel_tool_static(
         else static_url + "?v=" + __version__
     )
 
+    return_value = None
+
     # Return the versioned URL with integrity hash for CSS
     if file_type == "css":
-        return mark_safe(f'<link rel="stylesheet" href="{versioned_url}"{sri_string}>')
+        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 mark_safe(
+        return_value = mark_safe(
             f'<script{js_type} src="{versioned_url}"{sri_string}></script>'
         )
 
-    return None  # pragma: no cover
+    return return_value

aa_intel_tool/tests/test_app_settings.py

@@ -10,7 +10,7 @@
 from django.test import TestCase, override_settings
 
 # AA Intel Tool
-from aa_intel_tool.app_settings import AppSettings
+from aa_intel_tool.app_settings import AppSettings, debug_enabled
 
 SETTINGS_PATH = "aa_intel_tool.app_settings"
 
@@ -105,3 +105,25 @@ def test_dscan_grid_size_custom(self):
         expected_grid_size = 1000
 
         self.assertEqual(first=grid_size, second=expected_grid_size)
+
+    @override_settings(DEBUG=True)
+    def test_debug_enabled_with_debug_true(self) -> None:
+        """
+        Test debug_enabled with DEBUG = True
+
+        :return:
+        :rtype:
+        """
+
+        self.assertTrue(debug_enabled())
+
+    @override_settings(DEBUG=False)
+    def test_debug_enabled_with_debug_false(self) -> None:
+        """
+        Test debug_enabled with DEBUG = False
+
+        :return:
+        :rtype:
+        """
+
+        self.assertFalse(debug_enabled())

aa_intel_tool/tests/test_templatetags.py

@@ -8,6 +8,7 @@
 
 # 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
 
 
@@ -36,12 +37,12 @@ def test_versioned_static(self):
         rendered_template = template_to_render.render(context=context)
 
         expected_static_css_src = (
-            f'/static/aa_intel_tool/css/aa-intel-tool.min.css?v={context["version"]}'
+            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/aa_intel_tool/javascript/aa-intel-tool.min.js?v={context["version"]}'
+        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"
         )
@@ -75,8 +76,28 @@ def test_versioned_static_with_debug_enabled(self) -> None:
         rendered_template = template_to_render.render(context=context)
 
         expected_static_css_src = (
-            f'/static/aa_intel_tool/css/aa-intel-tool.min.css?v={context["version"]}'
+            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)