fix #304: SortableInlineAdminMixin works with SortableInlineAdminBase

Author: jrief

adminsortable2/admin.py

@@ -65,6 +65,26 @@ def media(self):
         js = ['adminsortable2/js/adminsortable2.min.js']
         return super().media + widgets.Media(css=css, js=js)
 
+    def get_formset_kwargs(self, request, obj, inline, prefix):
+        formset_params = super().get_formset_kwargs(request, obj, inline, prefix)
+        if hasattr(inline, 'default_order_direction') and hasattr(inline, 'default_order_field'):
+            formset_params.update(
+                default_order_direction=inline.default_order_direction,
+                default_order_field=inline.default_order_field,
+            )
+        return formset_params
+
+    def get_inline_formsets(self, request, formsets, inline_instances, obj=None):
+        inline_admin_formsets = super().get_inline_formsets(request, formsets, inline_instances, obj)
+        for inline_admin_formset in inline_admin_formsets:
+            if hasattr(inline_admin_formset.formset, 'default_order_direction'):
+                classes = inline_admin_formset.classes.split()
+                classes.append('sortable')
+                if inline_admin_formset.formset.default_order_direction == '-':
+                    classes.append('reversed')
+                inline_admin_formset.classes = ' '.join(classes)
+        return inline_admin_formsets
+
 
 class SortableAdminMixin(SortableAdminBase):
     BACK, FORWARD, FIRST, LAST, EXACT = range(5)
@@ -391,26 +411,6 @@ def get_update_url(self, request):
         """
         return reverse(f'{self.admin_site.name}:{self._get_update_url_name()}')
 
-    def get_formset_kwargs(self, request, obj, inline, prefix):
-        formset_params = super().get_formset_kwargs(request, obj, inline, prefix)
-        if hasattr(inline, 'default_order_direction') and hasattr(inline, 'default_order_field'):
-            formset_params.update(
-                default_order_direction=inline.default_order_direction,
-                default_order_field=inline.default_order_field,
-            )
-        return formset_params
-
-    def get_inline_formsets(self, request, formsets, inline_instances, obj=None):
-        inline_admin_formsets = super().get_inline_formsets(request, formsets, inline_instances, obj)
-        for inline_admin_formset in inline_admin_formsets:
-            if hasattr(inline_admin_formset.formset, 'default_order_direction'):
-                classes = inline_admin_formset.classes.split()
-                classes.append('sortable')
-                if inline_admin_formset.formset.default_order_direction == '-':
-                    classes.append('reversed')
-                inline_admin_formset.classes = ' '.join(classes)
-        return inline_admin_formsets
-
 
 class PolymorphicSortableAdminMixin(SortableAdminMixin):
     """
@@ -474,10 +474,14 @@ class CustomInlineFormSet(CustomInlineFormSetMixin, BaseInlineFormSet):
     pass
 
 
-class SortableInlineAdminMixin(SortableAdminBase):
+class SortableInlineAdminMixin:
     formset = CustomInlineFormSet
 
     def __init__(self, parent_model, admin_site):
+        assert isinstance(admin_site._registry[parent_model], SortableAdminBase), \
+            "{} must inherit from SortableAdminBase since {} inherits from SortableInlineAdminMixin.".format(
+                admin_site._registry[parent_model], self.__class__.__name__
+            )
         self.default_order_direction, self.default_order_field = _get_default_ordering(self.model, self)
         super().__init__(parent_model, admin_site)
 

docs/source/usage.rst

@@ -152,7 +152,20 @@ we simple use the mixin class :class:`adminsortable2.admin.SortableAdminMixin`.
 	    ...
 	    inlines = [ChapterStackedInline]
 
-For stacked inlines the editor for the book's detail view looks like:
+In case model ``Chapter`` shall be sortable, but model ``Book`` doesn't have to, rewrite the above
+class as:
+
+.. code-block:: python
+
+	...
+	from adminsortable2.admin import SortableAdminBase
+
+	@admin.register(Book)
+	class SortableBookAdmin(SortableAdminBase, admin.ModelAdmin):
+	    ...
+	    inlines = [ChapterStackedInline]
+
+For stacked inlines, the editor for the book's detail view looks like:
 
 .. image:: _static/stacked-inline-view.png
   :width: 800

testapp/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 
-from adminsortable2.admin import SortableAdminMixin, SortableInlineAdminMixin
+from adminsortable2.admin import SortableAdminBase, SortableAdminMixin, SortableInlineAdminMixin
 
 from . import models
 
@@ -51,8 +51,15 @@ class OrderedSortableBookAdmin(SortableBookAdmin):
     ordering = ['my_order']
 
 
+class UnsortedBookAdmin(SortableAdminBase, admin.ModelAdmin):
+    list_per_page = 12
+    list_display = ['title', 'author']
+    inlines = [ChapterTabularInline]
+
+
 admin.site.register(models.SortableBook, OrderedSortableBookAdmin)
 admin.site.register(models.SortableBook1, UpOrderedSortableBookAdmin)
 admin.site.register(models.SortableBook2, DownOrderedSortableBookAdmin)
 admin.site.register(models.SortableBook3, UnorderedSortableBookAdmin)
 admin.site.register(models.SortableBook4, UnorderedSortableBookAdmin)
+admin.site.register(models.SortableBook5, UnsortedBookAdmin)

testapp/models.py

@@ -37,6 +37,10 @@ class SortableBook(models.Model):
         on_delete=models.CASCADE,
     )
 
+    class Meta:
+        verbose_name = "Book"
+        verbose_name_plural = "Books"
+
     def __str__(self):
         return self.title
 
@@ -71,6 +75,13 @@ class Meta:
         verbose_name_plural = "Books"
 
 
+class SortableBook5(SortableBook):
+    class Meta:
+        proxy = True
+        verbose_name = "Book"
+        verbose_name_plural = "Books"
+
+
 class Chapter(models.Model):
     title = models.CharField(
         "Title",