allow NavItem.url to be a callable that returns a string (#112)

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Changed
+
+- Updated `NavItem.url` and `NavItem.get_url` to allow for using a callable. This allows `NavItem.url` to support `django.urls.reverse` or `django.urls.reverse_lazy` primarily, but it can be any callable as long as it returns a string.
+
 ## [0.7.0]
 
 ### Added

src/django_simple_nav/nav.py

@@ -5,6 +5,8 @@
 from dataclasses import field
 from typing import Callable
 from typing import cast
+from urllib.parse import urlparse
+from urllib.parse import urlunparse
 
 from django.apps import apps
 from django.conf import settings
@@ -14,6 +16,7 @@
 from django.template.loader import get_template
 from django.urls import reverse
 from django.urls.exceptions import NoReverseMatch
+from django.utils.functional import Promise
 from django.utils.safestring import mark_safe
 
 from django_simple_nav._templates import get_template_engine
@@ -63,7 +66,7 @@ def get_template_name(self) -> str:
 @dataclass(frozen=True)
 class NavItem:
     title: str
-    url: str | None = None
+    url: str | Callable[..., str] | None = None
     permissions: list[str | Callable[[HttpRequest], bool]] = field(default_factory=list)
     extra_context: dict[str, object] = field(default_factory=dict)
 
@@ -92,14 +95,33 @@ def get_title(self) -> str:
     def get_url(self) -> str:
         url: str | None
 
-        try:
-            url = reverse(self.url)
-        except NoReverseMatch:
-            url = self.url
+        if isinstance(self.url, Promise):
+            # django.urls.base.reverse_lazy
+            url = str(self.url)
+        elif callable(self.url):
+            # django.urls.base.reverse (or some other basic callable)
+            url = self.url()
+        else:
+            try:
+                url = reverse(self.url)
+            except NoReverseMatch:
+                url = self.url
 
         if url is not None:
-            if settings.APPEND_SLASH and not url.endswith("/"):  # pyright: ignore[reportAny]
-                url += "/"
+            parsed_url = urlparse(url)
+            path = parsed_url.path
+            if settings.APPEND_SLASH and not path.endswith("/"):
+                path += "/"
+            url = urlunparse(
+                (
+                    parsed_url.scheme,
+                    parsed_url.netloc,
+                    path,
+                    parsed_url.params,
+                    parsed_url.query,
+                    parsed_url.fragment,
+                )
+            )
             return url
 
         msg = f"{self.__class__!r} must define 'url' or override 'get_url()'"

tests/test_navitem.py

@@ -6,6 +6,8 @@
 from django.contrib.auth.models import AnonymousUser
 from django.core.exceptions import ImproperlyConfigured
 from django.test import override_settings
+from django.urls import reverse
+from django.urls import reverse_lazy
 from model_bakery import baker
 
 from django_simple_nav.nav import NavItem
@@ -83,6 +85,10 @@ def get_title(self):
         ("/test", False, "/test"),
         ("home", True, "/"),
         ("home", False, "/"),
+        (reverse("home"), True, "/"),
+        (reverse("home"), False, "/"),
+        (reverse_lazy("home"), True, "/"),
+        (reverse_lazy("home"), False, "/"),
     ],
 )
 def test_get_url(url, append_slash, expected):