Fix how extra context set by admins was not passed (#64)

* refactor admin to organize things better

* add failing test case for extra context

s

* fixing context data

Author: crccheck

django_object_actions/tests/test_admin.py

@@ -9,7 +9,7 @@
 from example_project.polls.factories import CommentFactory, PollFactory
 
 
-class CommentTest(LoggedInTestCase):
+class CommentTests(LoggedInTestCase):
     def test_action_on_a_model_with_uuid_pk_works(self):
         comment = CommentFactory()
         comment_url = reverse('admin:polls_comment_change', args=(comment.pk,))
@@ -20,13 +20,20 @@ def test_action_on_a_model_with_uuid_pk_works(self):
         self.assertRedirects(response, comment_url)
 
 
-class ChangeTest(LoggedInTestCase):
+class ChangeTests(LoggedInTestCase):
     def test_buttons_load(self):
         url = '/admin/polls/choice/'
         response = self.client.get(url)
         self.assertIn('objectactions', response.context_data)
         self.assertIn('Delete_all', response.rendered_content)
 
+    def test_changelist_template_context(self):
+        url = reverse('admin:polls_poll_changelist')
+        response = self.client.get(url)
+        self.assertIn('objectactions', response.context_data)
+        self.assertIn('tools_view_name', response.context_data)
+        self.assertIn('foo', response.context_data)
+
     def test_changelist_action_view(self):
         url = '/admin/polls/choice/actions/delete_all/'
         response = self.client.get(url)
@@ -55,10 +62,22 @@ def test_get_changelist_can_remove_action(self):
         self.assertNotIn(action_url, response.rendered_content)
 
 
-class MultipleAdmins(LoggedInTestCase):
+class ChangeListTests(LoggedInTestCase):
+    def test_changelist_template_context(self):
+        poll = PollFactory()
+        url = reverse('admin:polls_poll_change', args=(poll.pk,))
+
+        response = self.client.get(url)
+        self.assertIn('objectactions', response.context_data)
+        self.assertIn('tools_view_name', response.context_data)
+        self.assertIn('foo', response.context_data)
+
+
+class MultipleAdminsTests(LoggedInTestCase):
     def test_redirect_back_from_secondary_admin(self):
-        poll = PollFactory.create()
-        admin_change_url = reverse('admin:polls_poll_change', args=(poll.pk,), current_app='support')
+        poll = PollFactory()
+        admin_change_url = reverse('admin:polls_poll_change', args=(poll.pk,),
+                                   current_app='support')
         action_url = '/support/polls/poll/1/actions/question_mark/'
         self.assertTrue(admin_change_url.startswith('/support/'))
 

django_object_actions/utils.py

@@ -45,24 +45,26 @@ def get_urls(self):
         return self._get_action_urls() + urls
 
     def change_view(self, request, object_id, form_url='', extra_context=None):
-        extra_context = {
+        extra_context = extra_context or {}
+        extra_context.update({
             'objectactions': [
                 self._get_tool_dict(action) for action in
                 self.get_change_actions(request, object_id, form_url)
             ],
             'tools_view_name': self.tools_view_name,
-        }
+        })
         return super(BaseDjangoObjectActions, self).change_view(
             request, object_id, form_url, extra_context)
 
     def changelist_view(self, request, extra_context=None):
-        extra_context = {
+        extra_context = extra_context or {}
+        extra_context.update({
             'objectactions': [
                 self._get_tool_dict(action) for action in
                 self.get_changelist_actions(request)
             ],
             'tools_view_name': self.tools_view_name,
-        }
+        })
         return super(BaseDjangoObjectActions, self).changelist_view(
             request, extra_context)
 

example_project/polls/admin.py

@@ -15,6 +15,9 @@
 class ChoiceAdmin(DjangoObjectActions, admin.ModelAdmin):
     list_display = ('poll', 'choice_text', 'votes')
 
+    # Actions
+    #########
+
     @takes_instance_or_queryset
     def increment_vote(self, request, queryset):
         queryset.update(votes=F('votes') + 1)
@@ -26,6 +29,11 @@ def increment_vote(self, request, queryset):
         'class': 'addlink',
     }
 
+    actions = ['increment_vote']
+
+    # Object actions
+    ################
+
     def decrement_vote(self, request, obj):
         obj.votes -= 1
         obj.save()
@@ -51,8 +59,6 @@ def raise_key_error(self, request, obj):
         'raise_key_error',
     )
     changelist_actions = ('delete_all',)
-    actions = ['increment_vote']
-
 admin.site.register(Choice, ChoiceAdmin)
 
 
@@ -62,16 +68,34 @@ class ChoiceInline(admin.StackedInline):
 
 
 class PollAdmin(DjangoObjectActions, admin.ModelAdmin):
+    # List
+    ######
+
+    list_display = ('question', 'pub_date', 'was_published_recently')
+    list_filter = ['pub_date']
+    search_fields = ['question']
+    date_hierarchy = 'pub_date'
+
+    def changelist_view(self, request, extra_context=None):
+        extra_context = {'foo': 'changelist_view'}
+        return super(PollAdmin, self).changelist_view(request, extra_context)
+
+    # Detail
+    ########
+
     fieldsets = [
         (None, {'fields': ['question']}),
         ('Date information',
          {'fields': ['pub_date'], 'classes': ['collapse']}),
     ]
     inlines = [ChoiceInline]
-    list_display = ('question', 'pub_date', 'was_published_recently')
-    list_filter = ['pub_date']
-    search_fields = ['question']
-    date_hierarchy = 'pub_date'
+
+    def change_view(self, request, object_id, form_url='', extra_context=None):
+        extra = {'foo': 'change_view'}
+        return super(PollAdmin, self).change_view(request, object_id, form_url, extra)
+
+    # Object actions
+    ################
 
     def delete_all_choices(self, request, obj):
         from django.shortcuts import render_to_response
@@ -105,11 +129,14 @@ def get_change_actions(self, request, object_id, form_url):
             actions.remove('question_mark')
 
         return actions
-
 admin.site.register(Poll, PollAdmin)
 
 
 class CommentAdmin(DjangoObjectActions, admin.ModelAdmin):
+
+    # Object actions
+    ################
+
     def hodor(self, request, obj):
         if not obj.comment:
             # bail because we need a comment

example_project/polls/factories.py

@@ -20,14 +20,23 @@ class Meta:
     password = factory.PostGenerationMethodCall('set_password', 'password')
 
 
-class CommentFactory(factory.DjangoModelFactory):
-    class Meta:
-        model = models.Comment
-
-
 class PollFactory(factory.DjangoModelFactory):
     class Meta:
         model = models.Poll
 
     question = factory.LazyAttribute(lambda __: fake.sentence())
     pub_date = factory.LazyAttribute(lambda __: timezone.now())
+
+
+class ChoiceFactory(factory.DjangoModelFactory):
+    class Meta:
+        model = models.Choice
+
+    poll = factory.SubFactory(PollFactory)
+    choice_text = factory.LazyAttribute(lambda __: fake.word())
+    votes = factory.LazyAttribute(lambda __: fake.pyint())
+
+
+class CommentFactory(factory.DjangoModelFactory):
+    class Meta:
+        model = models.Comment

example_project/settings.py

@@ -10,7 +10,12 @@ def project_dir(*paths):
 
 
 DEBUG = True
-TEMPLATE_DEBUG = DEBUG
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'APP_DIRS': True,
+    },
+]
 
 DATABASES = {'default': dj_database_url.config(default='sqlite:///' +
     project_dir('example_project.db'))}