Ticket #8068: localflavor_kw.patch

django/contrib/localflavor/kw/forms.py

@@ +1 @@
+"""
+Kuwait-specific Form helpers
+"""
+
+from django.forms import ValidationError
+from django.forms.fields import Field, RegexField, EMPTY_VALUES
+from django.utils.translation import gettext as _
+import re
+from datetime import date
+
+id_re = re.compile(r'^(?P<initial>\d{1})(?P<yy>\d\d)(?P<mm>\d\d)(?P<dd>\d\d)(?P<mid>\d{4})(?P<checksum>\d{1})')
+
+class KWCivilIDNumberField(Field):
+    """
+    Kuwaiti Civil ID numbers are 12 digits, second to seventh digits
+    represents the person's birthdate.
+
+    Checks the following rules to determine the validty of the number:
+        * The number consist of 12 digits.
+        * The birthdate of the person is a valid date.
+        * The calculated checksum equals to the last digit of the Civil ID.
+    """
+    default_error_messages = {
+        'invalid': _(u'Enter a valid Kuwaiti Civil ID number'),
+    }
+
+    def has_valid_checksum(self, value):
+        weight = (2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2)
+        calculated_checksum = 0
+        for i in range(11):
+            calculated_checksum += int(value[i]) * weight[i]
+
+        remainder = calculated_checksum % 11
+        checkdigit = 11 - remainder
+        if checkdigit != int(value[11]):
+            return False
+        return True
+
+    def clean(self, value):
+        super(KWCivilIDNumberField, self).clean(value)
+        if value in EMPTY_VALUES:
+            return u''
+
+        if not re.match(r'^\d{12}$', value):
+            raise ValidationError(self.error_messages['invalid'])        
+
+        match = re.match(id_re, value)
+
+        if not match:
+            raise ValidationError(self.error_messages['invalid'])
+
+        gd = match.groupdict()
+
+        try:
+            d = date(int(gd['yy']), int(gd['mm']), int(gd['dd']))
+        except ValueError:
+            raise ValidationError(self.error_messages['invalid'])
+
+        if not self.has_valid_checksum(value):
+            raise ValidationError(self.error_messages['invalid'])
+
+        return value

docs/localflavor.txt

@@ -44 +44 @@
     * India_
     * Italy_
     * Japan_
+    * Kuwait_
     * Mexico_
     * Norway_
     * Peru_
@@ -83 +84 @@
 .. _India: `India (django.contrib.localflavor.in\_)`_
 .. _Italy: `Italy (django.contrib.localflavor.it)`_
 .. _Japan: `Japan (django.contrib.localflavor.jp)`_
+.. _Kuwait: `Kuwait (django.contrib.localflavor.kw)`_
 .. _Mexico: `Mexico (django.contrib.localflavor.mx)`_
 .. _Norway: `Norway (django.contrib.localflavor.no)`_
 .. _Peru: `Peru (django.contrib.localflavor.pe)`_
@@ -422 +424 @@
 
 A ``Select`` widget that uses a list of Japanese prefectures as its choices.
 
+Kuwait (``django.contrib.localflavor.kw``)
+==========================================
+
+KWCivilIDNumberField
+--------------------
+
+A form field that validates input as a Kuwaiti Civil ID number. A valid
+Civil ID number must obey the following rules:
+
+    * The number consist of 12 digits.
+    * The birthdate of the person is a valid date.
+    * The calculated checksum equals to the last digit of the Civil ID.
+
 Mexico (``django.contrib.localflavor.mx``)
 ==========================================
 

tests/regressiontests/forms/localflavor/kw.py

@@ +1 @@
+# -*- coding: utf-8 -*-
+# Tests for the contrib/localflavor/ KW form fields.
+
+tests = r"""
+# KWCivilIDNumberField ########################################################
+
+>>> from django.contrib.localflavor.kw.forms import KWCivilIDNumberField
+>>> f = KWCivilIDNumberField()
+>>> f.clean('282040701483')
+'282040701483'
+>>> f.clean('289332013455')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid Kuwaiti Civil ID number']
+"""

tests/regressiontests/forms/tests.py

@@ -18 +18 @@
 from localflavor.is_ import tests as localflavor_is_tests
 from localflavor.it import tests as localflavor_it_tests
 from localflavor.jp import tests as localflavor_jp_tests
+from localflavor.kw import tests as localflavor_kw_tests
 from localflavor.nl import tests as localflavor_nl_tests
 from localflavor.pl import tests as localflavor_pl_tests
 from localflavor.ro import tests as localflavor_ro_tests
@@ -51 +52 @@
     'localflavor_is_tests': localflavor_is_tests,
     'localflavor_it_tests': localflavor_it_tests,
     'localflavor_jp_tests': localflavor_jp_tests,
+    'localflavor_kw_tests': localflavor_kw_tests,
     'localflavor_nl_tests': localflavor_nl_tests,
     'localflavor_pl_tests': localflavor_pl_tests,
     'localflavor_ro_tests': localflavor_ro_tests,