bump-cli 1.0.4 → 1.1.3

package/Help.txt

@@ -8,6 +8,7 @@ Options:
 Interactivity:
     -y, --yes          assume yes, don't prompt
     -q, --quiet        supress messages (implies -y)
+    -n, --dry-run      don't do anything, just simulate
 
 Bumping:
     -v, --to VERSION   use this version
@@ -16,6 +17,7 @@ Bumping:
     -M, --major        bump major version (2.3.4 -> 3.0.0)
 
 Preleases:
+        --pre          same as --prerelease
         --prerelease   bump a prerelease number (2.3.4-8 -> 2.3.4-9)
         --prepatch     bump patch and add prerelease (2.3.4 -> 2.3.5-0)
         --preminor     bump minor and add prerelease (2.3.4 -> 2.4.0-0)

package/History.md

@@ -1,7 +1,26 @@
+## v1.1.3 - August 13, 2014
+
+ * No actual changes; just add `repository` metadata in the npm package.
+
+## v1.1.2 - August 11, 2014
+
+ * Fix execution error.
+
+## v1.1.1 - August 11, 2014
+
+ * Return a non-zero exit code when aborted.
+
+## v1.1.0 - August 11, 2014
+
+ * Implement `--dry-run` (`-n`) to simulate.
+ * Implement `--pre` as an alias for `--prerelease`.
+ * Supress the 'Done' message when using `--yes`.
+ * Remove dependency with the *prompt* npm package.
+
 ## v1.0.4 - August 11, 2014
 
- * Fix --version not working.
- * Improve --help appearance.
+ * Fix `--version` not working.
+ * Improve `--help` appearance.
 
 ## v1.0.3 - August 11, 2014
 

package/Readme.md

@@ -2,7 +2,7 @@
 
 Bumps semantic versions according to [semver] guidelines.
 
-![Loading screencast...](http://ricostacruz.com/bump-cli/bump.gif)
+![Screenshot]( http://cdn.rawgit.com/rstacruz/bump-cli/a251c63/bump.png )
 
 [![Status](https://travis-ci.org/rstacruz/bump-cli.svg?branch=master)](https://travis-ci.org/rstacruz/bump-cli)
 
@@ -25,16 +25,16 @@ Inspired by [@marksteve]'s [bump][bump-py]. `bump-cli` is backwards-compatible
 [@marksteve]: https://github.com/marksteve
 [bump-py]: https://github.com/marksteve/bump
 
-## :copyright:
+:copyright:
 
-**bump-cli** © 2014+, Rico Sta. Cruz. Released under the [MIT License].<br>
-Authored and maintained by Rico Sta. Cruz with help from [contributors].
+**bump-cli** © 2014+, Rico Sta. Cruz. Released under the [MIT] License.<br>
+Authored and maintained by Rico Sta. Cruz with help from contributors. [(list)][contributors]
 
 > [ricostacruz.com](http://ricostacruz.com) &nbsp;&middot;&nbsp;
 > GitHub [@rstacruz](https://github.com/rstacruz) &nbsp;&middot;&nbsp;
 > Twitter [@rstacruz](https://twitter.com/rstacruz)
 
-[MIT License]: http://mit-license.org/
+[MIT]: http://mit-license.org/
 [contributors]: http://github.com/rstacruz/bump-cli/contributors
 [semver]: https://www.npmjs.org/package/semver
 [options]: Help.txt

package/bin/bump

@@ -1,12 +1,11 @@
 #!/usr/bin/env node
 var Context = require('../index').Context;
-var prompt = require('prompt');
 var fs = require('fs');
 
 var args = require('minimist')(process.argv.slice(2), {
   string: 'to',
-  boolean: ['patch', 'minor', 'major', 'premajor', 'preminor', 'prepatch', 'prerelease', 'yes', 'quiet'],
-  alias: { h: 'help', V: 'version', v: 'to', p: 'patch', m: 'minor', M: 'major', y: 'yes', q: 'quiet' }
+  boolean: ['patch', 'minor', 'major', 'premajor', 'preminor', 'prepatch', 'prerelease', 'yes', 'quiet', 'dry-run', 'pre'],
+  alias: { h: 'help', V: 'version', v: 'to', p: 'patch', m: 'minor', M: 'major', y: 'yes', q: 'quiet', n: 'dry-run' }
 });
 
 if (args.version) {
@@ -31,20 +30,23 @@ try {
     contexts.push(ctx);
   });
 
-  print();
   contexts.forEach(function (ctx) {
-    print(ctx.preview());
     print();
+    print(ctx.preview());
   });
 
+  // don't proceed with --dry-run
+  if (args['dry-run']) return;
+
   askToProceed(function (res) {
     if (res) {
       contexts.forEach(function (ctx) {
         fs.writeFileSync(ctx.filename, ctx.toString(), 'utf-8');
       });
-      print('\033[1A\033[2K\033[32m✓\033[0m', 'done!');
+      if (!args.yes) print('\033[1A\033[2K\033[32m✓\033[0m', 'done!');
     } else {
-      print('\033[1A\033[2K\033[31m✗\033[0m', 'cancelled');
+      if (!args.yes) print('\033[1A\033[2K\033[31m✗\033[0m', 'cancelled');
+      process.exit(16);
     }
   });
 
@@ -60,6 +62,7 @@ function print () {
 
 function askToProceed (fn) {
   if (args.yes || args.quiet) return fn(true);
+  print();
   ask('proceed? [Yn] ', function (res) {
     if (res.toLowerCase() === 'y' || !res)
       fn(true);
@@ -82,7 +85,7 @@ function toOptions (args) {
   else if (args.premajor) options.inc = 'premajor';
   else if (args.preminor) options.inc = 'preminor';
   else if (args.prepatch) options.inc = 'prepatch';
-  else if (args.prerelease) options.inc = 'prerelease';
+  else if (args.prerelease || args.pre) options.inc = 'prerelease';
   else options.inc = 'patch';
 
   return options;

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "bump-cli",
-  "version": "1.0.4",
+  "version": "1.1.3",
   "description": "Increments version numbers in files",
   "main": "index.js",
   "directories": {
     "test": "test"
   },
+  "repository": {
+     "type": "git",
+     "url": "https://github.com/rstacruz/bump-cli.git"
+  },
   "scripts": {
     "test": "mocha"
   },
@@ -22,7 +26,6 @@
   },
   "dependencies": {
     "minimist": "^1.1.0",
-    "prompt": "^0.2.13",
     "semver": "^3.0.1"
   }
 }

package/test/cli.js

@@ -0,0 +1,153 @@
+require('./setup');
+var cli = require('./support/cli');
+cli.bin = './bin/bump';
+var fs = require('fs');
+var res = cli.result;
+
+function tempfile() {
+  return '/tmp/tmp' + Math.random();
+}
+
+describe('CLI: --help', function () {
+  cli.run('--help');
+  cli.success();
+
+  it('prints the command name', function () {
+    expect(res.out).match(/bump FILES/);
+  });
+
+  it('prints the command name', function () {
+    expect(res.out).match(/bump FILES/);
+  });
+});
+
+describe('CLI: --version', function () {
+  cli.run('--version');
+  cli.success();
+
+  it('prints out the version', function () {
+    expect(res.out).include(require('../package.json').version);
+  });
+});
+
+// NB: this is sequential!
+describe('working with files', function () {
+  var fname = tempfile();
+
+  before(function (next) {
+    fs.writeFile(fname, 'VERSION = "1.0.0"\n', 'utf-8', next);
+  });
+
+  after(function (next) {
+    fs.unlink(fname, next);
+  });
+
+  describe('invoking with -v', function () {
+    cli.pipe('\n', [fname, '-v', '2.2.0']);
+    cli.success();
+
+    it('works', function () {
+      var str = fs.readFileSync(fname, 'utf-8');
+      expect(str).eql('VERSION = "2.2.0"\n');
+    });
+
+    it('produced preview output', function () {
+      expect(res.stderr).match(/done!/);
+      expect(res.stderr).include('2.2.0');
+      expect(res.stderr).include('was 1.0.0');
+      expect(res.stderr).match(/VERSION = .*2\.2\.0.*/);
+    });
+  });
+
+  describe('invoking with --yes', function () {
+    cli.run(fname + ' -y');
+    cli.success();
+
+    it('works', function () {
+      var str = fs.readFileSync(fname, 'utf-8');
+      expect(str).eql('VERSION = "2.2.1"\n');
+    });
+  });
+
+  describe('invoking by default', function () {
+    cli.pipe('\n', [fname]);
+    cli.success();
+
+    it('prints a preview', function () {
+      expect(res.stderr).match(/done!/);
+      expect(res.stderr).include('2.2.2');
+      expect(res.stderr).include('was 2.2.1');
+      expect(res.stderr).match(/VERSION = .*2\.2\.2.*/);
+    });
+
+    it('updates the version', function () {
+      var str = fs.readFileSync(fname, 'utf-8');
+      expect(str).eql('VERSION = "2.2.2"\n');
+    });
+  });
+
+  describe('aborting with "n"', function () {
+    cli.pipe('n\n', [fname]);
+
+    it('produces a non-zero exit', function () {
+      expect(res.code).gt(0);
+    });
+
+    it('prints an aborted message', function () {
+      expect(res.stderr).match(/cancelled/);
+    });
+
+    it('doesnt do anything', function () {
+      var str = fs.readFileSync(fname, 'utf-8');
+      expect(str).eql('VERSION = "2.2.2"\n');
+    });
+  });
+
+  describe('invoking with --minor', function () {
+    cli.run(fname + ' -m -y');
+    cli.success();
+
+    it('works', function () {
+      var str = fs.readFileSync(fname, 'utf-8');
+      expect(str).eql('VERSION = "2.3.0"\n');
+    });
+  });
+
+  describe('invoking with --quiet', function () {
+    cli.run(fname + ' -q -v 2.2.0');
+    cli.success();
+
+    it('works', function () {
+      var str = fs.readFileSync(fname, 'utf-8');
+      expect(str).eql('VERSION = "2.2.0"\n');
+    });
+
+    it('produces no stderr', function () {
+      expect(res.stderr).eql("");
+    });
+  });
+
+  describe('invoking with a file without a version', function () {
+    cli.run('bin/bump');
+
+    it('produces a non-zero exit', function () {
+      expect(res.code).gt(0);
+    });
+
+    it('produces stderr', function () {
+      expect(res.stderr).match(/no version found/);
+    });
+  });
+
+  describe('invoking with an invalid file', function () {
+    cli.run('trololololol');
+
+    it('produces a non-zero exit', function () {
+      expect(res.code).gt(0);
+    });
+
+    it('produces stderr', function () {
+      expect(res.stderr).match(/no such file/);
+    });
+  });
+});

package/test/support/cli.js

@@ -0,0 +1,124 @@
+/* jshint expr: true */
+
+/***
+ * cli:
+ * Helper for CLI tests.
+ *
+ *     var cli = require('...');
+ *     cli.bin = './bin/hello';
+ */
+
+var exec = require('child_process').exec;
+
+/**
+ * result : cli.result
+ * the result.
+ *
+ *     describe('help', function () {
+ *       cli.run('--help');
+ *
+ *       it('works', function () {
+ *         cli.result.code   => 0
+ *         cli.result.error  => true/false
+ *         cli.result.out    => "..." (stdout output)
+ *         cli.result.stderr => "..." (stderr output)
+ *       });
+ *     });
+ */
+
+exports.result = {};
+
+
+/**
+ * bin : cli.bin
+ * the bin to run.
+ *
+ *     var cli = require('...');
+ *     cli.bin = './bin/hello';
+ */
+
+exports.bin = './bin/lol';
+
+/**
+ * run() : cli.run(cmd)
+ * Runs a given command.
+ *
+ *   describe('running', function () {
+ *     cli.run('--help');
+ *     cli.success();
+ *   });
+ */
+
+exports.run = function (args) {
+  before(function (next) {
+    exec(exports.bin + ' ' + args, function (_exit, _cout, _cerr) {
+      exports.result.code = _exit && _exit.code || 0;
+      exports.result.error = _exit;
+      exports.result.out = _cout;
+      exports.result.stripped = _cout.replace(/\033\[[^m]*m/g, '');
+      exports.result.stderr = _cerr;
+      next();
+    });
+  });
+
+  after(function () {
+    delete exports.result.code;
+    delete exports.result.error;
+    delete exports.result.out;
+    delete exports.result.stripped;
+    delete exports.result.stderr;
+  });
+};
+
+/**
+ * success() : cli.success()
+ * asserts success
+ *
+ *   describe('running', function () {
+ *     cli.run('--help');
+ *     cli.success();
+ *   });
+ */
+
+exports.success = function () {
+  it('is successful', function () {
+    expect(exports.result.code).eql(0);
+    expect(exports.result.error).falsy;
+  });
+};
+
+/**
+ * pipe() : cli.pipe(input, args)
+ * runs and pipes things into stdin
+ *
+ *   describe('pipes', function () {
+ *     cli.pipe('var x = 2', ['--no-pager'])
+ *     cli.success();
+ *   });
+ */
+
+exports.pipe = function (input, args) {
+  before(function (next) {
+    var spawn = require('child_process').spawn;
+    var child = spawn(exports.bin, args || [], { stdio: 'pipe' });
+    exports.result.out = '';
+    exports.result.stderr = '';
+
+    if (input) {
+      child.stdin.write(input);
+      child.stdin.end();
+    }
+
+    child.stdout.on('data', function (data) { exports.result.out += data; });
+    child.stderr.on('data', function (data) { exports.result.stderr += data; });
+    child.on('close', function (code) {
+      exports.result.code = code;
+      next();
+    });
+  });
+
+  after(function () {
+    delete exports.result.out;
+    delete exports.result.stderr;
+  });
+};

package/test/test.js

@@ -123,9 +123,9 @@ describe('using different version schemes', function () {
   });
 });
 
-xdescribe('xml', function () {
+describe('xml', function () {
   it('ignores xml version strings', function () {
-    ctx = new Context("<?xml version='1.0.0'?>\n<app version='2.0.4'>");
+    ctx = new Context("<?xml version='1.0'?>\n<app version='2.0.4'>");
     expect(ctx.version).eql('2.0.4');
   });
 });