Merge branch 'dev' into 1347-add-official-dark-mode-theme

Author: jchate6

poetry.lock

@@ -22,9 +22,15 @@
 def navbar_app_addons(context, position='left'):
     """
     Imports the navbar content from appropriate apps
-    This should be a list of partials containing an <li> element that you would like displayed in the navbar with the
-    following format:
-     `<li class="nav-item"> <a class="nav-link" href="{% url 'namespace:view_name' %}">Link Text</a> </li>`
+    Each nav_item should be contained in a list of dictionaries in an app's apps.py `nav_items` method.
+    Each nav_item dictionary should contain a 'partial' key with the path to the html partial template and
+    optionally a 'context' key with the path to the context processor class (typically a templatetag). An optional
+    'position' key will add the partial to either the right or left side of the nav bar.
+
+    FOR EXAMPLE:
+    [{'partial': 'path/to/partial.html',
+      'context': 'path/to/context/data/method',
+      'position: 'left'}]
     """
     nav_items_to_display = []
     for app in apps.get_app_configs():

tom_common/templatetags/tom_common_extras.py

@@ -1,3 +1,4 @@
-{% for button in button_list %}
-    <a href="{% url button.namespace pk=target.id %}" title="{{button.title}}" class="{{ button.class }}">{{button.text}}</a>
+{% load tom_common_extras %}
+{% for button in target_buttons_to_display %}
+    {% show_individual_app_partial button %}
 {% endfor %}

tom_targets/templates/tom_targets/partials/module_buttons.html

@@ -5,5 +5,5 @@
     <a href="{% url 'tom_targets:share' pk=target.id %}" title="Share target" class="btn  btn-info">Share</a>
     {% endif %}
     <a href="{% url 'tom_targets:delete' pk=target.id %}" title="Delete target" class="btn  btn-warning">Delete</a>
-    {% get_buttons target %}
+    {% get_buttons %}
 </div>

tom_targets/templates/tom_targets/partials/target_buttons.html

@@ -475,29 +475,41 @@ def create_persistent_share(context, target):
     return {'form': form, 'target': target}
 
 
-@register.inclusion_tag('tom_targets/partials/module_buttons.html')
-def get_buttons(target):
+@register.inclusion_tag('tom_targets/partials/module_buttons.html', takes_context=True)
+def get_buttons(context):
     """
-    Returns a list of buttons from imported modules to be displayed on the target detail page.
-    In order to add a button to the target detail page, an app must contain an integration points attribute.
-    The Integration Points attribute must be a dictionary with a key of 'target_detail_button':
-    'target_detail_button' = {'namespace': <<redirect path, i.e. 'app:name'>>,
-                              'title': <<Button title>>,
-                              'class': <<Button class i.e 'btn  btn-info'>>,
-                              'text': <<What you want the button to actually say>>,
-                              }
+    Imports the target detail Button content from relevant apps into the template.
 
+    Each target_button should be contained in a list of dictionaries in an app's apps.py `target_detail_buttons` method.
+    Each target_button dictionary should contain a 'partial' key with the path to the html partial template and
+    optionally a 'context' key with the path to the context processor class (typically a templatetag).
+
+    FOR EXAMPLE:
+    [{'partial': 'path/to/partial.html',
+      'context': 'path/to/context/data/method'}]
     """
-    button_list = []
+    target_buttons_to_display = []
     for app in apps.get_app_configs():
         try:
-            button_info = app.target_detail_buttons()
-            if button_info:
-                button_list.append(button_info)
+            target_buttons = app.target_detail_buttons()
         except AttributeError:
-            pass
-
-    return {'target': target, 'button_list': button_list}
+            continue
+        if target_buttons:
+            for button in target_buttons:
+                new_context = {}
+                if button.get('context'):
+                    try:
+                        context_method = import_string(button.get('context'))
+                    except ImportError as e:
+                        logger.warning(f'WARNING: Could not import context for {app.name} target detail button from '
+                                       f'{button["context"]}.\n'
+                                       f'{e}')
+                        continue
+                    new_context = context_method(context)
+                target_buttons_to_display.append({'partial': button['partial'],
+                                                  'context': new_context})
+    context['target_buttons_to_display'] = target_buttons_to_display
+    return context
 
 
 @register.filter