Update get_options method for multiple fields (#197)

* Update get_options method for CheckboxesField, RadioField, MultiSelectField and DropdownField

To create the choice options form the block_value, it gets the value. Yet, sometimes this block_value is a list with dicts with the value. Now it checks if this is the case, and gets the value from there instead of just the item of the list.

Author: VdeJong

tests/fields/test_fields.py

@@ -108,6 +108,26 @@ def test_dropdown_field(self):
         cls = wsf_fields.DropdownField()
         field = cls.get_formfield(data)
 
+        block_value = {
+            "label": "dropdown",
+            "help_text": "",
+            "required": False,
+            "empty_label": "",
+            "choices": ["choice 1", "choice 2", "choice 3"],
+        }
+        options = wsf_fields.DropdownField().get_options(block_value=block_value)
+        assert options == {
+            "label": "dropdown",
+            "help_text": "",
+            "required": False,
+            "initial": None,
+            "choices": [
+                ("choice 1", "choice 1"),
+                ("choice 2", "choice 2"),
+                ("choice 3", "choice 3"),
+            ],
+        }
+
         self.assertIsInstance(field, forms.ChoiceField)
         self.assertIsInstance(field.widget, forms.widgets.Select)
         self.assertEqual(field.label, data["label"])

tests/urls.py

@@ -1,5 +1,5 @@
-from django.urls import include, re_path
 from django.contrib import admin
+from django.urls import include, re_path
 from wagtail.admin import urls as wagtailadmin_urls
 from wagtail.core import urls as wagtail_urls
 

tests/views/test_submission_list.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+
 from django.conf import settings
 from django.contrib.auth.models import Permission, User
 from django.urls import reverse

wagtailstreamforms/wagtail_hooks.py

@@ -1,10 +1,9 @@
-from django.urls import include
 from django.contrib import messages
 from django.contrib.admin.utils import quote
 from django.contrib.auth.decorators import login_required
 from django.shortcuts import redirect
 from django.template.response import TemplateResponse
-from django.urls import path, reverse
+from django.urls import include, path, reverse
 from django.utils.decorators import method_decorator
 from django.utils.translation import gettext_lazy as _
 from wagtail.admin import messages as wagtail_messages

wagtailstreamforms/wagtailstreamforms_fields.py

@@ -1,3 +1,5 @@
+from typing import List, Tuple
+
 from django import forms
 from django.utils.translation import gettext_lazy as _
 from wagtail.core import blocks
@@ -53,7 +55,13 @@ class DropdownField(BaseField):
 
     def get_options(self, block_value):
         options = super().get_options(block_value)
-        choices = [(c.strip(), c.strip()) for c in block_value.get("choices")]
+        choices: List[Tuple[str, str]] = []
+        for c in block_value.get("choices"):
+            if isinstance(c, dict) and c.get("value"):
+                choices.append((c["value"].strip(), c["value"].strip()))
+            else:
+                choices.append((c.strip(), c.strip()))
+
         if block_value.get("empty_label"):
             choices.insert(0, ("", block_value.get("empty_label")))
         options.update({"choices": choices})
@@ -80,7 +88,12 @@ class MultiSelectField(BaseField):
 
     def get_options(self, block_value):
         options = super().get_options(block_value)
-        choices = [(c.strip(), c.strip()) for c in block_value.get("choices")]
+        choices: List[Tuple[str, str]] = []
+        for c in block_value.get("choices"):
+            if isinstance(c, dict) and c.get("value"):
+                choices.append((c["value"].strip(), c["value"].strip()))
+            else:
+                choices.append((c.strip(), c.strip()))
         options.update({"choices": choices})
         return options
 
@@ -105,7 +118,12 @@ class RadioField(BaseField):
 
     def get_options(self, block_value):
         options = super().get_options(block_value)
-        choices = [(c.strip(), c.strip()) for c in block_value.get("choices")]
+        choices: List[Tuple[str, str]] = []
+        for c in block_value.get("choices"):
+            if isinstance(c, dict) and c.get("value"):
+                choices.append((c["value"].strip(), c["value"].strip()))
+            else:
+                choices.append((c.strip(), c.strip()))
         options.update({"choices": choices})
         return options
 
@@ -130,7 +148,12 @@ class CheckboxesField(BaseField):
 
     def get_options(self, block_value):
         options = super().get_options(block_value)
-        choices = [(c.strip(), c.strip()) for c in block_value.get("choices")]
+        choices: List[Tuple[str, str]] = []
+        for c in block_value.get("choices"):
+            if isinstance(c, dict) and c.get("value"):
+                choices.append((c["value"].strip(), c["value"].strip()))
+            else:
+                choices.append((c.strip(), c.strip()))
         options.update({"choices": choices})
         return options