Skip asset download in CDN mode (GH-22)

Co-authored-by: Maik Sprenger <[email protected]>

Author: ArtyomVancyan

setup.cfg

@@ -32,6 +32,9 @@ classifiers =
     Framework :: Django :: 4.0
     Framework :: Django :: 4.1
     Framework :: Django :: 4.2
+    Framework :: Django :: 5.0
+    Framework :: Django :: 5.1
+    Framework :: Django :: 5.2
     Programming Language :: Python
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3.6
@@ -40,6 +43,7 @@ classifiers =
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
     License :: OSI Approved :: MIT License
 
 [options]

src/django_mermaid/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.9"
+__version__ = "0.1.0"

src/django_mermaid/apps.py

@@ -7,18 +7,24 @@
 from .templatetags import DEFAULT_VERSION
 from .templatetags import MERMAID_CDN
 
+def download_if_necessary(version):
+    """Download mermaid.js from CDN if not already present"""
+    cdn = "https://cdnjs.cloudflare.com/ajax/libs/mermaid/%s/mermaid.min.js" % version
+    current_dir = pathlib.Path(__file__).parent
+    static_dir = current_dir / "static"
+    mermaid_dir = static_dir / "mermaid" / version
+    mermaid_js = mermaid_dir / "mermaid.js"
+    if not mermaid_js.exists() or \
+            mermaid_js.stat().st_size == 0:
+        mermaid_dir.mkdir(parents=True, exist_ok=True)
+        urlretrieve(MERMAID_CDN % version, str(mermaid_js))
+
 
 class MermaidConfig(AppConfig):
     name = "django_mermaid"
 
     def ready(self):
-        """Download mermaid.js from CDN if not already present"""
-        version = getattr(settings, "MERMAID_VERSION", DEFAULT_VERSION)
-        current_dir = pathlib.Path(__file__).parent
-        static_dir = current_dir / "static"
-        mermaid_dir = static_dir / "mermaid" / version
-        mermaid_js = mermaid_dir / "mermaid.js"
-        if not mermaid_js.exists() or \
-               mermaid_js.stat().st_size == 0:
-            mermaid_dir.mkdir(parents=True, exist_ok=True)
-            urlretrieve(MERMAID_CDN % version, str(mermaid_js))
+        if not getattr(settings, "MERMAID_USE_CDN", False):
+            version = getattr(settings, "MERMAID_VERSION", DEFAULT_VERSION)
+            download_if_necessary(version)
+

src/django_mermaid/templatetags/mermaid.py

@@ -55,7 +55,7 @@ def startmermaid(parser, token):
     else:
         theme = None
 
-    nodelist = parser.parse(('endmermaid',))
+    nodelist = parser.parse(("endmermaid",))
     parser.delete_first_token()
 
     return MermaidNode(nodelist, theme)

tests/test_package.py

@@ -0,0 +1,39 @@
+from os.path import exists, join
+from unittest.mock import patch
+
+from django.apps import apps
+from django.test import override_settings
+
+try:
+    import site
+
+    site_packages = site.getsitepackages()[0]
+except (ImportError, IndexError):
+    import sysconfig
+
+    site_packages = sysconfig.get_paths()["purelib"]
+
+
+@override_settings(MERMAID_USE_CDN=False)
+@patch("django_mermaid.apps.download_if_necessary")
+def test_download_called_when_use_cdn_false(mock_download):
+    # Re-run the AppConfig.ready() method manually
+    app_config = apps.get_app_config("django_mermaid")
+    app_config.ready()
+
+    mock_download.assert_called_once()
+
+
+@override_settings(MERMAID_USE_CDN=True)
+@patch("django_mermaid.apps.download_if_necessary")
+def test_download_not_called_when_use_cdn_true(mock_download):
+    app_config = apps.get_app_config("django_mermaid")
+    app_config.ready()
+
+    mock_download.assert_not_called()
+
+
+def test_tag_use_custom_version():
+    static_dir = join(site_packages, "django_mermaid", "static")
+    assert exists(join(static_dir, "mermaid", "8.6.3", "mermaid.js"))
+    assert exists(join(static_dir, "mermaid", "9.4.3", "mermaid.js"))

tests/test_tag.py

@@ -1,6 +1,3 @@
-from os.path import exists
-from os.path import join
-
 import pytest
 from django.conf import settings
 from django.template import Context
@@ -123,9 +120,3 @@ def test_tag_use_custom_theme_variables_with_base_theme(version, template_code):
             "<script>mermaid.initialize({\"startOnLoad\": true, \"theme\": \"base\", \"themeVariables\": "
             "{\"primaryColor\": \"#efefef\"}});</script>" % version
     )
-
-
-def test_tag_use_custom_version():
-    static_dir = join(site_packages, "django_mermaid", "static")
-    assert exists(join(static_dir, "mermaid", "8.6.3", "mermaid.js"))
-    assert exists(join(static_dir, "mermaid", "9.4.3", "mermaid.js"))