Added a model field for Ecuadorian provinces

localflavor/ec/ec_provinces.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-#: A list of Ecuador departaments as `choices` in a formfield.
+#: A list of Ecuador provinces as `choices` in a formfield.
 PROVINCE_CHOICES = (
     ('A', 'Azuay'),
     ('B', 'Bolívar'),

localflavor/ec/models.py

@@ -0,0 +1,17 @@
+from django.utils.translation import ugettext_lazy as _
+from django.db.models.fields import CharField
+
+from .ec_provinces import PROVINCE_CHOICES
+
+
+class ECProvinceField(CharField):
+    """
+    A model field that represents an Ecuadorian province and stores its
+    abbreviation.
+    """
+    description = _("Ecuadorian province")
+
+    def __init__(self, *args, **kwargs):
+        kwargs['choices'] = PROVINCE_CHOICES
+        kwargs['max_length'] = 2
+        super(ECProvinceField, self).__init__(*args, **kwargs)

tests/settings.py

@@ -11,6 +11,7 @@
 INSTALLED_APPS = [
     'localflavor',
     'tests.test_au',
+    'tests.test_ec',
     'tests.test_mk',
     'tests.test_mx',
     'tests.test_us',

tests/test_ec/forms.py

@@ -0,0 +1,11 @@
+from __future__ import absolute_import
+
+from django.forms import ModelForm
+
+from .models import ECPlace
+
+
+class ECPlaceForm(ModelForm):
+    class Meta:
+        model = ECPlace
+        fields = ('province',)

tests/test_ec/models.py

@@ -0,0 +1,7 @@
+from django.db import models
+
+from localflavor.ec.models import ECProvinceField
+
+
+class ECPlace(models.Model):
+    province = ECProvinceField(blank=True)

tests/test_ec.py → tests/test_ec/tests.py

@@ -4,8 +4,15 @@
 
 from localflavor.ec.forms import ECProvinceSelect
 
+from .forms import ECPlaceForm
 
 class ECLocalFlavorTests(SimpleTestCase):
+
+    def setUp(self):
+        self.form = ECPlaceForm({
+            'province':'SD'
+        })
+
     def test_ECProvinceSelect(self):
         p = ECProvinceSelect()
         out = """<select name="province">
@@ -35,3 +42,9 @@ def test_ECProvinceSelect(self):
 <option value="Z">Zamora Chinchipe</option>
 </select>"""
         self.assertHTMLEqual(p.render('province', 'U'), out)
+
+    def test_get_display_methods(self):
+        """Test that the get_*_display() methods are added to the model instances."""
+        place = self.form.save()
+        self.assertEqual(place.get_province_display(),
+                         "Santo Domingo de los Ts\xe1chilas")