Clean up and document the bulk import/edit/delete templates

This commit is contained in:
jeremystretch 2022-02-08 11:23:52 -05:00
parent b0039e938e
commit e796fd1e11
4 changed files with 63 additions and 37 deletions

View File

@ -14,6 +14,7 @@ from django_tables2.export import TableExport
from extras.models import ExportTemplate from extras.models import ExportTemplate
from extras.signals import clear_webhooks from extras.signals import clear_webhooks
from netbox.tables import configure_table
from utilities.error_handlers import handle_protectederror from utilities.error_handlers import handle_protectederror
from utilities.exceptions import PermissionsViolation from utilities.exceptions import PermissionsViolation
from utilities.forms import ( from utilities.forms import (
@ -21,7 +22,6 @@ from utilities.forms import (
) )
from utilities.htmx import is_htmx from utilities.htmx import is_htmx
from utilities.permissions import get_permission_for_model from utilities.permissions import get_permission_for_model
from netbox.tables import configure_table
from utilities.views import GetReturnURLMixin from utilities.views import GetReturnURLMixin
from .base import BaseMultiObjectView from .base import BaseMultiObjectView
@ -369,9 +369,9 @@ class BulkImportView(GetReturnURLMixin, BaseMultiObjectView):
def get(self, request): def get(self, request):
return render(request, self.template_name, { return render(request, self.template_name, {
'model': self.model_form._meta.model,
'form': self._import_form(), 'form': self._import_form(),
'fields': self.model_form().fields, 'fields': self.model_form().fields,
'obj_type': self.model_form._meta.model._meta.verbose_name,
'return_url': self.get_return_url(request), 'return_url': self.get_return_url(request),
**self.get_extra_context(request), **self.get_extra_context(request),
}) })
@ -418,9 +418,9 @@ class BulkImportView(GetReturnURLMixin, BaseMultiObjectView):
logger.debug("Form validation failed") logger.debug("Form validation failed")
return render(request, self.template_name, { return render(request, self.template_name, {
'model': self.model_form._meta.model,
'form': form, 'form': form,
'fields': self.model_form().fields, 'fields': self.model_form().fields,
'obj_type': self.model_form._meta.model._meta.verbose_name,
'return_url': self.get_return_url(request), 'return_url': self.get_return_url(request),
**self.get_extra_context(request), **self.get_extra_context(request),
}) })
@ -759,8 +759,8 @@ class BulkDeleteView(GetReturnURLMixin, BaseMultiObjectView):
return redirect(self.get_return_url(request)) return redirect(self.get_return_url(request))
return render(request, self.template_name, { return render(request, self.template_name, {
'model': model,
'form': form, 'form': form,
'obj_type_plural': model._meta.verbose_name_plural,
'table': table, 'table': table,
'return_url': self.get_return_url(request), 'return_url': self.get_return_url(request),
**self.get_extra_context(request), **self.get_extra_context(request),

View File

@ -2,16 +2,26 @@
{% load helpers %} {% load helpers %}
{% load render_table from django_tables2 %} {% load render_table from django_tables2 %}
{% block title %}Delete {{ table.rows|length }} {{ obj_type_plural|bettertitle }}?{% endblock %} {% comment %}
Blocks:
message_extra: Supplementary warning message content
Context:
model: The model class of the objects being deleted
form: The bulk delete form class
table: The table class for rendering list of objects being deleted
return_url: The URL to which the user is redirected after submitting the form
{% endcomment %}
{% block title %}Delete {{ table.rows|length }} {{ model|meta:"verbose_name_plural"|bettertitle }}?{% endblock %}
{% block content %} {% block content %}
<div class="container-md px-0"> <div class="container-md px-0">
<div class="alert alert-danger mb-3" role="alert"> <div class="alert alert-danger mb-3" role="alert">
<h4 class="alert-heading">Confirm Bulk Deletion</h4> <h4 class="alert-heading">Confirm Bulk Deletion</h4>
<hr /> <hr />
<div> <strong>Warning:</strong> The following operation will delete <strong>{{ table.rows|length }}</strong>
<strong>Warning:</strong> The following operation will delete <strong>{{ table.rows|length }}</strong> {{ obj_type_plural }}. Please carefully review the {{ obj_type_plural }} to be deleted and confirm below. {{ model|meta:"verbose_name_plural" }}. Please carefully review the objects to be deleted and confirm below.
</div>
{% block message_extra %}{% endblock %} {% block message_extra %}{% endblock %}
</div> </div>
</div> </div>
@ -27,7 +37,7 @@
{% endfor %} {% endfor %}
<div class="text-end"> <div class="text-end">
<a href="{{ return_url }}" class="btn btn-outline-dark">Cancel</a> <a href="{{ return_url }}" class="btn btn-outline-dark">Cancel</a>
<button type="submit" name="_confirm" class="btn btn-danger">Delete {{ table.rows|length }} {{ obj_type_plural }}</button> <button type="submit" name="_confirm" class="btn btn-danger">Delete {{ table.rows|length }} {{ model|meta:"verbose_name_plural" }}</button>
</div> </div>
</form> </form>
</div> </div>

View File

@ -3,7 +3,15 @@
{% load form_helpers %} {% load form_helpers %}
{% load render_table from django_tables2 %} {% load render_table from django_tables2 %}
{% block title %}Editing {{ table.rows|length }} {{ model|meta:"verbose_name_plural" }}{% endblock %} {% comment %}
Context:
model: The model class of the objects being modified
form: The bulk edit form class
table: The table class for rendering list of objects being modified
return_url: The URL to which the user is redirected after submitting the form
{% endcomment %}
{% block title %}Editing {{ table.rows|length }} {{ model|meta:"verbose_name_plural"|bettertitle }}{% endblock %}
{% block tabs %} {% block tabs %}
<ul class="nav nav-tabs px-3"> <ul class="nav nav-tabs px-3">
@ -19,7 +27,7 @@
</button> </button>
</li> </li>
</ul> </ul>
{% endblock %} {% endblock tabs %}
{% block content-wrapper %} {% block content-wrapper %}
<div class="tab-content"> <div class="tab-content">
@ -128,6 +136,6 @@
</div> </div>
</div> </div>
{% endblock %} {% endblock content %}
</div> </div>
{% endblock %} {% endblock content-wrapper %}

View File

@ -2,7 +2,15 @@
{% load helpers %} {% load helpers %}
{% load form_helpers %} {% load form_helpers %}
{% block title %}{{ obj_type|bettertitle }} Bulk Import{% endblock %} {% comment %}
Context:
model: The model class being imported
form: The bulk import form
fields: A dictionary of form fields, to display import options (optional)
return_url: The URL to which the user is redirected after submitting the form
{% endcomment %}
{% block title %}{{ model|meta:"verbose_name"|bettertitle }} Bulk Import{% endblock %}
{% block tabs %} {% block tabs %}
<ul class="nav nav-tabs px-3"> <ul class="nav nav-tabs px-3">
@ -10,7 +18,7 @@
<a class ="nav-link active" href="#">Bulk Import</a> <a class ="nav-link active" href="#">Bulk Import</a>
</li> </li>
</ul> </ul>
{% endblock %} {% endblock tabs %}
{% block content-wrapper %} {% block content-wrapper %}
<div class="tab-content"> <div class="tab-content">
@ -145,4 +153,4 @@
</div> </div>
{% endblock content %} {% endblock content %}
</div> </div>
{% endblock %} {% endblock content-wrapper %}