Merge pull request #15 from achambers/add-plugin-helper

Add plugin helper

Author: LevelbossMike

index.js

@@ -1,5 +1,18 @@
 var CoreObject     = require('core-object');
 var chalk = require('chalk');
+var cloneDeep = require('lodash.clonedeep');
+
+function _pluginHelper() {
+  return {
+    readConfigDefault: function(property) {
+      var configuredValue = this.defaultConfig[property];
+      if (typeof configuredValue === 'function') {
+        return cloneDeep(configuredValue.call(this, this.context));
+      }
+      return cloneDeep(configuredValue);
+    }.bind(this)
+  };
+}
 
 var DeployPluginBase = CoreObject.extend({
   context: null,
@@ -43,7 +56,7 @@ var DeployPluginBase = CoreObject.extend({
   readConfig: function(property){
     var configuredValue = this.pluginConfig[property];
     if (typeof configuredValue === 'function') {
-      return configuredValue.call(this, this.context);
+      return configuredValue.call(this.pluginConfig, this.context, _pluginHelper.call(this));
     }
     return configuredValue;
   },

package.json

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

tests/unit/index-nodetest.js

@@ -70,7 +70,109 @@ 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({
+        defaultConfig: {
+          distFiles: ['index.html', 'assets/logo.png'],
+          jsonBlueprint: {
+            link: {
+              selector: 'link',
+              attributes: ['rel', 'href']
+            },
+          },
+          git: {
+            sha: function() {
+              return '1';
+            }
+          },
+          revisionKey: function(context) {
+            return context.revisionData.revisionKey;
+          }
+        }
+      });
+
+      var plugin = new Plugin({
+        name: 'build'
+      });
+
+      var context = {
+        revisionData: { revisionKey: '111' },
+        config: {
+          build: {
+            distFiles: function(context, pluginHelper) {
+              var arr = pluginHelper.readConfigDefault('distFiles');
+              arr.push('index.json');
+              return arr;
+            },
+            jsonBlueprint: function(context, pluginHelper) {
+              var blueprint = pluginHelper.readConfigDefault('jsonBlueprint');
+              blueprint.link.attributes.push('integrity');
+
+              return blueprint;
+            },
+            sha: function(context, pluginHelper) {
+              var git = pluginHelper.readConfigDefault('git');
+
+              return git.sha() + '2';
+            },
+            revisionKey: function(context, pluginHelper) {
+              return pluginHelper.readConfigDefault('revisionKey') + '222';
+            }
+          }
+        }
+      };
+
+      plugin.beforeHook(context);
+      assert.deepEqual(plugin.readConfig('distFiles'), ['index.html', 'assets/logo.png', 'index.json']);
+      assert.deepEqual(plugin.readConfig('jsonBlueprint').link.attributes, ['rel', 'href', 'integrity']);
+      assert.equal(plugin.readConfig('sha'), '12');
+      assert.equal(plugin.readConfig('revisionKey'), '111222');
+    });
+
+    it('ensures default values do not get mutated', function() {
+      var Plugin = Subject.extend({
+        defaultConfig: {
+          distFiles: ['index.html', 'assets/logo.png'],
+          jsonBlueprint: {
+            link: {
+              selector: 'link',
+              attributes: ['rel', 'href']
+            }
+          }
+        }
+      });
+
+      var plugin = new Plugin({
+        name: 'build'
+      });
+
+      var context = {
+        config: {
+          build: {
+            distFiles: function(context, pluginHelper) {
+              var arr = pluginHelper.readConfigDefault('distFiles');
+              arr.push('index.json');
+              return arr;
+            },
+            jsonBlueprint: function(context, pluginHelper) {
+              var blueprint = pluginHelper.readConfigDefault('jsonBlueprint');
+              blueprint.link.attributes.push('integrity');
+
+              return blueprint;
+            }
+          }
+        }
+      };
+
+      plugin.beforeHook(context);
+      plugin.readConfig('distFiles')
+      plugin.readConfig('jsonBlueprint')
+
+      assert.deepEqual(plugin.defaultConfig.distFiles, ['index.html', 'assets/logo.png']);
+      assert.deepEqual(plugin.defaultConfig.jsonBlueprint.link.attributes, ['rel', 'href']);
+    })
+  });
 });