I've done a lot of work on ValidateThis!, my validations framework for ColdFusion objects, over the past few months, and I'm just now getting around to packaging those changes into a new download. I hope to put together some decent documentation on the framework in the future, but for now hopefully this blog post will suffice as an explanation of the changes. In summary, the following additions have been made:
- Introduction of the ValidateThisConfig bean
- Multiple options for specifying form name/id
- XML schema addition - contexts block
- Support for the remote attribute of the jQuery validation plugin
- Support for custom failure messages for standard validations using the jQuery validation plugin
- Automatic discovery of concrete components
- New generateInitializationScript() method
- New getAllContexts() method
The details of each of these items can be found below:
Introduction of the ValidateThisConfig bean
Previous to this release if you wanted to change certain behaviours of the framework you had to edit the Coldspring config file that resided in the framework directory. That was not ideal, so a developer now has the ability to include a ValidateThisConfig bean definition in their application's own coldspring config file. A sample entry is:
And here is what those entries do:
- BOValidatorPath - This specifies the path to the BOValidator component, which is the facade to the entire framework. It is possible that advanced users may want to either extend or override that component with their own version, and this entry allows for that.
- defaultFormName - This is the default form name/id to be used when generating client-side validations. It is discussed in more detail in the next section.
Note that any additional behaviours that are deemed customizable will be added to this config bean, allowing those behaviours to be customized without having to touch any of the core framework code.
Multiple options for specifying form name/id
When generating client-side validation code, the setup of said code often needs to specify the name and/or id of the form to which the validation is being attached. In previous releases this was not done by the framework (you had to do it manually), so it was a non-issue. In the latest release the framework actually generates that code for you, so it needs to know the name/id of the form for which validations are being generated. To this end there are three different places in which you can specify that information:
- Global default form name - You can specify a form name in your ValidateThisConfig bean (mentioned above) which will be used as the default if you do not override it elsewhere. I find this useful as I tend to use the same name/id for all of my forms. If I'm creating a form (e.g., a search form or a login form) which might be included on a page with other forms then I'll give it a unique name, otherwise they're mostly called "frmMain".
- Associate a form name with a context - When using contexts to specify groups of validation rules that apply to a given domain object in different use cases, you have the option of specifying a form name that corresponds with a given context. For example, for a User object you may have a login form, with an associated login context as well as a registration form with an associated register context. If the name/id of your login form is frmLogin and the name/id of your registration form is frmRegister, you can specify those in the xml configuration file for the User object. The new elements that support that are described in the next section.
Specify a form name when requesting the client-side validation script - You ask your domain object for its client-side validation script by invoking the getValidationScript() method on it. That method accepts three arguments, all of which are optional:
- context - If you are using contexts you specify the context in order to get back the corresponding validation rules.
- formName - This is where you specify the name/id of the form. If you do not pass anything into this argument it uses the form name specified in the ValidateThisConfig bean.
XML schema addition - contexts block
The ValidateThis.xsd XML schema definition has been amended to allow for an optional block in which a developer can define the name of a form that should be used when generating client side validations for a specific context. An example is as follows:
<context name="Login" formName="frmLogin" />
<context name="Register" formName="frmRegister" />
This is an optional element as there are two other ways of specifying the form name to be used, which was discussed in the section above.
Support for the remote attribute of the jQuery validation plugin
A developer can now create client-side validations that are done via AJAX using the remote attribute of the jQuery validation plugin. This is done using the custom validation type. A sample validation rule from the xml file is:
failureMessage="That Nickname is already taken. Please try a different Nickname.">
<param methodname="CheckDupNickname" />
<param remoteURL="CheckDupNickname.cfm" />
This will cause the jQuery validation plugin to issue an AJAX request to CheckDupNickname.cfm to perform a validation. An example of this has been added to the demo application at www.validatethis.org.
Support for custom failure messages for standard validations using the jQuery validation plugin
Prior to this release only the standard validation failure messages that are built into the jQuery validation plugin were displayed, even if the developer specified a custom failure message (the custom failure messages were displayed for server-side validation failures). In this release, if you specify a custom failure message for a rule, it will be used for both client-side and server-side validations.
Automatic discovery of concrete components
Prior to this release all of the concrete components (ClientScriptWriters, ClientRuleScripters and ServerRuleValidators) were hardcoded into the coldspring.xml config file for ValidateThis. This is no longer necessary which means less maintenance and also that new concrete components can be added and they will be available to the framework immediately.
New generateInitializationScript() method
New getAllContexts() method
A getAllContexts() method has been added to the BOValidator which will return a struct containing all of the contexts defined for the object. Each key in the struct will contain an array of all of the business rules defined for that context. This was a user request.
A new download of version 0.6 will be available shortly at RIAForge.