fixed required if and unless to use struct literals

Author: lmajano

box.json

@@ -1,7 +1,7 @@
 {
     "name":"ColdBox Validation",
     "author":"Ortus Solutions <[email protected]>",
-    "version":"2.1.0",
+    "version":"2.0.1",
     "location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cbvalidation/@build.version@/[email protected]@.zip",
     "slug":"cbvalidation",
     "type":"modules",

changelog.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.0.1
+
+* Updated `RequiredUnless` and `RequiredIf` to use struct literal notation instead of the weird parsing we did.
+
 ## 2.0.0
 
 ### Features

models/validators/RequiredIfValidator.cfc

@@ -2,7 +2,8 @@
  * Copyright since 2020 by Ortus Solutions, Corp
  * www.ortussolutions.com
  * ---
- * This validator checks if a field has value and not null
+ * This validator checks a struct of key-value pairs passed in the validation data.
+ * If those key-value pairs are equal then the target field will be required
  */
 component accessors="true" extends="RequiredValidator" singleton {
 
@@ -18,11 +19,12 @@ component accessors="true" extends="RequiredValidator" singleton {
 
 	/**
 	 * Will check if an incoming value validates
-	 * @validationResultThe result object of the validation
-	 * @targetThe target object to validate on
-	 * @fieldThe field on the target object to validate on
-	 * @targetValueThe target value to validate
-	 * @validationDataThe validation data the validator was created with
+	 *
+	 * @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
+	 * @validationData The validation data the validator was created with
 	 */
 	boolean function validate(
 		required any validationResult,
@@ -31,24 +33,25 @@ component accessors="true" extends="RequiredValidator" singleton {
 		any targetValue,
 		any validationData
 	){
-		// Validation Data Format: property:value,...
-		var validationArray = arguments.validationData.listToArray();
+		// If you passed in simple data, conver it to a struct, simple values are not evaluated
+		if( isSimpleValue( arguments.validationData ) ){
+			arguments.validationData = {};
+		}
+
 		// Inflate to array to test multiple properties
-		var isRequired = validationArray
-			.map( function( item ){
+		var isRequired = arguments.validationData
+			.map( function( key, value ){
 				// Get comparison values
-				var compareProperty 		= getToken( arguments.item, 1, ":" );
-				var compareValue 			= getToken( arguments.item, 2, ":" );
-				var comparePropertyValue 	= invoke( target, "get#compareProperty#" );
+				var comparePropertyValue = invoke( target, "get#key#" );
 				// Check if the compareValue is the same as the defined one
-				return ( compareValue == comparePropertyValue ? true : false );
+				return ( arguments.value == comparePropertyValue ? true : false );
 			} )
 			// AND them all for a single result
-			.reduce( function( result, item ){
-				return arguments.result && arguments.item;
+			.reduce( function( result, key, value ){
+				return ( arguments.value && arguments.result );
 			}, true );
 
-		if( !validationArray.len() || !isRequired ){
+		if( !arguments.validationData.count() || !isRequired ){
 			return true;
 		}
 

models/validators/RequiredUnlessValidator.cfc

@@ -2,7 +2,8 @@
  * Copyright since 2020 by Ortus Solutions, Corp
  * www.ortussolutions.com
  * ---
- * This validator checks if a field has value and not null
+ * This validator checks a struct of key-value pairs passed in the validation data.
+ * If those key-value pairs are equal then the target field will NOT be required
  */
 component accessors="true" extends="RequiredValidator" singleton {
 
@@ -18,11 +19,12 @@ component accessors="true" extends="RequiredValidator" singleton {
 
 	/**
 	 * Will check if an incoming value validates
-	 * @validationResultThe result object of the validation
-	 * @targetThe target object to validate on
-	 * @fieldThe field on the target object to validate on
-	 * @targetValueThe target value to validate
-	 * @validationDataThe validation data the validator was created with
+	 *
+	 * @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
+	 * @validationData The validation data the validator was created with
 	 */
 	boolean function validate(
 		required any validationResult,
@@ -31,24 +33,26 @@ component accessors="true" extends="RequiredValidator" singleton {
 		any targetValue,
 		any validationData
 	){
-		// Validation Data Format: property:value,...
-		var validationArray = arguments.validationData.listToArray();
-		// Inflate to array to test multiple properties
-		var isOptional = validationArray
-			.map( function( item ){
+		// If you passed in simple data, conver it to a struct, simple values are not evaluated
+		if( isSimpleValue( arguments.validationData ) ){
+			arguments.validationData = {};
+		}
+
+		// Test the data
+		var isOptional = arguments.validationData
+			.map( function( key, value ){
 				// Get comparison values
-				var compareProperty 		= getToken( arguments.item, 1, ":" );
-				var compareValue 			= getToken( arguments.item, 2, ":" );
-				var comparePropertyValue 	= invoke( target, "get#compareProperty#" );
+				var comparePropertyValue = invoke( target, "get#key#" );
 				// Check if the compareValue is the same as the defined one
-				return ( compareValue == comparePropertyValue ? true : false );
+				return ( arguments.value == comparePropertyValue ? true : false );
 			} )
 			// AND them all for a single result
-			.reduce( function( result, item ){
-				return ( arguments.item && arguments.result );
+			.reduce( function( result, key, value ){
+				return ( arguments.value && arguments.result );
 			}, true );
 
-		if( validationArray.len() && isOptional ){
+		// If we have data, then test the optional
+		if( arguments.validationData.count() && isOptional ){
 			return true;
 		}
 

readme.md

@@ -25,7 +25,69 @@ Leverage CommandBox to install:
 
 `box install cbvalidation`
 
-The module will register several objects into WireBox using the `@cbvalidation` namespace.  The validation manager is registered as `ValidationManager@cbvalidation`.  It will also register several helper methods that can be used throughout the ColdBox application.
+The module will register several objects into WireBox using the `@cbvalidation` namespace.  The validation manager is registered as `ValidationManager@cbvalidation`.  It will also register several helper methods that can be used throughout the ColdBox application: `validate(), validateOrFail(), getValidationManager()`
+
+## Mixins
+
+The module will also register several methods in your handlers/interceptors/layouts/views
+
+```js
+/**
+ * Validate an object or structure according to the constraints rules.
+ *
+ * @target An object or structure to validate
+ * @fields The fields to validate on the target. By default, it validates on all fields
+ * @constraints A structure of constraint rules or the name of the shared constraint rules to use for validation
+ * @locale The i18n locale to use for validation messages
+ * @excludeFields The fields to exclude from the validation
+ * @includeFields The fields to include in the validation
+ *
+ * @return cbvalidation.model.result.IValidationResult
+ */
+function validate()
+
+/**
+ * Validate an object or structure according to the constraints rules and throw an exception if the validation fails.
+ * The validation errors will be contained in the `extendedInfo` of the exception in JSON format
+ *
+ * @target An object or structure to validate
+ * @fields The fields to validate on the target. By default, it validates on all fields
+ * @constraints A structure of constraint rules or the name of the shared constraint rules to use for validation
+ * @locale The i18n locale to use for validation messages
+ * @excludeFields The fields to exclude from the validation
+ * @includeFields The fields to include in the validation
+ *
+ * @return The validated object or the structure fields that where validated
+ * @throws ValidationException
+ */
+function validateOrFail()
+
+/**
+ * Retrieve the application's configured Validation Manager
+ */
+function getValidationManager()
+```
+
+## Settings
+
+Here are the module settings you can place in your `ColdBox.cfc` by using the `validation` settings structure:
+
+```js
+validation = {
+    // The third-party validation manager to use, by default it uses CBValidation.
+    manager = "class path",
+    
+    // You can store global constraint rules here with unique names
+    sharedConstraints = {
+        name = {
+            field = { constraints here }
+        }
+    }
+
+}
+```
+
+You can read more about ColdBox Validation here: - https://coldbox-validation.ortusbooks.com/
 
 ## Constraints
 
@@ -68,10 +130,14 @@ this.constraints = {
 		required : boolean [false],
 
 		// The field under validation must be present and not empty if the `anotherfield` field is equal to the passed `value`.
-		requiredIf : anotherfield:value,anotherfield:value,...
+		requiredIf : {
+			anotherfield:value, anotherfield:value
+		}
 
 		// The field under validation must be present and not empty unless the `anotherfield` field is equal to the passed 
-		requiredUnless : anotherfield:value,anotherfield:value,...
+		requiredUnless : {
+			anotherfield:value, anotherfield:value
+		}
 
 		// same as but with no case
 		sameAsNoCase : propertyName
@@ -95,70 +161,6 @@ this.constraints = {
 }
 ```
 
-## Mixins
-
-The module will also register several methods in your handlers/interceptors/layouts/views
-
-```js
-/**
- * Validate an object or structure according to the constraints rules.
- *
- * @target An object or structure to validate
- * @fields The fields to validate on the target. By default, it validates on all fields
- * @constraints A structure of constraint rules or the name of the shared constraint rules to use for validation
- * @locale The i18n locale to use for validation messages
- * @excludeFields The fields to exclude from the validation
- * @includeFields The fields to include in the validation
- *
- * @return cbvalidation.model.result.IValidationResult
- */
-function validate()
-
-/**
- * Validate an object or structure according to the constraints rules and throw an exception if the validation fails.
- * The validation errors will be contained in the `extendedInfo` of the exception in JSON format
- *
- * @target An object or structure to validate
- * @fields The fields to validate on the target. By default, it validates on all fields
- * @constraints A structure of constraint rules or the name of the shared constraint rules to use for validation
- * @locale The i18n locale to use for validation messages
- * @excludeFields The fields to exclude from the validation
- * @includeFields The fields to include in the validation
- *
- * @return The validated object or the structure fields that where validated
- * @throws ValidationException
- */
-function validateOrFail()
-
-/**
- * Retrieve the application's configured Validation Manager
- */
-function getValidationManager()
-```
-
-## Settings
-
-Here are the module settings you can place in your `ColdBox.cfc` by using the `validation` settings structure:
-
-```js
-validation = {
-    // The third-party validation manager to use, by default it uses CBValidation.
-    manager = "class path",
-    
-    // You can store global constraint rules here with unique names
-    sharedConstraints = {
-        name = {
-            field = { constraints here }
-        }
-    }
-
-}
-```
-
-You can read more about ColdBox Validation here: - https://coldbox-validation.ortusbooks.com/
-
----
-
 ```
 ********************************************************************************
 Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp

test-harness/tests/specs/validators/RequiredIfValidatorTest.cfc

@@ -29,22 +29,35 @@ component extends="coldbox.system.testing.BaseModelTest" model="cbvalidation.mod
 				var result = createMock( "cbvalidation.models.result.ValidationResult" ).init();
 
 				expect(
-					model.validate( result, mock, "testField", "", "name:luis" )
+					model.validate( result, mock, "testField", "", {
+						name : "luis"
+					} )
 				).toBeFalse();
 
 				expect(
-					model.validate( result, mock, "testField", "", "name:luis,role:admin" )
+					model.validate( result, mock, "testField", "", {
+						name : "luis",
+						role : "admin"
+					} )
 				).toBeFalse();
 				expect(
-					model.validate( result, mock, "testField", "test", "name:luis,role:admin" )
+					model.validate( result, mock, "testField", "test", {
+						name : "luis",
+						role : "admin"
+					} )
 				).toBeTrue();
 
 				expect(
-					model.validate( result, mock, "testField", "shouldPass", "name:luis,role:admin" )
+					model.validate( result, mock, "testField", "shouldPass", {
+						name : "luis",
+						role : "admin"
+					} )
 				).toBeTrue();
 
 				expect(
-					model.validate( result, mock, "testField", "", "name:luis" )
+					model.validate( result, mock, "testField", "", {
+						name : "luis"
+					} )
 				).toBeFalse();