Merge branch 'development'

Author: lmajano

.cfformat.json

@@ -0,0 +1,29 @@
+{
+    "brackets.padding": true,
+	"strings.quote": "double",
+	"strings.attributes.quote": "double",
+	"function_call.empty_padding": false,
+    "function_call.padding": true,
+	"function_declaration.padding": true,
+	"function_call.multiline.leading_comma.padding": true,
+	"function_declaration.multiline.leading_comma.padding" : true,
+	"function_declaration.empty_padding": false,
+	"function_declaration.group_to_block_spacing": "compact",
+	"struct.padding": true,
+	"struct.empty_padding": false,
+	"struct.multiline.leading_comma.padding" : true,
+	"array.empty_padding":false,
+    "array.padding":true,
+    "array.multiline.leading_comma.padding":true,
+    "binary_operators.padding":true,
+    "for_loop_semicolons.padding":true,
+    "indent_size":4,
+    "parentheses.padding":true,
+    "struct.separator":" : ",
+	"tab_indent":true,
+	"keywords.block_to_keyword_spacing" : "spaced",
+	"keywords.group_to_block_spacing" : "spaced",
+	"keywords.padding_inside_group" : true,
+	"keywords.spacing_to_block" : "compact",
+	"keywords.spacing_to_group" : true
+}

.travis.yml

@@ -26,14 +26,14 @@ sudo: required
 before_install:
   # CommandBox Keys
   - curl -fsSl https://downloads.ortussolutions.com/debs/gpg | sudo apt-key add -
-  - sudo echo "deb http://downloads.ortussolutions.com/debs/noarch /" | sudo tee -a
+  - sudo echo "deb https://downloads.ortussolutions.com/debs/noarch /" | sudo tee -a
     /etc/apt/sources.list.d/commandbox.list
 
 install:
   # Install Commandbox
   - sudo apt-get update && sudo apt-get --assume-yes install rsync jq commandbox
   # Install CommandBox Supporting Librarires
-  - box install commandbox-cfconfig,commandbox-dotenv,commandbox-docbox
+  - box install commandbox-cfconfig,commandbox-dotenv,commandbox-docbox,commandbox-cfformat
   # If using auto-publish, you will need to provide your API token with this line:
   - box config set endpoints.forgebox.APIToken=$FORGEBOX_API_TOKEN > /dev/null
 

box.json

@@ -1,12 +1,12 @@
 {
     "name":"ColdBox Validation",
-    "author":"Ortus Solutions.com <[email protected]",
-    "version":"1.4.1",
+    "author":"Ortus Solutions <[email protected]>",
+    "version":"1.5.0",
     "location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cbvalidation/@build.version@/[email protected]@.zip",
     "slug":"cbvalidation",
     "type":"modules",
     "homepage":"https://github.com/coldbox-modules/cbvalidation",
-    "documentation":"https://github.com/coldbox-modules/cbvalidation/wiki",
+    "documentation":"https://coldbox-validation.ortusbooks.com/",
     "repository":{
         "type":"git",
         "url":"https://github.com/coldbox-modules/cbvalidation"
@@ -23,7 +23,7 @@
         "Curt Gratz <[email protected]>"
     ],
     "dependencies":{
-        "cbi18n":"^1.3.1"
+        "cbi18n":"^1.4.0"
     },
     "ignore":[
         "**/.*",

build/Build.cfc

@@ -56,6 +56,8 @@ component{
         buildID=createUUID(),
         branch="development"
     ){
+		// Create project mapping
+		fileSystemUtil.createMapping( arguments.projectName, variables.cwd );
 
         // Run the tests
         runTests();
@@ -76,7 +78,7 @@ component{
             .toConsole();
     }
 
-     /**
+    /**
      * Run the test suites
      */
     function runTests(){

changelog.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 1.5.0
+
+* `features` : `validateOrFail()` new method to validate and if it fails it will throw a `ValidationException`. Also if the target is an object, the object is returned. If the target is a struct, the struct is returned ONLY with the validated fields.
+* `feature` : `validateModel()` is now deprecated in favor of `validate()`.  `validateModel()` is now marked for deprecation.
+* `improvement` : Direct scoping for performance an avoidance of lookup bugs
+* `improvement` : HTTPS protocol for everything
+* `improvement` : Updated to testbox 3
+* `bug` : Fix mapping declaration for apidocs`
+* `bug` : Missing return on `addSharedConstraint()` function
+
+
 ## 1.4.1
 
 * Location protocol

models/GenericObject.cfc

@@ -1,30 +1,41 @@
 /**
-********************************************************************************
-Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
-www.coldbox.org | www.luismajano.com | www.ortussolutions.com
-********************************************************************************
-A generic object that can simulate an object getters from a collection structure.
-Great for when you want to validate a form that is not represented by an object.
-*/
+ * *******************************************************************************
+ * Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
+ * www.ortussolutions.com
+ * *******************************************************************************
+ * Great for when you want to validate a form that is not represented by an object.
+ * A generic object that can simulate an object getters from a collection structure.
+ */
 component{
 
-	// constructor
+	/**
+	 * Constructor
+	 *
+	 * @memento The struct to represent
+	 */
 	GenericObject function init( struct memento=structNew() ){
-		collection = arguments.memento;
+		variables.collection = arguments.memento;
 		return this;
 	}
 
-	// Get the object's collection memento
+	/**
+	 * Retrieve the collection
+	 */
 	any function getMemento(){
-		return collection;
+		return variables.collection;
 	}
 
-	// Process getters and setters
+	/**
+	 * Process dynamic getters
+	 *
+	 * @missingMethodName
+	 * @missingMethodArguments
+	 */
 	any function onMissingMethod( required string missingMethodName, required struct missingMethodArguments ){
-		var key = replacenocase( arguments.missingMethodName, "get","");
+		var key = replacenocase( arguments.missingMethodName, "get", "" );
 
-		if( structKeyExists( collection, key ) ){
-			return collection[ key ];
+		if( structKeyExists( variables.collection, key ) ){
+			return variables.collection[ key ];
 		}
 
 		// Return null

models/IValidationManager.cfc

@@ -1,47 +1,61 @@
 /**
-********************************************************************************
-Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
-www.coldbox.org | www.luismajano.com | www.ortussolutions.com
-********************************************************************************
-The ColdBox validation manager interface, all inspired by awesome Hyrule Validation Framework by Dan Vega
-*/
+ * *******************************************************************************
+ * Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
+ * www.ortussolutions.com
+ * *******************************************************************************
+ * The ColdBox validation manager interface, all inspired by awesome Hyrule Validation Framework by Dan Vega
+ */
 import cbvalidation.models.*;
 import cbvalidation.models.result.*;
 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
-	* @excludeFieldsAn optional list of fields to exclude from the validation.
-	* @includeFieldsAn optional list of fields to include in the validation.
-	*/
-	IValidationResult function validate( required any target, string fields, any constraints, string locale="", string excludeFields="", string includeFields="" );
+	 * 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
+	 * @excludeFieldsAn optional list of fields to exclude from the validation.
+	 * @includeFieldsAn optional list of fields to include in the validation.
+	 *
+	 * @result ValidationResult object
+	 */
+	IValidationResult function validate(
+		required any target,
+		string fields,
+		any constraints,
+		string locale="",
+		string excludeFields="",
+		string includeFields=""
+	);
 
 	/**
-	* Retrieve the shared constraints
-	* @nameFilter by name or not
-	*/
+	 * Retrieve the shared constraints
+	 *
+	 * @nameFilter by name or not
+	 */
 	struct function getSharedConstraints( string name );
 
 	/**
-	* Check if a shared constraint exists by name
-	* @nameThe shared constraint to check
-	*/
+	 * Check if a shared constraint exists by name
+	 *
+	 * @nameThe shared constraint to check
+	 */
 	boolean function sharedConstraintsExists( required string name );
 
 	/**
-	* Set the shared constraints into the validation manager, usually these are described in the ColdBox configuraiton file
-	* @constraintsFilter by name or not
-	*/
+	 * Set the shared constraints into the validation manager, usually these are described in the ColdBox configuraiton file
+	 *
+	 * @constraintsFilter by name or not
+	 */
 	IValidationManager function setSharedConstraints( struct constraints );
 
 	/**
-	* Store a shared constraint
-	* @nameFilter by name or not
-	* @constraintThe constraint to store.
-	*/
+	 * Store a shared constraint
+	 *
+	 * @nameFilter by name or not
+	 * @constraintThe constraint to store.
+	 */
 	IValidationManager function addSharedConstraint( required string name, required struct constraint );
 }

models/Mixins.cfm

@@ -1,16 +1,51 @@
 <cfscript>
 
 /**
-* 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
-*/
+ * 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(){
+	return getValidationManager().validate( argumentCollection=arguments );
+}
+
+/**
+ * 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(){
+	return getValidationManager().validateOrFail( argumentCollection=arguments );
+}
+
+/**
+ * Retrieve the application's configured Validation Manager
+ */
+function getValidationManager(){
+	return wirebox.getInstance( "ValidationManager@cbvalidation" );
+}
+
+/**
+ * @deprecated
+ *
+ * Marked for deprecation, use `validate()` instead
+ */
 function validateModel(
 	required any target,
 	string fields="*",
@@ -19,14 +54,7 @@ function validateModel(
 	string excludeFields="",
 	string includeFields=""
 ){
-	return getValidationManager().validate( argumentCollection=arguments );
+	return this.validate( argumentCollection=arguments );
 }
 
-/**
-* Retrieve the application's configured Validation Manager
-*/
-function getValidationManager(){
-	return wirebox.getInstance( "ValidationManager@cbvalidation" );
-} 
-
 </cfscript>