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/*

MANIFEST.in

@@ -5,6 +5,7 @@ include *.rst
 include *.GPL
 include *.txt
 global-exclude *.pyc
+global-exclude *.DS_Store
 exclude coverage.json
 exclude .coveragerc
 exclude .isort.cfg

README.rst

@@ -297,6 +297,13 @@ This add-on can be seen in action at the following sites:
 
 - https://www.comune.modena.it/form/contatti
 
+Storing different values from how they are displayed
+====================================================
+
+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/browser/send_mail_template.pt

@@ -14,7 +14,7 @@
   <ul>
     <tal:field repeat="field parameters">
       <li tal:define="
-            value field/value|nothing;
+            value field/display_value|nothing;
             label field/label|nothing;
           ">
         <p>

src/collective/volto/formsupport/browser/send_mail_template_table.pt

@@ -38,7 +38,7 @@
       <tal:field repeat="field parameters">
         <tr role="row"
             tal:define="
-              value field/value|nothing;
+              value field/display_value|nothing;
               label field/label|nothing;
             "
         >

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

@@ -77,17 +77,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.internal_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,112 @@
+from collective.volto.formsupport import _
+from plone import api
+from plone.schema.email import _isemail
+from zExceptions import BadRequest
+from zope.i18n import translate
+
+
+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 display_value(self):
+        if self._display_value_mapping:
+            return self._display_value_mapping.get(self._value, self._value)
+        return self._value
+
+    @property
+    def internal_value(self):
+        return self._value
+
+    @property
+    def label(self):
+        return self._label if self._label else self.field_id
+
+    @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
+
+    @property
+    def send_in_email(self):
+        return True
+
+    def validate(self, request):
+        return
+
+
+class YesNoField(Field):
+    @property
+    def display_value(self):
+        if not self._display_value_mapping:
+            return self.internal_value
+        if self.internal_value is True:
+            return self._display_value_mapping.get("yes")
+        elif self.internal_value is False:
+            return self._display_value_mapping.get("no")
+
+
+class AttachmentField(Field):
+    @property
+    def send_in_email(self):
+        return False
+
+
+class EmailField(Field):
+    def validate(self, request):
+        super().validate(request=request)
+
+        if _isemail(self.internal_value) is None:
+            raise BadRequest(
+                translate(
+                    _(
+                        "wrong_email",
+                        default='Email not valid in "${field}" field.',
+                        mapping={
+                            "field": self.label,
+                        },
+                    ),
+                    context=request,
+                )
+            )
+
+
+class DateField(Field):
+    def display_value(self):
+        return api.portal.get_localized_time(self.internal_value)
+
+
+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)
+    elif field_data.get("field_type") in ["from", "email"]:
+        return EmailField(field_data)
+    elif field_data.get("field_type") == "date":
+        return DateField(field_data)
+
+    return Field(field_data)
+
+
+def construct_fields(fields):
+    return [construct_field(field) for field in fields]