Pass pluginHelper into config functions

Author: achambers

index.js

@@ -1,5 +1,18 @@
 var CoreObject     = require('core-object');
 var chalk = require('chalk');
+var merge = require('lodash.merge');
+
+function _pluginHelperDefaults() {
+  return {
+    readConfigDefault: function(property) {
+      var configuredValue = this.defaultConfig[property];
+      if (typeof configuredValue === 'function') {
+        return configuredValue.call(this, this.context);
+      }
+      return configuredValue;
+    }.bind(this)
+  };
+}
 
 var DeployPluginBase = CoreObject.extend({
   context: null,
@@ -43,7 +56,8 @@ var DeployPluginBase = CoreObject.extend({
   readConfig: function(property){
     var configuredValue = this.pluginConfig[property];
     if (typeof configuredValue === 'function') {
-      return configuredValue.call(this.pluginConfig, this.context);
+      var helper = merge(this.pluginHelper(this.context), _pluginHelperDefaults.call(this));
+      return configuredValue.call(this.pluginConfig, this.context, helper);
     }
     return configuredValue;
   },
@@ -74,6 +88,10 @@ var DeployPluginBase = CoreObject.extend({
 
       this.logRaw(chalkColor('- ' + message));
     }
+  },
+
+  pluginHelper: function(/*context*/) {
+    return {};
   }
 });
 

package.json

@@ -23,6 +23,7 @@
   },
   "dependencies": {
     "chalk": "^1.0.0",
-    "core-object": "0.0.2"
+    "core-object": "0.0.2",
+    "lodash.merge": "^4.6.0"
   }
 }

tests/unit/index-nodetest.js

@@ -70,7 +70,68 @@ describe('base plugin', function() {
       plugin.log('foo', {verbose: true});
       assert.deepEqual(verboseUi.messages, ['\u001b[34m|    \u001b[39m']);
     });
-
   });
 
+  describe('plugin helper', function() {
+    it('provides access to the oringal default values', function() {
+      var Plugin = Subject.extend({
+        requiredConfig: ['bar'],
+        defaultConfig: {
+          foo: function(context) {
+            return context.foo;
+          }
+        }
+      });
+
+      var plugin = new Plugin({
+        name: 'blah'
+      });
+
+      var context = {
+        foo: 'foo',
+        config: {
+          blah: {
+            foo: function(context, pluginHelper) {
+              return pluginHelper.readConfigDefault('foo') + 'foo';
+            },
+            bar: function(context, pluginHelper) {
+              return pluginHelper.readConfigDefault('bar') + 'bar';
+            }
+          }
+        }
+      };
+
+      plugin.beforeHook(context);
+      assert.equal(plugin.readConfig('foo'), 'foofoo');
+      assert.equal(plugin.readConfig('bar'), 'undefinedbar');
+    });
+
+    it('allows the implementer to add things to the pluginHelper', function() {
+      var Plugin = Subject.extend({
+        defaultConfig: { foo: 'foo' }
+      });
+
+      var plugin = new Plugin({
+        name: 'blah',
+
+        pluginHelper: function(context) {
+          return { bar: context.foo };
+        }
+      });
+
+      var context = {
+        foo: 'bar',
+        config: {
+          blah: {
+            foo: function(context, pluginHelper) {
+              return pluginHelper.readConfigDefault('foo') + pluginHelper.bar;
+            }
+          }
+        }
+      };
+
+      plugin.beforeHook(context);
+      assert.equal(plugin.readConfig('foo'), 'foobar');
+    });
+  });
 });