Merge pull request #263 from jaimedp/fn-in-options

Materialize configuration options parameters that are functions.

src/documentation/config/config.md

@@ -38,11 +38,11 @@ Each configuration option can be:
 
 		columnWidth: function() { return this.rangeBand/3 * 2; }
 
-	__Note__ Function parameters will be invoked just before each render happens or in the within the render cycle with the corresponding data point in the following cases:
-	* function expects a parameter (ie. `function (d) { return d.x; }`)
-	* parameter path is in the `options.skip`
-	* parameter path matches the RegExp `options.skipMatch`
+	__Note__ In general, function parameters will be invoked just before the render cycle happens except when:
+	* the function expects 1 or more parameters (ie. `function (d) { return d.x; }`) or
+	* the parameter path matches or is in  the `options.skip` array. The `options.skip` array can have string with a full path to skip or a RegExp to match a path. For example `['line.marker.enable', /formatter/i]` would skip the options `line.marker.enable` and any options called `formatter`.
 
+This allows functions to be used for things like formatters that need to be called for each point in the data set.
 
 <% if(notes) { %><%= notes %><% } %>
 

src/scripts/core/contour-utils.js

@@ -284,8 +284,19 @@
         materialize: function (object, ctx, options, curPath) {
             var isDom = function (obj) { return obj && typeof obj === 'object' && obj.nodeType === 1 && typeof obj.style === 'object' && typeof obj.ownerDocument === 'object'; };
             var skipList = (options || {}).skip || [];
-            var skipMatch = (options || {}).skipMatch;
-            if ( object == null ) {
+
+            var shouldSkip = function (path) {
+                return skipList.some(function (e) {
+                    if (!e) return false;
+                    if (typeof e === 'object' && e instanceof RegExp) {
+                        return e.test(path);
+                    }
+
+                    return e.toString() === path;
+                });
+            };
+
+            if (object == null) {
                 return object;
             } else if (Array.isArray(object)) {
                 return object;
@@ -296,10 +307,13 @@
             } else if (typeof object === 'object') {
                 return Object.keys(object).reduce(function (prev, key) {
                     var curKeyPath = curPath ? curPath + '.' + key : key;
-                    var notInSkipList =  skipList.indexOf(curKeyPath) === -1;
-                    var notSkipMatch = (skipMatch && skipMatch.test ? !skipMatch.test(curKeyPath) : true);
-                    var expectsParam = /(function)?\s?\(.+\)\s*({|=>)/.test((object[key] || '').toString());
-                    var shouldMaterialize = notInSkipList && notSkipMatch && !expectsParam;
+                    var expectsParam = (typeof object[key] === 'function' && !!object[key].length);
+                    var shouldMaterialize = !shouldSkip(curKeyPath) && !expectsParam;
+
+                    if (expectsParam && !shouldSkip(curKeyPath)) {
+                        console.warn('The funciton "' + curKeyPath + '" expects parameters and will not be resolved to a value before the render starts. It is assumed to be used inside a visualization. Add this function to the "skip" list to remove this message.');
+                    }
+
                     if (shouldMaterialize) {
                         prev[key] = generalHelpers.materialize(object[key], ctx, options, curKeyPath);
                     } else {

src/scripts/core/contour.js

@@ -315,7 +315,8 @@
             this._extraOptions.forEach(mergeExtraOptions);
             this._visualizations.forEach(mergeDefaults);
 
-            var opt = nwt.materialize(this.originalOptions, this, { skipMatch: /formatter/ });
+            var forceSkip = ['skip', /formatter/, 'el'];
+            var opt = nwt.materialize(this.originalOptions, this, { skip: forceSkip.concat(this.originalOptions.skip) });
 
             // compose the final list of options right before start rendering
             this.options = nwt.merge(opt, nwt.merge({}, allDefaults, opt));

tests/specs/contour-utils-spec.js

@@ -478,8 +478,7 @@ describe('utils', function () {
 
 
                 res = mat(input, expectedContext, {
-                    skip: ['x', 'd.x'],
-                    skipMatch: /zzz/
+                    skip: ['x', 'd.x', /zzz/],
                 });
             });
 

tests/specs/core-spec.js

@@ -373,4 +373,30 @@ describe('Contour', function () {
         });
     });
 
+    describe('composeOptions', function () {
+        var instance;
+        var formatter = function () { return 1; };
+        beforeEach(function () {
+            instance = createContour({
+                width: function () { return 80; },
+                skip: ['abc'],
+                formatter: formatter
+            });
+        });
+
+        it('should call options to materialzie', function () {
+            instance.composeOptions();
+            expect(instance.options).toEqual(jasmine.objectContaining({
+                width: 80,
+            }));
+        });
+        it('should not materialize skip list plus defaults', function () {
+            instance.composeOptions();
+            expect(instance.options).toEqual(jasmine.objectContaining({
+                skip: ['abc'],
+                formatter: formatter
+            }));
+        });
+    });
+
 });