Merge pull request #246 from novafloss/validate-view-from-schema

Add a ValidateView that works with ContextForm JSON

Author: wo0dyn

CHANGELOG.rst

@@ -5,7 +5,7 @@ ChangeLog
 master (unreleased)
 ===================
 
-- Nothing yet.
+- Add a ValidateView that works with ContextForm JSON (#246).
 
 Release 0.13.1 (2017-07-17)
 ===========================

circle.yml

@@ -4,7 +4,7 @@ machine:
 
 dependencies:
     override:
-        - pip install --upgrade tox
+        - pip install --upgrade tox virtualenv
 
 test:
     override:

demo/demo/urls.py

@@ -1,10 +1,13 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 
-from demo.views import FormPreview
+from demo.views import FormPreview, DemoValidateViewFromSchema
 
 urlpatterns = [
     url(r'^api/', include('formidable.urls', namespace='formidable')),
+    url(r'^api/forms/(?P<pk>\d+)/validate_schema/?$',
+        DemoValidateViewFromSchema.as_view(),
+        name='form_validation_schema'),
     url(r'^admin/', include(admin.site.urls)),
     url(r'^preview/(?P<pk>\d+)/', FormPreview.as_view()),
     url(r'^forms/', include('demo.builder.urls', namespace='builder')),

demo/demo/views.py

@@ -3,6 +3,7 @@
 from django.views.generic.edit import FormView
 
 from formidable.models import Formidable
+import formidable.views
 from formidable.views import ContextFormDetail
 
 
@@ -24,3 +25,12 @@ class DemoContextFormDetail(ContextFormDetail):
 
     def get_context(self, request, **kwargs):
         return kwargs['role']
+
+
+class DemoValidateViewFromSchema(formidable.views.ValidateViewFromSchema):
+
+    settings_permission_key = 'FORMIDABLE_PERMISSION_USING'
+
+    def get_formidable_object(self, kwargs):
+        formidable = Formidable.objects.get(pk=kwargs['pk'])
+        return formidable.to_json()

demo/tests/perfs/test_integration.perf.yml

@@ -0,0 +1,19 @@
+TestContextFormEndPoint.test_queryset:
+- db: 'SELECT ... FROM "django_session" WHERE ("django_session"."expire_date" > # AND "django_session"."session_key" = #)'
+- db: 'SELECT ... FROM "formidable_formidable" WHERE "formidable_formidable"."id" = #'
+- db: 'SELECT ... FROM "formidable_field" WHERE "formidable_field"."form_id" = # ORDER BY "formidable_field"."order" ASC'
+- db: 'SELECT ... FROM "formidable_access" WHERE ("formidable_access"."access_id" = # AND NOT ("formidable_access"."level" = #) AND "formidable_access"."field_id" IN (...))'
+- db: SELECT ... FROM "formidable_item" WHERE "formidable_item"."field_id" IN (...) ORDER BY "formidable_item"."order" ASC
+- db: SELECT ... FROM "formidable_validation" WHERE "formidable_validation"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_default" WHERE "formidable_default"."field_id" IN (...)
+- db: 'SELECT ... FROM "formidable_preset" WHERE "formidable_preset"."form_id" = #'
+- db: SELECT ... FROM "formidable_presetarg" WHERE "formidable_presetarg"."preset_id" IN (...)
+UpdateFormTestCase.test_queryset_on_get:
+- db: 'SELECT ... FROM "formidable_formidable" WHERE "formidable_formidable"."id" = #'
+- db: 'SELECT ... FROM "formidable_field" WHERE "formidable_field"."form_id" = # ORDER BY "formidable_field"."order" ASC'
+- db: SELECT ... FROM "formidable_item" WHERE "formidable_item"."field_id" IN (...) ORDER BY "formidable_item"."order" ASC
+- db: SELECT ... FROM "formidable_default" WHERE "formidable_default"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_validation" WHERE "formidable_validation"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_access" WHERE "formidable_access"."field_id" IN (...)
+- db: 'SELECT ... FROM "formidable_preset" WHERE "formidable_preset"."form_id" = #'
+- db: SELECT ... FROM "formidable_presetarg" WHERE "formidable_presetarg"."preset_id" IN (...)

demo/tests/tests_integration.py renamed to demo/tests/test_integration.py

@@ -445,6 +445,8 @@ class Meta:
 
 class TestValidationEndPoint(FormidableAPITestCase):
 
+    url = 'formidable:form_validation'
+
     def setUp(self):
         super(TestValidationEndPoint, self).setUp()
         self.formidable = MyForm.to_formidable(label='title')
@@ -459,7 +461,7 @@ def test_validate_data_ok(self):
         session['role'] = 'padawan'
         session.save()
         res = self.client.get(
-            reverse('formidable:form_validation', args=[self.formidable.pk]),
+            reverse(self.url, args=[self.formidable.pk]),
             parameters, format='json'
         )
         self.assertEqual(res.status_code, 204)
@@ -473,7 +475,7 @@ def test_validate_presets_ok(self):
         session['role'] = 'padawan'
         session.save()
         res = self.client.get(
-            reverse('formidable:form_validation', args=[self.formidable_p.pk]),
+            reverse(self.url, args=[self.formidable_p.pk]),
             parameters, format='json'
         )
         self.assertEqual(res.status_code, 204)
@@ -487,7 +489,7 @@ def test_validate_presets_ko(self):
         session['role'] = 'padawan'
         session.save()
         res = self.client.get(
-            reverse('formidable:form_validation', args=[self.formidable_p.pk]),
+            reverse(self.url, args=[self.formidable_p.pk]),
             parameters, format='json'
         )
         self.assertEqual(res.status_code, 400)
@@ -504,7 +506,7 @@ def test_validate_data_ko(self):
         session['role'] = 'padawan'
         session.save()
         res = self.client.get(
-            reverse('formidable:form_validation', args=[self.formidable.pk]),
+            reverse(self.url, args=[self.formidable.pk]),
             parameters, format='json'
         )
         self.assertEqual(res.status_code, 400)
@@ -523,7 +525,12 @@ class WithFile(FormidableForm):
         session['role'] = 'padawan'
         session.save()
         res = self.client.get(
-            reverse('formidable:form_validation', args=[formidable.pk]),
+            reverse(self.url, args=[formidable.pk]),
             parameters, format='json'
         )
         self.assertEqual(res.status_code, 204)
+
+
+class TestValidationFromSchemaEndPoint(TestValidationEndPoint):
+
+    url = 'form_validation_schema'

demo/tests/test_permissions.py

@@ -42,6 +42,7 @@ def test_settings_key_not_define(self):
         self.assertEqual(len(permission_classes), 1)
         self.assertEqual(permission_classes[0], AllowAny)
 
+    @override_settings()
     def test_no_settings_key_define(self):
         del settings.FORMIDABLE_DEFAULT_PERMISSION
 

formidable/forms/__init__.py

@@ -70,7 +70,12 @@ def get_dynamic_form_class_from_schema(schema, field_factory=None):
     field_factory = field_factory or field_builder_from_schema.FormFieldFactory()  # noqa
     doc = schema['description']
     for field in schema['fields']:
-        attrs[field['slug']] = field_factory.produce(field)
+        try:
+            form_field = field_factory.produce(field)
+        except field_builder.SkipField:
+            pass
+        else:
+            attrs[field['slug']] = form_field
 
     conditions = schema.get('conditions', None) or []
     attrs['_conditions'] = conditions_register.build(

formidable/views.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 from __future__ import unicode_literals
 
 import logging
@@ -9,13 +10,16 @@
 import six
 from formidable.accesses import get_accesses, get_context
 from formidable.exception_handler import ExceptionHandlerMixin
+from formidable.forms import (
+    field_builder_from_schema, get_dynamic_form_class_from_schema
+)
 from formidable.forms.field_builder import (
     FileFieldBuilder, FormFieldFactory, SkipField
 )
 from formidable.forms.validations.presets import presets_register
 from formidable.models import Formidable
 from formidable.serializers import FormidableSerializer, SimpleAccessSerializer
-from formidable.serializers.forms import ContextFormSerializer
+from formidable.serializers.forms import ContextFormSerializer, contextualize
 from formidable.serializers.presets import PresetsClassSerializer
 from rest_framework import exceptions
 from rest_framework.generics import (
@@ -290,3 +294,40 @@ def get_form(self, form_class):
 
     def get_form_kwargs(self):
         return {'data': self.request.GET}
+
+
+class ValidateViewFromSchema(ValidateView):
+    """
+    Acts like `ValidateView` but it uses a Formidable JSON schema
+    instead of a `Formidable` object.
+
+    """
+
+    settings_permission_key = 'FORMIDABLE_PERMISSION_USING'
+
+    def get_formidable_object(self):
+        """
+        This method should implement a way to retrieve the formidable
+        object with its JSON representation.
+
+        """
+        raise NotImplemented
+
+    class ValidationFileFieldBuilder(field_builder_from_schema.FileFieldBuilder):  # noqa
+
+        def build(self, *args, **kwargs):
+            raise SkipField
+
+    def get_form_class(self, formidable):
+        """
+        Retrieve form class from JSON definition, for a given role.
+
+        """
+        role = get_context(self.request, self.kwargs)
+
+        factory = field_builder_from_schema.FormFieldFactory(
+            field_map={'file': self.ValidationFileFieldBuilder}
+        )
+        schema = contextualize(formidable, role)
+        return get_dynamic_form_class_from_schema(schema,
+                                                  field_factory=factory)