Utility methods to get Git info

lib/actions/actions.js

@@ -1,4 +1,4 @@
-var logger = process.logging || require('./utils/log');
+var logger = process.logging || require('../util/log');
 var log = logger('generators:action');
 
 var fs = require('fs');

lib/actions/shell.js

@@ -0,0 +1,3 @@
+var shell = require('shelljs');
+
+module.exports.shell = shell;

lib/actions/user.js

@@ -0,0 +1,28 @@
+// User related helper methods
+
+var shell = require('./shell').shell;
+var _ = require('lodash');
+
+
+// Exports module
+var user = module.exports = {};
+
+
+// Git related method
+//
+// The value will come from the global scope or the project scope (it'll take what git
+// will use in the current context)
+
+user.git = {};
+
+// Get the current git user.name
+// Returns String
+user.git.getUsername = function (cb) {
+  return shell.exec('git config --get user.name', { silent: true }).output.trim();
+};
+
+// Get the current git user.email
+// Returns String
+user.git.getEmail = function (cb) {
+  return shell.exec('git config --get user.email', { silent: true }).output.trim();
+};

lib/base.js

@@ -89,6 +89,8 @@ _.extend(Base.prototype, require('./actions/install'));
 _.extend(Base.prototype, require('./actions/string'));
 _.extend(Base.prototype, require('./actions/wiring'));
 _.extend(Base.prototype, require('./util/common'));
+Base.prototype.user = require('./actions/user');
+Base.prototype.shell = require('./actions/shell');
 Base.prototype.prompt = require('./actions/prompt');
 Base.prototype.invoke = require('./actions/invoke');
 Base.prototype.spawnCommand = require('./actions/spawn_command');

package.json

@@ -42,7 +42,8 @@
     "dargs": "~0.1.0",
     "async": "~0.2.8",
     "inquirer": "~0.2.0",
-    "iconv-lite": "~0.2.10"
+    "iconv-lite": "~0.2.10",
+    "shelljs": "~0.1.4"
   },
   "devDependencies": {
     "mocha": "~1.11.0",

test/shell.js

@@ -0,0 +1,19 @@
+/*global describe, it */
+var assert = require('assert');
+var shelljs = require('shelljs');
+var shellModule = require('../lib/actions/shell');
+var _ = require('lodash');
+
+describe('Generator shell methods API', function () {
+
+  it('should be exposed on the Base generator', function () {
+    assert.equal(shellModule, require('../lib/base').prototype.shell);
+  });
+
+  it('should extend shelljs module', function () {
+    _.each(shelljs, function (method, name) {
+      assert.equal(method, shellModule.shell[name]);
+    });
+  });
+
+});

test/user.js

@@ -0,0 +1,39 @@
+/*global describe, before, it, after, before */
+var userUtils = require('../lib/actions/user');
+var shell = require('shelljs');
+var assert = require('assert');
+
+describe('user utility', function () {
+
+  it('should be exposed on the Base generator', function () {
+    assert.equal(userUtils, require('../lib/base').prototype.user);
+  });
+
+  describe('git methods', function () {
+
+    before(function () {
+      this.cwd = process.cwd();
+      this.tmp = shell.tempdir();
+      shell.cd(this.tmp);
+      shell.exec('git init --quiet');
+      shell.exec('git config --local user.name Yeoman');
+      shell.exec('git config --local user.email yo@yeoman.io');
+    });
+
+    after(function () {
+      shell.cd(this.cwd);
+    });
+
+    it('git.getUsername should return the username used by git', function () {
+      var username = userUtils.git.getUsername();
+      assert.equal(username, 'Yeoman');
+    });
+
+    it('git.getEmail should return the email used by git', function () {
+      var email = userUtils.git.getEmail();
+      assert.equal(email, 'yo@yeoman.io');
+    });
+
+  });
+
+});