Merge pull request #256 from pheus/feature/255-group-navigation-items

refactor(navigation): Group plugin menu items

Author: cruse1977

netbox_acls/navigation.py

@@ -1,76 +1,103 @@
 """
-Define the plugin menu buttons & the plugin navigation bar enteries.
+Define the plugin menu buttons and the plugin navigation bar entries.
 """
 
 from django.conf import settings
 from netbox.plugins import PluginMenu, PluginMenuButton, PluginMenuItem
 
-
 plugin_settings = settings.PLUGINS_CONFIG["netbox_acls"]
 
 #
 # Define plugin menu buttons
 #
-menu_buttons = (
-    PluginMenuItem(
-        link="plugins:netbox_acls:accesslist_list",
-        link_text="Access Lists",
-        permissions=["netbox_acls.view_accesslist"],
-        buttons=(
-            PluginMenuButton(
-                link="plugins:netbox_acls:accesslist_add",
-                title="Add",
-                icon_class="mdi mdi-plus-thick",
-                permissions=["netbox_acls.add_accesslist"],
-            ),
+
+# Access List
+accesslist_item = PluginMenuItem(
+    link="plugins:netbox_acls:accesslist_list",
+    link_text="Access Lists",
+    permissions=["netbox_acls.view_accesslist"],
+    buttons=(
+        PluginMenuButton(
+            link="plugins:netbox_acls:accesslist_add",
+            title="Add",
+            icon_class="mdi mdi-plus-thick",
+            permissions=["netbox_acls.add_accesslist"],
         ),
     ),
-    PluginMenuItem(
-        link="plugins:netbox_acls:aclstandardrule_list",
-        link_text="Standard Rules",
-        permissions=["netbox_acls.view_aclstandardrule"],
-        buttons=(
-            PluginMenuButton(
-                link="plugins:netbox_acls:aclstandardrule_add",
-                title="Add",
-                icon_class="mdi mdi-plus-thick",
-                permissions=["netbox_acls.add_aclstandardrule"],
-            ),
+)
+
+# ACL Standard Rule
+aclstandardrule_item = PluginMenuItem(
+    link="plugins:netbox_acls:aclstandardrule_list",
+    link_text="Standard Rules",
+    permissions=["netbox_acls.view_aclstandardrule"],
+    buttons=(
+        PluginMenuButton(
+            link="plugins:netbox_acls:aclstandardrule_add",
+            title="Add",
+            icon_class="mdi mdi-plus-thick",
+            permissions=["netbox_acls.add_aclstandardrule"],
         ),
     ),
-    PluginMenuItem(
-        link="plugins:netbox_acls:aclextendedrule_list",
-        link_text="Extended Rules",
-        permissions=["netbox_acls.view_aclextendedrule"],
-        buttons=(
-            PluginMenuButton(
-                link="plugins:netbox_acls:aclextendedrule_add",
-                title="Add",
-                icon_class="mdi mdi-plus-thick",
-                permissions=["netbox_acls.add_aclextendedrule"],
-            ),
+)
+
+# ACL Extended Rule
+aclextendedrule_item = PluginMenuItem(
+    link="plugins:netbox_acls:aclextendedrule_list",
+    link_text="Extended Rules",
+    permissions=["netbox_acls.view_aclextendedrule"],
+    buttons=(
+        PluginMenuButton(
+            link="plugins:netbox_acls:aclextendedrule_add",
+            title="Add",
+            icon_class="mdi mdi-plus-thick",
+            permissions=["netbox_acls.add_aclextendedrule"],
         ),
     ),
-    PluginMenuItem(
-        link="plugins:netbox_acls:aclinterfaceassignment_list",
-        link_text="Interface Assignments",
-        permissions=["netbox_acls.view_aclinterfaceassignment"],
-        buttons=(
-            PluginMenuButton(
-                link="plugins:netbox_acls:aclinterfaceassignment_add",
-                title="Add",
-                icon_class="mdi mdi-plus-thick",
-                permissions=["netbox_acls.add_aclinterfaceassignment"],
-            ),
+)
+
+# ACL Interface Assignment
+aclinterfaceassignment_item = PluginMenuItem(
+    link="plugins:netbox_acls:aclinterfaceassignment_list",
+    link_text="Interface Assignments",
+    permissions=["netbox_acls.view_aclinterfaceassignment"],
+    buttons=(
+        PluginMenuButton(
+            link="plugins:netbox_acls:aclinterfaceassignment_add",
+            title="Add",
+            icon_class="mdi mdi-plus-thick",
+            permissions=["netbox_acls.add_aclinterfaceassignment"],
         ),
     ),
 )
 
+
 if plugin_settings.get("top_level_menu"):
     menu = PluginMenu(
         label="Access Lists",
-        groups=(("ACLs", menu_buttons),),
+        groups=(
+            (
+                "Access Lists",
+                (accesslist_item,),
+            ),
+            (
+                "Rules",
+                (
+                    aclstandardrule_item,
+                    aclextendedrule_item,
+                ),
+            ),
+            (
+                "Assignments",
+                (aclinterfaceassignment_item,),
+            ),
+        ),
         icon_class="mdi mdi-lock",
     )
 else:
-    menu_items = menu_buttons
+    menu_items = (
+        accesslist_item,
+        aclstandardrule_item,
+        aclextendedrule_item,
+        aclinterfaceassignment_item,
+    )