From 847b471872a04358d03c1a011289b31b63db18eb Mon Sep 17 00:00:00 2001 From: Brandon Taylor Date: Fri, 3 May 2013 08:35:17 -0400 Subject: [PATCH] Added properties to allow sortable change list and change form view to extend a custom template or extend the default admin change form and change list templates. Fixed a problem with the detection of sortability of inline models at the template level that was preventing the drag-and-drop messaging in the template to be displayed. Updated unit tests. --- adminsortable/admin.py | 32 ++++++++++++++---- adminsortable/models.py | 13 ------- .../templates/adminsortable/change_form.html | 2 +- .../change_list_with_sort_link.html | 4 +-- .../adminsortable/edit_inline/stacked.html | 2 +- .../adminsortable/edit_inline/tabular.html | 2 +- sample_project/app/admin.py | 3 +- sample_project/app/tests.py | 11 +++--- sample_project/database/test_project.sqlite | Bin 68608 -> 68608 bytes 9 files changed, 39 insertions(+), 30 deletions(-) diff --git a/adminsortable/admin.py b/adminsortable/admin.py index 77b5682..34746de 100644 --- a/adminsortable/admin.py +++ b/adminsortable/admin.py @@ -40,6 +40,13 @@ class SortableAdminBase(object): self.change_list_template = \ self.sortable_change_list_with_sort_link_template self.is_sortable = True + + if extra_context is None: + extra_context = {} + + extra_context.update({ + 'change_list_template_extends': self.change_list_template_extends + }) return super(SortableAdminBase, self).changelist_view(request, extra_context=extra_context) @@ -58,6 +65,9 @@ class SortableAdmin(SortableAdminBase, ModelAdmin): sortable_javascript_includes_template = \ 'adminsortable/shared/javascript_includes.html' + change_form_template_extends = 'admin/change_form.html' + change_list_template_extends = 'admin/change_list.html' + class Meta: abstract = True @@ -162,6 +172,13 @@ class SortableAdmin(SortableAdminBase, ModelAdmin): self.has_sortable_tabular_inlines = False self.has_sortable_stacked_inlines = False + if extra_context is None: + extra_context = {} + + extra_context.update({ + 'change_form_template_extends': self.change_form_template_extends + }) + for klass in self.inlines: is_sortable = klass.model.is_sortable if issubclass(klass, SortableTabularInline) and is_sortable: @@ -171,15 +188,18 @@ class SortableAdmin(SortableAdminBase, ModelAdmin): if self.has_sortable_tabular_inlines or \ self.has_sortable_stacked_inlines: + self.change_form_template = self.sortable_change_form_template - extra_context = { + + extra_context.update({ 'sortable_javascript_includes_template': self.sortable_javascript_includes_template, 'has_sortable_tabular_inlines': self.has_sortable_tabular_inlines, 'has_sortable_stacked_inlines': self.has_sortable_stacked_inlines - } + }) + return super(SortableAdmin, self).change_view(request, object_id, extra_context=extra_context) @@ -238,21 +258,21 @@ class SortableInlineBase(SortableAdminBase, InlineModelAdmin): return qs -class SortableTabularInline(SortableInlineBase, TabularInline): +class SortableTabularInline(TabularInline, SortableInlineBase): """Custom template that enables sorting for tabular inlines""" template = 'adminsortable/edit_inline/tabular.html' -class SortableStackedInline(SortableInlineBase, StackedInline): +class SortableStackedInline(StackedInline, SortableInlineBase): """Custom template that enables sorting for stacked inlines""" template = 'adminsortable/edit_inline/stacked.html' -class SortableGenericTabularInline(SortableInlineBase, GenericTabularInline): +class SortableGenericTabularInline(GenericTabularInline, SortableInlineBase): """Custom template that enables sorting for tabular inlines""" template = 'adminsortable/edit_inline/tabular.html' -class SortableGenericStackedInline(SortableInlineBase, GenericStackedInline): +class SortableGenericStackedInline(GenericStackedInline, SortableInlineBase): """Custom template that enables sorting for stacked inlines""" template = 'adminsortable/edit_inline/stacked.html' diff --git a/adminsortable/models.py b/adminsortable/models.py index f7640be..461d987 100644 --- a/adminsortable/models.py +++ b/adminsortable/models.py @@ -39,19 +39,6 @@ class Sortable(models.Model): abstract = True ordering = ['order'] - # @classmethod - # def determine_if_sortable(cls): - # try: - # max_order = cls.objects.aggregate( - # models.Max('order'))['order__max'] - # except (TypeError, IndexError): - # max_order = 0 - - # if max_order > 1: - # cls.is_sortable = True - # else: - # cls.is_sortable = False - @classmethod def model_type_id(cls): return ContentType.objects.get_for_model(cls).id diff --git a/adminsortable/templates/adminsortable/change_form.html b/adminsortable/templates/adminsortable/change_form.html index 8cecd7f..e54840a 100644 --- a/adminsortable/templates/adminsortable/change_form.html +++ b/adminsortable/templates/adminsortable/change_form.html @@ -1,4 +1,4 @@ -{% extends "admin/change_form.html" %} +{% extends change_form_template_extends %} {% load i18n admin_modify %} {% load url from future %} diff --git a/adminsortable/templates/adminsortable/change_list_with_sort_link.html b/adminsortable/templates/adminsortable/change_list_with_sort_link.html index f5df853..b51c631 100644 --- a/adminsortable/templates/adminsortable/change_list_with_sort_link.html +++ b/adminsortable/templates/adminsortable/change_list_with_sort_link.html @@ -1,4 +1,4 @@ -{% extends 'admin/change_list.html' %} +{% extends change_list_template_extends %} {% load i18n %} {% block object-tools-items %} @@ -6,4 +6,4 @@ {% trans 'Change Order' %} {{ block.super }} -{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/adminsortable/templates/adminsortable/edit_inline/stacked.html b/adminsortable/templates/adminsortable/edit_inline/stacked.html index aaea0fc..b59b191 100644 --- a/adminsortable/templates/adminsortable/edit_inline/stacked.html +++ b/adminsortable/templates/adminsortable/edit_inline/stacked.html @@ -1,6 +1,6 @@ {% load i18n admin_modify adminsortable_tags %}
-

{{ inline_admin_formset.opts.verbose_name_plural|title }} {% if inline_admin_formset.opts.is_sortable %} - drag and drop to change order{% endif %}

+

{{ inline_admin_formset.opts.verbose_name_plural|title }} {% if inline_admin_formset.formset.initial_form_count > 1 %} - drag and drop to change order{% endif %}

{{ inline_admin_formset.formset.management_form }} {{ inline_admin_formset.formset.non_form_errors }} diff --git a/adminsortable/templates/adminsortable/edit_inline/tabular.html b/adminsortable/templates/adminsortable/edit_inline/tabular.html index ac8802a..0a4cf71 100644 --- a/adminsortable/templates/adminsortable/edit_inline/tabular.html +++ b/adminsortable/templates/adminsortable/edit_inline/tabular.html @@ -3,7 +3,7 @@
{{ inline_admin_formset.formset.management_form }}
-

{{ inline_admin_formset.opts.verbose_name_plural|capfirst }} {% if inline_admin_formset.opts.is_sortable %} - drag and drop to change order{% endif %}

+

{{ inline_admin_formset.opts.verbose_name_plural|capfirst }} {% if inline_admin_formset.formset.initial_form_count > 1 %} - drag and drop to change order{% endif %}

{{ inline_admin_formset.formset.non_form_errors }} diff --git a/sample_project/app/admin.py b/sample_project/app/admin.py index c382be1..181b2fb 100644 --- a/sample_project/app/admin.py +++ b/sample_project/app/admin.py @@ -14,7 +14,8 @@ class ComponentInline(SortableStackedInline): model = Component def queryset(self, request): - qs = super(ComponentInline, self).queryset(request).exclude(title__icontains='2') + qs = super(ComponentInline, self).queryset( + request).exclude(title__icontains='2') if get_is_sortable(qs): self.model.is_sortable = True else: diff --git a/sample_project/app/tests.py b/sample_project/app/tests.py index c72c5e9..31badde 100644 --- a/sample_project/app/tests.py +++ b/sample_project/app/tests.py @@ -9,6 +9,7 @@ from django.test.client import Client, RequestFactory from adminsortable.fields import SortableForeignKey from adminsortable.models import Sortable +from adminsortable.utils import get_is_sortable from app.models import Category, Credit, Note @@ -52,13 +53,13 @@ class SortableTestCase(TestCase): record to sort. """ self.create_category() - self.assertFalse(Category.is_sortable(), + self.assertFalse(get_is_sortable(Category.objects.all()), 'Category only has one record. It should not be sortable.') def test_is_sortable(self): self.create_category() self.create_category(title='Category 2') - self.assertTrue(Category.is_sortable(), + self.assertTrue(get_is_sortable(Category.objects.all()), 'Category has more than one record. It should be sortable.') def test_save_order_incremented(self): @@ -82,8 +83,8 @@ class SortableTestCase(TestCase): return category1, category2, category3 def get_sorting_url(self): - return reverse('admin:app_do_sorting', args=(), - kwargs={'model_type_id': Category.model_type_id()}) + return '/admin/app/category/sorting/do-sorting/{0}/'.format( + Category.model_type_id()) def get_category_indexes(self, *categories): return {'indexes': ','.join([str(c.id) for c in categories])} @@ -93,7 +94,7 @@ class SortableTestCase(TestCase): password=self.user_raw_password) self.assertTrue(logged_in, 'User is not logged in') - response = self.client.get(reverse('admin:app_sort')) + response = self.client.get('/admin/app/category/sort/') self.assertEqual(response.status_code, httplib.OK, 'Admin sort request failed.') diff --git a/sample_project/database/test_project.sqlite b/sample_project/database/test_project.sqlite index 975e9136d8349662b846f3ba6726e1302908024e..5c6bc273d7b21d8631f0c540ddea14fae5dd862e 100644 GIT binary patch delta 400 zcmZpe!O}2;Wr8&0mWeXXj9WG)#F>kj>KYg;7#dm`n_C$h>ls;?S{R#bzGQABBF4eg z&%pGL*@HQkX$#X$W@YBvO#RH;HVd+pGO4OC`!bd$CRJwTB^Klx7vz=}8&{%M@di^aPe&+oQEX-3Fm{&1RVSdGY1!#8*vx5i|3j?DzQ%GuY ziGp)tNosn2QKf>BFe3{Cr#7mfAp--0C=jE9%~$%3B)DEOGJjxx$^3=+7tquz%mU2J z?-^KGnHd?Gm>8IuIXO3fSuGI5#l$4Sz|6%Y!ng~lY8@jJW58rVmN1RRVnJ5lrcy^j XK`>eWy3gePn}vcH9-Pj_&G-!flQU{& delta 256 zcmZpe!O}2;Wr8&0nu#*bjB7R~#F>kj=o%X+7#dj_n_3xL>X{pvTbP(_zGQABBErtJ zg@NfGvj=l7(-x+i%*xESnYV2gWSPUXd5d3wt_VA`Is@||=7-FSnOm4sncbMxnK^*c zpP44VsngtSQh%0*pMimag?S|d^GfFZ%&(ZQ0A*X49hmnshyf)~fe0fD1EV%`NNRD3 zf^%X?YI=TArGlX_6AJ^UHmab}<}3Y15?rqsfF^!ne$V_1XzCSa0cPg+46H!gI2oB( em>D^lH-A|z5W~jE%*DXWwOEjac{&$2<2L{#r9nOb