django-pfx 1.4.dev80__tar.gz → 1.4.dev82__tar.gz

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev80
+Version: 1.4.dev82
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev80
+Version: 1.4.dev82
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/django_pfx.egg-info/SOURCES.txt

@@ -71,6 +71,7 @@ pfx/pfxcore/models/abstract_pfx_base_user.py
 pfx/pfxcore/models/cache_mixins.py
 pfx/pfxcore/models/login_ban.py
 pfx/pfxcore/models/not_null_fields.py
+pfx/pfxcore/models/ordered_model_mixin.py
 pfx/pfxcore/models/otp_user_mixin.py
 pfx/pfxcore/models/pfx_models.py
 pfx/pfxcore/models/pfx_user.py
@@ -90,6 +91,7 @@ pfx/pfxcore/views/authentication_views.py
 pfx/pfxcore/views/fields.py
 pfx/pfxcore/views/filters_views.py
 pfx/pfxcore/views/locale_views.py
+pfx/pfxcore/views/ordered_rest_view_mixin.py
 pfx/pfxcore/views/rest_views.py
 pfx/pfxcore/views/parameters/__init__.py
 pfx/pfxcore/views/parameters/date_format.py
@@ -136,6 +138,7 @@ tests/tests/test_client.py
 tests/tests/test_fields.py
 tests/tests/test_filters.py
 tests/tests/test_locale_api.py
+tests/tests/test_ordered_rest_view_mixin.py
 tests/tests/test_perm_tests.py
 tests/tests/test_permissions.py
 tests/tests/test_perms_api.py

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-01-29 12:33+0100\n"
+"POT-Creation-Date: 2025-01-31 09:52+0100\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -267,27 +267,37 @@ msgstr "Un nouveau code d'authentification a été envoyé par e-mail."
 msgid "Invalid value for {filter} filter"
 msgstr "Valeur invalide pour le filtre {filter}"
 
-#: views/rest_views.py:242
+#: views/ordered_rest_view_mixin.py:32
+#, python-brace-format
+msgid "object parameter is mandatory for move={move}."
+msgstr "Le paramètre object est requis pour move={move}."
+
+#: views/ordered_rest_view_mixin.py:39
+#, python-brace-format
+msgid "object {pk} does not exists in this move context."
+msgstr "object {pk} n'existe pas dans ce contexte de déplacement."
+
+#: views/rest_views.py:246
 #, python-brace-format
 msgid "{obj} cannot be deleted because it is referenced by other objects."
 msgstr ""
 "{obj} ne peut pas être supprimé car il est référencé par d’autres objets."
 
-#: views/rest_views.py:327
+#: views/rest_views.py:331
 #, python-brace-format
 msgid "{model} {obj} created."
 msgstr "{model} {obj} créé."
 
-#: views/rest_views.py:328
+#: views/rest_views.py:332
 #, python-brace-format
 msgid "{model} {obj} updated."
 msgstr "{model} {obj} modifié."
 
-#: views/rest_views.py:1153
+#: views/rest_views.py:1157
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."
 
-#: views/rest_views.py:1252 views/rest_views.py:1292
+#: views/rest_views.py:1256 views/rest_views.py:1296
 msgid "Unexpected storage error"
 msgstr "Erreur de stockage inattendue"

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/pfx/pfxcore/models/__init__.py

@@ -6,6 +6,7 @@ from .not_null_fields import (
     NotNullTextField,
     NotNullURLField,
 )
+from .ordered_model_mixin import OrderedModelMixin
 from .otp_user_mixin import OtpUserMixin
 from .pfx_models import (
     ErrorMessageMixin,

django_pfx-1.4.dev82/pfx/pfxcore/models/ordered_model_mixin.py

@@ -0,0 +1,140 @@
+from django.db import models
+from django.db.models import F, Max, Min
+
+
+class OrderedModelMixin(models.Model):
+    ordered_by = []
+    ordered_default = 'last'
+
+    seq = models.PositiveBigIntegerField("Séquence")
+
+    class Meta:
+        abstract = True
+
+    @property
+    def _ordered_by_values(self):
+        return {self.serializable_value(f) for f in self.ordered_by}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.__previous_ordered_by_values = self._ordered_by_values
+
+    def clean_fields(self, exclude=None):
+        if not self.seq:
+            self.seq = self._order_default
+        super().clean_fields(exclude=exclude)
+
+    def save(self, *args, **kwargs):
+        if not self.seq:
+            self.seq = self._order_default
+        super().save(*args, **kwargs)
+        if self.__previous_ordered_by_values != self._ordered_by_values:
+            if self.ordered_default == 'first':
+                self.top()
+            else:
+                self.bottom()
+
+    @property
+    def _order_qs(self):
+        return self.__class__._default_manager.filter(**{
+            f: getattr(self, f) for f in self.ordered_by})
+
+    @property
+    def _order_max(self):
+        return self._order_qs.aggregate(Max('seq'))['seq__max']
+
+    @property
+    def _order_min(self):
+        return self._order_qs.aggregate(Min('seq'))['seq__min']
+
+    @property
+    def _order_default(self):
+        if self.ordered_default == 'first':
+            min = self._order_min
+            res = min is None and 1 or min - 1
+            if res == 0:
+                self.first._order_shift()
+                return 1
+            return res
+        else:
+            return (self._order_max or 0) + 1
+
+    @property
+    def previous(self):
+        return self._order_qs.filter(
+            seq__lt=self.seq).order_by('seq', 'pk').last()
+
+    @property
+    def next(self):
+        return self._order_qs.filter(
+            seq__gt=self.seq).order_by('seq', 'pk').first()
+
+    @property
+    def first(self):
+        return self._order_qs.order_by('seq', 'pk').first()
+
+    @property
+    def last(self):
+        return self._order_qs.order_by('seq', 'pk').last()
+
+    def _order_shift(self):
+        self._order_qs.filter(seq__gte=self.seq).update(
+            seq=F('seq') + 1)
+
+    def _order_switch(self, other):
+        other_seq = other.seq
+        other.seq = self.seq
+        other.save(update_fields=['seq'])
+        self.seq = other_seq
+        self.save(update_fields=['seq'])
+
+    def up(self):
+        previous = self.previous
+        if not previous:
+            return
+        self._order_switch(previous)
+
+    def down(self):
+        next = self.next
+        if not next:
+            return
+        self._order_switch(next)
+
+    def top(self):
+        first = self.first
+        if first.pk == self.pk:
+            return
+        seq = first.seq - 1
+        if seq == 0:
+            first._order_shift()
+            seq = 1
+        self.seq = seq
+        self.save(update_fields=['seq'])
+
+    def bottom(self):
+        last = self.last
+        if last.pk == self.pk:
+            return
+        self.seq = last.seq + 1
+        self.save(update_fields=['seq'])
+
+    def above(self, other):
+        prev = other.previous
+        if not prev:
+            return self.top()
+        seq = other.seq - 1
+        if seq == prev.seq:
+            other._order_shift()
+            seq += 1
+        self.seq = seq
+        self.save(update_fields=['seq'])
+
+    def below(self, other):
+        next = other.next
+        if not next:
+            return self.bottom()
+        seq = other.seq + 1
+        if seq == next.seq:
+            next._order_shift()
+        self.seq = seq
+        self.save(update_fields=['seq'])

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/pfx/pfxcore/views/__init__.py

@@ -8,6 +8,7 @@ from .authentication_views import (
 from .fields import VF, FieldType, ViewField, ViewModelField
 from .filters_views import Filter, FilterGroup, ModelFilter
 from .locale_views import LocaleRestView
+from .ordered_rest_view_mixin import OrderedRestViewMixin
 from .rest_views import (
     BaseRestView,
     BodyMixin,

django_pfx-1.4.dev82/pfx/pfxcore/views/ordered_rest_view_mixin.py

@@ -0,0 +1,54 @@
+
+from django.core.exceptions import ObjectDoesNotExist
+from django.db import transaction
+from django.utils.translation import gettext_lazy as _
+
+from pfx.pfxcore.exceptions import APIError
+from pfx.pfxcore.models import OrderedModelMixin
+from pfx.pfxcore.shortcuts import f
+
+from .rest_views import ModelResponseMixin
+
+
+class OrderedRestViewMixin(ModelResponseMixin):
+    """Extension mixin for OrderedModelMixin models."""
+
+    def __init__(self, *args, **kwargs):
+        if not issubclass(self.model, OrderedModelMixin):
+            raise TypeError("model is not a subclass of OrderedModelMixin")
+        super().__init__(*args, **kwargs)
+
+    def is_valid(self, obj, created=False, **kwargs):
+        with transaction.atomic():
+            res = super().is_valid(obj, created, **kwargs)
+            self.apply_move(obj)
+        return res
+
+    def apply_move(self, obj):
+        def get_object(move):
+            pk = self.request.GET.get('object')
+            if not pk:
+                raise APIError(f(
+                    _("object parameter is mandatory for move={move}."),
+                    move=move))
+            try:
+                return self.get_queryset(
+                    from_queryset=obj._order_qs).get(pk=pk)
+            except ObjectDoesNotExist:
+                raise APIError(f(
+                    _("object {pk} does not exists in this move context."),
+                    pk=pk))
+
+        move = self.request.GET.get('move')
+        if move == 'up':
+            obj.up()
+        elif move == 'down':
+            obj.down()
+        elif move == 'bottom':
+            obj.bottom()
+        elif move == 'top':
+            obj.top()
+        elif move == 'above':
+            obj.above(get_object(move))
+        elif move == 'below':
+            obj.below(get_object(move))

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/pfx/pfxcore/views/rest_views.py

@@ -80,7 +80,9 @@ class ModelMixin():
             raise Exception("The queryset must be a UserFilteredQuerySetMixin")
         return qs
 
-    def get_queryset(self, select_related=None, prefetch_related=None):
+    def get_queryset(
+            self, select_related=None, prefetch_related=None,
+            from_queryset=None):
         """Get the queryset for the view model.
 
         The returned queryset is filtered according to user rights.
@@ -89,10 +91,12 @@ class ModelMixin():
         :type select_related: :class:`list[str]`
         :param prefetch_related: Arguments for queryset prefetch_related
         :type prefetch_related: :class:`list[str]`
+        :param from_queryset: A source queryset
         :returns: The queryset
         :rtype: :class:`django.db.models.QuerySet`
         """
-        qs = self.apply_user_filter(self.model._default_manager.all())
+        qs = self.apply_user_filter(
+            from_queryset or self.model._default_manager.all())
         if select_related:
             qs = qs.select_related(*select_related)
         if prefetch_related:

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/setup.cfg

@@ -69,6 +69,7 @@ line_length = 79
 
 [coverage:run]
 omit = 
+	manage.py
 	tests/*
 	setup.py
 	pfx/pfxcore/apps.py

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/tests/tests/__init__.py

@@ -9,6 +9,7 @@ from .test_client import TestApiClient
 from .test_fields import FieldsTest
 from .test_filters import FiltersTest
 from .test_locale_api import LocaleAPITest
+from .test_ordered_rest_view_mixin import TestOrderedRestViewMixin
 from .test_perm_tests import PermTestsTest
 from .test_permissions import TestPermissions
 from .test_perms_api import PermsAPITest

{django_pfx-1.4.dev80 → django_pfx-1.4.dev82}/tests/tests/test_client.py

@@ -11,6 +11,7 @@ from pfx.pfxcore.models import JSONReprMixin
 from pfx.pfxcore.test import APIClient, TestAssertMixin
 from pfx.pfxcore.views import RestView
 from tests.models import User
+from tests.views import FakeViewMixin
 
 
 class TestModel(JSONReprMixin, models.Model):
@@ -26,7 +27,7 @@ class TestModel(JSONReprMixin, models.Model):
 
 
 @rest_view("/test")
-class TestRestView(RestView):
+class TestRestView(FakeViewMixin, RestView):
     default_public = True
     model = TestModel