getting ready for final release

Author: lmajano

config/Coldbox.cfc

@@ -23,7 +23,7 @@
 			missingTemplateHandler	= "",
 
 			//Extension Points
-			ApplicationHelper 				= "",
+			UDFLibraryFile 				= "",
 			coldboxExtensionsLocation 	= "",
 			modulesExternalLocation		= [],
 			pluginsExternalLocation 	= "",

modules/validation/ModuleConfig.cfc

@@ -11,7 +11,7 @@ component{
 	this.author 			= "Luis Majano";
 	this.webURL 			= "http://www.ortussolutions.com";
 	this.description 		= "This module provides server-side validation to ColdBox applications";
-	this.version			= "1.0.0.@build.number@";
+	this.version			= "1.0.0+@build.number@";
 	// If true, looks for views in the parent first, if not found, then in the module. Else vice-versa
 	this.viewParentLookup 	= true;
 	// If true, looks for layouts in the parent first, if not found, then in module. Else vice-versa
@@ -33,7 +33,7 @@ component{
 	function configure(){
 
 		// Mixin our own methods on handlers, interceptors and views via the ColdBox UDF Library File setting
-		arrayAppend( controller.getSetting( "ApplicationHelper" ), "#moduleMapping#/models/Mixins.cfm" );
+		arrayAppend( controller.getSetting( "UDFLibraryFile" ), "#moduleMapping#/models/Mixins.cfm" );
 
 		// Validation Settings
 		settings = {
@@ -56,15 +56,15 @@ component{
 		var configSettings = controller.getConfigSettings();
 		// parse parent settings
 		parseParentSettings();
-		// setup shared constraints
-		wirebox.getInstance( "validationManager@validation" )
-			.setSharedConstraints( configSettings.validation.sharedConstraints );
-		// Did you change the manager
+		// Did you change the validation manager?
 		if( configSettings.validation.manager != this.COLDBOX_VALIDATION_MANAGER ){
-			map( "validationManager@validation" )
+			binder.map( "validationManager@validation" )
 				.to( configSettings.validation.manager )
 				.asSingleton();
 		}
+		// setup shared constraints
+		wirebox.getInstance( "validationManager@validation" )
+			.setSharedConstraints( configSettings.validation.sharedConstraints );
 
 	}
 

modules/validation/box.json

@@ -1,7 +1,7 @@
 {
 	"name" 		: "ColdBox Validation",
 	"author" 	: "Luis Majano <[email protected]",
-	"version"	: "1.0.0.@build.number@",
+	"version"	: "1.0.0+@build.number@",
 	"slug"		: "validation",
 	"type"		: "modules",
 	"homepage"	: "http://www.coldbox.org",
@@ -16,7 +16,7 @@
 	],
 	"engines"	: [
 		{ "type" : "railo", "version" : ">4.1" },
-		{ "type" : "adobe", "version" : ">9.02" },
+		{ "type" : "adobe", "version" : ">9.02" }
 	],
 	"dependencies" 	:{
 		"i18n" : "1.0.0"

modules/validation/changelog.md

@@ -0,0 +1,5 @@
+CHANGELOG
+=========
+
+##1.0.0
+* Create first module version

modules/validation/changelog.txt

@@ -0,0 +1,49 @@
+INSTRUCTIONS
+============
+
+Just drop into your **modules** folder or use the box-cli to install
+
+`box install validation`
+
+The module will register several objects into WireBox using the `@validation` namespace.  The validation manager is registered as `ValidationManager@validation`
+
+## Mixins
+The module will also register two 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 in the validation
+* 
+* @return cbvalidation.model.result.IValidationResult
+*/
+function validateModel()
+
+/**
+* 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: http://wiki.coldbox.org/wiki/Validation.cfm

modules/validation/instructions.md

@@ -1,14 +1,30 @@
-<!--- validateModel --->
-<cffunction name="validateModel" output="false" access="public" returntype="any" hint="Validate a target object">
-	<cfargument name="target" 		type="any" 		required="true" hint="The target object to validate or a structure of name-value paris to validate."/>
-	<cfargument name="fields" 		type="string" 	required="false" default="*" hint="Validate on all or one or a list of fields (properties) on the target, by default we validate all fields declared in its constraints"/>
-	<cfargument name="constraints" 	type="any" 		required="false" hint="The shared constraint name to use, or an actual constraints structure"/>
-	<cfargument name="locale"		type="string" 	required="false" default="" hint="The locale to validate in"/>
-	<cfargument name="excludeFields" type="string" 	required="false" default="" hint="The fields to exclude in the validation"/>
-	<cfreturn getValidationManager().validate( argumentCollection=arguments )>
-</cffunction>
+<cfscript>
 
-<!--- Retrieve the applications Validation Manager --->
-<cffunction name="getValidationManager" access="public" returntype="any" output="false" hint="Retrieve the application's configured Validation Manager">
-	<cfreturn wirebox.getInstance( "ValidationManager@validation" )>
-</cffunction>
+/**
+* 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 in the validation
+* 
+* @return cbvalidation.model.result.IValidationResult
+*/
+function validateModel(
+	required any target,
+	string fields="*",
+	any constraints,
+	string locale="",
+	string excludeFields=""
+){
+	return getValidationManager().validate( argumentCollection=arguments );
+}
+
+/**
+* Retrieve the application's configured Validation Manager
+*/
+function getValidationManager(){
+	return wirebox.getInstance( "ValidationManager@validation" );	
+} 
+
+</cfscript>

modules/validation/instructions.txt

@@ -0,0 +1,32 @@
+WELCOME TO THE COLDBOX VALIDATION MODULE
+========================================
+ColdBox sports its own server side validation engine so it can provide you with a unified approach to object and form validation.
+
+##LICENSE
+Apache License, Version 2.0.
+
+##IMPORTANT LINKS
+- https://github.com/ColdBox/cbox-validation
+- http://www.coldbox.org/forgebox/validation
+- http://wiki.coldbox.org/wiki/Validation.cfm
+
+##SYSTEM REQUIREMENTS
+- Railo 4+
+- ColdFusion 9+
+
+********************************************************************************
+Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
+www.coldbox.org | www.luismajano.com | www.ortussolutions.com
+********************************************************************************
+####HONOR GOES TO GOD ABOVE ALL
+Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.
+
+>"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ:
+By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God.
+And not only so, but we glory in tribulations also: knowing that tribulation worketh patience;
+And patience, experience; and experience, hope:
+And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the 
+Holy Ghost which is given unto us. ." Romans 5:5
+
+###THE DAILY BREAD
+ > "I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12