Merge pull request #2825 from SrdjanCosicPrica/Enh-Track-order-status-change

Enhancement #2737 Track order status changes

src/oscar/apps/dashboard/orders/views.py

@@ -50,7 +50,7 @@ def queryset_orders_for_user(user):
         'billing_address', 'billing_address__country',
         'shipping_address', 'shipping_address__country',
         'user'
-    ).prefetch_related('lines')
+    ).prefetch_related('lines', 'status_changes')
     if user.is_staff:
         return queryset
     else:

src/oscar/apps/order/abstract_models.py

@@ -149,8 +149,14 @@ class AbstractOrder(models.Model):
                                   new_status=new_status,
                                   )
 
+        self._create_order_status_change(old_status, new_status)
+
     set_status.alters_data = True
 
+    def _create_order_status_change(self, old_status, new_status):
+        # Not setting the status on the order as that should be handled before
+        self.status_changes.create(old_status=old_status, new_status=new_status)
+
     @property
     def is_anonymous(self):
         # It's possible for an order to be placed by a customer who then
@@ -430,6 +436,30 @@ class AbstractOrderNote(models.Model):
         return delta.seconds < self.editable_lifetime
 
 
+class AbstractOrderStatusChange(models.Model):
+    order = models.ForeignKey(
+        'order.Order',
+        on_delete=models.CASCADE,
+        related_name='status_changes',
+        verbose_name=_('Order Status Changes')
+    )
+    old_status = models.CharField(_('Old Status'), max_length=100, blank=True)
+    new_status = models.CharField(_('New Status'), max_length=100, blank=True)
+    date_created = models.DateTimeField(_('Date Created'), auto_now_add=True)
+
+    class Meta:
+        abstract = True
+        app_label = 'order'
+        verbose_name = _('Order Status Change')
+        verbose_name_plural = _('Order Status Changes')
+        ordering = ['-date_created']
+
+    def __str__(self):
+        return _('{order} has changed status from {old_status} to {new_status}').format(
+            order=self.order, old_status=self.old_status, new_status=self.new_status
+        )
+
+
 class AbstractCommunicationEvent(models.Model):
     """
     An order-level event involving a communication to the customer, such

src/oscar/apps/order/admin.py

@@ -4,6 +4,7 @@ from oscar.core.loading import get_model
 
 Order = get_model('order', 'Order')
 OrderNote = get_model('order', 'OrderNote')
+OrderStatusChange = get_model('order', 'OrderStatusChange')
 CommunicationEvent = get_model('order', 'CommunicationEvent')
 BillingAddress = get_model('order', 'BillingAddress')
 ShippingAddress = get_model('order', 'ShippingAddress')
@@ -68,6 +69,7 @@ class OrderDiscountAdmin(admin.ModelAdmin):
 
 admin.site.register(Order, OrderAdmin)
 admin.site.register(OrderNote)
+admin.site.register(OrderStatusChange)
 admin.site.register(ShippingAddress)
 admin.site.register(Line, LineAdmin)
 admin.site.register(LinePrice, LinePriceAdmin)

src/oscar/apps/order/migrations/0006_orderstatuschange.py

@@ -0,0 +1,30 @@
+# Generated by Django 2.1.1 on 2018-09-12 08:31
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('order', '0005_update_email_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='OrderStatusChange',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('old_status', models.CharField(blank=True, max_length=100, verbose_name='Old Status')),
+                ('new_status', models.CharField(blank=True, max_length=100, verbose_name='New Status')),
+                ('date_created', models.DateTimeField(auto_now_add=True, verbose_name='Date Created')),
+                ('order', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='status_changes', to='order.Order', verbose_name='Order Status Changes')),
+            ],
+            options={
+                'verbose_name': 'Order Status Change',
+                'verbose_name_plural': 'Order Status Changes',
+                'ordering': ['-date_created'],
+                'abstract': False,
+            },
+        ),
+    ]

src/oscar/apps/order/models.py

@@ -20,6 +20,13 @@ if not is_model_registered('order', 'OrderNote'):
     __all__.append('OrderNote')
 
 
+if not is_model_registered('order', 'OrderStatusChange'):
+    class OrderStatusChange(AbstractOrderStatusChange):
+        pass
+
+    __all__.append('OrderStatusChange')
+
+
 if not is_model_registered('order', 'CommunicationEvent'):
     class CommunicationEvent(AbstractCommunicationEvent):
         pass

src/oscar/templates/oscar/dashboard/orders/order_detail.html

@@ -329,6 +329,40 @@
                     {% endblock %}
                 </form>
 
+                {% block order_status_changes %}
+                    <div class="table-header">
+                        <h3>{% trans "Status Changes" %}</h3>
+                    </div>
+                    {% with status_changes=order.status_changes.all %}
+                        <table class="table table-striped table-bordered table-hover">
+                            {% if status_changes %}
+                                <thead>
+                                    <tr>
+                                        <th>{% trans "From" %}</th>
+                                        <th>{% trans "To" %}</th>
+                                        <th>{% trans "Date" %}</th>
+                                    </tr>
+                                </thead>
+                                <tbody>
+                                    {% for status_change in status_changes %}
+                                        <tr>
+                                            <td>{{ status_change.old_status }}</td>
+                                            <td>{{ status_change.new_status }}</td>
+                                            <td>{{ status_change.date_created }}</td>
+                                        </tr>
+                                    {% endfor %}
+                                </tbody>
+                            {% else %}
+                                <tbody>
+                                    <tr>
+                                        <td>{% trans "No status changes." %}</td>
+                                    </tr>
+                                </tbody>
+                            {% endif %}
+                        </table>
+                    {% endwith %}
+                {% endblock %}
+
                 {% block shipping_events %}
                     <div class="table-header">
                         <h3>{% trans "Shipping Events" %}</h3>

tests/integration/order/test_models.py

@@ -83,6 +83,16 @@ class OrderStatusPipelineTests(TestCase):
             self.order.set_status('SHIPPED')
             self.assertEqual(receiver.call_count, 1)
 
+    def test_set_status_signal_creates_a_order_status_change_object(self):
+        self.order = create_order(status='PENDING')
+        self.order.set_status('SHIPPED')
+
+        order_status_change = self.order.status_changes.first()
+
+        self.assertEqual(self.order.status_changes.count(), 1)
+        self.assertEqual(order_status_change.old_status, 'PENDING')
+        self.assertEqual(order_status_change.new_status, 'SHIPPED')
+
 
 class OrderNoteTests(TestCase):