Merge branch 'development' of github.com:coldbox-modules/cbox-validation into development

Author: lmajano

models/validators/InstanceOfValidator.cfc

@@ -0,0 +1,63 @@
+/**
+ * Copyright since 2020 by Ortus Solutions, Corp
+ * www.ortussolutions.com
+ * ---
+ * This validator verifies field type
+ */
+component extends="BaseValidator" accessors="true" singleton {
+
+	/**
+	 * Constructor
+	 */
+	InstanceOfValidator function init(){
+		variables.name       = "InstanceOf";
+		return this;
+	}
+
+	/**
+	 * Will check if an incoming instance type
+	 *
+	 * @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
+	 * @rules            The rules imposed on the currently validating field
+	 */
+	boolean function validate(
+		required any validationResult,
+		required any target,
+		required string field,
+		any targetValue,
+		any validationData,
+		struct rules
+	){
+		// return true if no data to check, type needs a data element to be checked.
+		if ( isNull( arguments.targetValue ) || isNullOrEmpty( arguments.targetValue ) ) {
+			return true;
+		}
+
+		// value is valid if it is an object and of the correct type
+		var r = ( 
+			isObject( arguments.targetValue ) && 
+			isInstanceOf( arguments.targetValue, arguments.validationData ) 
+		);
+
+		if ( !r ) {
+			var args = {
+				message        : "The '#arguments.field#' has an invalid instance type, expected type is #arguments.validationData#",
+				field          : arguments.field,
+				validationType : getName(),
+				rejectedValue  : ( isSimpleValue( arguments.targetValue ) ? arguments.targetValue : "" ),
+				validationData : arguments.validationData
+			};
+			var error = validationResult
+				.newError( argumentCollection = args )
+				.setErrorMetadata( { "type" : arguments.validationData } );
+			validationResult.addError( error );
+		}
+
+		return r;
+	}
+
+}

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

@@ -0,0 +1,108 @@
+/**
+ * *******************************************************************************
+ * *******************************************************************************
+ */
+component extends="coldbox.system.testing.BaseModelTest" model="cbvalidation.models.validators.InstanceOfValidator" {
+
+	// executes before all suites+specs in the run() method
+	function beforeAll(){
+		super.setup();
+		model.init();
+	}
+
+	// executes after all suites+specs in the run() method
+	function afterAll(){
+	}
+
+	/*********************************** BDD SUITES ***********************************/
+
+	function run( testResults, testBox ){
+		// all your suites go here.
+		describe( "InstanceOf", function(){
+			beforeEach( function( currentSpec ){
+				result = createMock( "cbvalidation.models.result.ValidationResult" ).init();
+			} );
+
+			it( "validates true when expecting a User and receives a User", function(){
+				
+                var user = createMock( "root.models.User" ).init();
+                
+                expect(
+					model.validate(
+						validationResult: result,
+						target          : this,
+						field           : "testField",
+						targetValue     : user,
+						validationData  : "user",
+						rules           : {}
+					)
+				).toBeTrue();
+			} );
+
+            it( "validates false when expecting a Car and receives a User", function(){
+				
+                var user = createMock( "root.models.User" ).init();
+                
+                expect(
+					model.validate(
+						validationResult: result,
+						target          : this,
+						field           : "testField",
+						targetValue     : user,
+						validationData  : "car",
+						rules           : {}
+					)
+				).toBeFalse();
+			} );
+
+            it( "validates true when passed nothing", function(){
+                
+                expect(
+					model.validate(
+						validationResult: result,
+						target          : this,
+						field           : "testField",
+						targetValue     : "",
+						validationData  : "car",
+						rules           : {}
+					)
+				).toBeTrue();
+			} );
+
+            it( "validates false when passed a non-object", function(){
+                
+                expect(
+					model.validate(
+						validationResult: result,
+						target          : this,
+						field           : "testField",
+						targetValue     : "not an object", // not an object
+						validationData  : "car",
+						rules           : {}
+					)
+				).toBeFalse();
+                expect(
+					model.validate(
+						validationResult: result,
+						target          : this,
+						field           : "testField",
+						targetValue     : { "name": "not an object" }, // not an object
+						validationData  : "car",
+						rules           : {}
+					)
+				).toBeFalse();
+                expect(
+					model.validate(
+						validationResult: result,
+						target          : this,
+						field           : "testField",
+						targetValue     : [ 1, 2, 3 ], // not an object
+						validationData  : "car",
+						rules           : {}
+					)
+				).toBeFalse();
+			} );
+		} );
+	}
+
+}