implement Transport#with(). close #4

README.md

@@ -454,6 +454,24 @@ var result = transport.waitFor(function(done) {
 console.log(result); // 'sent!'
 ```
 
+### transport.with(cmd|options[, options], fn)
+
+Execute commands with a certain context.
+
+```javascript
+transport.with('cd /tmp', function() {
+  transport.ls('-al'); // 'cd /tmp && ls -al'
+});
+
+transport.with({silent: true, failsafe: true}, function() {
+  transport.ls('-al'); // output suppressed, fail safely
+});
+
+transport.with('cd /tmp', {silent: true}, function() {
+  transport.ls('-al'); // 'cd /tmp && ls -al', output suppressed
+});
+```
+
 ### transport.silent()
 
 When calling `silent()` all subsequent commands are executed without

lib/transport/shell.js

@@ -21,7 +21,7 @@ ShellTransport.prototype.__exec = function(cmd, args, options) {
 		stderr: null
 	};
 
-	cmd = cmd + (args ? ' ' + args : '');
+	cmd = this._execWith + cmd + (args ? ' ' + args : '');
 	this.logger.command(cmd);
 	proc = exec(cmd);
 

lib/transport/ssh.js

@@ -36,7 +36,7 @@ SSHTransport.prototype.__exec = function(cmd, args, options) {
 		stdout: null,
 		stderr: null
 	};
-	cmd = cmd + (args ? ' ' + args : '');
+	cmd = this._execWith + cmd + (args ? ' ' + args : '');
 
 	this.logger.command(cmd);
 	var execOpts = options.exec || this.target.exec || {};

lib/transport/transport.js

@@ -52,6 +52,7 @@ function Transport(flight) {
 		failsafe: false
 	};
 
+	this._execWith = '';
 
 	commands.forEach(function(cmd) {
 		this[cmd] = function(args, opts) {
@@ -293,6 +294,42 @@ Transport.prototype = {
 		return Fiber.yield();
 	},
 
+	/**
+	 * Execute commands with a certain context.
+	 *
+	 * ```javascript
+	 * transport.with('cd /tmp', function() {
+	 *   transport.ls('-al'); // 'cd /tmp && ls -al'
+	 * });
+	 *
+	 * transport.with({silent: true, failsafe: true}, function() {
+	 *   transport.ls('-al'); // output suppressed, fail safely
+	 * });
+	 *
+	 * transport.with('cd /tmp', {silent: true}, function() {
+	 *   transport.ls('-al'); // 'cd /tmp && ls -al', output suppressed
+	 * });
+	 * ```
+	 *
+	 * @method with(cmd|options[, options], fn)
+	 */
+	with: function() {
+		var previousOptions = util._extend({}, this.options); // clone
+		var args = Array.prototype.slice.call(arguments, 0);
+
+		for(var i in args) {
+			if(typeof args[i] === 'string') {
+				this._execWith = args[i] + ' && ';
+			} else if(typeof args[i] === 'object') {
+				this.options = util._extend(this.options, args[i]);
+			} else if(typeof args[i] === 'function') {
+				args[i]();
+			}
+		}
+		this._execWith = '';
+		this.options = previousOptions;
+	},
+
 	/**
 	 * When calling `silent()` all subsequent commands are executed without
 	 * printing their output to stdout until `verbose()` is called.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "flightplan",
   "description": "Library for streamlining application deployment or systems administration tasks",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "author": "Patrick Stadler <[email protected]>",
   "keywords": [
     "deploy",