feat(plugins): inline plugins

Author: sjelin

docs/plugins.md

@@ -51,16 +51,29 @@ using the 'ngHint' plugin is shown below.
   }]
 ```
 
-Finally, if your plugin is a node module, you may use it with the `package`
-option. For example, if you did `npm install example-protractor-plugin` your
-config would look like:
+If your plugin is a node module, you may use it with the `package` option. For
+example, if you did `npm install example-protractor-plugin` your config would
+look like:
 
 ```javascript
   plugins: [{
     package: 'example-protractor-plugin',
   }]
 ```
 
+Finally, if you are writing a small plugin which will only be used by one config
+file, you can write the plugin inline into the config:
+
+```javascript
+  plugins: [{
+    inline: {
+      setup: function() { ... },
+      teardown: function() { ... },
+      ...
+    }
+  }]
+```
+
 Writing Plugins
 ---------------
 
@@ -124,6 +137,8 @@ exports.postTest = function(config, passed) {};
 exports.name = '';
 ```
 
+Each of these exported properties are totally optional.
+
 The protractor results object follows the format specified in
 the [Framework documentation](../lib/frameworks/README.md).
 

lib/plugins.js

@@ -35,11 +35,15 @@ var Plugins = function(config) {
     } else {
       path = pluginConf.package;
     }
-    if (!path) {
-      throw new Error('Plugin configuration did not contain a valid path.');
+    if (path) {
+      pluginConf.name = path;
+      self.pluginObjs.push(require(path));
+    } else if(pluginConf.inline) {
+      self.pluginObjs.push(pluginConf.inline);
+    } else {
+      throw new Error('Plugin configuration did not contain a valid path or ' +
+          'inline definition.');
     }
-    pluginConf.name = path;
-    self.pluginObjs.push(require(path));
   });
 };
 

spec/plugins/basic_spec.js

@@ -2,8 +2,4 @@ describe('check if plugin setup ran', function() {
   it('should have set protractor.__BASIC_PLUGIN_RAN', function() {
     expect(protractor.__BASIC_PLUGIN_RAN).toBe(true);
   });
-
-  it('should run multiple tests', function() {
-    expect(true).toBe(true);
-  });
 });

spec/plugins/bigger_spec.js

@@ -0,0 +1,9 @@
+describe('check if plugin setup ran', function() {
+  it('should have set protractor.__BASIC_PLUGIN_RAN', function() {
+    expect(protractor.__BASIC_PLUGIN_RAN).toBe(true);
+  });
+
+  it('should have set protractor.__INLINE_PLUGIN_RAN', function() {
+    expect(protractor.__INLINE_PLUGIN_RAN).toBe(true);
+  });
+});

spec/pluginsFullConf.js

@@ -8,7 +8,7 @@ exports.config = {
 
   // Spec patterns are relative to this directory.
   specs: [
-    'plugins/basic_spec.js'
+    'plugins/bigger_spec.js'
   ],
 
   capabilities: env.capabilities,
@@ -25,5 +25,11 @@ exports.config = {
     path: 'plugins/basic_plugin.js'
   }, {
     path: 'plugins/test_plugin.js'
+  }, {
+    inline: {
+      setup: function() {
+        protractor.__INLINE_PLUGIN_RAN = true;
+      }
+    }
   }]
 };