Ajax works and more docs

daffl · daffl · commit cfdd92c417ca · 2012-05-24T21:39:05.000-06:00
diff --git a/readme.md b/readme.md
@@ -161,7 +161,7 @@ Now generates
 ## Subscribers
 
 While type generators are being used to generate a base element for the given type, subscribers attach to
-certain attributes in the options object. When traversing the object all subscribers registered for the
+certain attributes in the options object. When traversing the object, all subscribers registered for the
 current key will be executed on the current element.
 
 ### Core subscribers
@@ -478,24 +478,29 @@ to an array of generator functions will be returned.
 
 **$.dform.addType(name, generator \[, condition\])** *{String}* *{Function}* *{Boolean}*<br />
 Add a new type with a given name and generator function which takes the options as the parameter
-and returns a new element. Optionally pass a condition which will add the type only if
-it returns true.
+and returns a new element. Optionally pass a condition which will add the type only if it is true.
 
-**$.dform.subscribe(name, subscriber \[, condition\])**<br />
-**$.dform.subscribers**<br />
+**$.dform.subscribe(name, subscriber \[, condition\])** *{String}* *{Function}* *{Boolean}*<br />
+Add a new subscriber function for a given name that takes the value and type name as the parameter and will have
+`this` set to the current element. Optionally pass as condition which will add the subscriber only if it is true.
+
+**$.dform.subscribers(\[name\])**<br />
+Returns all subscribers for a given name. If no name is given, an object containing all subscribers will
+be returned.
 
 **$.dform.hasSubscription(name)** *{String}*<br />
-Returns if there is any subscribers with the given name.
+Returns if there is at least one subscriber registered with the given name.
 
-**$.dform.createElement(options)**<br />
+**$.dform.createElement(options)** *{Object}*<br />
+Returns a new element either using a registered type generator or the default type generator.
 
 ## jQuery UI
 
 jQuery.dForm automatically adds support for whichever jQuery UI plugin is available.
 If the form has the *ui-widget* class the plugin will automatically turn buttons into jQuery UI buttons and add
 corners to *text*, *textarea*, *password* and *fieldset* elements.
 
-> Note: jQuery UI has to be loaded __before__ the plugin.
+> Note: jQuery UI has to be loaded __before__ the dForm plugin.
 
 ### Types
 
@@ -563,8 +568,7 @@ to the element:
 		}
 	}
 
-If the form has the *ui-widget* class the jQuery UI CSS error classes will be used to highlight
-invalid fields.
+If the form has the *ui-widget* class the jQuery UI CSS error classes will be used to highlight fields.
 
 ### jQuery Globalize
 
@@ -650,4 +654,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/src/dform.js b/src/dform.js
@@ -8,14 +8,14 @@
 	var _subscriptions = {},
 		_types = {},
 		each = $.each,
-		addToObject = function(obj) {
+		addToObject = function (obj) {
 			var result = function (data, fn, condition) {
-				if(typeof data === 'object') {
-					$.each(data, function(name, val) {
+				if (typeof data === 'object') {
+					$.each(data, function (name, val) {
 						result(name, val, condition);
 					});
-				} else if(condition === undefined || condition === true) {
-					if(!obj[data]) {
+				} else if (condition === undefined || condition === true) {
+					if (!obj[data]) {
 						obj[data] = [];
 					}
 					obj[data].push(fn);
@@ -30,7 +30,7 @@
 		 * @param {Object} object The object to use
 		 * @return {Array} An array containing all properties in the object
 		 */
-		keyset = function (object) {
+			keyset = function (object) {
 			return $.map(object, function (val, key) {
 				return key;
 			});
@@ -44,7 +44,7 @@
 		 * @return {Object} A new object containing only the properties
 		 * with names given in keys
 		 */
-		withKeys = function (object, keys) {
+			withKeys = function (object, keys) {
 			var result = {};
 			each(keys, function (index, value) {
 				if (object[value]) {
@@ -62,7 +62,7 @@
 		 * @return {Object} A new object with all properties of the given object, except
 		 * for the ones given in the list of keys
 		 */
-		withoutKeys = function (object, keys) {
+			withoutKeys = function (object, keys) {
 			var result = {};
 			each(object, function (index, value) {
 				if (!~$.inArray(index, keys)) {
@@ -80,7 +80,7 @@
 		 * @param {String} type The type of the current element as in the registered types
 		 * @return {Object} The jQuery object
 		 */
-		runSubscription = function (name, options, type) {
+			runSubscription = function (name, options, type) {
 			if ($.dform.hasSubscription(name)) {
 				this.each(function () {
 					var element = $(this);
@@ -98,7 +98,7 @@
 		 * @param {Object} options The options to use
 		 * @return {Object} The jQuery element this function has been called on
 		 */
-		runAll = function (options) {
+			runAll = function (options) {
 			var type = options.type, self = this;
 			// Run preprocessing subscribers
 			this.dform('run', '[pre]', options, type);
@@ -171,7 +171,7 @@
 			 * @return {Object} Mapping from subscriber names
 			 * to an array of subscriber functions.
 			 */
-			subscribers : function(name) {
+			subscribers : function (name) {
 				return name ? _subscriptions[name] : _subscriptions;
 			},
 			/**
@@ -189,7 +189,7 @@
 			 *
 			 * @param {String} name The subscriber name
 			 * @return {Boolean} True if the given name has at least one subscriber registered,
-			 *	 false otherwise
+			 *     false otherwise
 			 */
 			hasSubscription : function (name) {
 				return _subscriptions[name] ? true : false;
@@ -199,15 +199,15 @@
 			 *
 			 * @param {Object} options - The options to use
 			 * @return {Object} The element as created by the builder function specified
-			 *	 or returned by the defaultType function.
+			 *     or returned by the defaultType function.
 			 */
 			createElement : function (options) {
 				if (!options.type) {
 					throw "No element type given! Must always exist.";
 				}
 				var type = options.type,
 					element = null,
-					// We don't need the type key in the options
+				// We don't need the type key in the options
 					opts = $.withoutKeys(options, ["type"]);
 
 				if (_types[type]) {
@@ -286,7 +286,9 @@
 					}
 					options.success = function (data) {
 						self.dform(data);
-						success(data);
+						if(success) {
+							success(data, self);
+						}
 					}
 					$.ajax(options);
 				},
@@ -318,12 +320,19 @@
 	 * @param {String} converter The name of the converter in $.dform.converters
 	 * that will be used to convert the options
 	 */
-	$.fn.dform = function (options, converter) {
+	$.fn.dform = function (options, converter, error) {
 		var self = $(this);
 		if ($.dform.methods[options]) {
 			$.dform.methods[options].apply(self, Array.prototype.slice.call(arguments, 1));
 		} else {
-			$.dform.methods.init.apply(self, arguments);
+			if (typeof options === 'string') {
+				$.dform.methods.ajax.call(self, {
+					url : options,
+					dataType : 'json'
+				}, converter, error);
+			} else {
+				$.dform.methods.init.apply(self, arguments);
+			}
 		}
 		return this;
 	}
diff --git a/test/test.js b/test/test.js
@@ -56,4 +56,13 @@ $(document).ready(function () {
 		equal(created.attr('id'), 'test-id', 'ID added');
 		equal(created.data('test'), 'Test data attribute', 'Added test data attribute');
 	});
+
+	test("Ajax", function() {
+		stop();
+		$('<div>').dform('test.json', function(data, form) {
+			equal(data.html, 'The test', 'Data passed to success callback');
+			equal(form.html(), 'The test', 'Form got created');
+			start();
+		});
+	})
 });
diff --git a/test/test.json b/test/test.json
@@ -0,0 +1,4 @@
+{
+  "type" : "div",
+  "html" : "The test"
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "type" : "div",
 +  "html" : "The test"
 +}