Merge pull request #400 from peopledoc/include-parameters-contextualized-serializer

Include parameters when serializing a form using the ContextFormSerializer

Author: brunobord

CHANGELOG.rst

@@ -9,6 +9,7 @@ master (unreleased)
 - Drop support for Django REST Framework 3.8 (#382).
 - Fix Postgresql configuration in CircleCI regarding the authentication (#395).
 - Small cleanups of Python2-related code.
+- Include the property ``parameters`` serializing a form using the ContextFormSerializer.
 
 Release 4.0.2 (2020-02-13)
 ==========================

demo/tests/serializers/test_formidable_serializer.py

@@ -2,6 +2,7 @@
 
 from formidable.register import FieldSerializerRegister, load_serializer
 from formidable.serializers import FormidableSerializer
+from formidable.serializers.forms import ContextFormSerializer
 from formidable.serializers.fields import BASE_FIELDS, FieldSerializer
 
 import mock
@@ -60,10 +61,10 @@ def test_register(self):
 
     def test_custom_field_serialize(self):
         serializer = FormidableSerializer(data=self.schema)
-        serializer.is_valid()
+        assert serializer.is_valid()
         serializer.save()
         # get field instance
-        self.instance = serializer.instance
+        instance = serializer.instance
         custom_field = serializer.instance.fields.first()
         # test field instance
         self.assertIn('meta_info', custom_field.parameters)
@@ -80,7 +81,35 @@ def test_custom_field_serialize(self):
         self.assertIn('some_another_data', data)
         self.assertIn('parameters', data)
         # remove instance
-        self.instance.delete()
+        instance.delete()
+
+    def test_custom_field_serialize_contextserializer(self):
+        # Create a Formidable form using the schema
+        serializer = FormidableSerializer(data=self.schema)
+        assert serializer.is_valid()
+        serializer.save()
+        # get form instance
+        instance = serializer.instance
+
+        # Convert it into a "padawan" form
+        serializer = ContextFormSerializer(
+            instance, context={'role': 'padawan'}
+        )
+
+        # get field instance
+        fields = serializer['fields'].value
+        custom_field = fields[0]
+        # test field instance
+        self.assertIn('meta_info', custom_field['parameters'])
+        self.assertEqual(custom_field["parameters"]['meta_info'], "meta")
+        self.assertIn('some_another_data', custom_field["parameters"])
+        self.assertEqual(
+            custom_field["parameters"]['some_another_data'],
+            "some_another_data"
+        )
+
+        # remove instance
+        instance.delete()
 
     def test_context_in_field_serializer(self):
         # backup a serializer

formidable/serializers/fields.py

@@ -216,14 +216,15 @@ class ContextFieldSerializer(serializers.ModelSerializer):
     defaults = DefaultSerializer(many=True, required=False)
     description = serializers.CharField(required=False, allow_null=True,
                                         allow_blank=True, source='help_text')
+    parameters = serializers.JSONField()
 
     class Meta:
         list_serializer_class = ListContextFieldSerializer
         model = Field
         fields = (
             'slug', 'label', 'type_id', 'placeholder', 'description',
             'validations', 'disabled', 'required', 'multiple', 'items',
-            'defaults',
+            'defaults', 'parameters',
         )
 
     @property