Html5 widget support; Hopefully got rid of the need for _dont_save stuff on forms

Jan Schrewe · Jan Schrewe · commit d9bf32cdc135 · 2013-10-21T16:50:25.000+02:00
diff --git a/README.txt b/README.txt
@@ -7,8 +7,8 @@ documents.
 Requirements
 ------------
 
--  Django >= 1.3
--  `mongoengine <http://mongoengine.org/>`__ >= 0.6
+-  Django >= 1.4
+-  `mongoengine <http://mongoengine.org/>`__ >= 0.8.3
 
 Supported field types
 ---------------------
diff --git a/mongodbforms/documentoptions.py b/mongodbforms/documentoptions.py
@@ -224,7 +224,7 @@ def swapped(self):
         
         NOTE: Not sure this is actually usefull for documents. So at the moment
         it's really only here because the admin wants it. It might prove usefull
-        for someone though, so it'S more then just a dummy.
+        for someone though, so it's more then just a dummy.
         """
         if self._meta.get('swappable', False):
             model_label = '%s.%s' % (self.app_label, self.object_name.lower())
diff --git a/mongodbforms/documents.py b/mongodbforms/documents.py
@@ -1,9 +1,8 @@
 import os
 import itertools
-from collections import Callable
+from collections import Callable, OrderedDict
 from functools import reduce
 
-from django.utils.datastructures import SortedDict
 from django.forms.forms import BaseForm, get_declared_fields, NON_FIELD_ERRORS, pretty_name
 from django.forms.widgets import media_property
 from django.core.exceptions import FieldError
@@ -166,8 +165,7 @@ def save_instance(form, instance, fields=None, fail_message='saved',
             instance.save()
             instance._data = data
         else:
-            instance.save()
-        
+            instance.save()   
     return instance
 
 def document_to_dict(instance, fields=None, exclude=None):
@@ -230,8 +228,15 @@ def fields_for_document(document, fields=None, exclude=None, widgets=None, \
 
         if formfield:
             field_list.append((f.name, formfield))
+    
+    field_dict = OrderedDict(field_list)
+    if fields:
+        field_dict = OrderedDict(
+            [(f, field_dict.get(f)) for f in fields
+                if ((not exclude) or (exclude and f not in exclude))]
+        )
 
-    return SortedDict(field_list)
+    return field_dict
 
 
 
@@ -399,16 +404,24 @@ def _post_clean(self):
                     # mongoengine chokes on empty strings for fields
                     # that are not required. Clean them up here, though
                     # this is maybe not the right place :-)
-                    opts._dont_save.append(f.name)
+                    print "Setting %s to None" % f.name
+                    setattr(self.instance, f.name, None)
+                    #opts._dont_save.append(f.name)
         except ValidationError as e:
             err = {f.name: [e.message]}
             self._update_errors(err)
 
         
-        # Call the model instance's clean method.
+        # Call validate() on the document. Since mongoengine
+        # does not provide an argument to specify which fields
+        # should be excluded during validation, we replace
+        # instance._fields_ordered with a version that does
+        # not include excluded fields. The attribute gets
+        # restored after validation.
         original_fields = self.instance._fields_ordered
-        to_check = tuple([f for f in original_fields if f not in exclude])
-        self.instance._fields_ordered = to_check
+        self.instance._fields_ordered = tuple(
+                [f for f in original_fields if f not in exclude]
+        )
         try:
             self.instance.validate()
         except ValidationError as e:
diff --git a/mongodbforms/fieldgenerator.py b/mongodbforms/fieldgenerator.py
@@ -21,7 +21,7 @@
                 ListField as MongoListField, MapField as MongoMapField
 
 from .fields import MongoCharField, ReferenceField, DocumentMultipleChoiceField, ListField, MapField
-from .widgets import DynamicListWidget
+from .widgets import Html5SplitDateTimeWidget
 from .documentoptions import create_verbose_name
 
 BLANK_CHOICE_DASH = [("", "---------")]
@@ -142,7 +142,7 @@ def get_field_default(self, field):
             d['initial'] = field.default
         return f.default
         
-    def _check_widget(self, map_key):
+    def check_widget(self, map_key):
         if map_key in self.widget_override_map:
             return {'widget': self.widget_override_map.get(map_key)}
         else:
@@ -176,7 +176,7 @@ def generate_stringfield(self, field, **kwargs):
                 defaults['regex'] = field.regex
             
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -190,7 +190,7 @@ def generate_emailfield(self, field, **kwargs):
             'label': self.get_field_label(field),
             'help_text': self.get_field_help_text(field)
         }
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         form_class = self.form_field_map.get(map_key)
         defaults.update(kwargs)
         return form_class(**defaults)
@@ -206,7 +206,7 @@ def generate_urlfield(self, field, **kwargs):
             'help_text':  self.get_field_help_text(field)
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -231,7 +231,7 @@ def generate_intfield(self, field, **kwargs):
                 'max_value': field.max_value,
             })
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -246,7 +246,7 @@ def generate_floatfield(self, field, **kwargs):
             'help_text': self.get_field_help_text(field)
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -262,7 +262,7 @@ def generate_decimalfield(self, field, **kwargs):
             'help_text': self.get_field_help_text(field)
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -283,7 +283,7 @@ def generate_booleanfield(self, field, **kwargs):
         else:
             map_key = 'booleanfield'
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -295,7 +295,7 @@ def generate_datetimefield(self, field, **kwargs):
             'label': self.get_field_label(field),
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -308,7 +308,7 @@ def generate_referencefield(self, field, **kwargs):
             'queryset': field.document_type.objects.clone(),
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -340,7 +340,7 @@ def generate_listfield(self, field, **kwargs):
                 'contained_field': form_field.__class__,
             })
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
         
@@ -358,7 +358,7 @@ def generate_mapfield(self, field, **kwargs):
             'contained_field': form_field.__class__,
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -371,7 +371,7 @@ def generate_filefield(self, field, **kwargs):
             'help_text': self.get_field_help_text(field)
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -384,7 +384,7 @@ def generate_imagefield(self, field, **kwargs):
             'help_text': self.get_field_help_text(field)
         }
         form_class = self.form_field_map.get(map_key)
-        defaults.update(self._check_widget(map_key))
+        defaults.update(self.check_widget(map_key))
         defaults.update(kwargs)
         return form_class(**defaults)
 
@@ -416,10 +416,38 @@ def generate(self, field, **kwargs):
 
             defaults.update(kwargs)
             return forms.CharField(**defaults)
-            
-class DynamicFormFieldGenerator(MongoDefaultFormFieldGenerator):
-    widget_override_map = {
-        'stringfield_long': forms.Textarea,
-        'listfield': DynamicListWidget,
-    }
-    
+
+class Html5FormFieldGenerator(MongoDefaultFormFieldGenerator):
+    def check_widget(self, map_key):
+        override = super(Html5FormFieldGenerator, self).check_widget(map_key)
+        if override != {}:
+            return override
+        
+        chunks = map_key.split('field')
+        kind = chunks[0]
+        
+        if kind == 'email':
+            if hasattr(forms, 'EmailInput'):
+                return {'widget': forms.EmailInput}
+            else:
+                input = forms.TextInput
+                input.input_type = 'email'
+                return {'widget': input}
+        elif kind in ['int', 'float'] and len(chunks) < 2:
+            if hasattr(forms, 'NumberInput'):
+                return {'widget': forms.NumberInput}
+            else:
+                input = forms.TextInput
+                input.input_type = 'number'
+                return {'widget': input}
+        elif kind == 'url':
+            if hasattr(forms, 'URLInput'):
+                return {'widget': forms.URLInput}
+            else:
+                input = forms.TextInput
+                input.input_type = 'url'
+                return {'widget': input}
+        elif kind == 'datetime':
+            return {'widget': Html5SplitDateTimeWidget}
+        else:
+            return {}
diff --git a/mongodbforms/widgets.py b/mongodbforms/widgets.py
@@ -1,10 +1,19 @@
 import copy
 
-from django.forms.widgets import Widget, Media, TextInput
+from django.forms.widgets import Widget, Media, TextInput, SplitDateTimeWidget, DateInput, TimeInput, MultiWidget
 from django.utils.safestring import mark_safe
 from django.core.validators import EMPTY_VALUES
 from django.forms.util import flatatt
 
+class Html5SplitDateTimeWidget(SplitDateTimeWidget):
+    def __init__(self, attrs=None, date_format=None, time_format=None):
+        date_input = DateInput(attrs=attrs, format=date_format)
+        date_input.input_type = 'date'
+        time_input = TimeInput(attrs=attrs, format=time_format)
+        time_input.input_type = 'time'
+        widgets = (date_input, time_input)
+        MultiWidget.__init__(self, widgets, attrs)
+
 class ListWidget(Widget):
     def __init__(self, contained_widget, attrs=None):
         self.contained_widget = contained_widget
@@ -73,41 +82,6 @@ def __deepcopy__(self, memo):
         obj.contained_widget = copy.deepcopy(self.contained_widget)
         #obj.widget_type = copy.deepcopy(self.widget_type)
         return obj
-    
-class DynamicListWidget(ListWidget):
-    def __init__(self, widget_type, attrs=None):
-        class_attr = {'class': 'dynamiclistwidget'}
-        if attrs is None:
-            attrs = class_attr
-        elif 'class' in attrs:
-            attrs['class'] = '%s %s' % (attrs['class'], class_attr['class'])
-        else:
-            attrs.update(class_attr)
-        super(DynamicListWidget, self).__init__(widget_type, attrs)
-    
-    def format_output(self, rendered_widgets):
-        """
-        Given a list of rendered widgets (as strings), returns a Unicode string
-        representing the HTML for the whole lot.
-
-        This hook allows you to format the HTML design of the widgets, if
-        needed.
-        """
-        #print(rendered_widgets)
-        output = []
-        for widget in rendered_widgets:
-            output.append("<p>%s</p>" % widget)
-        #output.append('<script type="text/javascript">mdbf.onDomReady(mdbf.init("field-%s"))</script>' % self._name)
-        return ''.join(output)
-    
-    def _get_media(self):
-        "Media for a multiwidget is the combination of all media of the subwidgets"
-        media = Media(js=('mongodbforms/dynamiclistwidget.js',))
-        for w in self.widgets:
-            media = media + w.media
-        return media
-    media = property(_get_media)
-
 
 class MapWidget(Widget):
     """
diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@ def convert_readme():
     return open('README.txt').read()
 
 setup(name='mongodbforms',
-    version='0.2.2',
+    version='0.3',
     description="An implementation of django forms using mongoengine.",
     author='Jan Schrewe',
     author_email='jan@schafproductions.com',
