Merge branch 'feature/x-should-be-in-a-form' into development

Author: davidlgj

docs/index.md

@@ -4,6 +4,7 @@ Documentation
 1. [Basic Usage](#basic-usage)
 1. [Handling Submit](#handling-submit)
 1. [Global Options](#global-options)
+1. [Form defaults in schema](#form-defaults-in-schema)
 1. [Form types](#form-types)
 1. [Default form types](#default-form-types)
 1. [Form definitions](#form-definitions)
@@ -174,7 +175,29 @@ Ex.
 </div>
 ```
 
+Form defaults in schema
+-----------------------
+Its recommended to split presentation and validation into a form definition and a json schema. But
+if you for some reason can't do this, but *do* have the power to change the schema, you can supply form
+default values within the schema using the custom attribute `x-schema-form`. `x-schema-form` should
+be a form object and acts as form definition defaults for that field.  
 
+Example schema.
+```js
+{
+  "type": "object",
+  "properties": {
+    "comment": {
+      "type": "string",
+      "title": "Comment",
+      "x-schema-form": {
+        "type": "textarea",
+        "placeholder": "Don't hold back"
+      }
+    }
+  }
+}
+```
 
 Form types
 ----------

src/services/schema-form.js

@@ -40,8 +40,15 @@ angular.module('schemaForm').provider('schemaForm',
       var def;
       for (var i = 0; i < rules.length; i++) {
         def = rules[i](name, schema, options);
+
         //first handler in list that actually returns something is our handler!
         if (def) {
+
+          // Do we have form defaults in the schema under the x-schema-form-attribute?
+          if (def.schema['x-schema-form'] && angular.isObject(def.schema['x-schema-form'])) {
+            def = angular.extend(def, def.schema['x-schema-form']);
+          }
+
           return def;
         }
       }
@@ -67,14 +74,16 @@ angular.module('schemaForm').provider('schemaForm',
     if (schema.minimum) { f.minimum = schema.minimum + (schema.exclusiveMinimum ? 1 : 0); }
     if (schema.maximum) { f.maximum = schema.maximum - (schema.exclusiveMaximum ? 1 : 0); }
 
-    //Non standard attributes
+    // Non standard attributes (DONT USE DEPRECATED)
+    // If you must set stuff like this in the schema use the x-schema-form attribute
     if (schema.validationMessage) { f.validationMessage = schema.validationMessage; }
     if (schema.enumNames) { f.titleMap = canonicalTitleMap(schema.enumNames, schema['enum']); }
     f.schema = schema;
 
     // Ng model options doesn't play nice with undefined, might be defined
     // globally though
     f.ngModelOptions = f.ngModelOptions || {};
+
     return f;
   };
 

test/services/schema-form-test.js

@@ -257,6 +257,30 @@ describe('schemaForm', function() {
       });
     });
 
+    it.only('should handle x-schema-form defaults',function(){
+      inject(function(schemaForm){
+
+        var schema = {
+          "type": "object",
+          "properties": {
+            "name": {
+              "title": "Name",
+              "description": "Gimme yea name lad",
+              "type": "string",
+              "x-schema-form": {
+                "type": "textarea"
+              }
+            }
+          }
+        };
+
+
+
+        var f = schemaForm.defaults(schema,{});
+        f.form[0].type.should.be.eq('textarea');
+      });
+    });
+
     it('should ignore parts of schema in ignore list',function(){
       inject(function(schemaForm){