Extension methods to the schemaFormProvider

Letting you add rules so you can change or create new default forms
for different schema types and other combinations.

Author: davidlgj

karma.conf.js

@@ -37,8 +37,8 @@ module.exports = function(config) {
     reporters: ['progress','coverage','growler'],
 
     preprocessors: {
-      'src/*.js': 'coverage',
-      'src/**/*.html': 'ng-html2js'
+      'src/**/*.js': ['coverage'],
+      'src/**/*.html': ['ng-html2js']
     },
 
     // optionally, configure the reporter

src/services/schema-form.js

@@ -5,6 +5,19 @@
  */
 angular.module('schemaForm').provider('schemaForm',[function(){
 
+  var defaultFormDefinition = function(name,schema,options){
+    var rules = defaults[schema.type];
+    if (rules) {
+      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) {
+          return def;
+        }
+      }
+    }
+  };
 
   //Creates a form object with all common properties
   var stdFormObj = function(schema,options) {
@@ -146,17 +159,50 @@ angular.module('schemaForm').provider('schemaForm',[function(){
 
 
 
+  /**
+   * Provider API
+   */
+  this.defaults   = defaults;
 
+  /**
+   * Append default form rule
+   * @param {string}   type json schema type
+   * @param {Function} rule a function(propertyName,propertySchema,options) that returns a form definition or undefined
+   */
+  this.appendRule = function(type,rule) {
+    if (!defaults[type]) {
+      defaults[type] = [];
+    }
+    defaults[type].push(rule);
+  };
 
+  /**
+   * Prepend default form rule
+   * @param {string}   type json schema type
+   * @param {Function} rule a function(propertyName,propertySchema,options) that returns a form definition or undefined
+   */
+  this.prependRule = function(type,rule) {
+    if (!defaults[type]) {
+      defaults[type] = [];
+    }
+    defaults[type].unshift(rule);
+  };
 
+  /**
+   * Utility function to create a standard form object.
+   * This does *not* set the type of the form but rather all shared attributes.
+   * You probably want to start your rule with creating the form with this method
+   * then setting type and any other values you need.
+   * @param {Object} schema
+   * @param {Object} options
+   * @return {Object} a form field defintion
+   */
+  this.createStandardForm = stdFormObj;
+  /* End Provider API */
 
 
-  
-
   this.$get = function(){
 
-
-
     var service = {};
 
     service.merge = function(schema,form,ignore) {
@@ -198,18 +244,6 @@ angular.module('schemaForm').provider('schemaForm',[function(){
       });
     };
 
-  
-    var defaultFormDefinition = function(name,schema,options){
-      var def;
-      for (var i=0;i<defaults.length; i++) {
-
-        def = defaults[i](name,schema,options);
-        //first handler in list that actually returns something is our handler!
-        if (def) {
-          return def;
-        }
-      }
-    };
 
 
     /**
@@ -237,7 +271,7 @@ angular.module('schemaForm').provider('schemaForm',[function(){
         });
 
       } else {
-        throw new Exception('Not implemented. Only type "object" allowed at root level of schema.');
+        throw new Error('Not implemented. Only type "object" allowed at root level of schema.');
       }
 
       return { form: form, lookup: lookup };

test/schema-form-test.js

@@ -2,10 +2,12 @@
 chai.should();
 
 describe('Schema form',function(){
-  beforeEach(module('templates'));
-  beforeEach(module('schemaForm'));
 
   describe('directive',function(){
+    beforeEach(module('templates'));
+    beforeEach(module('schemaForm'));
+
+
 
     var exampleSchema = {
       "type": "object",
@@ -719,6 +721,9 @@ describe('Schema form',function(){
 
 
   describe('service',function(){
+    beforeEach(module('templates'));
+    beforeEach(module('schemaForm'));
+
     it('should generate default form def from a schema',function(){
       inject(function(schemaForm){
 
@@ -836,6 +841,57 @@ describe('Schema form',function(){
       });
     });
 
+    it('should be extendable with new defaults',function(){
+      module(function(schemaFormProvider){
+        schemaFormProvider.prependRule('string',function(name,schema,options){
+          if (schema.format === 'foobar') {
+            var f = schemaFormProvider.createStandardForm(schema,options);
+            f.type = 'foobar';
+            return f;
+          }
+        });
+
+        schemaFormProvider.appendRule('string',function(name,schema,options){
+          var f = schemaFormProvider.createStandardForm(schema,options);
+          f.type = 'notused';
+          return f;
+        });
+      });
+
+      inject(function(schemaForm){
+
+        var schema = {
+          "type": "object",
+          "properties": {
+            "name": {
+              "title": "Name",
+              "format": "foobar",
+              "description": "Gimme yea name lad",
+              "type": "string"
+            },
+            "gender": {
+              "title": "Choose",
+              "type": "string",
+              "enum": [
+                "undefined",
+                "null",
+                "NaN",
+              ]
+            }
+          }
+        };
+
+        //no form is implicitly ['*']
+        var defaults = schemaForm.defaults(schema).form;
+        defaults[0].type.should.be.equal('foobar');
+        defaults[0].title.should.be.equal('Name');
+        defaults[1].type.should.be.equal('select');
+        defaults[1].title.should.be.equal('Choose');
+
+      });
+    });
+
+
 
     it('should ignore parts of schema in ignore list',function(){
       inject(function(schemaForm){
@@ -912,6 +968,9 @@ describe('Schema form',function(){
   });
 
   describe('decorator factory service',function(){
+    beforeEach(module('templates'));
+    beforeEach(module('schemaForm'));
+
     it('should enable you to create new decorator directives',function(){
       module(function(schemaFormDecoratorsProvider){
         schemaFormDecoratorsProvider.createDecorator('foobar',{ 'foo':'/bar.html' },[angular.noop]);