Accelerated validation by removing type checks. ACF chokes on interface checks

Author: lmajano

changelog.md

@@ -9,6 +9,7 @@
 * New Validator: `Alpha` - Only allows alphabetic characters
 * New Validator: `RequiredUnless` with validation data: `anotherField:value,...`  -  The field under validation must be present and not empty unless the `anotherfield` field is equal to the passed `value`.
 * New Validator: `RequiredIf` with validation data: `anotherField:value,...`  -  The field under validation must be present and not empty if the `anotherfield` field is equal to the passed `value`.
+* Accelerated validation by removing type checks. ACF chokes on interface checks
 
 ### Improvements
 

models/IValidationManager.cfc

@@ -18,9 +18,9 @@ interface {
 	 * @excludeFieldsAn optional list of fields to exclude from the validation.
 	 * @includeFieldsAn optional list of fields to include in the validation.
 	 *
-	 * @result ValidationResult object
+	 * @return IValidationResult
 	 */
-	IValidationResult function validate(
+	any function validate(
 		required any target,
 		string fields,
 		any constraints,
@@ -47,15 +47,19 @@ interface {
 	 * Set the shared constraints into the validation manager, usually these are described in the ColdBox configuraiton file
 	 *
 	 * @constraintsFilter by name or not
+	 *
+	 * @return IValidationManager
 	 */
-	IValidationManager function setSharedConstraints( struct constraints );
+	any function setSharedConstraints( struct constraints );
 
 	/**
 	 * Store a shared constraint
 	 *
 	 * @nameFilter by name or not
 	 * @constraintThe constraint to store.
+	 *
+	 * @return IValidationManager
 	 */
-	IValidationManager function addSharedConstraint( required string name, required struct constraint );
+	any function addSharedConstraint( required string name, required struct constraint );
 
 }

models/ValidationManager.cfc

@@ -52,7 +52,7 @@
  */
 import cbvalidation.models.*;
 import cbvalidation.models.result.*;
-component accessors="true" serialize="false" implements="IValidationManager" singleton {
+component accessors="true" serialize="false" singleton {
 
 	/**
 	 * WireBox Object Factory
@@ -118,9 +118,9 @@ component accessors="true" serialize="false" implements="IValidationManager" sin
 	 * @excludeFields An optional list of fields to exclude from the validation.
 	 * @IncludeFields An optional list of fields to include in the validation.
 	 *
-	 * @return Results object
+	 * @return IValidationResult
 	 */
-	IValidationResult function validate(
+	any function validate(
 		required any target,
 		string fields        = "*",
 		any constraints      = "",
@@ -231,12 +231,13 @@ component accessors="true" serialize="false" implements="IValidationManager" sin
 	 * Process validation rules on a target object and field
 	 *
 	 * @results The validation result object
+	 * @results_generic cbvalidation.models.result.IValidationResult
 	 * @rules The structure containing validation rules
 	 * @target The target object to do validation on
 	 * @field The field to validate
 	 */
 	ValidationManager function processRules(
-		required cbvalidation.models.result.IValidationResult results,
+		required any results,
 		required struct rules,
 		required any target,
 		required any field
@@ -249,13 +250,15 @@ component accessors="true" serialize="false" implements="IValidationManager" sin
 			}
 
 			// had to use nasty evaluate until adobe cf get's their act together on invoke.
-			getValidator( validatorType = key, validationData = arguments.rules[ key ] ).validate(
-				validationResult = results,
-				target           = arguments.target,
-				field            = arguments.field,
-				targetValue      = invoke( arguments.target, "get" & arguments.field ),
-				validationData   = arguments.rules[ key ]
-			);
+			getValidator( validatorType = key, validationData = arguments.rules[ key ] )
+				.validate(
+					validationResult = results,
+					target           = arguments.target,
+					field            = arguments.field,
+					targetValue      = invoke( arguments.target, "get" & arguments.field ),
+					validationData   = arguments.rules[ key ],
+					rules 			 = arguments.rules
+				);
 		}
 		return this;
 	}
@@ -267,8 +270,9 @@ component accessors="true" serialize="false" implements="IValidationManager" sin
 	 * @validationData The validation data that is used for custom validators
 	 *
 	 * @throws ValidationManager.InvalidValidatorType
+	 * @return cbvalidation.models.validators.IValidator
 	 */
-	cbvalidation.models.validators.IValidator function getValidator(
+	any function getValidator(
 		required string validatorType,
 		required any validationData
 	){
@@ -324,8 +328,10 @@ component accessors="true" serialize="false" implements="IValidationManager" sin
 	 * Set the entire shared constraints structure
 	 *
 	 * @constraints Filter by name or not
+	 *
+	 * @return IValidationManager
 	 */
-	IValidationManager function setSharedConstraints( struct constraints ){
+	any function setSharedConstraints( struct constraints ){
 		variables.sharedConstraints = arguments.constraints;
 		return this;
 	}
@@ -335,8 +341,10 @@ component accessors="true" serialize="false" implements="IValidationManager" sin
 	 *
 	 * @name The name to store the constraint as
 	 * @constraint The constraint structures to store.
+	 *
+	 * @return IValidationManager
 	 */
-	IValidationManager function addSharedConstraint( required string name, required struct constraint ){
+	any function addSharedConstraint( required string name, required struct constraint ){
 		variables.sharedConstraints[ arguments.name ] = arguments.constraints;
 		return this;
 	}

models/result/IValidationResult.cfc

@@ -8,75 +8,86 @@ import cbvalidation.models.result.*;
 interface{
 
 	/**
-	* Add errors into the result object
-	* @errorThe validation error to add into the results object
-	*/
-	IValidationResult function addError(required IValidationError error);
+	 * Add errors into the result object
+	 * @error The validation error to add into the results object
+	 * @error_generic IValidationError
+	 *
+	 * @return IValidationResult
+	 */
+	any function addError(required error);
 
 	/**
-	* Set the validation target object name
-	*/
-	IValidationResult function setTargetName(required string name);
+	 * Set the validation target object name
+	 * @return IValidationResult
+	 */
+	any function setTargetName(required string name);
 
 	/**
-	* Get the name of the target object that got validated
-	*/
+	 * Get the name of the target object that got validated
+	 */
 	string function getTargetName();
 
 	/**
-	* Get the validation locale
-	*/
+	 * Get the validation locale
+	 */
 	string function getValidationLocale();
 
 	/**
-	* has locale information
-	*/
+	 * has locale information
+	 */
 	boolean function hasLocale();
 
 	/**
-	* Set the validation locale
-	*/
-	IValidationResult function setLocale(required string locale);
+	 * Set the validation locale
+	 *
+	 * @return IValidationResult
+	 */
+	any function setLocale(required string locale);
 
 
 	/**
-	* Determine if the results had error or not
-	* @fieldThe field to count on (optional)
-	*/
+	 * Determine if the results had error or not
+	 * @fieldThe field to count on (optional)
+	 */
 	boolean function hasErrors(string field);
 
 	/**
-	* Clear All errors
-	*/
-	IValidationResult function clearErrors();
+	 * Clear All errors
+	 * @return IValidationResult
+	 */
+	any function clearErrors();
 
 
 	/**
-	* Get how many errors you have
-	* @fieldThe field to count on (optional)
-	*/
+	 * Get how many errors you have
+	 * @fieldThe field to count on (optional)
+	 */
 	numeric function getErrorCount(string field);
 
 	/**
-	* Get the Errors Array, which is an array of error messages (strings)
-	* @fieldThe field to use to filter the error messages on (optional)
-	*/
+	 * Get the Errors Array, which is an array of error messages (strings)
+	 * @fieldThe field to use to filter the error messages on (optional)
+	 */
 	array function getAllErrors(string field);
 
 	/**
-	* Get an error object for a specific field that failed. Throws exception if the field does not exist
-	* @fieldThe field to return error objects on
-	*/
-	IValidationError[] function getFieldErrors(required string field);
+	 * Get an error object for a specific field that failed. Throws exception if the field does not exist
+	 * @fieldThe field to return error objects on
+	 *
+	 * @return IValidationError[]
+	 */
+	array function getFieldErrors(required string field);
 
 	/**
-	* Get a collection of metadata about the validation results
-	*/
+	 * Get a collection of metadata about the validation results
+	 */
 	struct function getResultMetadata();
 
 	/**
-	* Set a collection of metadata into the results object
-	*/
-	IValidationResult function setResultMetadata(required struct data);
+	 * Set a collection of metadata into the results object
+	 *
+	 * @return IValidationResult
+	 */
+	any function setResultMetadata(required struct data);
 
 }

models/result/ValidationError.cfc

@@ -4,7 +4,7 @@
  * ---
  * The ColdBox validation error, all inspired by awesome Hyrule Validation Framework by Dan Vega
  */
-component accessors="true" implements="cbvalidation.models.result.IValidationError" {
+component accessors="true" {
 
 	// constructor
 	ValidationError function init(){
@@ -20,8 +20,10 @@ component accessors="true" implements="cbvalidation.models.result.IValidationErr
 	/**
 	 * Set error metadata that can be used in i18n message replacements or in views
 	 * @data The name-value pairs of data to store in this error.
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function setErrorMetadata( required any data ){
+	any function setErrorMetadata( required any data ){
 		errorMetadata = arguments.data;
 		return this;
 	}
@@ -36,8 +38,10 @@ component accessors="true" implements="cbvalidation.models.result.IValidationErr
 	/**
 	 * Set the validator data
 	 * @data The data of the validator
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function setValidationData( required any data ){
+	any function setValidationData( required any data ){
 		validationData = arguments.data;
 		return this;
 	}
@@ -53,35 +57,43 @@ component accessors="true" implements="cbvalidation.models.result.IValidationErr
 	/**
 	 * Set the error message
 	 * @message The error message
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function setMessage( required string message ){
+	any function setMessage( required string message ){
 		variables.message = arguments.message;
 		return this;
 	}
 
 	/**
 	 * Set the field
 	 * @message The error message
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function setField( required string field ){
+	any function setField( required string field ){
 		variables.field = arguments.field;
 		return this;
 	}
 
 	/**
 	 * Set the rejected value
 	 * @value The rejected value
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function setRejectedValue( required any value ){
+	any function setRejectedValue( required any value ){
 		variables.rejectedValue = arguments.value;
 		return this;
 	}
 
 	/**
 	 * Set the validator type name that rejected
 	 * @validationType The name of the rejected validator
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function setValidationType( required any validationType ){
+	any function setValidationType( required any validationType ){
 		variables.validationType = arguments.validationType;
 		return this;
 	}
@@ -135,8 +147,10 @@ component accessors="true" implements="cbvalidation.models.result.IValidationErr
 	 * @field The required field that case the exception
 	 * @rejectedValue The optional rejected value
 	 * @validationType The name of the rejected validator
+	 *
+	 * @return IValidationError
 	 */
-	IValidationError function configure(
+	any function configure(
 		required string message,
 		required string field,
 		string rejectedValue,