Implement child sorting. Improve tests. Fixes #34

Author: Evan Borgstrom

menu/menu.py

@@ -55,7 +55,10 @@ def load_menus(c):
         # Fetch all installed app names
         app_names = settings.INSTALLED_APPS
         if apps:
-            app_names = [app_config.name for app_config in apps.get_app_configs()]
+            app_names = [
+                app_config.name
+                for app_config in apps.get_app_configs()
+            ]
 
         # loop through our INSTALLED_APPS
         for app in app_names:
@@ -115,7 +118,11 @@ def process(c, request, name=None):
             curitem.selected = True
 
         def filter_visible(items):
-            return [filter_visible_children(item) for item in items if item.visible]
+            return [
+                filter_visible_children(item)
+                for item in items
+                if item.visible
+            ]
 
         def filter_visible_children(item):
             item.children = filter_visible(item.children)
@@ -172,7 +179,6 @@ def __init__(self, title, url, children=[], weight=1, check=None,
         self._title = None
         self.visible = visible
         self.children = children
-        self.children_sorted = False
         self.weight = weight
         self.check = check
         self.slug = slug
@@ -204,6 +210,7 @@ def process(self, request):
         # evaluate children
         visible_children = []
         self.check_children(request)
+        self.children.sort(key=lambda child: child.weight)
         for child in self.children:
             child.process(request)
             if child.visible:

menu/templatetags/menu.py

@@ -11,7 +11,7 @@ def render(self, context):
         # if a 500 error happens we get an empty context, in which case
         # we should just return to let the 500.html template render
         if 'request' not in context:
-            return ''
+            return '<!-- menu failed to render due to missing request in the context -->'
 
         menus = Menu.process(context['request'])
 

menu/tests/test_menu.py

@@ -10,19 +10,20 @@
 class MenuTests(TestCase):
     def setUp(self):
         kids2 = [
-            MenuItem("kids2-1", "/parent2/kids2-1"),
+            MenuItem("kids2-1", "/parent2/kids2-1", weight=999),
             MenuItem("kids2-2", "/kids2-2")
         ]
         kids3 = [
             MenuItem("kids3-1", "/parent3/kids3-1", children=[
               MenuItem("kids3-1-1", "/parent3/kids3-1/kid1")
-            ])
+            ]),
+            MenuItem("kids3-2", "/parent3/kids3-2")
         ]
 
         Menu.items = {}
         Menu.sorted = {}
         Menu.loaded = False
-        Menu.add_item("test", MenuItem("Parent 1", "/parent1"))
+        Menu.add_item("test", MenuItem("Parent 1", "/parent1", weight=999))
         Menu.add_item("test", MenuItem("Parent 2", "/parent2", children=kids2))
         Menu.add_item("test", MenuItem("Parent 3", "/parent3", children=kids3))
 
@@ -32,54 +33,58 @@ def test_select_parents(self):
         """
         Ensure the MENU_SELECT_PARENTS setting works
         """
+        settings.MENU_SELECT_PARENTS = False
         request = self.factory.get('/parent2/kids2-1')
         Menu.process(request, 'test')
-        self.assertEqual(Menu.items['test'][1].selected, True)
-        self.assertEqual(Menu.items['test'][2].selected, False)
-        self.assertEqual(Menu.items['test'][1].children[0].selected, True)
+        self.assertEqual(Menu.items['test'][0].selected, True)
+        self.assertEqual(Menu.items['test'][1].selected, False)
+        self.assertEqual(Menu.items['test'][0].children[1].selected, True)
 
         request = self.factory.get('/kids2-2')
         Menu.process(request, 'test')
+        self.assertEqual(Menu.items['test'][0].selected, False)
         self.assertEqual(Menu.items['test'][1].selected, False)
-        self.assertEqual(Menu.items['test'][2].selected, False)
-        self.assertEqual(Menu.items['test'][1].children[1].selected, True)
+        self.assertEqual(Menu.items['test'][0].children[0].selected, True)
 
         settings.MENU_SELECT_PARENTS = True
         request = self.factory.get('/kids2-2')
         Menu.process(request, 'test')
-        self.assertEqual(Menu.items['test'][1].selected, True)
-        self.assertEqual(Menu.items['test'][2].selected, False)
-        self.assertEqual(Menu.items['test'][1].children[1].selected, True)
+        self.assertEqual(Menu.items['test'][0].selected, True)
+        self.assertEqual(Menu.items['test'][1].selected, False)
+        self.assertEqual(Menu.items['test'][0].children[0].selected, True)
 
-        settings.MENU_SELECT_PARENTS = True
         request = self.factory.get('/parent3/kids3-1/kid1')
         Menu.process(request, 'test')
         self.assertEqual(Menu.items['test'][0].selected, False)
-        self.assertEqual(Menu.items['test'][1].selected, False)
+        self.assertEqual(Menu.items['test'][0].children[1].selected, False)
+        self.assertEqual(Menu.items['test'][1].selected, True)
+        self.assertEqual(Menu.items['test'][1].children[0].selected, True)
+        self.assertEqual(Menu.items['test'][1].children[0].children[0].selected, True)
         self.assertEqual(Menu.items['test'][1].children[1].selected, False)
-        self.assertEqual(Menu.items['test'][2].selected, True)
-        self.assertEqual(Menu.items['test'][2].children[0].selected, True)
-        self.assertEqual(Menu.items['test'][2].children[0].children[0].selected, True)
+        self.assertEqual(Menu.items['test'][2].selected, False)
 
     def test_template_tag(self):
         """
         Ensure the templating works
         """
-        request = self.factory.get('/parent2/kids2-1')
+        request = self.factory.get('/parent3/kids3-1')
         out = Template(
             "{% load menu %}"
             "{% generate_menu %}"
             "{% for item in menus.test %}"
             "{{ item.title }},"
             "{% for child in item.children %}"
             "{{ child.title }},"
+            "{% for grandchild in child.children %}"
+            "{{ grandchild.title }},"
+            "{% endfor %}"
             "{% endfor %}"
             "{% endfor %}"
         ).render(Context({
             'request': request,
         }))
 
-        self.assertEqual(out, "Parent 1,Parent 2,kids2-1,kids2-2,Parent 3,kids3-1,")
+        self.assertEqual(out, "Parent 2,kids2-2,kids2-1,Parent 3,kids3-1,kids3-1-1,kids3-2,Parent 1,")
 
     def test_template_tag_missing_attribute(self):
         """
@@ -96,7 +101,7 @@ def test_template_tag_missing_attribute(self):
             'request': request,
         }))
 
-        self.assertEqual(out, "Parent 1,Parent 2,Parent 3,")
+        self.assertEqual(out, "Parent 2,Parent 3,Parent 1,")
 
 class MenuItemTests(TestCase):
     def test_kwargs(self):