Add support for nested attributes with DeepModel

Author: powmedia

README.md

@@ -409,6 +409,31 @@ Forms provide a `validate` method, which returns a dictionary of errors, or `nul
 
 If you model provides a `validate` method, then this will be called when you call `Form.validate`. Forms are also validated when you call `commit`. See the Backbone documentation for more details on model validation.
 
+Using nested attributes/fields
+==============================
+
+If you are using a schema with nested attributes (using the `Object` type), you may want to include only some of the nested fields in a form. This can be accomplished by using 'path' syntax as in the example below.
+
+However, due to Backbone's lack of support for nested model attributes, getting and setting values will not work out of the box.  For this to work as expected you must adapt your model's get() and set() methods to handle the path names, or simply use [DeepModel](http://github.com/powmedia/backbone-deep-model) which will handle paths for you automatically.
+
+    var Model = Backbone.DeepModel.extend({
+        schema: {
+            title: {},
+            author: { type: 'Object', subSchema: {
+                id: { type: 'Number' },
+                name: { type: 'Object', subSchema: {
+                    first: {},
+                    last: {}
+                }}
+            }}
+        }
+    });
+    
+    var form = new Form({
+        model: new Model,
+        fields: ['title', 'author.id', 'author.name.last']
+    }).render();
+
 
 Known issues
 ============

src/backbone-forms.js

@@ -1,5 +1,20 @@
 ;(function() {
 
+    //Support paths for nested attributes e.g. 'user.name'
+    function getNested(obj, path) {
+        var fields = path.split(".");
+        var result = obj;
+        for (var i = 0, n = fields.length; i < n; i++) {
+            result = result[fields[i]];
+        }
+        return result;
+    }
+    
+    function getNestedSchema(obj, path) {
+        path = path.replace(/\./g, '.subSchema.');
+        return getNested(obj, path);
+    }
+    
     var helpers = {};
     var validators = {};
 
@@ -193,10 +208,10 @@
                 fields = this.fields,
                 el = el || $(this.el),
                 self = this;
-
+            
             //Create form fields
             _.each(fieldsToRender, function(key) {
-                var itemSchema = schema[key];
+                var itemSchema = getNestedSchema(schema, key);
 
                 if (!itemSchema) throw "Field '"+key+"' not found in schema";
 

test/form.js

@@ -204,3 +204,29 @@ test('Allows access to field views', function() {
     ok(form.fields.title instanceof Form.Field);
     ok(form.fields.author instanceof Form.Field);
 });
+
+test("Supports picking nested fields from within Objects", function() {
+    var Model = Backbone.Model.extend({
+        schema: {
+            title: {},
+            author: { type: 'Object', subSchema: {
+                id: { type: 'Number' },
+                name: { type: 'Object', subSchema: {
+                    first: {},
+                    last: {}
+                }}
+            }}
+        }
+    });
+    
+    var form = new Form({
+        model: new Model,
+        fields: ['title', 'author.id', 'author.name.last']
+    }).render();
+    
+    deepEqual(_.keys(form.fields), ['title', 'author.id', 'author.name.last']);
+    
+    ok(form.fields['title'].editor instanceof Form.editors.Text);
+    ok(form.fields['author.id'].editor instanceof Form.editors.Number);
+    ok(form.fields['author.name.last'].editor instanceof Form.editors.Text);
+});