Allow overriding label for values

.coveragerc

@@ -1,6 +1,10 @@
 [run]
 relative_files = True
 
+omit =
+    src/collective/volto/formsupport/tests/*
+    src/collective/volto/formsupport/upgrades.py
+
 [report]
 include =
     */src/collective/*

README.rst

@@ -258,6 +258,13 @@ This add-on can be seen in action at the following sites:
 
 - https://www.comune.modena.it/form/contatti
 
+Custom label mapping
+=========================
+
+In some cases, the text that is displayed for a field on the page and in the sent email may need to be different from the value that is stored internally. For example, you may want your "Yes/ No" widget to show "Accept" and "Decline" as the labels, but internally still store `True` and `False`.
+
+By storing a `display_values` dictionary for each field in the block data, you can perform these mappings.
+
 
 Translations
 ============

src/collective/volto/formsupport/datamanager/catalog.py

@@ -79,17 +79,19 @@ def add(self, data):
                 )
             )
             return None
+        fields = {}
+        for field in form_fields:
+            custom_field_id = field.get("custom_field_id")
+            field_id = custom_field_id if custom_field_id else field["field_id"]
+            fields[field_id] = field.get("label", field_id)
 
-        fields = {
-            x["field_id"]: x.get("custom_field_id", x.get("label", x["field_id"]))
-            for x in form_fields
-        }
         record = Record()
         fields_labels = {}
         fields_order = []
         for field_data in data:
-            field_id = field_data.get("field_id", "")
-            value = field_data.get("value", "")
+            field_id = field_data.field_id
+            # TODO: not nice using the protected member to access the real internal value, but easiest way.
+            value = field_data._value
             if field_id in fields:
                 record.attrs[field_id] = value
                 fields_labels[field_id] = fields[field_id]

src/collective/volto/formsupport/restapi/services/submit_form/field.py

@@ -0,0 +1,86 @@
+class Field:
+    def __init__(self, field_data):
+        def _attribute(attribute_name):
+            setattr(self, attribute_name, field_data.get(attribute_name))
+
+        _attribute("field_type")
+        _attribute("id")
+        _attribute("show_when_when")
+        _attribute("show_when_is")
+        _attribute("show_when_to")
+        _attribute("input_values")
+        _attribute("required")
+        _attribute("widget")
+        _attribute("use_as_reply_to")
+        _attribute("use_as_reply_bcc")
+        self._display_value_mapping = field_data.get("display_value_mapping")
+        self._value = field_data.get("value", "")
+        self._custom_field_id = field_data.get("custom_field_id")
+        self._label = field_data.get("label", "")
+        self._field_id = field_data.get("field_id", "")
+
+    @property
+    def value(self):
+        if self._display_value_mapping:
+            return self._display_value_mapping.get(self._value, self._value)
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        self._value = value
+
+    @property
+    def label(self):
+        return self._label if self._label else self.field_id
+
+    @label.setter
+    def label(self, label):
+        self._label = label
+
+    @property
+    def field_id(self):
+        if self._custom_field_id:
+            return self._custom_field_id
+        return self._field_id if self._field_id else self._label
+
+    @field_id.setter
+    def field_id(self, field_id):
+        self._field_id = field_id
+
+    @property
+    def send_in_email(self):
+        return True
+
+
+class YesNoField(Field):
+    @property
+    def value(self):
+        if self._display_value_mapping:
+            if self._value is True:
+                return self._display_value_mapping.get("yes")
+            elif self._value is False:
+                return self._display_value_mapping.get("no")
+        return self._value
+
+    @property
+    def send_in_email(self):
+        return True
+
+
+class AttachmentField(Field):
+    @property
+    def send_in_email(self):
+        return False
+
+
+def construct_field(field_data):
+    if field_data.get("widget") == "single_choice":
+        return YesNoField(field_data)
+    elif field_data.get("field_type") == "attachment":
+        return AttachmentField(field_data)
+
+    return Field(field_data)
+
+
+def construct_fields(fields):
+    return [construct_field(field) for field in fields]

src/collective/volto/formsupport/restapi/services/submit_form/post.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+
 import codecs
 import logging
 import math
@@ -27,6 +28,9 @@
     IFormDataStore,
     IPostEvent,
 )
+from collective.volto.formsupport.restapi.services.submit_form.field import (
+    construct_fields,
+)
 from collective.volto.formsupport.utils import get_blocks
 
 logger = logging.getLogger(__name__)
@@ -41,6 +45,8 @@ def __init__(self, context, data):
 
 
 class SubmitPost(Service):
+    fields = []
+
     def __init__(self, context, request):
         super(SubmitPost, self).__init__(context, request)
 
@@ -61,6 +67,27 @@ def reply(self):
 
         notify(PostEventService(self.context, self.form_data))
 
+        # Construct self.fieldss
+        fields_data = []
+        for submitted_field in self.form_data.get("data", []):
+            # TODO: Review if fields submitted without a field_id should be included. Is breaking change if we remove it
+            if submitted_field.get("field_id") is None:
+                fields_data.append(submitted_field)
+                continue
+            for field in self.block.get("subblocks", []):
+                if field.get("id", field.get("field_id")) == submitted_field.get(
+                    "field_id"
+                ):
+                    fields_data.append(
+                        {
+                            **field,
+                            **submitted_field,
+                            "display_value_mapping": field.get("display_values"),
+                            "custom_field_id": self.block.get(field["field_id"]),
+                        }
+                    )
+        self.fields = construct_fields(fields_data)
+
         if send_action:
             try:
                 self.send_data()
@@ -332,16 +359,7 @@ def filter_parameters(self):
         """
         do not send attachments fields.
         """
-        skip_fields = [
-            x.get("field_id", "")
-            for x in self.block.get("subblocks", [])
-            if x.get("field_type", "") == "attachment"
-        ]
-        return [
-            x
-            for x in self.form_data.get("data", [])
-            if x.get("field_id", "") not in skip_fields
-        ]
+        return [field for field in self.fields if field.send_in_email]
 
     def send_mail(self, msg, charset):
         host = api.portal.get_tool(name="MailHost")
@@ -394,9 +412,7 @@ def attach_xml(self, msg):
         xmlRoot = Element("form")
 
         for field in self.filter_parameters():
-            SubElement(
-                xmlRoot, "field", name=field.get("custom_field_id", field["label"])
-            ).text = str(field.get("value", ""))
+            SubElement(xmlRoot, "field", name=field.field_id).text = str(field._value)
 
         doc = ElementTree(xmlRoot)
         doc.write(output, encoding="utf-8", xml_declaration=True)