Merge pull request #256 from gbataille/field_list

treyhunner · web-flow · commit c07d9074c8f4 · 2017-06-11T20:51:45.000-07:00
Field list
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -36,6 +36,7 @@ Authors
 - vnagendra
 - Lucas Wiman
 - Michael England
+- Gregory Bataille
 
 Background
 ==========
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,8 @@ Changes
 tip (unreleased)
 ----------------
 - Added --batchsize option to the populate_history management command.
+- Add the ability to display object attributes in the history list view to see
+  what has changed easily
 
 1.8.2 (2017-01-19)
 ------------------
diff --git a/docs/screens/5_history_list_display.png b/docs/screens/5_history_list_display.png
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -127,6 +127,39 @@ An example of admin integration for the ``Poll`` and ``Choice`` models:
 Changing a history-tracked model from the admin interface will automatically record the user who made the change (see :doc:`/advanced`).
 
 
+Displaying custom columns in the admin history list view
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, the history log displays one line per change containing
+
+* a link to the detail of the object at that point in time
+* the date and time the object was changed
+* a comment corresponding to the change
+* the author of the change
+
+You can add other columns (for example the object's status to see
+how it evolved) by adding a ``history_list_display`` array of fields to the
+admin class
+
+.. code-block:: python
+
+    from django.contrib import admin
+    from simple_history.admin import SimpleHistoryAdmin
+    from .models import Poll, Choice
+
+
+    class PollHistoryAdmin(SimpleHistoryAdmin):
+        list_display = ["id", "name", "status"]
+        history_list_display = ["status"]
+        search_fields = ['name', 'user__username']
+
+    admin.site.register(Poll, PollHistoryAdmin)
+    admin.site.register(Choice, SimpleHistoryAdmin)
+
+
+.. image:: screens/5_history_list_display.png
+
+
 Querying history
 ----------------
 
diff --git a/simple_history/admin.py b/simple_history/admin.py
@@ -57,6 +57,7 @@ def history_view(self, request, object_id, extra_context=None):
         history = getattr(model, model._meta.simple_history_manager_attribute)
         object_id = unquote(object_id)
         action_list = history.filter(**{pk_name: object_id})
+        history_list_display = getattr(self, "history_list_display", [])
         # If no history was found, see whether this object even exists.
         try:
             obj = model.objects.get(**{pk_name: object_id})
@@ -77,7 +78,8 @@ def history_view(self, request, object_id, extra_context=None):
             'root_path': getattr(self.admin_site, 'root_path', None),
             'app_label': app_label,
             'opts': opts,
-            'admin_user_view': admin_user_view
+            'admin_user_view': admin_user_view,
+            'history_list_display': history_list_display,
         }
         context.update(extra_context or {})
         extra_kwargs = {}
diff --git a/simple_history/templates/simple_history/_object_history_list.html b/simple_history/templates/simple_history/_object_history_list.html
@@ -0,0 +1,42 @@
+{% load i18n %}
+{% load url from simple_history_compat %}
+{% load admin_urls %}
+{% load getattribute from getattributes %}
+
+<table id="change-history" class="table table-bordered table-striped">
+  <thead>
+    <tr>
+      <th scope="col">{% trans 'Object' %}</th>
+      {% for column in history_list_display %}
+        <th scope="col">{% trans column %}</th>
+      {% endfor %}
+      <th scope="col">{% trans 'Date/time' %}</th>
+      <th scope="col">{% trans 'Comment' %}</th>
+      <th scope="col">{% trans 'Changed by' %}</th>
+    </tr>
+  </thead>
+  <tbody>
+    {% for action in action_list %}
+      <tr>
+        <td><a href="{% url opts|admin_urlname:'simple_history' object.pk action.pk %}">{{ action.history_object }}</a></td>
+        {% for column in history_list_display %}
+        <td scope="col">{{ action|getattribute:column }}</th>
+        {% endfor %}
+        <td>{{ action.history_date }}</td>
+        <td>{{ action.get_history_type_display }}</td>
+        <td>
+          {% if action.history_user %}
+            {% url admin_user_view action.history_user_id as admin_user_url %}
+            {% if admin_user_url %}
+              <a href="{{ admin_user_url }}">{{ action.history_user }}</a>
+            {% else %}
+              {{ action.history_user }}
+            {% endif %}
+          {% else %}
+            {% trans "None" %}
+          {% endif %}
+        </td>
+      </tr>
+    {% endfor %}
+  </tbody>
+</table>
diff --git a/simple_history/templates/simple_history/object_history.html b/simple_history/templates/simple_history/object_history.html
@@ -2,6 +2,7 @@
 {% load i18n %}
 {% load url from simple_history_compat %}
 {% load admin_urls %}
+{% load display_list from simple_history_admin_list %}
 
 
 {% block content %}
@@ -11,37 +12,7 @@
 
     <div class="module">
       {% if action_list %}
-        <table id="change-history" class="table table-bordered table-striped">
-          <thead>
-            <tr>
-              <th scope="col">{% trans 'Object' %}</th>
-              <th scope="col">{% trans 'Date/time' %}</th>
-              <th scope="col">{% trans 'Comment' %}</th>
-              <th scope="col">{% trans 'Changed by' %}</th>
-            </tr>
-          </thead>
-          <tbody>
-            {% for action in action_list %}
-              <tr>
-                <td><a href="{% url opts|admin_urlname:'simple_history' object.pk action.pk %}">{{ action.history_object }}</a></td>
-                <td>{{ action.history_date }}</td>
-                <td>{{ action.get_history_type_display }}</td>
-                <td>
-                  {% if action.history_user %}
-                    {% url admin_user_view action.history_user_id as admin_user_url %}
-                    {% if admin_user_url %}
-                      <a href="{{ admin_user_url }}">{{ action.history_user }}</a>
-                    {% else %}
-                      {{ action.history_user }}
-                    {% endif %}
-                  {% else %}
-                  {% trans "None" %}
-                  {% endif %}
-                </td>
-              </tr>
-            {% endfor %}
-          </tbody>
-        </table>
+        {% display_list %}
       {% else %}
         <p>{% trans "This object doesn't have a change history." %}</p>
       {% endif %}
diff --git a/simple_history/templatetags/getattributes.py b/simple_history/templatetags/getattributes.py
@@ -0,0 +1,11 @@
+from django import template
+
+register = template.Library()
+
+
+def getattribute(value, arg):
+    """Gets an attribute of an object dynamically from a string name"""
+
+    return getattr(value, arg, None)
+
+register.filter('getattribute', getattribute)
diff --git a/simple_history/templatetags/simple_history_admin_list.py b/simple_history/templatetags/simple_history_admin_list.py
@@ -0,0 +1,9 @@
+from django import template
+
+register = template.Library()
+
+
+@register.inclusion_tag("simple_history/_object_history_list.html",
+                        takes_context=True)
+def display_list(context):
+    return context
diff --git a/simple_history/tests/admin.py b/simple_history/tests/admin.py
@@ -11,8 +11,12 @@ def has_change_permission(self, request, obj=None):
         return False
 
 
+class ChoiceAdmin(SimpleHistoryAdmin):
+    history_list_display = ['votes']
+
+
 admin.site.register(Poll, SimpleHistoryAdmin)
-admin.site.register(Choice, SimpleHistoryAdmin)
+admin.site.register(Choice, ChoiceAdmin)
 admin.site.register(Person, PersonAdmin)
 admin.site.register(Book, SimpleHistoryAdmin)
 admin.site.register(Document, SimpleHistoryAdmin)
diff --git a/simple_history/tests/tests/test_admin.py b/simple_history/tests/tests/test_admin.py
@@ -13,7 +13,7 @@
 
 from simple_history.models import HistoricalRecords
 from simple_history.admin import SimpleHistoryAdmin, get_complete_version
-from ..models import Book, Person, Poll, State, Employee
+from ..models import Book, Person, Poll, State, Employee, Choice
 
 try:
     from django.contrib.admin.utils import quote
@@ -75,6 +75,27 @@ def test_history_list(self):
         self.assertIn("Created", response.unicode_normal_body)
         self.assertIn(self.user.username, response.unicode_normal_body)
 
+    def test_history_list_custom_fields(self):
+        model_name = self.user._meta.model_name
+        self.assertEqual(model_name, 'customuser')
+        self.login()
+        poll = Poll(question="why?", pub_date=today)
+        poll._history_user = self.user
+        poll.save()
+        choice = Choice(poll=poll, choice='because', votes=12)
+        choice._history_user = self.user
+        choice.save()
+        choice.votes = 15
+        choice.save()
+        response = self.app.get(get_history_url(choice))
+        self.assertIn(get_history_url(choice, 0), response.unicode_normal_body)
+        self.assertIn("Choice object", response.unicode_normal_body)
+        self.assertIn("Created", response.unicode_normal_body)
+        self.assertIn(self.user.username, response.unicode_normal_body)
+        self.assertIn("votes", response.unicode_normal_body)
+        self.assertIn("12", response.unicode_normal_body)
+        self.assertIn("15", response.unicode_normal_body)
+
     def test_history_form_permission(self):
         self.login(self.user)
         person = Person.objects.create(name='Sandra Hale')
diff --git a/simple_history/tests/tests/test_templatetags.py b/simple_history/tests/tests/test_templatetags.py
@@ -0,0 +1,16 @@
+from simple_history.templatetags.getattributes import getattribute
+
+from django.test import TestCase
+
+
+class Foo(object):
+    bar = "bar"
+
+
+class TestGetAttributes(TestCase):
+
+    def test_get_existing_attributes_return_it(self):
+        self.assertEqual(getattribute(Foo(), 'bar'), 'bar')
+
+    def test_get_missing_attributes_return_None(self):
+        self.assertIsNone(getattribute(Foo(), 'baz'))
