Source code for localflavor.nl.forms

# -*- coding: utf-8 -*-
"""NL-specific Form helpers."""

from __future__ import unicode_literals

from django import forms
from django.utils import six

from localflavor.generic.forms import DeprecatedPhoneNumberFormFieldMixin

from .nl_provinces import PROVINCE_CHOICES
from .validators import NLPhoneNumberFieldValidator, NLSoFiNumberFieldValidator, NLZipCodeFieldValidator


class NLZipCodeField(forms.CharField):
    """A Dutch zip code field."""

    default_validators = [NLZipCodeFieldValidator()]

    def clean(self, value):
        if isinstance(value, six.string_types):
            value = value.upper().replace(' ', '')

            if len(value) == 6:
                value = '%s %s' % (value[:4], value[4:])

        return super(NLZipCodeField, self).clean(value)


class NLProvinceSelect(forms.Select):
    """A Select widget that uses a list of provinces of the Netherlands as it's choices."""

    def __init__(self, attrs=None):
        super(NLProvinceSelect, self).__init__(attrs, choices=PROVINCE_CHOICES)


class NLPhoneNumberField(forms.CharField, DeprecatedPhoneNumberFormFieldMixin):
    """A Dutch telephone number field."""

    default_validators = [NLPhoneNumberFieldValidator()]


class NLSoFiNumberField(forms.CharField):
    """
    A Dutch social security number (SoFi/BSN) field.

    http://nl.wikipedia.org/wiki/Sofinummer
    """

    default_validators = [NLSoFiNumberFieldValidator()]

    def __init__(self, *args, **kwargs):
        kwargs['max_length'] = 9
        super(NLSoFiNumberField, self).__init__(*args, **kwargs)