Add option to pass change_reason explicitly

Author: joaojunior

simple_history/registry_tests/migration_test_app/migrations/0001_initial.py

@@ -29,6 +29,7 @@ class Migration(migrations.Migration):
                 ('history_id', models.AutoField(primary_key=True, serialize=False)),
                 ('history_date', models.DateTimeField()),
                 ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)),
+                ('history_change_reason', models.CharField(max_length=100, null=True)),
                 ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
             ],
             options={

simple_history/tests/tests/test_models.py

@@ -12,6 +12,7 @@
 from django.test import TestCase
 
 from simple_history.models import HistoricalRecords, convert_auto_field
+from simple_history.utils import update_change_reason
 from ..models import (
     AdminProfile, Bookcase, MultiOneToOne, Poll, Choice, Restaurant,
     Person, FileModel, Document, Book, HistoricalPoll, Library, State,
@@ -52,7 +53,7 @@ def assertRecordValues(self, record, klass, values_dict):
             self.assertEqual(getattr(record, key), value)
         self.assertEqual(record.history_object.__class__, klass)
         for key, value in values_dict.items():
-            if key not in ['history_type', 'history_change_reason'] :
+            if key not in ['history_type', 'history_change_reason']:
                 self.assertEqual(getattr(record.history_object, key), value)
 
     def test_create(self):
@@ -71,8 +72,8 @@ def test_update(self):
         Poll.objects.create(question="what's up?", pub_date=today)
         p = Poll.objects.get()
         p.pub_date = tomorrow
-        p.changeReason = 'future poll'
         p.save()
+        update_change_reason(p, 'future poll')
         update_record, create_record = p.history.all()
         self.assertRecordValues(create_record, Poll, {
             'question': "what's up?",
@@ -90,7 +91,7 @@ def test_update(self):
         })
         self.assertDatetimesEqual(update_record.history_date, datetime.now())
 
-    def test_delete(self):
+    def test_delete_verify_change_reason_implicitly(self):
         p = Poll.objects.create(question="what's up?", pub_date=today)
         poll_id = p.id
         p.changeReason = 'wrongEntry'
@@ -111,6 +112,27 @@ def test_delete(self):
             'history_type': "-"
         })
 
+    def test_delete_verify_change_reason_explicity(self):
+        p = Poll.objects.create(question="what's up?", pub_date=today)
+        poll_id = p.id
+        p.delete()
+        update_change_reason(p, 'wrongEntry')
+        delete_record, create_record = Poll.history.all()
+        self.assertRecordValues(create_record, Poll, {
+            'question': "what's up?",
+            'pub_date': today,
+            'id': poll_id,
+            'history_change_reason': None,
+            'history_type': "+"
+        })
+        self.assertRecordValues(delete_record, Poll, {
+            'question': "what's up?",
+            'pub_date': today,
+            'id': poll_id,
+            'history_change_reason': 'wrongEntry',
+            'history_type': "-"
+        })
+
     def test_save_without_historical_record(self):
         pizza_place = Restaurant.objects.create(name='Pizza Place', rating=3)
         pizza_place.rating = 4

simple_history/utils.py

@@ -0,0 +1,14 @@
+def update_change_reason(instance, reason):
+    attrs = {}
+    model = type(instance)
+    manager = instance if instance.id is not None else model
+    for field in instance._meta.fields:
+        value = getattr(instance, field.attname)
+        if field.primary_key is True:
+            if value is not None:
+                attrs[field.attname] = value
+        else:
+            attrs[field.attname] = value
+    record = manager.history.filter(**attrs).order_by('-history_date').first()
+    record.history_change_reason = reason
+    record.save()