Allow generation of custom menu from mapping of app/name -> models

David Farrington · David Farrington · commit e5fafe25bba2 · 2020-12-31T12:16:53.000Z
diff --git a/jazzmin/settings.py b/jazzmin/settings.py
@@ -50,6 +50,8 @@
     "order_with_respect_to": [],
     # Custom links to append to side menu app groups, keyed on app name
     "custom_links": {},
+    # Do not generate a menu based off of installed apps, instead, manually craft one using this app -> model mapping
+    "custom_menu": {},
     # Custom icons for side menu apps/models See https://fontawesome.com/icons?d=gallery&m=free
     # for a list of icon classes
     "icons": {"auth": "fas fa-users-cog", "auth.user": "fas fa-user", "auth.Group": "fas fa-users"},
diff --git a/jazzmin/templatetags/jazzmin.py b/jazzmin/templatetags/jazzmin.py
@@ -31,6 +31,7 @@
     get_admin_url,
     make_menu,
     has_fieldsets_check,
+    regroup_available_apps,
 )
 
 User = get_user_model()
@@ -49,18 +50,22 @@ def get_side_menu(context: Context, using: str = "available_apps") -> List[Dict]
     if not user:
         return []
 
+    menu = []
     options = get_settings()
     ordering = options.get("order_with_respect_to", [])
     ordering = [x.lower() for x in ordering]
 
-    menu = []
     available_apps = copy.deepcopy(context.get(using, []))
 
     custom_links = {
         app_name: make_menu(user, links, options, allow_appmenus=False)
         for app_name, links in options.get("custom_links", {}).items()
     }
 
+    # If we are using custom grouping, overwrite available_apps based on our grouping
+    if options.get("custom_menu") and options["custom_menu"]:
+        available_apps = regroup_available_apps(available_apps, options["custom_menu"])
+
     for app in available_apps:
         app_label = app["app_label"].lower()
         app_custom_links = custom_links.get(app_label, [])
@@ -83,18 +88,13 @@ def get_side_menu(context: Context, using: str = "available_apps") -> List[Dict]
 
         custom_link_names = [x.get("name", "").lower() for x in app_custom_links]
         model_ordering = list(
-            filter(
-                lambda x: x.lower().startswith("{}.".format(app_label)) or x.lower() in custom_link_names,
-                ordering,
-            )
+            filter(lambda x: x.lower().startswith("{}.".format(app_label)) or x.lower() in custom_link_names, ordering,)
         )
 
         if len(menu_items):
             if model_ordering:
                 menu_items = order_with_respect_to(
-                    menu_items,
-                    model_ordering,
-                    getter=lambda x: x.get("model_str", x.get("name", "").lower()),
+                    menu_items, model_ordering, getter=lambda x: x.get("model_str", x.get("name", "").lower()),
                 )
             app["models"] = menu_items
             menu.append(app)
@@ -420,8 +420,7 @@ def deleted(x: str) -> Dict:
 
             elif "changed" in sub_message:
                 sub_message["changed"]["fields"] = get_text_list(
-                    [gettext(field_name) for field_name in sub_message["changed"]["fields"]],
-                    gettext("and"),
+                    [gettext(field_name) for field_name in sub_message["changed"]["fields"]], gettext("and"),
                 )
                 if "name" in sub_message["changed"]:
                     sub_message["changed"]["name"] = gettext(sub_message["changed"]["name"])
diff --git a/jazzmin/utils.py b/jazzmin/utils.py
@@ -232,3 +232,32 @@ def has_fieldsets_check(adminform: AdminForm) -> bool:
     if not fieldsets or (len(fieldsets) == 1 and fieldsets[0][0] is None):
         return False
     return True
+
+
+def regroup_available_apps(available_apps: List[Dict], grouping: Dict[str, List[str]]) -> List[Dict]:
+    # Make a list of all apps, and all models, keyed on app name or model name
+    all_models, all_apps = {}, {}
+    for app in available_apps:
+        app_label = app["app_label"].lower()
+        all_apps[app_label] = app
+        for model in app["models"]:
+            model_name = model["object_name"].lower()
+            all_models[app_label + "." + model_name] = model.copy()
+
+    # Start overwriting available_apps
+    new_available_apps = []
+    for group, children in grouping.items():
+        app = all_apps.get(
+            group.lower(),
+            {"name": group.title(), "app_label": group, "app_url": None, "has_module_perms": True, "models": []},
+        )
+
+        app["models"] = []
+        for model in children:
+            model_obj = all_models.get(model.lower())
+            if model_obj:
+                app["models"].append(model_obj)
+
+        new_available_apps.append(app)
+
+    return new_available_apps
diff --git a/tests/test_app/library/settings.py b/tests/test_app/library/settings.py
@@ -71,25 +71,15 @@
 
 DATABASES = {
     "default": dj_database_url.config(
-        env="DATABASE_URL",
-        conn_max_age=500,
-        default="sqlite:///{}".format(os.path.join(BASE_DIR, "db.sqlite3")),
+        env="DATABASE_URL", conn_max_age=500, default="sqlite:///{}".format(os.path.join(BASE_DIR, "db.sqlite3")),
     )
 }
 
 AUTH_PASSWORD_VALIDATORS = [
-    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
-    },
-    {
-        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
-    },
-    {
-        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
-    },
-    {
-        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
-    },
+    {"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",},
+    {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",},
+    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",},
+    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",},
 ]
 
 LANGUAGE_CODE = "en"
@@ -144,11 +134,7 @@
         # Url that gets reversed (Permissions can be added)
         {"name": "Home", "url": "admin:index", "permissions": ["auth.view_user"]},
         # external url that opens in a new window (Permissions can be added)
-        {
-            "name": "Support",
-            "url": "https://github.com/farridav/django-jazzmin/issues",
-            "new_window": True,
-        },
+        {"name": "Support", "url": "https://github.com/farridav/django-jazzmin/issues", "new_window": True,},
         # model admin to link to (Permissions checked against model)
         {"model": "auth.User"},
         # App with dropdown menu to all its models pages (Permissions checked against models)
@@ -160,11 +146,7 @@
     #############
     # Additional links to include in the user menu on the top right ('app' url type is not allowed)
     "usermenu_links": [
-        {
-            "name": "Support",
-            "url": "https://github.com/farridav/django-jazzmin/issues",
-            "new_window": True,
-        },
+        {"name": "Support", "url": "https://github.com/farridav/django-jazzmin/issues", "new_window": True,},
         {"model": "auth.user"},
     ],
     #############
@@ -191,6 +173,8 @@
             }
         ]
     },
+    # Dont generate a menu based off installed apps, instead, craft one using this app/arbitrary name -> model mapping
+    "custom_menu": {},
     # Custom icons for side menu apps/models See https://fontawesome.com/icons?d=gallery&m=free
     # for a list of icon classes
     "icons": {
diff --git a/tests/test_jazzmin_menus.py b/tests/test_jazzmin_menus.py
@@ -1,6 +1,9 @@
 import pytest
+from django.contrib.admin import site
+from django.template import Context
 from django.urls import reverse
 
+from jazzmin.templatetags.jazzmin import get_side_menu
 from .test_app.library.factories import UserFactory
 from .utils import (
     parse_sidemenu,
@@ -21,21 +24,10 @@ def test_side_menu(admin_client, settings):
 
     assert parse_sidemenu(response) == {
         "Administration": ["/en/admin/admin/logentry/"],
-        "Authentication and Authorization": [
-            "/en/admin/auth/group/",
-            "/en/admin/auth/user/",
-        ],
-        "Books": [
-            "/en/admin/books/author/",
-            "/en/admin/books/book/",
-            "/en/admin/books/genre/",
-        ],
+        "Authentication and Authorization": ["/en/admin/auth/group/", "/en/admin/auth/user/",],
+        "Books": ["/en/admin/books/author/", "/en/admin/books/book/", "/en/admin/books/genre/",],
         "Global": ["/en/admin/"],
-        "Loans": [
-            "/make_messages/",
-            "/en/admin/loans/bookloan/",
-            "/en/admin/loans/library/",
-        ],
+        "Loans": ["/make_messages/", "/en/admin/loans/bookloan/", "/en/admin/loans/library/",],
     }
 
     settings.JAZZMIN_SETTINGS = override_jazzmin_settings(hide_models=["auth.user"])
@@ -44,16 +36,8 @@ def test_side_menu(admin_client, settings):
     assert parse_sidemenu(response) == {
         "Global": ["/en/admin/"],
         "Authentication and Authorization": ["/en/admin/auth/group/"],
-        "Books": [
-            "/en/admin/books/author/",
-            "/en/admin/books/book/",
-            "/en/admin/books/genre/",
-        ],
-        "Loans": [
-            "/make_messages/",
-            "/en/admin/loans/bookloan/",
-            "/en/admin/loans/library/",
-        ],
+        "Books": ["/en/admin/books/author/", "/en/admin/books/book/", "/en/admin/books/genre/",],
+        "Loans": ["/make_messages/", "/en/admin/loans/bookloan/", "/en/admin/loans/library/",],
         "Administration": ["/en/admin/admin/logentry/"],
     }
 
@@ -103,11 +87,7 @@ def test_top_menu(admin_client, settings):
     settings.JAZZMIN_SETTINGS = override_jazzmin_settings(
         topmenu_links=[
             {"name": "Home", "url": "admin:index", "permissions": ["auth.view_user"]},
-            {
-                "name": "Support",
-                "url": "https://github.com/farridav/django-jazzmin/issues",
-                "new_window": True,
-            },
+            {"name": "Support", "url": "https://github.com/farridav/django-jazzmin/issues", "new_window": True,},
             {"model": "auth.User"},
             {"app": "books"},
         ]
@@ -117,10 +97,7 @@ def test_top_menu(admin_client, settings):
 
     assert parse_topmenu(response) == [
         {"name": "Home", "link": "/en/admin/"},
-        {
-            "name": "Support",
-            "link": "https://github.com/farridav/django-jazzmin/issues",
-        },
+        {"name": "Support", "link": "https://github.com/farridav/django-jazzmin/issues",},
         {"name": "Users", "link": "/en/admin/auth/user/"},
         {
             "name": "Books",
@@ -144,11 +121,7 @@ def test_user_menu(admin_user, client, settings):
     settings.JAZZMIN_SETTINGS = override_jazzmin_settings(
         usermenu_links=[
             {"name": "Home", "url": "admin:index", "permissions": ["auth.view_user"]},
-            {
-                "name": "Support",
-                "url": "https://github.com/farridav/django-jazzmin/issues",
-                "new_window": True,
-            },
+            {"name": "Support", "url": "https://github.com/farridav/django-jazzmin/issues", "new_window": True},
             {"model": "auth.User"},
         ]
     )
@@ -160,13 +133,18 @@ def test_user_menu(admin_user, client, settings):
         {"link": "/en/admin/password_change/", "name": "Change password"},
         {"link": "/en/admin/logout/", "name": "Log out"},
         {"link": "/en/admin/", "name": "Home"},
-        {
-            "link": "https://github.com/farridav/django-jazzmin/issues",
-            "name": "Support",
-        },
+        {"link": "https://github.com/farridav/django-jazzmin/issues", "name": "Support"},
         {"link": "/en/admin/auth/user/", "name": "Users"},
-        {
-            "link": "/en/admin/auth/user/{}/change/".format(admin_user.pk),
-            "name": "See Profile",
-        },
+        {"link": "/en/admin/auth/user/{}/change/".format(admin_user.pk), "name": "See Profile"},
     ]
+
+
+def test_custom_menu_grouping(settings, rf):
+    context = site.each_context(rf)
+    settings.JAZZMIN_SETTINGS = override_jazzmin_settings(
+        custom_menu={"auth": ["books.book"], "arbitrary name": ["auth.user", "auth.group"]}
+    )
+
+    menu = get_side_menu(context)
+
+    assert menu == []
