reorderable EditTable, models.Orderable, model_fields.SortOrderField

Author: berycz

conftest.py

@@ -8,6 +8,7 @@
     Album,
     Artist,
     Track,
+    FavoriteArtist,
 )
 
 
@@ -253,3 +254,20 @@ def really_big_discography():
 @pytest.fixture
 def staff_user():
     return User.objects.create(username='staff_user', is_staff=True)
+
+
+@pytest.fixture
+def john_doe_user(transactional_db):
+    return User.objects.create(username='john.doe', email='john.doe@example.com')
+
+
+@pytest.fixture
+def damnation(transactional_db):
+    return Artist.objects.create(name='Damnation')
+
+
+@pytest.fixture
+def fav_artists(john_doe_user, black_sabbath, damnation, ozzy):
+    FavoriteArtist.objects.create(user=john_doe_user, artist=black_sabbath, comment='Love it!', sort_order=0)
+    FavoriteArtist.objects.create(user=john_doe_user, artist=ozzy, comment='I love this too!', sort_order=1)
+    FavoriteArtist.objects.create(user=john_doe_user, artist=damnation, comment='And this as well', sort_order=2)

docs/models.py

@@ -8,6 +8,9 @@
     OneToOneField,
     TextField,
 )
+from django.conf import settings
+
+from iommi.models import Orderable
 
 
 class Genre(Model):
@@ -91,3 +94,15 @@ def __str__(self):
     class Meta:
         ordering = ('artist__name',)
         app_label = 'docs'
+
+
+class FavoriteArtist(Orderable):
+    user = ForeignKey(settings.AUTH_USER_MODEL, on_delete=CASCADE, related_name='favorite_artists')
+    artist = ForeignKey(Artist, on_delete=CASCADE, related_name='+')
+    comment = CharField(max_length=255)
+
+    def __str__(self):
+        return self.artist.name
+
+    class Meta(Orderable.Meta):
+        app_label = 'docs'

docs/test_doc_edit_tables.py

@@ -1,6 +1,9 @@
+from django.contrib.auth import get_user_model
+
 import pytest
 from docs.models import *
 from iommi import *
+from iommi.form import save_nested_forms
 from tests.helpers import (
     req,
     show_output,
@@ -46,3 +49,104 @@ def test_edit_tables(really_big_discography):
 
     show_output(t.bind(request=request))
     # @end
+
+
+def test_orderable_edit_tables(fav_artists):
+    # language=rst
+    """
+    .. _orderable-edit-tables:
+
+    Orderable edit tables
+    =====================
+
+    iommi edit tables also support ordering. That can be especially useful for editing reverse FK's in nested forms.
+    """
+
+    # language=rst
+    """
+    The easiest way to make an EditTable orderable is to inherit your model from `iommi.models.Orderable`:
+
+    .. code-block:: python
+
+           class FavoriteArtist(Orderable):
+               user = ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name='favorite_artists')
+               artist = ForeignKey(Artist, on_delete=CASCADE, related_name='+')
+               comment = CharField(max_length=255)
+
+               def __str__(self):
+                   return self.artist.name
+    """
+
+    class UserForm(Form):
+        class Meta:
+            auto__model = get_user_model()
+            auto__include = ['username', 'email']
+            fields__username__editable = False
+
+    class FavoriteArtists(EditTable):
+        class Meta:
+            auto__model = FavoriteArtist
+            auto__include = ['artist__name', 'comment', 'sort_order']
+            columns__comment__field__include = True
+
+    user = get_user_model().objects.get(username='john.doe')
+
+    class ParentForm(Form):
+        user_form = UserForm.edit(auto__instance=user)
+        favorite_artists = FavoriteArtists(rows=user.favorite_artists.all())
+
+        class Meta:
+            actions__submit__post_handler = save_nested_forms
+
+    # @test
+    t = (
+    # @end
+
+    ParentForm()
+
+    # @test
+    )
+
+    show_output(t.bind(request=request))
+    # @end
+
+    # language=rst
+    """
+    If you already have a custom model field for ordering, you can register it as a reorderderin column:
+
+    .. code-block:: python
+
+           from iommi import register_edit_column_factory
+
+           register_edit_column_factory(YourOrderField, shortcut_name='reorder_handle')
+    """
+
+    # language=rst
+    """
+    If you just use any django integer field, you can still make your EditTable orderable with:
+
+    .. code-block:: python
+
+               class MyEditTable(EditTable):
+                   class Meta:
+                       auto__model = Foo
+                       columns__bar = EditColumn.reorder_handle()
+    """
+
+    # language=rst
+    """
+    We use SortableJS and if you want, you can also pass other `options <https://github.com/SortableJS/Sortable?tab=readme-ov-file#options>`__.
+    For example this allows multi-drag:
+
+    .. code-block:: python
+
+               class MyEditTable(EditTable):
+                   class Meta:
+                       auto__model = Foo
+                       columns__bar = EditColumn.reorder_handle()
+                       reorderable = {
+                           "multiDrag": True,  # Enable multi-drag
+                           "selectedClass": 'selected',  # The class applied to the selected items
+                           "fallbackTolerance": 3,  # So that we can select items on mobile
+                       }
+    """

iommi/_db_compat.py

@@ -4,6 +4,7 @@
 
 def setup_db_compat():
     setup_db_compat_django()
+    setup_db_compat_iommi()
 
 
 def register_factory(django_field_class, *, shortcut_name=MISSING, factory=MISSING, **kwargs):
@@ -168,6 +169,13 @@ def fn(model_field, **_):
     register_field_factory(FileField, shortcut_name='file')
 
 
+def setup_db_compat_iommi():
+    from iommi.model_fields import SortOrderField
+    from iommi.edit_table import register_edit_column_factory
+
+    register_edit_column_factory(SortOrderField, shortcut_name='reorder_handle')
+
+
 def base_defaults_factory(model_field):
     from iommi.base import capitalize
 

iommi/model_fields.py

@@ -0,0 +1,14 @@
+from django.db.models import PositiveIntegerField
+from django import VERSION as DJANGO_VERSION
+
+
+class SortOrderField(PositiveIntegerField):
+    def __init__(self, to=None, **kwargs):
+        kwargs.setdefault("null", False)
+        kwargs.setdefault("blank", False)
+        if DJANGO_VERSION[0] >= 5:
+            kwargs.setdefault("db_default", 0)
+        kwargs.setdefault("db_index", True)
+        kwargs.setdefault("default", 0)
+        kwargs.setdefault("editable", False)
+        super().__init__(to, **kwargs)

iommi/models.py

@@ -0,0 +1,11 @@
+from django.db.models import Model
+
+from iommi.model_fields import SortOrderField
+
+
+class Orderable(Model):
+    sort_order = SortOrderField()
+
+    class Meta:
+        abstract = True
+        ordering = ["sort_order"]