Localflavor Sri Lanka: Support for Sri Lanka added in django-localflavor

docs/authors.rst

@@ -137,3 +137,4 @@ Authors
 * Xabi Bello
 * Abhineet Tamrakar
 * Tudor Amariei
+* Dishan Sachin

docs/changelog.rst

@@ -31,7 +31,8 @@ instructions on how to suppress this warning once the migration has been complet
 
 New flavors:
 
-- None
+- Sri Lanka LocalFlavor: Support for Sri Lanka added
+  (`gh-493 <https://github.com/django/django-localflavor/pull/493>`_).
 
 New fields for existing flavors:
 

docs/localflavor/lk.rst

@@ -0,0 +1,19 @@
+Sri Lanka (``lk``)
+==================
+
+Forms
+-----
+
+.. automodule:: localflavor.lk.forms
+    :members:
+
+Models
+------
+
+.. automodule:: localflavor.lk.models
+    :members:
+
+Data
+----
+.. autodata:: localflavor.lk.lk_provinces.PROVINCES
+.. autodata:: localflavor.lk.lk_districts.DISTRICTS

localflavor/lk/forms.py

@@ -0,0 +1,49 @@
+"""Sri Lanka specific Form helpers."""
+
+from django.forms.fields import RegexField, Select
+from django.utils.translation import gettext_lazy as _
+
+from .lk_provinces import PROVINCES
+from .lk_districts import DISTRICTS
+
+
+class LKPostalCodeFormField(RegexField):
+    """
+        A form field that accepts Sri Lanka postal code.
+        Format : NNNNN
+
+        Postal codes: https://en.wikipedia.org/wiki/Postal_codes_in_Sri_Lanka
+
+        .. versionadded:: 5.0
+    """
+
+    default_error_messages = {
+        'invalid': _('Enter a postal code in format NNNNN'),
+    }
+
+    def __init__(self, **kwargs):
+        super().__init__(r'^[0-9]{5}$', **kwargs)
+
+
+class LKProvinceSelect(Select):
+    """
+        A Select widget with option to select a provinces from
+        list of all provinces of Sri Lanka.
+
+        .. versionadded:: 5.0
+    """
+
+    def __init__(self, attrs=None):
+        super().__init__(attrs, choices=PROVINCES)
+
+
+class LKDistrictSelect(Select):
+    """
+    A Select widget with option to select a districts from
+    list of all districts of Sri Lanka.
+
+    .. versionadded:: 5.0
+    """
+
+    def __init__(self, attrs=None):
+        super().__init__(attrs, choices=DISTRICTS)

localflavor/lk/lk_districts.py

@@ -0,0 +1,82 @@
+"""
+List of Districts of Sri Lanka.
+
+Source: https://en.wikipedia.org/wiki/Districts_of_Sri_Lanka
+
+Sri Lanka districts list choices are in this format:
+
+    ('name_of_districts',_('Name of districts')),
+
+eg.
+    ('name_of_district', _('Name of district')),
+"""
+
+from django.utils.translation import gettext_lazy as _
+
+# list of districts in Central
+CENTRAL_DISTRICTS = [
+    ('kandy', _('Kandy')),
+    ('matale', _('Matale')),
+    ('nuwara_eliya', _('Nuwara Eliya')),
+]
+
+# list of districts in North Central
+NORTH_CENTRAL_DISTRICTS = [
+    ('anuradhapura', _('Anuradhapura')),
+    ('polonnaruwa', _('Polonnaruwa')),
+]
+
+# list of districts in Northern
+NORTHERN_DISTRICTS = [
+    ('jaffna', _('Jaffna')),
+    ('kilinochchi', _('Kilinochchi')),
+    ('mannar', _('Mannar')),
+    ('vavuniya', _('Vavuniya')),
+    ('mullativu', _('Mullativu')),
+    ('alambil', _('Alambil')),
+]
+
+# list of districts in Eastern
+EASTERN_DISTRICTS = [
+    ('ampara', _('Ampara')),
+    ('batticaloa', _('Batticaloa')),
+    ('trincomalee', _('Trincomalee')),
+]
+
+# list of districts in North Western
+NORTH_WESTERN_DISTRICTS = [
+    ('kurunagala', _('Kurunagala')),
+    ('puttalam', _('Puttalam')),
+]
+
+# list of districts in Southern
+SOUTHERN_DISTRICTS = [
+    ('galle', _('Galle')),
+    ('hambanthota', _('Hambanthota')),
+    ('mathara', _('Mathara')),
+]
+
+# list of districts in Uva
+UVA_DISTRICTS = [
+    ('badulla', _('Badulla')),
+    ('monaragala', _('Monaragala')),
+]
+
+# list of districts in Sabaragamuwa
+SABARAGAMUWA_DISTRICTS = [
+    ('kegalle', _('Kegalle')),
+    ('rathnapura', _('Rathnapura')),
+]
+
+# list of districts in Western
+WESTERN_DISTRICTS = [
+    ('colombo', _('Colombo')),
+    ('gampaha', _('Gampaha')),
+    ('kaluthara', _('Kaluthara')),
+]
+
+# Combining all the district lists from different provinces into a single list
+DISTRICTS =  CENTRAL_DISTRICTS + NORTH_CENTRAL_DISTRICTS + NORTHERN_DISTRICTS + EASTERN_DISTRICTS + NORTH_WESTERN_DISTRICTS + SOUTHERN_DISTRICTS + UVA_DISTRICTS + SABARAGAMUWA_DISTRICTS + WESTERN_DISTRICTS
+
+# Alphabetically sorting the list of all districts based on their names (first element of each tuple)
+DISTRICTS.sort(key=lambda district: district[0])

localflavor/lk/lk_provinces.py

@@ -0,0 +1,26 @@
+"""
+List of Provinces of Sri Lanka.
+
+Source: https://en.wikipedia.org/wiki/Provinces_of_Sri_Lanka
+
+Sri Lanka province list choices are in this format:
+
+    ('name_of_province',_('Name of province')),
+
+e.g.
+    ('central', _('Central')),
+"""
+
+from django.utils.translation import gettext_lazy as _
+
+PROVINCES = [
+    ('central', _('Central')),
+    ('eastern', _('Eastern')),
+    ('north_central', _('North Central')),
+    ('north_western', _('North Western')),
+    ('northern', _('Northern')),
+    ('sabaragamuwa', _('Sabaragamuwa')),
+    ('southern', _('Southern')),
+    ('uva', _('Uva')),
+    ('western', _('Western')),
+]

localflavor/lk/models.py

@@ -0,0 +1,82 @@
+"""Sri Lanka specific Model fields"""
+
+import re
+
+from django.core.validators import RegexValidator
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from .forms import LKPostalCodeFormField
+from .lk_districts import DISTRICTS
+from .lk_provinces import PROVINCES
+
+
+class LKPostalCodeValidator(RegexValidator):
+    """
+    A validator for Sri Lanka Postal Codes.
+    """
+    default_error_messages = {
+        'invalid': _('Enter a postal code in format NNNNN'),
+    }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(re.compile(r'^[0-9]{5}$'), *args, **kwargs)
+
+
+class LKPostalCodeField(models.CharField):
+    """
+    A model field that accepts Sri Lanka postal codes.
+    Format: NNNNN
+    Source: https://en.wikipedia.org/wiki/Postal_codes_in_Sri_Lanka
+
+    .. versionadded:: 5.0
+    """
+    description = _("Postal Code")
+
+    def __init__(self, *args, **kwargs):
+        kwargs['max_length'] = 5
+        super().__init__(*args, **kwargs)
+        self.validators.append(LKPostalCodeValidator())
+
+    def formfield(self, **kwargs):
+        defaults = {'form_class': LKPostalCodeFormField}
+        defaults.update(kwargs)
+        return super().formfield(**defaults)
+
+
+class LKDistrictField(models.CharField):
+    """
+    A model field that provides an option to select
+    a district from the list of all Sri Lanka districts.
+
+    .. versionadded:: 5.0
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs['choices'] = DISTRICTS
+        kwargs['max_length'] = 15
+        super().__init__(*args, **kwargs)
+
+    def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        del kwargs['choices']
+        return name, path, args, kwargs
+
+
+class LKProvinceField(models.CharField):
+    """
+    A model field that provides an option to select
+    a province from the list of all Sri Lanka provinces.
+
+    .. versionadded:: 5.0
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs['choices'] = PROVINCES
+        kwargs['max_length'] = 15
+        super().__init__(*args, **kwargs)
+
+    def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        del kwargs['choices']
+        return name, path, args, kwargs

tests/settings.py

@@ -16,6 +16,7 @@
     'tests.test_fr',
     'tests.test_generic',
     'tests.test_gh',
+    'tests.test_lk',
     'tests.test_md',
     'tests.test_mk',
     'tests.test_mx',

tests/test_lk/models.py

@@ -0,0 +1,8 @@
+from django.db import models
+
+from localflavor.lk.models import (LKDistrictField, LKProvinceField)
+
+
+class LKPlace(models.Model):
+    district = LKDistrictField(blank=True)
+    province = LKProvinceField(blank=True)

tests/test_lk/selectfields_html.py

@@ -0,0 +1,46 @@
+"""Option for all select box fields"""
+
+districts_select = """
+<select name="district">
+  <option value="alambil">Alambil</option>
+  <option value="ampara">Ampara</option>
+  <option value="anuradhapura">Anuradhapura</option>
+  <option value="badulla">Badulla</option>
+  <option value="batticaloa">Batticaloa</option>
+  <option value="colombo">Colombo</option>
+  <option value="galle">Galle</option>
+  <option value="gampaha">Gampaha</option>
+  <option value="hambanthota">Hambanthota</option>
+  <option value="jaffna">Jaffna</option>
+  <option value="kaluthara">Kaluthara</option>
+  <option value="kandy" selected>Kandy</option>
+  <option value="kegalle">Kegalle</option>
+  <option value="kilinochchi">Kilinochchi</option>
+  <option value="kurunagala">Kurunagala</option>
+  <option value="mannar">Mannar</option>
+  <option value="matale">Matale</option>
+  <option value="mathara">Mathara</option>
+  <option value="monaragala">Monaragala</option>
+  <option value="mullativu">Mullativu</option>
+  <option value="nuwara_eliya">Nuwara Eliya</option>
+  <option value="polonnaruwa">Polonnaruwa</option>
+  <option value="puttalam">Puttalam</option>
+  <option value="rathnapura">Rathnapura</option>
+  <option value="trincomalee">Trincomalee</option>
+  <option value="vavuniya">Vavuniya</option>
+</select>
+"""
+
+provinces_select = """
+<select name="province">
+  <option value="central" selected>Central</option>
+  <option value="eastern">Eastern</option>
+  <option value="north_central">North Central</option>
+  <option value="north_western">North Western</option>
+  <option value="northern">Northern</option>
+  <option value="sabaragamuwa">Sabaragamuwa</option>
+  <option value="southern">Southern</option>
+  <option value="uva">Uva</option>
+  <option value="western">Western</option>
+</select>
+"""

tests/test_lk/tests.py

@@ -0,0 +1,51 @@
+from django.test import TransactionTestCase
+from localflavor.lk.forms import LKDistrictSelect, LKPostalCodeFormField, LKProvinceSelect
+
+from .selectfields_html import districts_select, provinces_select
+from .models import LKPlace
+
+
+class SriLanakDetailsTests(TransactionTestCase):
+    """
+        This Test class tests all the selectbox
+        fields and Postal Code Fields.
+    """
+    maxDiff = None
+
+    def test_LKDistrictSelect(self):
+        field = LKDistrictSelect()
+        self.assertHTMLEqual(field.render('district', 'kandy'), districts_select)
+
+    def test_LKProvinceSelect(self):
+        field = LKProvinceSelect()
+        self.assertHTMLEqual(field.render('province', 'central'), provinces_select)
+
+    def test_LKPostalCodeFieldTest(self):
+        error_format = ['Enter a postal code in format NNNNN']
+        valid = {
+            '12345': '12345',
+            '00000': '00000',
+            '11111': '11111'
+        }
+        invalid = {
+            '12345_123': error_format,
+            '1234-123': error_format,
+            '-232': error_format,
+            'abc_den': error_format,
+            '2345-': error_format,
+        }
+        self.assertFieldOutput(LKPostalCodeFormField, valid, invalid)
+
+    def test_LKDistrictField(self):
+        place = LKPlace()
+        place.district = 'kandy'
+        place.clean_fields()
+        place.save()
+        self.assertEqual(place.get_district_display(), 'Kandy')
+
+    def test_LKProvinceField(self):
+        place = LKPlace()
+        place.province = 'central'
+        place.clean_fields()
+        place.save()
+        self.assertEqual(place.get_province_display(), 'Central')