django-admin-ordering 0.18.0__tar.gz → 0.18.2__tar.gz

{django_admin_ordering-0.18.0 → django_admin_ordering-0.18.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-admin-ordering
-Version: 0.18.0
+Version: 0.18.2
 Summary: Orderable change lists and inlines done right^Wsimple
 Project-URL: Homepage, https://github.com/matthiask/django-admin-ordering/
 Author-email: Matthias Kestenholz <mk@feinheit.ch>
@@ -66,7 +66,7 @@ attribute is set to the correct value:
     class MyModel(OrderableModel):
         # ...
 
-        class Meta(OrderableModel):
+        class Meta(OrderableModel.Meta):
             # ...
 
 
@@ -80,16 +80,16 @@ Orderable change lists
     @admin.register(MyModel)
     class MyModelAdmin(OrderableAdmin, admin.ModelAdmin):
         # The field used for ordering. Prepend a minus for reverse
-        # ordering: "-order"
-        ordering_field = "order"
+        # ordering: "-ordering"
+        ordering_field = "ordering"  # The default.
 
         # You may optionally hide the ordering field in the changelist:
         # ordering_field_hide_input = False
 
         # The ordering field must be included both in list_display and
         # list_editable:
-        list_display = ["name", "order"]
-        list_editable = ["order"]
+        list_display = ["name", "ordering"]
+        list_editable = ["ordering"]
 
 
 Orderable inlines
@@ -102,8 +102,8 @@ Orderable inlines
     class MyModelTabularInline(OrderableAdmin, admin.TabularInline):
         model = MyModel
 
-        # Same as above; "-order" is also allowed here:
-        ordering_field = "order"
+        # Same as above; "-ordering" is also allowed here:
+        ordering_field = "ordering"
         # ordering_field_hide_input = False
 
 ``OrderableAdmin`` comes with a default of ``extra = 0`` (no extra
@@ -115,9 +115,6 @@ inlines just because you wanted to change the ordering.
 Limitations
 ===========
 
-- Starting with Django 1.9 newly created inlines are automatically
-  assigned a good ordering value. Earlier versions do not support the
-  required ``formset:added`` signal.
 - ``OrderableAdmin`` can be used both for inlines and parents, but this
   also means that you cannot register a model directly with
   ``OrderableAdmin``.

{django_admin_ordering-0.18.0 → django_admin_ordering-0.18.2}/README.rst

@@ -35,7 +35,7 @@ attribute is set to the correct value:
     class MyModel(OrderableModel):
         # ...
 
-        class Meta(OrderableModel):
+        class Meta(OrderableModel.Meta):
             # ...
 
 
@@ -49,16 +49,16 @@ Orderable change lists
     @admin.register(MyModel)
     class MyModelAdmin(OrderableAdmin, admin.ModelAdmin):
         # The field used for ordering. Prepend a minus for reverse
-        # ordering: "-order"
-        ordering_field = "order"
+        # ordering: "-ordering"
+        ordering_field = "ordering"  # The default.
 
         # You may optionally hide the ordering field in the changelist:
         # ordering_field_hide_input = False
 
         # The ordering field must be included both in list_display and
         # list_editable:
-        list_display = ["name", "order"]
-        list_editable = ["order"]
+        list_display = ["name", "ordering"]
+        list_editable = ["ordering"]
 
 
 Orderable inlines
@@ -71,8 +71,8 @@ Orderable inlines
     class MyModelTabularInline(OrderableAdmin, admin.TabularInline):
         model = MyModel
 
-        # Same as above; "-order" is also allowed here:
-        ordering_field = "order"
+        # Same as above; "-ordering" is also allowed here:
+        ordering_field = "ordering"
         # ordering_field_hide_input = False
 
 ``OrderableAdmin`` comes with a default of ``extra = 0`` (no extra
@@ -84,9 +84,6 @@ inlines just because you wanted to change the ordering.
 Limitations
 ===========
 
-- Starting with Django 1.9 newly created inlines are automatically
-  assigned a good ordering value. Earlier versions do not support the
-  required ``formset:added`` signal.
 - ``OrderableAdmin`` can be used both for inlines and parents, but this
   also means that you cannot register a model directly with
   ``OrderableAdmin``.

django_admin_ordering-0.18.2/admin_ordering/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.18.2"

{django_admin_ordering-0.18.0 → django_admin_ordering-0.18.2}/admin_ordering/admin.py

@@ -75,4 +75,14 @@ class OrderableAdmin(BaseModelAdmin):
                     id="admin_ordering.E001",
                 )
             )
+        ordering = self.model._meta.ordering
+        if list(ordering)[:1] != [self.ordering_field]:
+            errors.append(
+                checks.Warning(
+                    f"The ordering of {self.model._meta.label} is {ordering}, but {self.__class__.__name__} uses {self.ordering_field!r}. This is inconsistent and potentially broken.",
+                    obj=self.__class__,
+                    id="admin_ordering.W004",
+                    hint="Check that ordering_field is set if you're using a descending ordering.",
+                )
+            )
         return errors

{django_admin_ordering-0.18.0 → django_admin_ordering-0.18.2}/admin_ordering/static/admin_ordering/admin_ordering.js

@@ -1,5 +1,5 @@
 /* global django */
-django.jQuery(function ($) {
+django.jQuery(($) => {
   function updatePlaceholderHeight(ui) {
     // set placeholder height equal to item height
     ui.placeholder.height(ui.item.outerHeight())
@@ -18,28 +18,28 @@ django.jQuery(function ($) {
   $(".admin-ordering-context:not(.activated)")
     .addClass("activated")
     .each(function () {
-      var $sortable,
-        $sortableHandle,
-        $sortableInputWrapper =
-          '<span class="admin-ordering-field-input-wrapper"></span>',
-        $sortableHandleSelector = ".admin-ordering-field-input-wrapper"
+      let $sortable
+      let $sortableHandle
+      const $sortableInputWrapper =
+        '<span class="admin-ordering-field-input-wrapper"></span>'
+      const $sortableHandleSelector = ".admin-ordering-field-input-wrapper"
 
-      var data = JSON.parse(this.getAttribute("data-context"))
-      if (data.field.indexOf("-") == 0) {
+      const data = JSON.parse(this.getAttribute("data-context"))
+      if (data.field.indexOf("-") === 0) {
         data.field = data.field.substring(1)
         data.fieldDesc = true
       } else {
         data.fieldDesc = false
       }
 
-      var inputFieldSelector = 'input[name$="-' + data.field + '"]'
+      const inputFieldSelector = `input[name$="-${data.field}"]`
 
       function updateOrdering(nodes) {
-        var incOrdering = 10
-        var maxOrdering = nodes.length * incOrdering
+        const incOrdering = 10
+        const maxOrdering = nodes.length * incOrdering
         nodes.each(function (index) {
-          var row = $(this)
-          var rowOrdering = data.fieldDesc
+          const row = $(this)
+          const rowOrdering = data.fieldDesc
             ? maxOrdering - incOrdering * index
             : incOrdering * (index + 1)
           row.find(inputFieldSelector).val(rowOrdering)
@@ -48,60 +48,60 @@ django.jQuery(function ($) {
       }
 
       if (data.tabular) {
-        $sortable = $("#" + data.prefix + "-group tbody")
-        $sortableHandle = $sortable.find(".field-" + data.field)
+        $sortable = $(`#${data.prefix}-group tbody`)
+        $sortableHandle = $sortable.find(`.field-${data.field}`)
         $sortableHandle.addClass("admin-ordering-field")
         if (data.fieldHideInput) {
           $sortableHandle.addClass("admin-ordering-field-hide-input")
         }
         $sortableHandle
-          .find(inputFieldSelector + ':not([type="hidden"])')
+          .find(`${inputFieldSelector}:not([type="hidden"])`)
           .wrap($sortableInputWrapper)
         $sortable.sortable({
           items: ">.has_original",
           handle: $sortableHandleSelector,
-          start: function (_event, ui) {
+          start: (_event, ui) => {
             hideHorizontalOverflow()
             updatePlaceholderHeight(ui)
             // fix ui item height
             ui.item.css("height", ui.item.outerHeight())
           },
-          update: function (_event, _ui) {
-            updateOrdering($(".dynamic-" + data.prefix))
+          update: (_event, _ui) => {
+            updateOrdering($(`.dynamic-${data.prefix}`))
           },
-          stop: function (_event, ui) {
+          stop: (_event, ui) => {
             autoHorizontalOverflow()
             // reset ui item height
             ui.item.css("height", "auto")
           },
         })
       } else if (data.stacked) {
-        $sortable = $("#" + data.prefix + "-group")
-        $sortableHandle = $sortable.find(".field-" + data.field)
+        $sortable = $(`#${data.prefix}-group`)
+        $sortableHandle = $sortable.find(`.field-${data.field}`)
         $sortableHandle.addClass("admin-ordering-field")
         if (data.fieldHideInput) {
           $sortableHandle.addClass("admin-ordering-field-hide-input")
         }
         $sortableHandle
-          .find(inputFieldSelector + ':not([type="hidden"])')
+          .find(`${inputFieldSelector}:not([type="hidden"])`)
           .wrap($sortableInputWrapper)
         $sortable.sortable({
           items: ">.has_original,>>.has_original",
           handle: $sortableHandleSelector,
-          start: function (_event, ui) {
+          start: (_event, ui) => {
             hideHorizontalOverflow()
             updatePlaceholderHeight(ui)
           },
-          update: function (_event, _ui) {
-            updateOrdering($(".dynamic-" + data.prefix))
+          update: (_event, _ui) => {
+            updateOrdering($(`.dynamic-${data.prefix}`))
           },
-          stop: function (_event, _ui) {
+          stop: (_event, _ui) => {
             autoHorizontalOverflow()
           },
         })
       } else {
         $sortable = $("#result_list tbody")
-        $sortableHandle = $sortable.find(".field-" + data.field)
+        $sortableHandle = $sortable.find(`.field-${data.field}`)
         $sortableHandle.addClass("admin-ordering-field")
         if (data.fieldHideInput) {
           $sortableHandle.addClass("admin-ordering-field-hide-input")
@@ -110,34 +110,33 @@ django.jQuery(function ($) {
           return
         }
         $sortableHandle
-          .find(inputFieldSelector + ':not([type="hidden"])')
+          .find(`${inputFieldSelector}:not([type="hidden"])`)
           .wrap($sortableInputWrapper)
         $sortable.sortable({
           handle: $sortableHandleSelector,
-          start: function (_event, ui) {
+          start: (_event, ui) => {
             hideHorizontalOverflow()
             updatePlaceholderHeight(ui)
           },
-          update: function (_event, _ui) {
+          update: (_event, _ui) => {
             updateOrdering($sortable.find("tr"))
           },
-          stop: function (_event, _ui) {
+          stop: (_event, _ui) => {
             autoHorizontalOverflow()
           },
         })
       }
 
       if (data.tabular || data.stacked) {
-        // Yay, Django 1.9 or better!
         $(document).on("formset:added", function newForm(event, $row) {
-          if (event.detail && event.detail.formsetName) {
+          if (event.detail?.formsetName) {
             // Django 4.1 or better!
-            if ($(event.target).hasClass("dynamic-" + data.prefix)) {
-              updateOrdering($(".dynamic-" + data.prefix))
+            if ($(event.target).hasClass(`dynamic-${data.prefix}`)) {
+              updateOrdering($(`.dynamic-${data.prefix}`))
             }
           } else {
-            if ($row.hasClass("dynamic-" + data.prefix)) {
-              updateOrdering($(".dynamic-" + data.prefix))
+            if ($row.hasClass(`dynamic-${data.prefix}`)) {
+              updateOrdering($(`.dynamic-${data.prefix}`))
             }
           }
         })

django_admin_ordering-0.18.0/admin_ordering/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.18.0"