Ticket #17591: us_ssnfield_fix.patch

django/contrib/localflavor/us/forms.py

@@ -15 +15 @@
 
 phone_digits_re = re.compile(r'^(?:1-?)?(\d{3})[-\.]?(\d{3})[-\.]?(\d{4})$')
 ssn_re = re.compile(r"^(?P<area>\d{3})[-\ ]?(?P<group>\d{2})[-\ ]?(?P<serial>\d{4})$")
+zeros_re = re.compile('^0+$')
 
 class USZipCodeField(RegexField):
     default_error_messages = {
@@ -55 +56 @@
           promotional use or distribution (e.g., the Woolworth's number or the
           1962 promotional number).
     """
+
     default_error_messages = {
         'invalid': _('Enter a valid U.S. Social Security number in XXX-XX-XXXX format.'),
     }
 
+    def __init__(self, *args, **kwargs):
+        self.no_hyphens = kwargs.pop("no_hyphens", False)
+        super(USSocialSecurityNumberField, self).__init__(*args, **kwargs)
+
     def clean(self, value):
-        super(USSocialSecurityNumberField, self).clean(value)
+        value = super(USSocialSecurityNumberField, self).clean(value)
         if value in EMPTY_VALUES:
-            return u''
-        match = re.match(ssn_re, value)
-        if not match:
-            raise ValidationError(self.error_messages['invalid'])
-        area, group, serial = match.groupdict()['area'], match.groupdict()['group'], match.groupdict()['serial']
+            return ''
 
-        # First pass: no blocks of all zeroes.
-        if area == '000' or \
-           group == '00' or \
-           serial == '0000':
-            raise ValidationError(self.error_messages['invalid'])
+        ssn_parts = self._get_ssn_parts(value)
+        if self._is_invalid_ssn(ssn_parts):
+            self._raise_invalid()
+        return self._get_formatted_ssn(ssn_parts)
 
-        # Second pass: promotional and otherwise permanently invalid numbers.
-        if area == '666' or \
-           (area == '987' and group == '65' and 4320 <= int(serial) <= 4329) or \
-           value == '078-05-1120' or \
-           value == '219-09-9999':
-            raise ValidationError(self.error_messages['invalid'])
-        return u'%s-%s-%s' % (area, group, serial)
+    def _is_invalid_ssn(self, ssn_parts):
+        return any([
+            self._has_zero_blocks(**ssn_parts),
+            self._is_invalid_area(ssn_parts['area']),
+            self._is_in_promotional_range(**ssn_parts),
+            self._is_known_invalid(**ssn_parts),
+        ])
+
+    def _get_formatted_ssn(self, ssn_parts):
+        ssn = "{area}-{group}-{serial}".format(**ssn_parts)
+        if self.no_hyphens:
+            ssn = ssn.replace('-', '')
+        return ssn
+
+    def _get_ssn_parts(self, value):
+        m = ssn_re.match(value)
+        if not m:
+            self._raise_invalid()
+        return m.groupdict()
+
+    def _raise_invalid(self):
+        raise ValidationError(self.error_messages['invalid'])
+
+    def _has_zero_blocks(self, area, group, serial):
+        return any([self._is_all_zeros(p) for p in (area, group, serial)])
+
+    def _is_all_zeros(self, part):
+        return zeros_re.match(part)
+
+    def _is_invalid_area(self, area):
+        return bool(area == '666')
+
+    def _is_in_promotional_range(self, area, group, serial):
+        return bool(area == '987' and group == '65' and 4320 <= int(serial) <= 4329)
+
+    def _is_known_invalid(self, area, group, serial):
+        return any([
+            bool(area == '078' and group == '05' and serial == '1120'),
+            bool(area == '219' and group == '09' and serial == '9999'),
+        ])
 
 class USStateField(Field):
     """

tests/regressiontests/localflavor/us/tests.py

@@ -4 +4 @@
     USPhoneNumberField, USStateField, USStateSelect,
     USSocialSecurityNumberField)
 from django.test import SimpleTestCase
+from django.forms import ValidationError
 
 from .forms import USPlaceForm
 
@@ -11 +12 @@
 class USLocalFlavorTests(SimpleTestCase):
 
     def setUp(self):
+        self.ssn_field = USSocialSecurityNumberField()
         self.form = USPlaceForm({'state':'GA', 'state_req':'NC', 'postal_code': 'GA', 'name':'impossible'})
 
     def test_get_display_methods(self):
@@ -278 +280 @@
 
         valid = {
             '987-65-4330': '987-65-4330',
-            '987654330': '987-65-4330',
+            '987654330':   '987-65-4330',
         }
         invalid = {
             '078-05-1120': error_invalid,
+            '078051120':   error_invalid,
+            '219-09-9999': error_invalid,
+            '219099999':   error_invalid,
+            '000-12-1234': error_invalid,
+            '123-00-1234': error_invalid,
+            '123-12-0000': error_invalid,
         }
         self.assertFieldOutput(USSocialSecurityNumberField, valid, invalid)
+
+    def test_returns_value_when_valid_social_security_number(self):
+        ssn = "123-45-6789"
+        self.assertEqual(ssn, self.ssn_field.clean(ssn))
+
+    def test_forces_number_to_dashes_when_valid_and_not_remove_dashes(self):
+        ssn = "123456789"
+        self.assertEqual("123-45-6789", self.ssn_field.clean(ssn))
+
+    def test_forces_number_to_no_dashes_when_valid_and_remove_dashes(self):
+        field = USSocialSecurityNumberField(no_hyphens=True)
+        ssn = "123-45-6789"
+        self.assertEqual("123456789", field.clean(ssn))
+
+    def test_is_not_valid_when_any_blocks_are_all_zero(self):
+        with self.assertRaises(ValidationError):
+            self.ssn_field.clean("000-12-1234")
+
+        with self.assertRaises(ValidationError):
+            self.ssn_field.clean("123-00-1234")
+
+        with self.assertRaises(ValidationError):
+            self.ssn_field.clean("123-12-0000")
+
+    def test_is_not_valid_when_area_is_666(self):
+        with self.assertRaises(ValidationError):
+            self.ssn_field.clean("666-12-1234")
+
+    def test_is_not_valid_when_in_promotional_range(self):
+        # 987-65-(4320 - 4329) is invalid
+        for x in range(4320, 4330):
+            with self.assertRaises(ValidationError):
+                self.ssn_field.clean("987-65-{area}".format(area=x))
+        self.assertEqual("987-65-4330", self.ssn_field.clean("987-65-4330"))
+
+    def test_078_05_1120_is_invalid(self):
+        with self.assertRaises(ValidationError):
+            self.ssn_field.clean("078-05-1120")
+
+    def test_219_09_9999_is_invalid(self):
+        with self.assertRaises(ValidationError):
+            self.ssn_field.clean("219-09-9999")