Merge branch 'kaedroho-mope-584-fix-formbuilder-checkboxes'

CHANGELOG.txt

@@ -22,6 +22,7 @@ Changelog
  * Fix: Fixed references to "username" in login form help text for better custom user model support (John-Scott Atlakson)
  * Fix: Later items in a model's search_field list now consistently override earlier items, allowing subclasses to redefine rules from the parent
  * Fix: Image uploader now accepts JPEG images that PIL reports as being in MPO format
+ * Fix: Multiple checkbox fields on form-builder forms did not correctly save multiple values
 
 0.7 (09.10.2014)
 ~~~~~~~~~~~~~~~~

docs/releases/0.8.rst

@@ -37,7 +37,8 @@ Bug fixes
  * Search indexing now avoids trying to index abstract models
  * Fixed references to "username" in login form help text for better custom user model support
  * Later items in a model's search_field list now consistently override earlier items, allowing subclasses to redefine rules from the parent
-* Image uploader now accepts JPEG images that PIL reports as being in MPO format
+ * Image uploader now accepts JPEG images that PIL reports as being in MPO format
+ * Multiple checkbox fields on form-builder forms did not correctly save multiple values
 
 Upgrade considerations
 ======================

wagtail/tests/fixtures/test.json

@@ -256,6 +256,20 @@
         "page": 8
     }
 },
+{
+    "pk": 3,
+    "model": "tests.formfield",
+    "fields": {
+        "sort_order": 3,
+        "label": "Your choices",
+        "field_type": "checkboxes",
+        "required": false,
+        "choices": "foo,bar,baz",
+        "default_value": "",
+        "help_text": "",
+        "page": 8
+    }
+},
 
 {
     "pk": 10,

wagtail/wagtailforms/models.py

@@ -131,14 +131,8 @@ class AbstractForm(Page):
         return {}
 
     def process_form_submission(self, form):
-        # remove csrf_token from form.data
-        form_data = dict(
-            i for i in form.data.items()
-            if i[0] != 'csrfmiddlewaretoken'
-        )
-
         FormSubmission.objects.create(
-            form_data=json.dumps(form_data),
+            form_data=json.dumps(form.cleaned_data),
             page=self,
         )
 

wagtail/wagtailforms/tests.py

@@ -24,7 +24,9 @@ class TestFormSubmission(TestCase):
 
     def test_post_invalid_form(self):
         response = self.client.post('/contact-us/', {
-            'your-email': 'bob', 'your-message': 'hello world'
+            'your-email': 'bob',
+            'your-message': 'hello world',
+            'your-choices': ''
         })
 
         # Check response
@@ -34,7 +36,9 @@ class TestFormSubmission(TestCase):
 
     def test_post_valid_form(self):
         response = self.client.post('/contact-us/', {
-            'your-email': 'bob@example.com', 'your-message': 'hello world'
+            'your-email': 'bob@example.com',
+            'your-message': 'hello world',
+            'your-choices': {'foo': '', 'bar': '', 'baz': ''}
         })
 
         # Check response
@@ -45,7 +49,7 @@ class TestFormSubmission(TestCase):
         # Check that an email was sent
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].subject, "The subject")
-        self.assertTrue("Your message: hello world" in mail.outbox[0].body)
+        self.assertIn("Your message: hello world", mail.outbox[0].body)
         self.assertEqual(mail.outbox[0].to, ['to@email.com'])
         self.assertEqual(mail.outbox[0].from_email, 'from@email.com')
 
@@ -53,6 +57,27 @@ class TestFormSubmission(TestCase):
         form_page = Page.objects.get(url_path='/home/contact-us/')
         self.assertTrue(FormSubmission.objects.filter(page=form_page, form_data__contains='hello world').exists())
 
+    def test_post_multiple_values(self):
+        response = self.client.post('/contact-us/', {
+            'your-email': 'bob@example.com',
+            'your-message': 'hello world',
+            'your-choices': {'foo': 'on', 'bar': 'on', 'baz': 'on'}
+        })
+
+        # Check response
+        self.assertContains(response, "Thank you for your feedback.")
+        self.assertTemplateNotUsed(response, 'tests/form_page.html')
+        self.assertTemplateUsed(response, 'tests/form_page_landing.html')
+
+        # Check that the three checkbox values were saved correctly
+        form_page = Page.objects.get(url_path='/home/contact-us/')
+        submission = FormSubmission.objects.filter(
+            page=form_page, form_data__contains='hello world'
+        )
+        self.assertIn("foo", submission[0].form_data)
+        self.assertIn("bar", submission[0].form_data)
+        self.assertIn("baz", submission[0].form_data)
+
 
 class TestPageModes(TestCase):
     fixtures = ['test.json']
@@ -89,9 +114,9 @@ class TestFormBuilder(TestCase):
         This tests that all fields were added to the form with the correct types
         """
         form_class = self.fb.get_form_class()
-        
-        self.assertTrue('your-email' in form_class.base_fields.keys())
-        self.assertTrue('your-message' in form_class.base_fields.keys())
+
+        self.assertIn('your-email', form_class.base_fields.keys())
+        self.assertIn('your-message', form_class.base_fields.keys())
 
         self.assertIsInstance(form_class.base_fields['your-email'], forms.EmailField)
         self.assertIsInstance(form_class.base_fields['your-message'], forms.CharField)
@@ -178,7 +203,7 @@ class TestFormsIndex(TestCase):
         response = self.client.get(reverse('wagtailforms_index'))
 
         # Check that the user can see the form page
-        self.assertTrue(self.form_page in response.context['form_pages'])
+        self.assertIn(self.form_page, response.context['form_pages'])
 
 
 class TestFormsSubmissions(TestCase):
@@ -259,4 +284,4 @@ class TestFormsSubmissions(TestCase):
         # Check response
         self.assertEqual(response.status_code, 200)
         data_line = response.content.decode().split("\n")[1]
-        self.assertTrue('new@example.com' in data_line)
+        self.assertIn('new@example.com', data_line)