cfformatting

Author: lmajano

.cfformat.json

@@ -1,13 +1,14 @@
 {
 	"array.empty_padding": false,
 	"array.padding": true,
-	"array.multiline.min_length": 40,
+	"array.multiline.min_length": 50,
 	"array.multiline.element_count": 2,
 	"array.multiline.leading_comma.padding": true,
 	"array.multiline.leading_comma": false,
 	"alignment.consecutive.assignments": true,
 	"alignment.consecutive.properties": true,
 	"alignment.consecutive.params": true,
+	"alignment.doc_comments" : true,
 	"brackets.padding": true,
 	"comment.asterisks": "align",
 	"binary_operators.padding": true,
@@ -17,22 +18,22 @@
 	"function_call.multiline.leading_comma.padding": true,
 	"function_call.casing.builtin": "cfdocs",
 	"function_call.casing.userdefined": "camel",
-	"function_call.multiline.element_count": 2,
+	"function_call.multiline.element_count": 3,
 	"function_call.multiline.leading_comma": false,
-	"function_call.multiline.min_length": 40,
+	"function_call.multiline.min_length": 50,
 	"function_declaration.padding": true,
 	"function_declaration.empty_padding": false,
 	"function_declaration.multiline.leading_comma": false,
 	"function_declaration.multiline.leading_comma.padding": true,
-	"function_declaration.multiline.element_count": 2,
-	"function_declaration.multiline.min_length": 40,
+	"function_declaration.multiline.element_count": 3,
+	"function_declaration.multiline.min_length": 50,
 	"function_declaration.group_to_block_spacing": "compact",
 	"function_anonymous.empty_padding": false,
 	"function_anonymous.group_to_block_spacing": "compact",
-	"function_anonymous.multiline.element_count": 2,
+	"function_anonymous.multiline.element_count": 3,
 	"function_anonymous.multiline.leading_comma": false,
 	"function_anonymous.multiline.leading_comma.padding": true,
-	"function_anonymous.multiline.min_length": 40,
+	"function_anonymous.multiline.min_length": 50,
 	"function_anonymous.padding": true,
 	"indent_size": 4,
 	"keywords.block_to_keyword_spacing": "spaced",
@@ -41,13 +42,13 @@
 	"keywords.spacing_to_block": "spaced",
 	"keywords.spacing_to_group": true,
 	"keywords.empty_group_spacing": false,
-	"max_columns": 120,
+	"max_columns": 115,
 	"metadata.multiline.element_count": 3,
-	"metadata.multiline.min_length": 40,
+	"metadata.multiline.min_length": 50,
 	"method_call.chain.multiline" : 3,
 	"newline":"\n",
 	"property.multiline.element_count": 3,
-	"property.multiline.min_length": 40,
+	"property.multiline.min_length": 30,
 	"parentheses.padding": true,
 	"strings.quote": "double",
 	"strings.attributes.quote": "double",
@@ -57,6 +58,6 @@
 	"struct.multiline.leading_comma": false,
 	"struct.multiline.leading_comma.padding": true,
 	"struct.multiline.element_count": 2,
-	"struct.multiline.min_length": 40,
+	"struct.multiline.min_length": 60,
 	"tab_indent": true
-}
+}

ModuleConfig.cfc

@@ -43,10 +43,7 @@ component {
 		// Did you change the validation manager?
 		if ( variables.settings.manager != this.COLDBOX_VALIDATION_MANAGER ) {
 			binder
-				.map(
-					alias = "validationManager@cbvalidation",
-					force = true
-				)
+				.map( alias = "validationManager@cbvalidation", force = true )
 				.to( variables.settings.manager )
 				.asSingleton();
 		}

changelog.md

@@ -7,12 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ----
 
-## [3.3.0] => 2021-NOV-12
+## [3.3.0] => 2022-JAN-12
+
+### Added
+
+* Allow UDF and Method Validators to Utilize Error Metadata by @homestar9 (https://github.com/coldbox-modules/cbvalidation/pull/48)
 
 ### Fixed
 
 * Date Comparisons Fail if Compare field is empty #58 thanks to @nockhigan: https://github.com/coldbox-modules/cbvalidation/pull/58
-* 
 
 ----
 
@@ -55,7 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Two new helpers: `validateIsNullorEmpty()` and `validateHasValue` so you can do simple validations not only on objects and constraints.
 * `RequiredIf, RequiredUnless` can now be declared with a simple value pointing to a field. Basically testing if `anotherField` exists, or unless `anotherField` exists.
 * New `BaseValidator` for usage by all validators to bring uniformity, global di, and helpers.
-  
+
 ### Changed
 
 * The `IValidator` removes the `getName()` since that comes from the `BaseValidator` now.

interfaces/IValidationError.cfc

@@ -9,24 +9,28 @@ interface {
 
 	/**
 	 * Set the error message
+	 *
 	 * @messageThe error message
 	 */
 	cbvalidation.interfaces.IValidationError function setMessage( required string message );
 
 	/**
 	 * Set the field
+	 *
 	 * @messageThe error message
 	 */
 	cbvalidation.interfaces.IValidationError function setField( required string field );
 
 	/**
 	 * Set the rejected value
+	 *
 	 * @valueThe rejected value
 	 */
 	cbvalidation.interfaces.IValidationError function setRejectedValue( required any value );
 
 	/**
 	 * Set the validator type name that rejected
+	 *
 	 * @validationTypeThe name of the rejected validator
 	 */
 	cbvalidation.interfaces.IValidationError function setValidationType( required any validationType );
@@ -38,6 +42,7 @@ interface {
 
 	/**
 	 * Set the validator data
+	 *
 	 * @dataThe data of the validator
 	 */
 	cbvalidation.interfaces.IValidationError function setValidationData( required any data );

interfaces/IValidationManager.cfc

@@ -11,10 +11,10 @@ interface {
 	/**
 	 * Validate an object
 	 *
-	 * @targetThe target object to validate
-	 * @fieldsOne or more fields to validate on, by default it validates all fields in the constraints. This can be a simple list or an array.
-	 * @constraintsAn optional shared constraints name or an actual structure of constraints to validate on.
-	 * @localeAn optional locale to use for i18n messages
+	 * @targetThe       target object to validate
+	 * @fieldsOne       or more fields to validate on, by default it validates all fields in the constraints. This can be a simple list or an array.
+	 * @constraintsAn   optional shared constraints name or an actual structure of constraints to validate on.
+	 * @localeAn        optional locale to use for i18n messages
 	 * @excludeFieldsAn optional list of fields to exclude from the validation.
 	 * @includeFieldsAn optional list of fields to include in the validation.
 	 *
@@ -55,14 +55,11 @@ interface {
 	/**
 	 * Store a shared constraint
 	 *
-	 * @nameFilter by name or not
+	 * @nameFilter    by name or not
 	 * @constraintThe constraint to store.
 	 *
 	 * @return cbvalidation.interfaces.IValidationManager
 	 */
-	any function addSharedConstraint(
-		required string name,
-		required struct constraint
-	);
+	any function addSharedConstraint( required string name, required struct constraint );
 
 }

interfaces/IValidationResult.cfc

@@ -9,7 +9,8 @@ interface {
 
 	/**
 	 * Add errors into the result object
-	 * @error The validation error to add into the results object
+	 *
+	 * @error         The validation error to add into the results object
 	 * @error_generic cbvalidation.interfaces.IValidationError
 	 *
 	 * @return cbvalidation.interfaces.IValidationResult
@@ -18,6 +19,7 @@ interface {
 
 	/**
 	 * Set the validation target object name
+	 *
 	 * @return cbvalidation.interfaces.IValidationResult
 	 */
 	any function setTargetName( required string name );
@@ -47,31 +49,36 @@ interface {
 
 	/**
 	 * Determine if the results had error or not
+	 *
 	 * @fieldThe field to count on (optional)
 	 */
 	boolean function hasErrors( string field );
 
 	/**
 	 * Clear All errors
+	 *
 	 * @return cbvalidation.interfaces.IValidationResult
 	 */
 	any function clearErrors();
 
 
 	/**
 	 * 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)
 	 */
 	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
 	 *
 	 * @return cbvalidation.interfaces.IValidationError[]

interfaces/IValidator.cfc

@@ -8,11 +8,12 @@ interface {
 
 	/**
 	 * Will check if an incoming value validates
+	 *
 	 * @validationResult The result object of the validation
-	 * @target The target object to validate on
-	 * @field The field on the target object to validate on
-	 * @targetValue The target value to validate
-	 * @rules The rules imposed on the currently validating field
+	 * @target           The target object to validate on
+	 * @field            The field on the target object to validate on
+	 * @targetValue      The target value to validate
+	 * @rules            The rules imposed on the currently validating field
 	 */
 	boolean function validate(
 		required any validationResult,

models/GenericObject.cfc

@@ -27,18 +27,11 @@ component {
 	/**
 	 * Process dynamic getters
 	 *
-	 * @missingMethodName
+	 * @missingMethodName     
 	 * @missingMethodArguments
 	 */
-	any function onMissingMethod(
-		required string missingMethodName,
-		required struct missingMethodArguments
-	){
-		var key = replaceNoCase(
-			arguments.missingMethodName,
-			"get",
-			""
-		);
+	any function onMissingMethod( required string missingMethodName, required struct missingMethodArguments ){
+		var key = replaceNoCase( arguments.missingMethodName, "get", "" );
 
 		if ( structKeyExists( variables.collection, key ) ) {
 			return variables.collection[ key ];