Feat: option to retain child menu items when visible=False

docs/configuration.rst

@@ -18,5 +18,13 @@ MENU_HIDE_EMPTY
 ``MENU_HIDE_EMPTY`` controls if menu items without an explicit ``check`` callback
 should be visible even if they have no children
 
+MENU_TRIM_NON_VISIBLE_CHILD_ITEMS
+-------------------
+**Default: ``True``**
+
+``MENU_TRIM_NON_VISIBLE_CHILD_ITEMS`` controls if children of menu items should be
+removed from the ``item.children`` list if they are not visible. Retaining them
+can be useful for breadcrumbs, but can also lead to unexpected results if you do not
+check the ``visible`` property of the children in templates.
 
 .. _Django settings file: https://docs.djangoproject.com/en/dev/topics/settings/

simple_menu/menu.py

@@ -224,11 +224,12 @@ def process(self, request):
             child.parent = self
             child.process(request)
 
-        self.children = [
-            child
-            for child in children
-            if child.visible
-        ]
+        if getattr(settings, 'MENU_TRIM_NON_VISIBLE_CHILD_ITEMS', True):
+            self.children = [
+                child
+                for child in children
+                if child.visible
+            ]
         self.children.sort(key=lambda child: child.weight)
 
         # if we have no children and MENU_HIDE_EMPTY then we are not visible and should return

simple_menu/tests/test_menu.py

@@ -4,7 +4,7 @@
 
 from django.conf import settings
 from django.template import Template, Context
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.test.client import RequestFactory
 
 from simple_menu import Menu, MenuItem
@@ -264,3 +264,36 @@ def test_kwargs(self):
         self.assertTrue(item.arbitrary)
         self.assertEqual(item.dictionary, {'a': 1})
         self.assertRaises(AttributeError, lambda: item.nope)
+
+    @override_settings(MENU_TRIM_NON_VISIBLE_CHILD_ITEMS=False)
+    def test_trim_non_visible_child_items__disabled(self):
+        """
+        Ensure that non-visible child items are NOT trimmed from the menu
+        """
+        # Generate the menu
+        child_item = MenuItem("child", "/child", visible=False)
+        item = MenuItem("test", "/test", children=[child_item])
+
+        # Process the item
+        request = RequestFactory().get('/test')
+        item.process(request)
+
+        # Check that non-visible child items are still in the menu
+        self.assertIn(child_item, item.children)
+
+    def test_trim_non_visible_child_items__enabled(self):
+        """
+        Ensure that non-visible child items are trimmed from the menu.
+
+        This is the default behaviour
+        """
+        # Generate the menu
+        child_item = MenuItem("child", "/child", visible=False)
+        item = MenuItem("test", "/test", children=[child_item])
+
+        # Process the item
+        request = RequestFactory().get('/test')
+        item.process(request)
+
+        # Check that non-visible child items removed still in the menu
+        self.assertNotIn(child_item, item.children)