update django support

Author: marcinn

.github/workflows/ci.yml

@@ -8,6 +8,25 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        django-version: ["3.2", "4.2", "5.1"]
+        exclude:
+          # Django 3.2 requires Python 3.6-3.10.
+          - python-version: "3.11"
+            django-version: "3.2"
+          - python-version: "3.12"
+            django-version: "3.2"
+          - python-version: "3.13"
+            django-version: "3.2"
+
+          # Django 4.2 requires Python 3.8-3.12.
+          - python-version: "3.13"
+            django-version: "4.2"
+
+          # Django 5.1 requires Python 3.10+.
+          - python-version: "3.8"
+            django-version: "5.1"
+          - python-version: "3.9"
+            django-version: "5.1"
 
     steps:
       - uses: actions/checkout@v3
@@ -20,6 +39,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements.txt
           pip install -r requirements-dev.txt
+          pip install "Django~=${{ matrix.django-version }}.0"
       - name: Test with pytest
         run: |
-          pytest
+          pytest --no-migrations

README.md

@@ -37,27 +37,29 @@ declaring a `StateMachineField`.
 ```python
 
 from django.db import models
+from django.utils.translation import gettext_lazy as _
 from dsm.fields import StateMachineField
 
 
 class Order(models.Model):
+    class Status(models.TextChoices):
+        NEW = 'new', _('New')
+        PROCESSING = 'processing', _('Processing')
+        SENDING = 'sending', _('Sending')
+        FINISHED = 'finished', _('Finished')
+        CANCELLED = 'cancelled', _('Cancelled')
+
     status = StateMachineField(
         transitions=(
-            ('new', ['confirm'], 'processing'),
-            ('processing', ['cancel'], 'cancelled'),
-            ('processing', ['send'], 'sending'),
-            ('sending', ['deliver'], 'finished'),
+            (Status.NEW, ['confirm'], Status.PROCESSING),
+            (Status.PROCESSING, ['cancel'], Status.CANCELLED),
+            (Status.PROCESSING, ['send'], Status.SENDING),
+            (Status.SENDING, ['deliver'], Status.FINISHED),
         ),
+        choices=Status.choices,
         max_length=16,
-        choices=(
-            ('new', _('New')),
-            ('processing', _('Processing')),
-            ('sending', _('Sending')),
-            ('finished', _('Finished')),
-            ('canceled', _('Cancelled')),
-        ),
         db_index=True,
-        default='new'
+        default=Status.NEW,
     )
 ```
 

dsm/fields.py

@@ -1,6 +1,6 @@
 from django.db import models
-from . import StateMachine, Transitions
 
+from . import StateMachine, Transitions
 
 __all__ = ['StateMachineField']
 

pyproject.toml

@@ -44,7 +44,6 @@ classifiers = [
 ]
 dependencies = [
     "observable",
-    "six",
 ]
 
 [project.urls]

requirements-dev.txt

@@ -3,3 +3,4 @@ ipython
 ipdb
 wheel
 pytest
+pytest-django

requirements.txt

@@ -1,2 +1 @@
-six
-observable
+observable

tests/models.py

@@ -0,0 +1,27 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from dsm.fields import StateMachineField
+
+class Order(models.Model):
+    class Status(models.TextChoices):
+        NEW = 'new', _('New')
+        PROCESSING = 'processing', _('Processing')
+        SENDING = 'sending', _('Sending')
+        FINISHED = 'finished', _('Finished')
+        CANCELLED = 'cancelled', _('Cancelled')
+
+    status = StateMachineField(
+        transitions=(
+            (Status.NEW, ['confirm'], Status.PROCESSING),
+            (Status.PROCESSING, ['cancel'], Status.CANCELLED),
+            (Status.PROCESSING, ['send'], Status.SENDING),
+            (Status.SENDING, ['deliver'], Status.FINISHED),
+        ),
+        choices=Status.choices,
+        max_length=16,
+        db_index=True,
+        default=Status.NEW,
+    )
+
+    class Meta:
+        app_label = 'tests'

tests/test_django_example.py

@@ -0,0 +1,55 @@
+import os
+import unittest
+
+from django.conf import settings
+from django.test import TestCase
+from django.utils.translation import gettext_lazy as _
+
+# Configure Django settings for the test
+if not settings.configured:
+    settings.configure(
+        DATABASES={
+            'default': {
+                'ENGINE': 'django.db.backends.sqlite3',
+                'NAME': ':memory:',
+            }
+        },
+        INSTALLED_APPS=[
+            'dsm',
+            'tests',
+        ],
+        # Add this to avoid AppRegistryNotReady error in some cases
+        DEFAULT_AUTO_FIELD='django.db.models.AutoField',
+    )
+    import django
+    django.setup()
+
+
+from dsm.fields import StateMachineField, MachineState
+from tests.models import Order
+
+
+class DjangoExampleTest(TestCase):
+    def test_django_example(self):
+        # Create an Order and check its status
+        order = Order.objects.create()
+        self.assertEqual(order.status, 'new')
+        self.assertIsInstance(order.status, MachineState)
+
+        # Test transitions
+        order.status.process('confirm')
+        self.assertEqual(order.status, 'processing')
+
+        order.status.process('send')
+        self.assertEqual(order.status, 'sending')
+
+        order.status.process('deliver')
+        self.assertEqual(order.status, 'finished')
+
+        # Test another transition path
+        order_to_cancel = Order.objects.create()
+        self.assertEqual(order_to_cancel.status, 'new')
+        order_to_cancel.status.process('confirm')
+        self.assertEqual(order_to_cancel.status, 'processing')
+        order_to_cancel.status.process('cancel')
+        self.assertEqual(order_to_cancel.status, 'cancelled')

tests/test_fields.py

@@ -0,0 +1,57 @@
+import os
+import unittest
+
+from django.conf import settings
+from django.core.management import call_command
+from django.db import models
+from django.test import TestCase
+from dsm.fields import StateMachineField
+
+if not settings.configured:
+    settings.configure(
+        DATABASES={
+            'default': {
+                'ENGINE': 'django.db.backends.sqlite3',
+                'NAME': ':memory:',
+            }
+        },
+        INSTALLED_APPS=[
+            'dsm',
+            'tests',
+        ],
+        DEFAULT_AUTO_FIELD='django.db.models.AutoField',
+    )
+    import django
+    django.setup()
+
+from tests.models import Order
+
+
+class StateMachineFieldTest(TestCase):
+    def test_create_order(self):
+        order = Order.objects.create()
+        self.assertEqual(order.status, Order.Status.NEW)
+        order.status.process('confirm')
+        self.assertEqual(order.status, Order.Status.PROCESSING)
+        order.save()
+        order.refresh_from_db()
+        self.assertEqual(order.status, Order.Status.PROCESSING)
+
+    def test_deconstruct(self):
+        # Order needs to be created for the field to be deconstructed
+        Order.objects.create()
+        field = Order._meta.get_field('status')
+        name, path, args, kwargs = field.deconstruct()
+        self.assertEqual(name, 'status')
+        self.assertEqual(path, 'dsm.fields.StateMachineField')
+        self.assertEqual(len(args), 1)
+        self.assertEqual(kwargs['max_length'], 16)
+        self.assertEqual(kwargs['default'], 'new')
+        self.assertEqual(kwargs['choices'], Order.Status.choices)
+
+    def test_choices(self):
+        # Order needs to be created for the field to have choices
+        Order.objects.create()
+        field = Order._meta.get_field('status')
+        self.assertEqual(field.choices, Order.Status.choices)
+