collective.itvalidators 0.2.1

A set of Archetype validators for Plone, some for Italian specific needs, others useful for all

Table of contents

• Introduction

• Italian Specific validators

  • isCAP

  • isItalianNIN

• General purpose validators

  • MinCharsValidator

    • How to use

  • DependencyCheckValidator

    • How to use

    • Final note

• Contribute!

• Credits

• Authors

• Changelog

  • 0.2.1 (2012-02-09)

  • 0.2.0 (2012-02-07)

  • 0.1.0 (2011-05-03)

Introduction

This product add to Plone some additional validators.

Some of theme can be useful only for Italian users or sites targeted on Italy (as many of the default ones like isSSN or isUSPhoneNumber are not useful for non-US sites), other are simply additional validators that everyone can find useful.

The idea behind the product is simply collect a set of validators that commonly are putted inside other products, but in this way not easily reusable.

Italian Specific validators

isCAP

Very similar to the native isZipCode but this only accept 5 digits values. Formally is Codice di Avviamento Postale.

isItalianNIN

Check if a string is a valid Italian National Insurance Number (“Codice Fiscale”). The validator only check the format of the string, not if the string itself is a real and existing code.

General purpose validators

MinCharsValidator

This validator test if the given value is at least a specific number of characters long. The default character value is 500.

The validator will also ignore any whitespace (space character, carriage return, tab…) so the text:

Hello World

is long like:

Hello      World

and also long like:

Hello

     World

How to use

An example:

from collective.itvalidators.validators import MinCharsValidator
...

TextField('text',
          validators = (MinCharsValidator()),
),
...

To customize the number of characters:

TextField('text',
          validators = (MinCharsValidator(100)),
),
...

You can also threat is a special way HTML text (for example, if it came from TinyMCE) beeing sure that only content characters (not HTML tags) are counted. Example:

...
TextField('text',
          default_output_type = 'text/x-html-safe',
          validators = ('isTidyHtmlWithCleanup', MinCharsValidator(100, strict=True)),
),
...

DependencyCheckValidator

This validator check the value (”wanted value”) contained in a field, but only when another field contains a “warning value”. This mean that when the observed field isn’t matching the value you are monitor, no validation take place; when this is true, a second level of validation of the current field take place.

You need to configure this validator giving the observed field. After that you need to provide both warnValue and wantedValue.

Example:

Check that when an observed field contains the value “Other…”, this field contains the value “Foo”.

This first example seems not very useful but know that both configuration parameters can be a specific value, or a boolean value.

When using boolean values:

• When warnValue is False mean that you want to monitor when the observed field is empty.

• When warnValue is True mean that you want to monitor when the observed field is not empty.

• When wantedValue is False mean that validation will pass if the field if empty.

• When wantedValue is True mean that validation will pass if the field not empty (see below).

Another (better) example:

Check that when an observed field contains the value “Other…”, this field contains something.

How to use

The first example above:

from collective.itvalidators.validators import DependencyCheckValidator
...

StringField('field1',),
StringField('field2',
            validators = (DependencyCheckValidator('field1', warnValue='Other...', wantedValue='Foo')),
),
...

The second example above:

...
StringField('field1',),
StringField('field2',
            validators = (DependencyCheckValidator('field1', warnValue='Other...', wantedValue=True)),
),
...

Final note

Normally Archetypes framework doesn’t run validation for non-required empty fields. This happens adding as first validator a default sufficient “isEmptyNoError”.

You probably need to play with Products.validation APIs to use wantedValue True:

YourSchema['field2'].validators.insertRequired(
                DependencyCheckValidator('field1', warnValue='Other...', wantedValue=True)
)

This will add in position 0 a required validator. In this way the validation runs normally.

Contribute!

You are welcome to add to this product your additional validation (also some unit-tests for every new validator are welcome)! Contact us at [e-mail]

You can also contribute providing new translation for validation messages.

Credits

Developed with the support of:

• Azienda USL Ferrara

  

• S. Anna Hospital, Ferrara

  

• Regione Emilia Romagna

All of them supports the PloneGov initiative.

Authors

This product was developed by RedTurtle Technology team.

Changelog

0.2.1 (2012-02-09)

• fixed error when fields provide a custom i18n Message string. Overriding the default ones was not possible [keul]

0.2.0 (2012-02-07)

• new validator: DependencyCheckValidator [keul]

• fixed translations [keul]

0.1.0 (2011-05-03)

• Initial release