Add SIMPLE_HISTORY_EDIT setting to turn on and off history editing

Author: buddylindsey

simple_history/admin.py

@@ -2,7 +2,6 @@
 
 from django.core.exceptions import PermissionDenied
 from django.conf.urls import patterns, url
-from django.contrib import admin
 from django.contrib.admin import helpers, ModelAdmin
 from django.contrib.contenttypes.models import ContentType
 from django.core.urlresolvers import reverse
@@ -25,6 +24,8 @@
 
 USER_NATURAL_KEY = tuple(key.lower() for key in USER_NATURAL_KEY.split('.', 1))
 
+settings.SIMPLE_HISTORY_EDIT = getattr(settings, 'SIMPLE_HISTORY_EDIT', False)
+
 
 class SimpleHistoryAdmin(ModelAdmin):
     object_history_template = "simple_history/object_history.html"
@@ -77,7 +78,7 @@ def history_view(self, request, object_id, extra_context=None):
                       dictionary=context, current_app=self.admin_site.name)
 
     def response_change(self, request, obj):
-        if '_change_history' in request.POST:
+        if '_change_history' in request.POST and settings.SIMPLE_HISTORY_EDIT:
             verbose_name = obj._meta.verbose_name
 
             msg = _('The %(name)s "%(obj)s" was changed successfully.') % {
@@ -86,8 +87,7 @@ def response_change(self, request, obj):
             }
 
             self.message_user(
-                request, "%s - %s" % (msg, _("You may edit it again below")),
-                fail_silently=True)
+                request, "%s - %s" % (msg, _("You may edit it again below")))
 
             return HttpResponseRedirect(request.path)
         else:
@@ -108,7 +108,12 @@ def history_form_view(self, request, object_id, version_id):
         if not self.has_change_permission(request, obj):
             raise PermissionDenied
 
-        if '_change_history' in request.POST:
+        if settings.SIMPLE_HISTORY_EDIT:
+            change_history = True
+        else:
+            change_history = False
+
+        if '_change_history' in request.POST and settings.SIMPLE_HISTORY_EDIT:
             obj = obj.history.get(pk=version_id)
 
         formsets = []
@@ -156,6 +161,8 @@ def history_form_view(self, request, object_id, version_id):
                                   args=(obj.pk,)),
             'history_url': reverse('%s:%s_%s_history' % url_triplet,
                                    args=(obj.pk,)),
+            'change_history': change_history,
+
             # Context variables copied from render_change_form
             'add': False,
             'change': True,

simple_history/templates/simple_history/object_history_form.html

@@ -18,5 +18,5 @@
 {% endblock %}
 
 {% block form_top %}
-  <p>{% blocktrans %}Press the 'Revert' button below to revert to this version of the object. Or press the 'Change History' button to edit the history.{% endblocktrans %}</p>
+<p>{% blocktrans %}Press the 'Revert' button below to revert to this version of the object.{% endblocktrans %} {% if change_history %}{% blocktrans %}Or press the 'Change History' button to edit the history.{% endblocktrans %}{% endif %}</p>
 {% endblock %}

simple_history/templates/simple_history/submit_line.html

@@ -1,5 +1,5 @@
 {% load i18n %}
 <div class="submit-row">
 <input type="submit" value="{% trans 'Revert' %}" class="default" name="_save" {{ onclick_attrib }}/>
-<input type="submit" value="{% trans 'Change History' %}" class="default" name="_change_history" {{ onclick_attrib }}/>
+{% if change_history %}<input type="submit" value="{% trans 'Change History' %}" class="default" name="_change_history" {{ onclick_attrib }}/>{% endif %}
 </div>

simple_history/tests/tests/test_admin.py

@@ -248,7 +248,9 @@ def test_deleteting_user(self):
         self.assertEqual(historical_poll.history_user, None)
 
     def test_missing_one_to_one(self):
-        """A relation to a missing one-to-one model should still show history"""
+        """
+        A relation to a missing one-to-one model should still show history
+        """
         self.login()
         manager = Employee.objects.create()
         employee = Employee.objects.create(manager=manager)
@@ -259,6 +261,10 @@ def test_missing_one_to_one(self):
         self.assertEqual(response.status_code, 200)
 
     def test_response_change(self):
+        """
+        Test the response_change method that it works with a _change_history
+        in the POST and settings.SIMPLE_HISTORY_EDIT set to True
+        """
         request = RequestFactory().post('/')
         request.POST = {'_change_history': True}
         request.session = 'session'
@@ -269,12 +275,42 @@ def test_response_change(self):
         poll.question = "how?"
         poll.save()
 
-        admin = SimpleHistoryAdmin(Poll, 'admin')
+        admin_site = AdminSite()
+        admin = SimpleHistoryAdmin(Poll, admin_site)
 
-        response = admin.response_change(request, poll)
+        with override_settings(SIMPLE_HISTORY_EDIT=True):
+            response = admin.response_change(request, poll)
 
         self.assertEqual(response.url, '/awesome/url/')
 
+    def test_response_change_change_history_setting_off(self):
+        """
+        Test the response_change method that it works with a _change_history
+        in the POST and settings.SIMPLE_HISTORY_EDIT set to False
+        """
+        request = RequestFactory().post('/')
+        request.POST = {'_change_history': True}
+        request.session = 'session'
+        request._messages = FallbackStorage(request)
+        request.path = '/awesome/url/'
+        request.user = self.user
+
+        poll = Poll.objects.create(question="why?", pub_date=today)
+        poll.question = "how?"
+        poll.save()
+
+        admin_site = AdminSite()
+        admin = SimpleHistoryAdmin(Poll, admin_site)
+
+        response = admin.response_change(request, poll)
+
+        with patch(
+                'simple_history.admin.ModelAdmin.response_change') as m_admin:
+            m_admin.return_value = 'it was called'
+            response = admin.response_change(request, poll)
+
+        self.assertEqual(response, 'it was called')
+
     def test_response_change_no_change_history(self):
         request = RequestFactory().post('/')
         request.session = 'session'
@@ -285,11 +321,12 @@ def test_response_change_no_change_history(self):
         poll.question = "how?"
         poll.save()
 
-        admin = SimpleHistoryAdmin(Poll, 'admin')
+        admin_site = AdminSite()
+        admin = SimpleHistoryAdmin(Poll, admin_site)
 
         with patch(
-            'simple_history.admin.ModelAdmin.response_change') as mock_admin:
-            mock_admin.return_value = 'it was called'
+                'simple_history.admin.ModelAdmin.response_change') as m_admin:
+            m_admin.return_value = 'it was called'
             response = admin.response_change(request, poll)
 
         self.assertEqual(response, 'it was called')
@@ -305,7 +342,6 @@ def test_history_form_view_without_getting_history(self):
         poll.save()
         history = poll.history.all()[0]
 
-
         admin_site = AdminSite()
         admin = SimpleHistoryAdmin(Poll, admin_site)
 
@@ -315,8 +351,9 @@ def test_history_form_view_without_getting_history(self):
         context = {
             # Verify this is set for original object
             'original': poll,
+            'change_history': False,
 
-            'title': 'Revert {}'.format(force_text(history)),
+            'title': 'Revert {}'.format(force_text(poll)),
             'adminform': ANY,
             'object_id': poll.id,
             'is_popup': False,
@@ -363,16 +400,17 @@ def test_history_form_view_getting_history(self):
         poll.save()
         history = poll.history.all()[0]
 
-
         admin_site = AdminSite()
         admin = SimpleHistoryAdmin(Poll, admin_site)
 
         with patch('simple_history.admin.render') as mock_render:
-            admin.history_form_view(request, poll.id, history.pk)
+            with override_settings(SIMPLE_HISTORY_EDIT=True):
+                admin.history_form_view(request, poll.id, history.pk)
 
         context = {
             # Verify this is set for history object not poll object
             'original': history,
+            'change_history': True,
 
             'title': 'Revert {}'.format(force_text(history)),
             'adminform': ANY,
@@ -408,3 +446,62 @@ def test_history_form_view_getting_history(self):
         mock_render.assert_called_once_with(
             request, template_name=admin.object_history_form_template,
             dictionary=context, current_app=admin_site.name)
+
+    def test_history_form_view_getting_history_with_setting_off(self):
+        request = RequestFactory().post('/')
+        request.session = 'session'
+        request._messages = FallbackStorage(request)
+        request.user = self.user
+        request.POST = {'_change_history': True}
+
+        poll = Poll.objects.create(question="why?", pub_date=today)
+        poll.question = "how?"
+        poll.save()
+        history = poll.history.all()[0]
+
+        admin_site = AdminSite()
+        admin = SimpleHistoryAdmin(Poll, admin_site)
+
+        with patch('simple_history.admin.render') as mock_render:
+            with override_settings(SIMPLE_HISTORY_EDIT=False):
+                admin.history_form_view(request, poll.id, history.pk)
+
+        context = {
+            # Verify this is set for history object not poll object
+            'original': poll,
+            'change_history': False,
+
+            'title': 'Revert {}'.format(force_text(poll)),
+            'adminform': ANY,
+            'object_id': poll.id,
+            'is_popup': False,
+            'media': ANY,
+            'errors': [
+                '<ul class="errorlist"><li>This field is required.</li></ul>',
+                '<ul class="errorlist"><li>This field is required.</li></ul>'
+            ],
+            'app_label': 'tests',
+            'original_opts': ANY,
+            'changelist_url': '/admin/tests/poll/',
+            'change_url': '/admin/tests/poll/1/',
+            'history_url': '/admin/tests/poll/1/history/',
+            'add': False,
+            'change': True,
+            'has_add_permission': admin.has_add_permission(request),
+            'has_change_permission': admin.has_change_permission(
+                request, poll),
+            'has_delete_permission': admin.has_delete_permission(
+                request, poll),
+            'has_file_field': True,
+            'has_absolute_url': False,
+            'form_url': '',
+            'opts': ANY,
+            'content_type_id': ANY,
+            'save_as': admin.save_as,
+            'save_on_top': admin.save_on_top,
+            'root_path': getattr(admin_site, 'root_path', None),
+        }
+
+        mock_render.assert_called_once_with(
+            request, template_name=admin.object_history_form_template,
+            dictionary=context, current_app=admin_site.name)