1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
from django.conf import settings
from django.core.exceptions import ValidationError
from django.forms.formsets import formset_factory
from django.template import Context, Template
from django.test import TestCase
from django.utils.translation import ugettext_lazy as _
import floppyforms as forms
from .base import InvalidVariable
def render(template, context=None):
if context is None:
context = {}
c = Context(context)
t = Template('{% load floppyforms %}' + template)
return t.render(c)
class HiddenForm(forms.Form):
hide = forms.CharField(widget=forms.HiddenInput())
class OneFieldForm(forms.Form):
text = forms.CharField()
def clean(self):
if self.errors:
raise ValidationError(u'Please correct the errors below.')
class ShortForm(forms.Form):
name = forms.CharField(label=_(u'Your first name?'))
age = forms.IntegerField(required=False)
metadata = forms.CharField(required=False, widget=forms.HiddenInput)
class RegistrationForm(forms.Form):
honeypot = forms.CharField(required=False, widget=forms.HiddenInput)
firstname = forms.CharField(label=_(u'Your first name?'))
lastname = forms.CharField(label=_(u'Your last name:'))
username = forms.CharField(max_length=30)
password = forms.CharField(
widget=forms.PasswordInput,
help_text=_(u'Make sure to use a secure password.'),
)
password2 = forms.CharField(label=_(u'Retype password'), widget=forms.PasswordInput)
age = forms.IntegerField(required=False)
def clean_honeypot(self):
if self.cleaned_data.get('honeypot'):
raise ValidationError(u'Haha, you trapped into the honeypot.')
return self.cleaned_data['honeypot']
def clean(self):
if self.errors:
raise ValidationError(u'Please correct the errors below.')
class PLayoutTests(TestCase):
def test_default_layout_is_same_as_p_layout(self):
form = RegistrationForm()
default = render('{% form form %}', {'form': form})
layout = render('{% form form using "floppyforms/layouts/table.html" %}', {'form': form})
self.assertEqual(default, layout)
def test_layout(self):
form = RegistrationForm()
with self.assertTemplateUsed('floppyforms/layouts/p.html'):
with self.assertTemplateUsed('floppyforms/rows/p.html'):
layout = render('{% form form using "floppyforms/layouts/p.html" %}', {'form': form})
self.maxDiff = None
self.assertHTMLEqual(layout, """
<p><label for="id_firstname">Your first name?</label> <input type="text" name="firstname" id="id_firstname" required />
</p>
<p><label for="id_lastname">Your last name:</label> <input type="text" name="lastname" id="id_lastname" required />
</p>
<p><label for="id_username">Username:</label> <input type="text" name="username" id="id_username" maxlength="30" required />
</p>
<p><label for="id_password">Password:</label> <input type="password" name="password" id="id_password" required />
<span class="helptext">Make sure to use a secure password.</span></p>
<p><label for="id_password2">Retype password:</label> <input type="password" name="password2" id="id_password2" required />
</p>
<p><label for="id_age">Age:</label> <input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" />
</p>
""")
def test_layout_with_errors(self):
form = RegistrationForm({'non_field_errors': True})
layout = render('{% form form using "floppyforms/layouts/p.html" %}', {'form': form})
self.maxDiff = None
self.assertHTMLEqual(layout, """
<ul class="errorlist"><li>Please correct the errors below.</li></ul>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_firstname">Your first name?</label> <input type="text" name="firstname" id="id_firstname" required /></p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_lastname">Your last name:</label> <input type="text" name="lastname" id="id_lastname" required /></p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_username">Username:</label> <input type="text" name="username" id="id_username" maxlength="30" required /></p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p>
<label for="id_password">Password:</label> <input type="password" name="password" id="id_password" required />
<span class="helptext">Make sure to use a secure password.</span>
</p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_password2">Retype password:</label> <input type="password" name="password2" id="id_password2" required /></p>
<p><label for="id_age">Age:</label> <input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" /></p>
""")
form = RegistrationForm({'non_field_errors': True, 'honeypot': 1})
layout = render('{% form form using "floppyforms/layouts/p.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<ul class="errorlist">
<li>Please correct the errors below.</li>
<li>Haha, you trapped into the honeypot.</li>
</ul>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_firstname">Your first name?</label> <input type="text" name="firstname" id="id_firstname" required /></p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_lastname">Your last name:</label> <input type="text" name="lastname" id="id_lastname" required /></p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_username">Username:</label> <input type="text" name="username" id="id_username" maxlength="30" required /></p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p>
<label for="id_password">Password:</label> <input type="password" name="password" id="id_password" required />
<span class="helptext">Make sure to use a secure password.</span>
</p>
<ul class="errorlist"><li>This field is required.</li></ul>
<p><label for="id_password2">Retype password:</label> <input type="password" name="password2" id="id_password2" required /></p>
<p><label for="id_age">Age:</label> <input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" value="1" /></p>
""")
def test_layout_with_custom_label(self):
form = OneFieldForm()
layout = render("""
{% form form using %}
{% formrow form.text using "floppyforms/rows/p.html" with label="Custom label" %}
{% endform %}
""", {'form': form})
self.assertHTMLEqual(layout, """
<p><label for="id_text">Custom label:</label> <input type="text" name="text" id="id_text" required /></p>
""")
def test_layout_with_custom_help_text(self):
form = OneFieldForm()
layout = render("""
{% form form using %}
{% formrow form.text using "floppyforms/rows/p.html" with help_text="Would you mind entering text here?" %}
{% endform %}
""", {'form': form})
self.assertHTMLEqual(layout, """
<p>
<label for="id_text">Text:</label> <input type="text" name="text" id="id_text" required />
<span class="helptext">Would you mind entering text here?</span>
</p>
""")
def test_hidden_only_fields(self):
form = HiddenForm()
rendered = render("""{% form form using "floppyforms/layouts/p.html" %}""", {'form': form})
self.assertHTMLEqual(rendered, """
<input type="hidden" name="hide" id="id_hide" required>
""")
def test_formsets_with_hidden_fields(self):
ShortFormset = formset_factory(form=ShortForm, extra=1)
formset = ShortFormset(initial=[{'name': 'Johnson', 'age': 23, 'metadata': 'Hidden details'}])
rendered = render("""{% form formset using "floppyforms/layouts/p.html" %}""", {'formset': formset})
self.assertHTMLEqual(rendered, """
<p>
<label for="id_form-0-name">Your first name?</label>
<input type="text" name="form-0-name" value="Johnson" required id="id_form-0-name">
</p>
<p>
<label for="id_form-0-age">Age:</label>
<input type="number" name="form-0-age" value="23" id="id_form-0-age">
<input type="hidden" name="form-0-metadata" value="Hidden details" id="id_form-0-metadata">
</p>
<p>
<label for="id_form-1-name">Your first name?</label>
<input type="text" name="form-1-name" required id="id_form-1-name">
</p>
<p>
<label for="id_form-1-age">Age:</label>
<input type="number" name="form-1-age" id="id_form-1-age">
<input type="hidden" name="form-1-metadata" id="id_form-1-metadata">
</p>
""")
class TableLayoutTests(TestCase):
def test_layout(self):
form = RegistrationForm()
with self.assertTemplateUsed('floppyforms/layouts/table.html'):
with self.assertTemplateUsed('floppyforms/rows/tr.html'):
layout = render('{% form form using "floppyforms/layouts/table.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<tr><th><label for="id_firstname">Your first name?</label></th><td><input type="text" name="firstname" id="id_firstname" required /></td></tr>
<tr><th><label for="id_lastname">Your last name:</label></th><td><input type="text" name="lastname" id="id_lastname" required /></td></tr>
<tr><th><label for="id_username">Username:</label></th><td><input type="text" name="username" id="id_username" maxlength="30" required /></td></tr>
<tr><th>
<label for="id_password">Password:</label></th><td><input type="password" name="password" id="id_password" required />
<br /><span class="helptext">Make sure to use a secure password.</span></td></tr>
<tr><th><label for="id_password2">Retype password:</label></th><td><input type="password" name="password2" id="id_password2" required /></td></tr>
<tr><th>
<label for="id_age">Age:</label></th><td><input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" />
</td></tr>
""")
def test_layout_with_errors(self):
form = RegistrationForm({'non_field_errors': True})
layout = render('{% form form using "floppyforms/layouts/table.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<tr><td colspan="2"><ul class="errorlist"><li>Please correct the errors below.</li></ul></td></tr>
<tr><th><label for="id_firstname">Your first name?</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="firstname" id="id_firstname" required /></td></tr>
<tr><th><label for="id_lastname">Your last name:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="lastname" id="id_lastname" required /></td></tr>
<tr><th><label for="id_username">Username:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="username" id="id_username" maxlength="30" required /></td></tr>
<tr>
<th><label for="id_password">Password:</label></th>
<td>
<ul class="errorlist"><li>This field is required.</li></ul>
<input type="password" name="password" id="id_password" required />
<br /><span class="helptext">Make sure to use a secure password.</span>
</td>
</tr>
<tr>
<th><label for="id_password2">Retype password:</label></th>
<td><ul class="errorlist"><li>This field is required.</li></ul><input type="password" name="password2" id="id_password2" required /></td>
</tr>
<tr><th><label for="id_age">Age:</label></th><td><input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" /></td></tr>
""")
form = RegistrationForm({'non_field_errors': True, 'honeypot': 1})
layout = render('{% form form using "floppyforms/layouts/table.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<tr><td colspan="2"><ul class="errorlist"><li>Please correct the errors below.</li><li>Haha, you trapped into the honeypot.</li></ul></td></tr>
<tr><th><label for="id_firstname">Your first name?</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="firstname" id="id_firstname" required /></td></tr>
<tr><th><label for="id_lastname">Your last name:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="lastname" id="id_lastname" required /></td></tr>
<tr><th><label for="id_username">Username:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="username" id="id_username" maxlength="30" required /></td></tr>
<tr><th><label for="id_password">Password:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="password" name="password" id="id_password" required /><br /><span class="helptext">Make sure to use a secure password.</span></td></tr>
<tr><th><label for="id_password2">Retype password:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="password" name="password2" id="id_password2" required /></td></tr>
<tr><th><label for="id_age">Age:</label></th><td><input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" value="1" id="id_honeypot" /></td></tr>
""")
def test_layout_with_custom_label(self):
form = OneFieldForm()
layout = render("""
{% form form using %}
{% formrow form.text using "floppyforms/rows/tr.html" with label="Custom label" %}
{% endform %}
""", {'form': form})
self.assertHTMLEqual(layout, """
<tr><th><label for="id_text">Custom label:</label></th><td><input type="text" name="text" id="id_text" required /></td></tr>
""")
def test_layout_with_custom_help_text(self):
form = OneFieldForm()
layout = render("""
{% form form using %}
{% formrow form.text using "floppyforms/rows/tr.html" with help_text="Would you mind entering text here?" %}
{% endform %}
""", {'form': form})
self.assertHTMLEqual(layout, """
<tr><th>
<label for="id_text">Text:</label>
</th><td>
<input type="text" name="text" id="id_text" required />
<br /><span class="helptext">Would you mind entering text here?</span>
</td></tr>
""")
def test_hidden_only_fields(self):
form = HiddenForm()
rendered = render("""{% form form using "floppyforms/layouts/table.html" %}""", {'form': form})
self.assertHTMLEqual(rendered, """
<input type="hidden" name="hide" id="id_hide" required>
""")
def test_formsets_with_hidden_fields(self):
ShortFormset = formset_factory(form=ShortForm, extra=1)
formset = ShortFormset(initial=[{'name': 'Johnson', 'age': 23, 'metadata': 'Hidden details'}])
rendered = render("""{% form formset using "floppyforms/layouts/table.html" %}""", {'formset': formset})
self.assertHTMLEqual(rendered, """
<tr>
<th><label for="id_form-0-name">Your first name?</label></th>
<td>
<input type="text" name="form-0-name" value="Johnson" required id="id_form-0-name">
</td>
</tr>
<tr>
<th><label for="id_form-0-age">Age:</label></th>
<td>
<input type="number" name="form-0-age" value="23" id="id_form-0-age">
<input type="hidden" name="form-0-metadata" value="Hidden details" id="id_form-0-metadata">
</td>
</tr>
<tr>
<th><label for="id_form-1-name">Your first name?</label></th>
<td>
<input type="text" name="form-1-name" required id="id_form-1-name">
</td>
</tr>
<tr>
<th><label for="id_form-1-age">Age:</label></th>
<td>
<input type="number" name="form-1-age" id="id_form-1-age">
<input type="hidden" name="form-1-metadata" id="id_form-1-metadata">
</td>
</tr>
""")
class UlLayoutTests(TestCase):
def test_layout(self):
form = RegistrationForm()
with self.assertTemplateUsed('floppyforms/layouts/ul.html'):
with self.assertTemplateUsed('floppyforms/rows/li.html'):
layout = render('{% form form using "floppyforms/layouts/ul.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<li><label for="id_firstname">Your first name?</label> <input type="text" name="firstname" id="id_firstname" required /></li>
<li><label for="id_lastname">Your last name:</label> <input type="text" name="lastname" id="id_lastname" required /></li>
<li><label for="id_username">Username:</label> <input type="text" name="username" id="id_username" maxlength="30" required /></li>
<li><label for="id_password">Password:</label> <input type="password" name="password" id="id_password" required />
<span class="helptext">Make sure to use a secure password.</span></li>
<li><label for="id_password2">Retype password:</label> <input type="password" name="password2" id="id_password2" required /></li>
<li><label for="id_age">Age:</label> <input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" /></li>
""")
def test_layout_with_errors(self):
form = RegistrationForm({'non_field_errors': True})
layout = render('{% form form using "floppyforms/layouts/ul.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<li><ul class="errorlist"><li>Please correct the errors below.</li></ul></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_firstname">Your first name?</label> <input type="text" name="firstname" id="id_firstname" required /></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_lastname">Your last name:</label> <input type="text" name="lastname" id="id_lastname" required /></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_username">Username:</label> <input type="text" name="username" id="id_username" maxlength="30" required /></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_password">Password:</label> <input type="password" name="password" id="id_password" required />
<span class="helptext">Make sure to use a secure password.</span></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_password2">Retype password:</label> <input type="password" name="password2" id="id_password2" required /></li>
<li><label for="id_age">Age:</label> <input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" id="id_honeypot" /></li>
""")
form = RegistrationForm({'non_field_errors': True, 'honeypot': 1})
layout = render('{% form form using "floppyforms/layouts/ul.html" %}', {'form': form})
self.assertHTMLEqual(layout, """
<li><ul class="errorlist"><li>Please correct the errors below.</li><li>Haha, you trapped into the honeypot.</li></ul></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_firstname">Your first name?</label> <input type="text" name="firstname" id="id_firstname" required /></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_lastname">Your last name:</label> <input type="text" name="lastname" id="id_lastname" required /></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_username">Username:</label> <input type="text" name="username" id="id_username" maxlength="30" required /></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_password">Password:</label> <input type="password" name="password" id="id_password" required />
<span class="helptext">Make sure to use a secure password.</span></li>
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_password2">Retype password:</label> <input type="password" name="password2" id="id_password2" required /></li>
<li><label for="id_age">Age:</label> <input type="number" name="age" id="id_age" />
<input type="hidden" name="honeypot" value="1" id="id_honeypot" /></li>
""")
def test_layout_with_custom_label(self):
form = OneFieldForm()
layout = render("""
{% form form using %}
{% formrow form.text using "floppyforms/rows/li.html" with label="Custom label" %}
{% endform %}
""", {'form': form})
self.assertHTMLEqual(layout, """
<li><label for="id_text">Custom label:</label><input type="text" name="text" id="id_text" required /></li>
""")
def test_layout_with_custom_help_text(self):
form = OneFieldForm()
layout = render("""
{% form form using %}
{% formrow form.text using "floppyforms/rows/li.html" with help_text="Would you mind entering text here?" %}
{% endform %}
""", {'form': form})
self.assertHTMLEqual(layout, """
<li>
<label for="id_text">Text:</label>
<input type="text" name="text" id="id_text" required />
<span class="helptext">Would you mind entering text here?</span>
</li>
""")
def test_hidden_only_fields(self):
form = HiddenForm()
rendered = render("""{% form form using "floppyforms/layouts/ul.html" %}""", {'form': form})
self.assertHTMLEqual(rendered, """
<input type="hidden" name="hide" id="id_hide" required>
""")
def test_formsets_with_hidden_fields(self):
ShortFormset = formset_factory(form=ShortForm, extra=1)
formset = ShortFormset(initial=[{'name': 'Johnson', 'age': 23, 'metadata': 'Hidden details'}])
rendered = render("""{% form formset using "floppyforms/layouts/ul.html" %}""", {'formset': formset})
self.assertHTMLEqual(rendered, """
<li>
<label for="id_form-0-name">Your first name?</label>
<input type="text" name="form-0-name" value="Johnson" required id="id_form-0-name">
</li>
<li>
<label for="id_form-0-age">Age:</label>
<input type="number" name="form-0-age" value="23" id="id_form-0-age">
<input type="hidden" name="form-0-metadata" value="Hidden details" id="id_form-0-metadata">
</li>
<li>
<label for="id_form-1-name">Your first name?</label>
<input type="text" name="form-1-name" required id="id_form-1-name">
</li>
<li>
<label for="id_form-1-age">Age:</label>
<input type="number" name="form-1-age" id="id_form-1-age">
<input type="hidden" name="form-1-metadata" id="id_form-1-metadata">
</li>
""")
class TemplateStringIfInvalidTests(TestCase):
'''
Regression tests for issue #37.
'''
def setUp(self):
self.original_TEMPLATE_STRING_IF_INVALID = settings.TEMPLATE_STRING_IF_INVALID
def tearDown(self):
settings.TEMPLATE_STRING_IF_INVALID = self.original_TEMPLATE_STRING_IF_INVALID
def test_none(self):
settings.TEMPLATE_STRING_IF_INVALID = None
layout = OneFieldForm().as_p()
self.assertHTMLEqual(layout, """
<p><label for="id_text">Text:</label> <input type="text" name="text" id="id_text" required /></p>
""")
def test_non_empty(self):
settings.TEMPLATE_STRING_IF_INVALID = InvalidVariable(u'INVALID')
layout = OneFieldForm().as_p()
self.assertHTMLEqual(layout, """
<p><label for="id_text">Text:</label> <input type="text" name="text" id="id_text" required /></p>
""")
|
