Set attribute on history list entries, from evaluated admin methods (#390)

* Set attribute on history list entries, from evaluated admin methods

* Added test

* Remove trailing commas

* Fix line width in test

* Add change

* More descriptive names

Author: blawson

AUTHORS.rst

@@ -8,6 +8,7 @@ Authors
 =======
 
 - Aleksey Kladov
+- Ben Lawson
 - bradford281
 - Buddy Lindsey, Jr.
 - Brian Dixon

CHANGES.rst

@@ -5,6 +5,7 @@ Unreleased
 ----------
 - Add ability to specify custom history_id field (gh-368)
 - Add HistoricalRecord instance properties `prev_record` and `next_record` (gh-365)
+- Can set admin methods as attributes on object history change list template (gh-390)
 
 2.0 (2018-04-05)
 ----------------

simple_history/admin.py

@@ -61,6 +61,14 @@ def history_view(self, request, object_id, extra_context=None):
         if not self.has_change_permission(request, obj):
             raise PermissionDenied
 
+        # Set attribute on each action_list entry from admin methods
+        for history_list_entry in history_list_display:
+            value_for_entry = getattr(self, history_list_entry, None)
+            if value_for_entry and callable(value_for_entry):
+                for list_entry in action_list:
+                    setattr(list_entry, history_list_entry,
+                            value_for_entry(list_entry))
+
         content_type = ContentType.objects.get_by_natural_key(
             *USER_NATURAL_KEY)
         admin_user_view = 'admin:%s_%s_change' % (content_type.app_label,

simple_history/tests/admin.py

@@ -9,6 +9,7 @@
     ConcreteExternal,
     Document,
     Employee,
+    FileModel,
     Paper,
     Person,
     Poll
@@ -24,6 +25,14 @@ class ChoiceAdmin(SimpleHistoryAdmin):
     history_list_display = ['votes']
 
 
+class FileModelAdmin(SimpleHistoryAdmin):
+
+    def test_method(self, obj):
+        return 'test_method_value'
+
+    history_list_display = ['title', 'test_method']
+
+
 admin.site.register(Poll, SimpleHistoryAdmin)
 admin.site.register(Choice, ChoiceAdmin)
 admin.site.register(Person, PersonAdmin)
@@ -32,3 +41,4 @@ class ChoiceAdmin(SimpleHistoryAdmin):
 admin.site.register(Paper, SimpleHistoryAdmin)
 admin.site.register(Employee, SimpleHistoryAdmin)
 admin.site.register(ConcreteExternal, SimpleHistoryAdmin)
+admin.site.register(FileModel, FileModelAdmin)

simple_history/tests/models.py

@@ -119,6 +119,7 @@ def save(self, *args, **kwargs):
 
 
 class FileModel(models.Model):
+    title = models.CharField(max_length=100)
     file = models.FileField(upload_to='files')
     history = HistoricalRecords()
 

simple_history/tests/tests/test_admin.py

@@ -19,6 +19,7 @@
     Choice,
     ConcreteExternal,
     Employee,
+    FileModel,
     Person,
     Poll,
     State
@@ -103,6 +104,25 @@ def test_history_list_custom_fields(self):
         self.assertIn("12", response.unicode_normal_body)
         self.assertIn("15", response.unicode_normal_body)
 
+    def test_history_list_custom_admin_methods(self):
+        model_name = self.user._meta.model_name
+        self.assertEqual(model_name, 'customuser')
+        self.login()
+        file_model = FileModel(title='Title 1')
+        file_model._history_user = self.user
+        file_model.save()
+        file_model.title = 'Title 2'
+        file_model.save()
+        response = self.app.get(get_history_url(file_model))
+        self.assertIn(get_history_url(file_model, 0),
+                      response.unicode_normal_body)
+        self.assertIn("FileModel object", response.unicode_normal_body)
+        self.assertIn("Created", response.unicode_normal_body)
+        self.assertIn(self.user.username, response.unicode_normal_body)
+        self.assertIn("test_method_value", response.unicode_normal_body)
+        self.assertIn("Title 1", response.unicode_normal_body)
+        self.assertIn("Title 2", response.unicode_normal_body)
+
     def test_history_view_permission(self):
         self.login()
         person = Person.objects.create(name='Sandra Hale')