Ticket #17591: us_ssnfield_fix_v2.patch

tests/regressiontests/localflavor/us/tests.py

@@ -277 +277 @@
         error_invalid = [u'Enter a valid U.S. Social Security number in XXX-XX-XXXX format.']
 
         valid = {
-            '987-65-4330': '987-65-4330',
-            '987654330': '987-65-4330',
+            '987-65-4330': '987-65-4330', # perfectly valid
+
+            # allow no hyphens input, forces output to hyphenated
+            '987654330':   '987-65-4330',
         }
         invalid = {
-            '078-05-1120': error_invalid,
+            # improper format
+            'A11-222-3333': error_invalid,   # can't have alphanumeric
+            '12-12-3333'  : error_invalid,   # first block wrong length
+            '123-1-3333'  : error_invalid,   # second block wrong length
+            '123-12-333'  : error_invalid,   # third block wrong length
+            '12312333'    : error_invalid,   # no hyphens too short
+            '1231233333'  : error_invalid,   # no hyphens too long
+
+            # known bad blocks of proper format
+            '078-05-1120' : error_invalid, # Known invalid
+            '219-09-9999' : error_invalid, # Known invalid
+            '000-12-1234' : error_invalid, # zeros in first block
+            '123-00-1234' : error_invalid, # zeros in second block
+            '123-12-0000' : error_invalid, # zeros in third block
+            '666-12-1234' : error_invalid, # area block can't be 666
+
+            # known bad blocks input with no hyphens
+            '078051120': error_invalid, # known invalid
+            '219099999': error_invalid, # known invalid
+            '000121234': error_invalid, # zeros in first block
+            '123001234': error_invalid, # zeros in second block
+            '123120000': error_invalid, # zeros in third block
+            '666121234': error_invalid, # area block can't be 666
         }
+        self.assertFieldOutput(USSocialSecurityNumberField, valid, invalid)
+
+    def test_forces_number_to_no_hyphens_when_option_set(self):
+        field = USSocialSecurityNumberField(no_hyphens=True)
+        ssn = "123-45-6789"
+        self.assertEqual("123456789", field.clean(ssn))
+
+    def test_is_not_valid_when_in_promotional_range(self):
+        error_invalid = [u'Enter a valid U.S. Social Security number in XXX-XX-XXXX format.']
+
+        # 987-65-(4320 - 4329) is invalid
+        valid = {
+            '987-65-4319': '987-65-4319', # last good before range
+            '987-65-4330': '987-65-4330', # first good after range
+        }
+        invalid = dict([("987-65-%d" % x, error_invalid) for x in range(4320, 4330)])
         self.assertFieldOutput(USSocialSecurityNumberField, valid, invalid)

django/contrib/localflavor/us/forms.py

@@ -55 +55 @@
           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':
+        ssn_parts = self._get_ssn_parts(value)
+        if not ssn_parts or self._is_invalid_ssn(ssn_parts):
             raise ValidationError(self.error_messages['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  self._has_zero_blocks(**ssn_parts) or \
+                self._is_invalid_area(ssn_parts['area']) or \
+                self._is_in_promotional_range(**ssn_parts) or \
+                self._is_known_invalid(**ssn_parts)
+
+    def _get_formatted_ssn(self, ssn_parts):
+        ssn = "%(area)s-%(group)s-%(serial)s" % ssn_parts
+        if self.no_hyphens:
+            ssn = ssn.replace('-', '')
+        return ssn
+
+    def _get_ssn_parts(self, value):
+        m = ssn_re.match(value)
+        if m:
+            return m.groupdict()
+
+    def _has_zero_blocks(self, area, group, serial):
+        return area == '000' or group == '00' or serial == '0000'
+
+    def _is_invalid_area(self, area):
+        return area == '666'
+
+    def _is_in_promotional_range(self, area, group, serial):
+        return area == '987' and group == '65' and 4320 <= int(serial) <= 4329
+
+    def _is_known_invalid(self, area, group, serial):
+        return area == '078' and group == '05' and serial == '1120' or \
+               area == '219' and group == '09' and serial == '9999'
 
 class USStateField(Field):
     """

docs/ref/contrib/localflavor.txt

@@ -1294 +1294 @@
       use or distribution (e.g., the Woolworth's number or the 1962
       promotional number)
 
+    As an optional argument, you can instantiate ``forms.USSocialSecurityNumberField``
+    with 'no_hyphens=True' to remove hyphens from SSN output. (XXXXXXXXX)
+
 .. class:: us.forms.USStateField
 
     A form field that validates input as a U.S. state name or abbreviation. It