Merge pull request zostera#164 from dyve/xrmx-fixformgroupclasses

Pull in changes for success / bound form class handling

Author: Dylan Verheul

bootstrap3/bootstrap.py

@@ -19,7 +19,8 @@
     'set_required': True,
     'set_placeholder': True,
     'required_css_class': '',
-    'error_css_class': '',
+    'error_css_class': 'has-error',
+    'success_css_class': 'has-success',
     'formset_renderers': {
         'default': 'bootstrap3.renderers.FormsetRenderer',
     },

bootstrap3/renderers.py

@@ -201,6 +201,7 @@ def __init__(self, field, *args, **kwargs):
         # These are set in Django or in the global BOOTSTRAP3 settings, and they can be overwritten in the template
         error_css_class = kwargs.get('error_css_class', '')
         required_css_class = kwargs.get('required_css_class', '')
+        bound_css_class = kwargs.get('bound_css_class', '')
         if error_css_class:
             self.error_css_class = error_css_class
         else:
@@ -210,6 +211,11 @@ def __init__(self, field, *args, **kwargs):
         else:
             self.required_css_class = getattr(field.form, 'required_css_class',
                                                get_bootstrap_setting('required_css_class'))
+        if bound_css_class:
+            self.success_css_class = bound_css_class
+        else:
+            self.success_css_class = getattr(field.form, 'bound_css_class', get_bootstrap_setting('success_css_class'))
+
         # Handle form.empty_permitted
         if self.field.form.empty_permitted:
             self.set_required = False
@@ -377,7 +383,7 @@ def get_form_group_class(self):
         if self.field_errors:
             form_group_class = add_css_class(form_group_class, 'has-error')
         elif self.field.form.is_bound:
-            form_group_class = add_css_class(form_group_class, 'has-success')
+            form_group_class = add_css_class(form_group_class, self.success_css_class)
         if self.layout == 'horizontal':
             form_group_class = add_css_class(form_group_class, self.get_size_class(prefix='form-group'))
         return form_group_class

bootstrap3/tests.py

@@ -136,6 +136,21 @@ def test_settings_filter(self):
             '{% load bootstrap3 %}{% if "javascript_in_head"|bootstrap_setting %}head{% else %}body{% endif %}')
         self.assertEqual(res.strip(), 'head')
 
+    def test_required_class(self):
+        form = TestForm()
+        res = render_template('{% bootstrap_form form %}', form=form)
+        self.assertIn('bootstrap3-req', res)
+
+    def test_error_class(self):
+        form = TestForm({})
+        res = render_template('{% bootstrap_form form %}', form=form)
+        self.assertIn('bootstrap3-err', res)
+
+    def test_bound_class(self):
+        form = TestForm({'sender': 'sender'})
+        res = render_template('{% bootstrap_form form %}', form=form)
+        self.assertIn('bootstrap3-bound', res)
+
 
 class TemplateTest(TestCase):
     def test_empty_template(self):

docs/settings.rst

@@ -51,7 +51,10 @@ The ``BOOTSTRAP3`` dict variable is contains these settings and defaults:
         'required_css_class': '',
 
         # Class to indicate error (better to set this in your Django form)
-        'error_css_class': '',
+        'error_css_class': 'has-error',
+
+        # Class to indicate success, meaning the field has valid input (better to set this in your Django form)
+        'success_css_class': 'has-success',
 
         # Renderers (only set these if you have studied the source and understand the inner workings)
         'formset_renderers':{

testsettings.py

@@ -12,6 +12,8 @@
 BOOTSTRAP3 = {
     'javascript_in_head': True,
     'required_css_class': 'bootstrap3-req',
+    'error_css_class': 'bootstrap3-err',
+    'success_css_class': 'bootstrap3-bound',
 }
 
 SECRET_KEY = 'bootstrap3isawesome'