Feature: Include request context on signal triggers

Author: Octocat

setup.py

@@ -17,7 +17,7 @@
 def do_setup():
     setup(
         name="django-wizard",
-        version='0.2.7',
+        version='0.3.0',
         author="Matthew J. Morrison",
         author_email="mattjmorrison@mattjmorrison.com",
         description="A wizard that helps to control page flow.",

wizard/__init__.py

@@ -185,9 +185,9 @@ def create_prereq(self, step):
 
         @wraps(step.prereq)
         def wrapper_new_prereq():
-            signals.wizard_pre_prereq.send(self, step_key=step._key)
+            signals.wizard_pre_prereq.send(self, step_key=step._key, request=self.request)
             orig_prereq()
-            signals.wizard_post_prereq.send(self, step_key=step._key)
+            signals.wizard_post_prereq.send(self, step_key=step._key, request=self.request)
 
         return wrapper_new_prereq
 
@@ -223,9 +223,9 @@ def redirect(self, step):
 
     def post(self, request, step):
         try:
-            signals.wizard_pre_save.send(self, step_key=step)
+            signals.wizard_pre_save.send(self, step_key=step, request=self.request)
             self.get_step_object_by_key(step).save()
-            signals.wizard_post_save.send(self, step_key=step)
+            signals.wizard_post_save.send(self, step_key=step, request=self.request)
         except SaveStepException:
             return self.render(request, self.do_display(step), step)
         else:
@@ -284,9 +284,9 @@ def render(self, request, data, step):
 
     def do_display(self, step):
         step_object = self.get_step_object_by_key(step)
-        signals.wizard_pre_display.send(self, step_key=step)
+        signals.wizard_pre_display.send(self, step_key=step, request=self.request)
         data = step_object.display() or {}
-        signals.wizard_post_display.send(self, step_key=step)
+        signals.wizard_post_display.send(self, step_key=step, request=self.request)
         return self.add_wizard_data_to_template(data, step)
 
     def add_wizard_data_to_template(self, data, step):

wizard/signals.py

@@ -1,8 +1,8 @@
 from django import dispatch
 
-wizard_pre_save = dispatch.Signal(providing_args=['step_key'])
-wizard_post_save = dispatch.Signal(providing_args=['step_key'])
-wizard_pre_display = dispatch.Signal(providing_args=['step_key'])
-wizard_post_display = dispatch.Signal(providing_args=['step_key'])
-wizard_post_prereq = dispatch.Signal(providing_args=['step_key'])
-wizard_pre_prereq = dispatch.Signal(providing_args=['step_key'])
+wizard_pre_save = dispatch.Signal(providing_args=['step_key', 'request'])
+wizard_post_save = dispatch.Signal(providing_args=['step_key', 'request'])
+wizard_pre_display = dispatch.Signal(providing_args=['step_key', 'request'])
+wizard_post_display = dispatch.Signal(providing_args=['step_key', 'request'])
+wizard_post_prereq = dispatch.Signal(providing_args=['step_key', 'request'])
+wizard_pre_prereq = dispatch.Signal(providing_args=['step_key', 'request'])

wizard/tests.py

@@ -620,7 +620,7 @@ def test_sends_pre_save_signal_in_post(self, send_presave):
         self.mock_request.method = 'POST'
         self.mock_request.POST = {}
         wiz.handle_request(self.mock_request, 'first')
-        send_presave.assert_called_once_with(wiz, step_key='first')
+        send_presave.assert_called_once_with(wiz, step_key='first', request=self.mock_request)
 
     @mock.patch('wizard.signals.wizard_post_save.send')
     def test_sends_post_save_signal_in_post(self, send_postsave):
@@ -629,7 +629,7 @@ def test_sends_post_save_signal_in_post(self, send_postsave):
         self.mock_request.method = 'POST'
         self.mock_request.POST = {}
         wiz.handle_request(self.mock_request, 'first')
-        send_postsave.assert_called_once_with(wiz, step_key='first')
+        send_postsave.assert_called_once_with(wiz, step_key='first', request=self.mock_request)
 
     @mock.patch.object(TestStepOne, 'save', mock.Mock(side_effect=wizard.SaveStepException))
     @mock.patch('wizard.signals.wizard_post_save.send')
@@ -645,29 +645,31 @@ def test_does_not_send_post_save_signal_in_post_on_save_step_exception(self, sen
     def test_sends_pre_display_signal_in_do_display(self, send_predisplay):
         wiz = wizard.Wizard('test:test3', self.steps)
         wiz.handle_request(self.mock_request, 'first')
-        send_predisplay.assert_called_once_with(wiz, step_key='first')
+        send_predisplay.assert_called_once_with(wiz, step_key='first', request=self.mock_request)
 
     @mock.patch('wizard.signals.wizard_post_display.send')
     def test_sends_post_display_signal_in_do_display(self, send_postdisplay):
         wiz = wizard.Wizard('test:test3', self.steps)
         wiz.handle_request(self.mock_request, 'first')
-        send_postdisplay.assert_called_once_with(wiz, step_key='first')
+        send_postdisplay.assert_called_once_with(wiz, step_key='first', request=self.mock_request)
 
     @mock.patch('wizard.signals.wizard_post_prereq.send')
     def test_sends_post_prereq_signal_in_prereq(self, send_post_prereq):
         wiz = wizard.Wizard('test:test3', self.steps)
+        wiz.request = self.mock_request
         wiz.steps = dict(self.steps)
         wiz._current_step = 'fourth'
         wiz.current_step_object.prereq()
-        send_post_prereq.assert_called_once_with(wiz, step_key='fourth')
+        send_post_prereq.assert_called_once_with(wiz, step_key='fourth', request=self.mock_request)
 
     @mock.patch('wizard.signals.wizard_pre_prereq.send')
     def test_sends_pre_prereq_signal_in_prereq(self, send_pre_prereq):
         wiz = wizard.Wizard('test:test3', self.steps)
+        wiz.request = self.mock_request
         wiz.steps = dict(self.steps)
         wiz._current_step = 'fourth'
         wiz.current_step_object.prereq()
-        send_pre_prereq.assert_called_once_with(wiz, step_key='fourth')
+        send_pre_prereq.assert_called_once_with(wiz, step_key='fourth', request=self.mock_request)
 
     @mock.patch.object(TestStepFour, 'prereq', mocksignature=True)
     @mock.patch('wizard.signals.wizard_post_prereq.send')