rename get_object_actions since it broke anyways

Author: crccheck

CHANGELOG.md

@@ -1,5 +1,15 @@
-##0.8.0 (unreleased)
+0.8.0 (unreleased)
+------------------
 
-Breaking changes:
+### Breaking changes
 
-.get_objectactions
+* Deleted `get_objectactions(request, context, **kwargs)`. If you used this
+  before, use `get_change_actions(request, object_id, form_url)` instead. To
+  get at the original object, instead of `context['original']`, you can use
+  `self.model.get(pk=object_id)`, `self.get_object(request, object_id)`, etc.
+  This isn't as convenient as it used to be, but now it uses the officially
+  documented way to add extra context to admin views.
+  https://docs.djangoproject.com/en/dev/ref/contrib/admin/#other-methods
+
+* Renamed `objectactions`. In your admin, instead of defining your actions in
+  the `objectactions` attribute, use `change_actions`.

README.rst

@@ -120,12 +120,12 @@ Programmatically Disabling Object Admin Actions
 ``````````````````````````````````````````````
 
 You can programmatically disable registered actions by defining your own custom
-``get_object_actions()`` method. In this example, certain actions only apply to
+``get_change_actions()`` method. In this example, certain actions only apply to
 certain object states (i.e. You should not be able to close an company account
 if the account is already closed)::
 
-   def get_object_actions(self, request, object_id, **kwargs):
-        actions = super().get_object_actions(request, object_id, **kwargs)
+   def get_change_actions(self, request, object_id, **kwargs):
+        actions = super().get_change_actions(request, object_id, **kwargs)
 
         obj = self.model.get(pk=object_id)
 

django_object_actions/tests/test_utils.py

@@ -24,20 +24,19 @@ def test_get_tool_urls_trivial_case(self, mock_site):
         self.assertEqual(len(urls), 2)
         self.assertEqual(urls[0].name, 'app_model_tools')
 
-    def test_get_object_actions_gets_attribute(self):
+    def test_get_change_actions_gets_attribute(self):
         # Set up
-        mock_objectactions = mock.Mock()
-        self.instance.objectactions = mock_objectactions
+        self.instance.change_actions = mock.Mock()
 
         # Test
-        returned_value = self.instance.get_object_actions(
+        returned_value = self.instance.get_change_actions(
             request=mock.Mock(),
             object_id=mock.Mock(),
             form_url=mock.Mock(),
         )
 
         # Assert
-        self.assertEqual(id(mock_objectactions), id(returned_value))
+        self.assertEqual(id(self.instance.change_actions), id(returned_value))
 
     def test__get_tool_button_attrs_returns_defaults(self):
         # TODO: use `mock`

django_object_actions/utils.py

@@ -22,17 +22,17 @@ class BaseDjangoObjectActions(object):
     ----------
     model : django.db.models.Model
         The Django Model these tools work on. This is populated by Django.
-    objectactions : list of str
-        Write the names of the callable attributes (methods) of the model admin
-        that can be used as tools in the change view.
+    change_actions : list of str
+        Write the names of the methods of the model admin that can be used as
+        tools in the change view.
     changelist_actions : list of str
-        Write the names of the callable attributes (methods) of the model admin
-        that can be used as tools in the changelist view.
+        Write the names of the methods of the model admin that can be used as
+        tools in the changelist view.
     tools_view_name : str
         The name of the Django Object Actions admin view, including the 'admin'
         namespace. Populated by `get_tool_urls`.
     """
-    objectactions = []
+    change_actions = []
     changelist_actions = []
     tools_view_name = None
 
@@ -52,7 +52,7 @@ def get_tool_urls(self):
 
         self.tools_view_name = 'admin:' + model_tools_url_name
 
-        for tool in chain(self.objectactions, self.changelist_actions):
+        for tool in chain(self.change_actions, self.changelist_actions):
             tools[tool] = getattr(self, tool)
         return [
             # change, supports pks that are numbers or uuids
@@ -90,7 +90,7 @@ def change_view(self, request, object_id, form_url='', extra_context=None):
         extra_context = {
             'objectactions': [
                 self._get_tool_dict(action) for action in
-                self.get_object_actions(request, object_id, form_url)
+                self.get_change_actions(request, object_id, form_url)
             ],
             'tools_view_name': self.tools_view_name,
         }
@@ -122,7 +122,7 @@ def _get_tool_dict(self, tool_name):
             custom_attrs=custom_attrs,
         )
 
-    def get_object_actions(self, request, object_id, form_url):
+    def get_change_actions(self, request, object_id, form_url):
         """
         Override this to customize what actions get to the change view.
 
@@ -131,14 +131,14 @@ def get_object_actions(self, request, object_id, form_url):
         For example, to restrict actions to superusers, you could do:
 
             class ChoiceAdmin(DjangoObjectActions, admin.ModelAdmin):
-                def get_object_actions(self, request, **kwargs):
+                def get_change_actions(self, request, **kwargs):
                     if request.user.is_superuser:
-                        return super(ChoiceAdmin, self).get_object_actions(
+                        return super(ChoiceAdmin, self).get_change_actions(
                             request, **kwargs
                         )
                     return []
         """
-        return self.objectactions
+        return self.change_actions
 
     def get_changelist_actions(self, request):
         """

example_project/polls/admin.py

@@ -45,7 +45,7 @@ def edit_poll(self, request, obj):
     def raise_key_error(self, request, obj):
         raise KeyError
 
-    objectactions = (
+    change_actions = (
         'increment_vote', 'decrement_vote', 'reset_vote', 'edit_poll',
         'raise_key_error',
     )
@@ -86,7 +86,13 @@ def delete_all_choices(self, request, obj):
             dict(object=obj), context_instance=RequestContext(request))
     delete_all_choices.label = "Delete All Choices"
 
-    objectactions = ('delete_all_choices', )
+    change_actions = ('delete_all_choices', )
+
+    def get_change_actions(self, request, object_id, form_url):
+        actions = super(PollAdmin, self).get_change_actions(request, object_id, form_url)
+        import ipdb; ipdb.set_trace()
+        return actions
+
 admin.site.register(Poll, PollAdmin)
 
 
@@ -97,5 +103,5 @@ def hodor(self, request, obj):
             return
         obj.comment = ' '.join(['hodor' for x in obj.comment.split()])
         obj.save()
-    objectactions = ('hodor', )
+    change_actions = ('hodor', )
 admin.site.register(Comment, CommentAdmin)