From f369b5f588ad29d9de0f36cfdce586bd3769e7eb Mon Sep 17 00:00:00 2001
From: jeremystretch <jstretch@ns1.com>
Date: Wed, 22 Dec 2021 15:05:24 -0500
Subject: [PATCH] Reorganize & clean up templatetag templates

---
 netbox/templates/base/layout.html             |  3 +-
 netbox/templates/base/sidenav.html            |  2 +-
 netbox/templates/home.html                    |  1 -
 .../form_helpers}/render_custom_fields.html   |  0
 .../form_helpers}/render_errors.html          |  0
 .../templates/form_helpers}/render_field.html |  0
 .../templates/form_helpers}/render_form.html  |  0
 .../templates/helpers}/applied_filters.html   |  0
 .../templates/helpers}/badge.html             |  0
 .../templates/helpers}/table_config_form.html |  0
 .../templates/helpers}/tag.html               |  0
 .../templates/helpers}/utilization_graph.html |  0
 .../navigation/{nav_items.html => menu.html}  |  0
 netbox/utilities/templatetags/form_helpers.py | 74 ++++++++++---------
 netbox/utilities/templatetags/get_status.py   | 21 ------
 netbox/utilities/templatetags/helpers.py      | 10 +--
 .../templatetags/{nav.py => navigation.py}    |  2 +-
 .../{search_options.py => search.py}          |  0
 18 files changed, 49 insertions(+), 64 deletions(-)
 rename netbox/{templates/utilities => utilities/templates/form_helpers}/render_custom_fields.html (100%)
 rename netbox/{templates/utilities => utilities/templates/form_helpers}/render_errors.html (100%)
 rename netbox/{templates/utilities => utilities/templates/form_helpers}/render_field.html (100%)
 rename netbox/{templates/utilities => utilities/templates/form_helpers}/render_form.html (100%)
 rename netbox/{templates/utilities/templatetags => utilities/templates/helpers}/applied_filters.html (100%)
 rename netbox/{templates/utilities/templatetags => utilities/templates/helpers}/badge.html (100%)
 rename netbox/{templates/utilities/templatetags => utilities/templates/helpers}/table_config_form.html (100%)
 rename netbox/{templates/utilities/templatetags => utilities/templates/helpers}/tag.html (100%)
 rename netbox/{templates/utilities/templatetags => utilities/templates/helpers}/utilization_graph.html (100%)
 rename netbox/utilities/templates/navigation/{nav_items.html => menu.html} (100%)
 delete mode 100644 netbox/utilities/templatetags/get_status.py
 rename netbox/utilities/templatetags/{nav.py => navigation.py} (81%)
 rename netbox/utilities/templatetags/{search_options.py => search.py} (100%)

diff --git a/netbox/templates/base/layout.html b/netbox/templates/base/layout.html
index 38c1dc21b..d6a21c2b5 100644
--- a/netbox/templates/base/layout.html
+++ b/netbox/templates/base/layout.html
@@ -1,8 +1,7 @@
 {# Base layout for the core NetBox UI w/navbar and page content #}
 {% extends 'base/base.html' %}
 {% load helpers %}
-{% load nav %}
-{% load search_options %}
+{% load search %}
 {% load static %}
 
 {% block layout %}
diff --git a/netbox/templates/base/sidenav.html b/netbox/templates/base/sidenav.html
index 5790e8c44..1df20e6de 100644
--- a/netbox/templates/base/sidenav.html
+++ b/netbox/templates/base/sidenav.html
@@ -1,4 +1,4 @@
-{% load nav %}
+{% load navigation %}
 {% load static %}
 
 <nav class="sidenav noprint" id="sidenav" data-simplebar>
diff --git a/netbox/templates/home.html b/netbox/templates/home.html
index 8dc5ab4f9..2932bdc99 100644
--- a/netbox/templates/home.html
+++ b/netbox/templates/home.html
@@ -1,5 +1,4 @@
 {% extends 'base/layout.html' %}
-{% load get_status %}
 {% load helpers %}
 {% load render_table from django_tables2 %}
 
diff --git a/netbox/templates/utilities/render_custom_fields.html b/netbox/utilities/templates/form_helpers/render_custom_fields.html
similarity index 100%
rename from netbox/templates/utilities/render_custom_fields.html
rename to netbox/utilities/templates/form_helpers/render_custom_fields.html
diff --git a/netbox/templates/utilities/render_errors.html b/netbox/utilities/templates/form_helpers/render_errors.html
similarity index 100%
rename from netbox/templates/utilities/render_errors.html
rename to netbox/utilities/templates/form_helpers/render_errors.html
diff --git a/netbox/templates/utilities/render_field.html b/netbox/utilities/templates/form_helpers/render_field.html
similarity index 100%
rename from netbox/templates/utilities/render_field.html
rename to netbox/utilities/templates/form_helpers/render_field.html
diff --git a/netbox/templates/utilities/render_form.html b/netbox/utilities/templates/form_helpers/render_form.html
similarity index 100%
rename from netbox/templates/utilities/render_form.html
rename to netbox/utilities/templates/form_helpers/render_form.html
diff --git a/netbox/templates/utilities/templatetags/applied_filters.html b/netbox/utilities/templates/helpers/applied_filters.html
similarity index 100%
rename from netbox/templates/utilities/templatetags/applied_filters.html
rename to netbox/utilities/templates/helpers/applied_filters.html
diff --git a/netbox/templates/utilities/templatetags/badge.html b/netbox/utilities/templates/helpers/badge.html
similarity index 100%
rename from netbox/templates/utilities/templatetags/badge.html
rename to netbox/utilities/templates/helpers/badge.html
diff --git a/netbox/templates/utilities/templatetags/table_config_form.html b/netbox/utilities/templates/helpers/table_config_form.html
similarity index 100%
rename from netbox/templates/utilities/templatetags/table_config_form.html
rename to netbox/utilities/templates/helpers/table_config_form.html
diff --git a/netbox/templates/utilities/templatetags/tag.html b/netbox/utilities/templates/helpers/tag.html
similarity index 100%
rename from netbox/templates/utilities/templatetags/tag.html
rename to netbox/utilities/templates/helpers/tag.html
diff --git a/netbox/templates/utilities/templatetags/utilization_graph.html b/netbox/utilities/templates/helpers/utilization_graph.html
similarity index 100%
rename from netbox/templates/utilities/templatetags/utilization_graph.html
rename to netbox/utilities/templates/helpers/utilization_graph.html
diff --git a/netbox/utilities/templates/navigation/nav_items.html b/netbox/utilities/templates/navigation/menu.html
similarity index 100%
rename from netbox/utilities/templates/navigation/nav_items.html
rename to netbox/utilities/templates/navigation/menu.html
diff --git a/netbox/utilities/templatetags/form_helpers.py b/netbox/utilities/templatetags/form_helpers.py
index 808b24b4d..03cc0ac0b 100644
--- a/netbox/utilities/templatetags/form_helpers.py
+++ b/netbox/utilities/templatetags/form_helpers.py
@@ -4,6 +4,10 @@ from django import template
 register = template.Library()
 
 
+#
+# Filters
+#
+
 @register.filter()
 def getfield(form, fieldname):
     """
@@ -12,38 +16,6 @@ def getfield(form, fieldname):
     return form[fieldname]
 
 
-@register.inclusion_tag('utilities/render_field.html')
-def render_field(field, bulk_nullable=False, label=None):
-    """
-    Render a single form field from template
-    """
-    return {
-        'field': field,
-        'label': label,
-        'bulk_nullable': bulk_nullable,
-    }
-
-
-@register.inclusion_tag('utilities/render_custom_fields.html')
-def render_custom_fields(form):
-    """
-    Render all custom fields in a form
-    """
-    return {
-        'form': form,
-    }
-
-
-@register.inclusion_tag('utilities/render_form.html')
-def render_form(form):
-    """
-    Render an entire form from template
-    """
-    return {
-        'form': form,
-    }
-
-
 @register.filter(name='widget_type')
 def widget_type(field):
     """
@@ -57,7 +29,43 @@ def widget_type(field):
         return None
 
 
-@register.inclusion_tag('utilities/render_errors.html')
+#
+# Inclusion tags
+#
+
+@register.inclusion_tag('form_helpers/render_field.html')
+def render_field(field, bulk_nullable=False, label=None):
+    """
+    Render a single form field from template
+    """
+    return {
+        'field': field,
+        'label': label,
+        'bulk_nullable': bulk_nullable,
+    }
+
+
+@register.inclusion_tag('form_helpers/render_custom_fields.html')
+def render_custom_fields(form):
+    """
+    Render all custom fields in a form
+    """
+    return {
+        'form': form,
+    }
+
+
+@register.inclusion_tag('form_helpers/render_form.html')
+def render_form(form):
+    """
+    Render an entire form from template
+    """
+    return {
+        'form': form,
+    }
+
+
+@register.inclusion_tag('form_helpers/render_errors.html')
 def render_errors(form):
     """
     Render form errors, if they exist.
diff --git a/netbox/utilities/templatetags/get_status.py b/netbox/utilities/templatetags/get_status.py
deleted file mode 100644
index fde677053..000000000
--- a/netbox/utilities/templatetags/get_status.py
+++ /dev/null
@@ -1,21 +0,0 @@
-from django import template
-
-register = template.Library()
-
-TERMS_DANGER = ("delete", "deleted", "remove", "removed")
-TERMS_WARNING = ("changed", "updated", "change", "update")
-TERMS_SUCCESS = ("created", "added", "create", "add")
-
-
-@register.simple_tag
-def get_status(text: str) -> str:
-    lower = text.lower()
-
-    if lower in TERMS_DANGER:
-        return "danger"
-    elif lower in TERMS_WARNING:
-        return "warning"
-    elif lower in TERMS_SUCCESS:
-        return "success"
-    else:
-        return "info"
diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py
index 47e341400..c054785fc 100644
--- a/netbox/utilities/templatetags/helpers.py
+++ b/netbox/utilities/templatetags/helpers.py
@@ -384,7 +384,7 @@ def querystring(request, **kwargs):
         return ''
 
 
-@register.inclusion_tag('utilities/templatetags/utilization_graph.html')
+@register.inclusion_tag('helpers/utilization_graph.html')
 def utilization_graph(utilization, warning_threshold=75, danger_threshold=90):
     """
     Display a horizontal bar graph indicating a percentage of utilization.
@@ -403,7 +403,7 @@ def utilization_graph(utilization, warning_threshold=75, danger_threshold=90):
     }
 
 
-@register.inclusion_tag('utilities/templatetags/tag.html')
+@register.inclusion_tag('helpers/tag.html')
 def tag(tag, url_name=None):
     """
     Display a tag, optionally linked to a filtered list of objects.
@@ -414,7 +414,7 @@ def tag(tag, url_name=None):
     }
 
 
-@register.inclusion_tag('utilities/templatetags/badge.html')
+@register.inclusion_tag('helpers/badge.html')
 def badge(value, bg_class='secondary', show_empty=False):
     """
     Display the specified number as a badge.
@@ -426,7 +426,7 @@ def badge(value, bg_class='secondary', show_empty=False):
     }
 
 
-@register.inclusion_tag('utilities/templatetags/table_config_form.html')
+@register.inclusion_tag('helpers/table_config_form.html')
 def table_config_form(table, table_name=None):
     return {
         'table_name': table_name or table.__class__.__name__,
@@ -434,7 +434,7 @@ def table_config_form(table, table_name=None):
     }
 
 
-@register.inclusion_tag('utilities/templatetags/applied_filters.html')
+@register.inclusion_tag('helpers/applied_filters.html')
 def applied_filters(form, query_params):
     """
     Display the active filters for a given filter form.
diff --git a/netbox/utilities/templatetags/nav.py b/netbox/utilities/templatetags/navigation.py
similarity index 81%
rename from netbox/utilities/templatetags/nav.py
rename to netbox/utilities/templatetags/navigation.py
index 205d1b590..ede8792fa 100644
--- a/netbox/utilities/templatetags/nav.py
+++ b/netbox/utilities/templatetags/navigation.py
@@ -8,7 +8,7 @@ from netbox.navigation_menu import MENUS
 register = template.Library()
 
 
-@register.inclusion_tag("navigation/nav_items.html", takes_context=True)
+@register.inclusion_tag("navigation/menu.html", takes_context=True)
 def nav(context: Context) -> Dict:
     """
     Render the navigation menu.
diff --git a/netbox/utilities/templatetags/search_options.py b/netbox/utilities/templatetags/search.py
similarity index 100%
rename from netbox/utilities/templatetags/search_options.py
rename to netbox/utilities/templatetags/search.py