Merge pull request #12 from FieldVal/develop

Changed error structure to use only "invalid"

Author: MarcusLongmuir

bower.json

@@ -1,6 +1,6 @@
 {
 	"name": "fieldval",
-	"version": "0.3.1",
+	"version": "0.4.0",
 	"main": "fieldval.js",
 	"ignore": [
 		"coverage",

docs/fieldval.json

@@ -0,0 +1,27 @@
+var validator = new FieldVal({
+    my_number: 56,
+    my_email: "test@example.com"
+});
+
+validator.get_async(
+	"my_email",
+	[
+		BasicVal.email({required: true}),
+		function(val,emit,done){
+			setTimeout(function(){
+				done({
+					"error_message": "I couldn't find that email address"
+				})
+			},500);
+		}
+	],
+	function(my_email){
+		console.log("my_email: ",my_email);
+	}
+);
+
+var my_number = validator.get("my_number", BasicVal.number({required:true}));
+
+validator.end(function(error){
+	console.log(error);
+});

docs_src/Async/Async.code

@@ -0,0 +1,13 @@
+Requiring an asynchronous action to validate a parameter is a common validation scenario.
+
+To use asynchronous checks, call ```.get_async(key_name, check_array, [callback])``` on the FieldVal instance.
+
+```check_array``` is an array of checks and ```callback``` is a function to call after validation has finished.
+
+You can use synchronous ```.get``` and asynchronous ```.get_async``` within the same FieldVal instance.
+
+Synchronous checks work with ```.get_async```, but asynchronous checks will not work with ```.get```.
+
+The ```.end``` function of the FieldVal instance takes a callback that will be called with the error if one is present.
+
+```.end``` waits for all fields to finish validating before calling the callback.

docs_src/Async/Async.md

@@ -0,0 +1,31 @@
+var validator = new FieldVal({
+    my_number: 56,
+    my_email: "test@example.com"
+});
+
+validator.get_async(
+	"my_email",
+	[
+		BasicVal.email({required: true}),
+		function(val,emit,done){
+			setTimeout(function(){
+				done({
+					"error_message": "I couldn't find that email address"
+				});
+			},500);
+		}
+	],
+	function(my_email){
+		var element = document.createElement("div");
+		element.innerHTML = "my_email: "+my_email
+		document.body.appendChild(element);
+	}
+);
+
+var my_number = validator.get("my_number", BasicVal.number({required:true}));
+
+validator.end(function(error){
+	var element = document.createElement("pre");
+	element.innerHTML = JSON.stringify(error, null, 4);
+	document.body.appendChild(element);
+});

docs_src/Async/Async_runnable.code

@@ -1,7 +1,5 @@
 ```BasicVal.each(on_each, [flags])```
 
-Iterates through the array value and calls ```on_each``` function on each value.
-
 Iterates through the provided array and calls the ```on_each``` function on each array's value.
 
 ```on_each(value, index, emit)```

docs_src/BasicVal/OtherChecks/each/each.md

@@ -0,0 +1,28 @@
+//CODE
+var validator = new FieldVal({
+	an_array: [44, 56, 3]
+});
+
+validator.get_async(
+	'an_array',
+	[
+		BasicVal.array(true),
+		BasicVal.each_async(function(val,index,emit,done){
+			setTimeout(function(){
+				var error = BasicVal.integer().check(val); 
+				if(error){
+					done(error);
+					return;
+				}
+				
+				done(BasicVal.minimum(40).check(val));
+			},1);
+		})
+	]
+)
+
+validator.end(function(error){
+	var element = document.createElement("pre");
+	element.innerHTML = JSON.stringify(error, null, 4);
+	document.body.appendChild(element);
+});

docs_src/BasicVal/OtherChecks/each_async/each_async.code

@@ -0,0 +1,7 @@
+```BasicVal.each_async(on_each, [flags])```
+
+Iterates through the provided array and calls the ```on_each``` function on each array's value. The ```on_each``` function for ```each_async``` uses a callback to provide its response.
+
+```on_each(value, index, emit, done)```
+
+The provided function should call ```done``` with a FieldVal [error](/docs/fieldval/Errors) or with no arguments if there are no errors.

docs_src/BasicVal/OtherChecks/each_async/each_async.md

@@ -0,0 +1,27 @@
+var validator = new FieldVal({
+	an_array: [44, 56, 3]
+});
+
+validator.get_async(
+	'an_array',
+	[
+		BasicVal.array(true),
+		BasicVal.each_async(function(val,index,emit,done){
+			setTimeout(function(){
+				var error = BasicVal.integer().check(val); 
+				if(error){
+					done(error);
+					return;
+				}
+				
+				done(BasicVal.minimum(40).check(val));
+			},1);
+		})
+	]
+)
+
+validator.end(function(error){
+	var element = document.createElement("pre");
+	element.innerHTML = JSON.stringify(error, null, 4);
+	document.body.appendChild(element);
+});

docs_src/BasicVal/OtherChecks/each_async/each_async_runnable.code

@@ -0,0 +1,26 @@
+var validator = new FieldVal({
+	value: 15//Change to 20 to successfully pass .minimum check
+});
+
+validator.get_async(
+	'value',
+	[
+		BasicVal.multiple_async([
+			[
+				BasicVal.integer(),function(val,emit,done){
+				  setTimeout(function(){
+					done(BasicVal.minimum(20).check(val));
+				  },1);
+				}
+			],
+			[
+				BasicVal.prefix("abc")
+			]
+		])
+	]
+)
+
+validator.end(function(error){
+	console.log(error);
+});
+