Ticket #3368: newforms-new-fields.diff

django/newforms/fields.py

@@ -15 +15 @@
     'DEFAULT_TIME_INPUT_FORMATS', 'TimeField',
     'DEFAULT_DATETIME_INPUT_FORMATS', 'DateTimeField',
     'RegexField', 'EmailField', 'URLField', 'BooleanField',
+    'USStateField', 'PhoneNumberField',
     'ChoiceField', 'NullBooleanField', 'MultipleChoiceField',
     'ComboField', 'MultiValueField',
     'SplitDateTimeField',
@@ -266 +267 @@
     def __init__(self, max_length=None, min_length=None, required=True, widget=None, label=None, initial=None):
         RegexField.__init__(self, email_re, max_length, min_length, gettext(u'Enter a valid e-mail address.'), required, widget, label, initial)
 
+phone_re = re.compile(r'^[A-PR-Y0-9]{3}-[A-PR-Y0-9]{3}-[A-PR-Y0-9]{4}$', re.IGNORECASE)
+
+class PhoneNumberField(RegexField):
+    def __init__(self, max_length=None, min_length=None, required=True, widget=None, label=None, initial=None):
+        super(PhoneNumberField, self).__init__(phone_re, max_length, min_length, u'Phone numbers must be in XXX-XXX-XXXX format.', required, widget, label, initial)
+
+class USStateField(CharField):
+    def __init__(self, max_length=None, min_length=None, required=True, widget=None, label=None, initial=None):
+        super(USStateField, self).__init__(max_length, min_length, required, widget, label, initial)
+
+    def clean(self, value):
+        value = super(USStateField, self).clean(value)
+        if value == u'':
+            return value
+        # always store as upper case
+        value = value.upper()
+        states = ['AA', 'AE', 'AK', 'AL', 'AP', 'AR', 'AS', 'AZ', 'CA', 'CO', 'CT', 'DC', 'DE', 'FL', 'FM', 'GA', 'GU', 'HI', 'IA', 'ID', 'IL', 'IN', 'KS', 'KY', 'LA', 'MA', 'MD', 'ME', 'MH', 'MI', 'MN', 'MO', 'MP', 'MS', 'MT', 'NC', 'ND', 'NE', 'NH', 'NJ', 'NM', 'NV', 'NY', 'OH', 'OK', 'OR', 'PA', 'PR', 'PW', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VA', 'VI', 'VT', 'WA', 'WI', 'WV', 'WY']
+        if value not in states:
+            raise ValidationError(u'Enter a valid U.S. state abbreviation.')
+        return value
+
 url_re = re.compile(
     r'^https?://' # http:// or https://
     r'(?:[A-Z0-9-]+\.)+[A-Z]{2,6}' # domain

tests/regressiontests/forms/tests.py

@@ -1307 +1307 @@
 ...
 ValidationError: [u'Ensure this value has at most 15 characters.']
 
+# PhoneNumberField ###########################################################
+
+>>> f = PhoneNumberField()
+>>> f.clean('')
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean(None)
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean('555-555-5555')
+u'555-555-5555'
+>>> f.clean('foo')
+Traceback (most recent call last):
+...
+ValidationError: [u'Phone numbers must be in XXX-XXX-XXXX format.']
+
+>>> f = PhoneNumberField(required=False)
+>>> f.clean('')
+u''
+>>> f.clean(None)
+u''
+
+# USStatefield ###############################################################
+
+>>> f = USStateField()
+>>> f.clean('')
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean(None)
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean('KS')
+u'KS'
+
+USStateField always converts to upper case
+>>> f.clean('ks')
+u'KS'
+>>> f.clean('YY')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid U.S. state abbreviation.']
+
+>>> f = USStateField(required=False)
+>>> f.clean('')
+u''
+>>> f.clean(None)
+u''
+
 # URLField ##################################################################
 
 >>> f = URLField()