Make github internals testable

Author: tmcw

lib/find_git.js renamed to lib/git/find_git.js

@@ -2,6 +2,7 @@
 
 var path = require('path');
 var fs = require('fs');
+var gitDir = require('./git_dir');
 
 /**
  * Given a full path to a single file, iterate upwards through the filesystem
@@ -12,7 +13,7 @@ var fs = require('fs');
 function findGit(filename) {
   var paths = filename.split(path.sep);
   for (var i = paths.length; i > 0; i--) {
-    var p = path.resolve(paths.slice(0, i).join(path.sep) + path.sep + '.git');
+    var p = path.resolve(paths.slice(0, i).join(path.sep) + path.sep + gitDir.name);
     if (fs.existsSync(p)) {
       return p;
     }

lib/git/url_prefix.js

@@ -0,0 +1,13 @@
+var fs = require('fs');
+var path = require('path');
+var urlFromGit = require('github-url-from-git');
+var getRemoteOrigin = require('remote-origin-url');
+
+function getGithubURLPrefix(root) {
+  return urlFromGit(getRemoteOrigin.sync(root)) + '/blob/' +
+    fs.readFileSync(path.join(root, '.git',
+      fs.readFileSync(path.join(root, '.git', 'HEAD'), 'utf8')
+        .match(/ref\: (.*)/)[1]), 'utf8').trim() + '/';
+}
+
+module.exports = getGithubURLPrefix;

lib/github.js

@@ -2,18 +2,8 @@
 
 var path = require('path');
 var fs = require('fs');
-var urlFromGit = require('github-url-from-git');
-var getRemoteOrigin = require('remote-origin-url');
-var findGit = require('../lib/find_git');
-
-// TODO: cache/memoize the output of this method
-function getURLPrefix(root) {
-  var remoteURL = getRemoteOrigin.sync(root);
-  var head = fs.readFileSync(path.join(root, '.git', 'HEAD'), 'utf8');
-  var ref = head.match(/ref\: (.*)/);
-  var sha = fs.readFileSync(path.join(root, '.git', ref[1]), 'utf8').trim();
-  return urlFromGit(remoteURL) + '/blob/' + sha + '/';
-}
+var findGit = require('../lib/git/find_git');
+var getGithubURLPrefix = require('../lib/git/url_prefix');
 
 function getFileRoot(file) {
   return path.dirname(findGit(file));
@@ -28,7 +18,7 @@ function getFileRoot(file) {
  */
 module.exports = function (comment) {
   var root = getFileRoot(comment.context.file);
-  var urlPrefix = getURLPrefix(root);
+  var urlPrefix = getGithubURLPrefix(root);
   comment.context.path = comment.context.file.replace(root + '/', '');
   comment.context.github = urlPrefix +
     comment.context.file.replace(root + '/', '') +

package.json

@@ -48,6 +48,7 @@
     "eslint": "^1.5.1",
     "glob": "^5.0.2",
     "lodash": "^3.10.1",
+    "mock-fs": "^3.2.0",
     "tap": "^1.4.1"
   },
   "keywords": [

test/lib/git/find_git.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var test = require('tap').test,
+  path = require('path'),
+  mock = require('mock-fs'),
+  mockRepo = require('./mock_repo'),
+  findGit = require('../../../lib/git/find_git');
+
+test('findGit', function (t) {
+
+  mock(mockRepo);
+
+  t.equal(
+    findGit(
+      '/my/repository/path/index.js'),
+      '/my/repository/path/.git', 'finds git path');
+
+  mock.restore();
+
+  t.end();
+});
+

test/lib/git/mock_repo.js

@@ -0,0 +1,20 @@
+module.exports = {
+  '/my': {
+    repository: {
+      path: {
+        '.git': {
+          'HEAD': 'ref: refs/heads/master',
+          'config': '[remote "origin"]\n' +
+            'url = [email protected]:foo/bar.git\n' +
+            'fetch = +refs/heads/*:refs/remotes/origin/*',
+          refs: {
+            heads: {
+              master: 'this_is_the_sha'
+            }
+          }
+        },
+        'index.js': 'module.exports = 42;'
+      }
+    }
+  },
+};

test/lib/git/url_prefix.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var test = require('tap').test,
+  mock = require('mock-fs'),
+  mockRepo = require('./mock_repo'),
+  getGithubURLPrefix = require('../../../lib/git/url_prefix');
+
+test('getGithubURLPrefix', function (t) {
+
+  mock(mockRepo);
+
+  t.equal(
+    getGithubURLPrefix(
+      '/my/repository/path/'),
+      'https://github.com/foo/bar/blob/this_is_the_sha/', 'finds git path');
+
+  mock.restore();
+
+  t.end();
+});

test/lib/github.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var test = require('tap').test,
+  parse = require('../../lib/parsers/javascript'),
+  github = require('../../lib/github');
+
+function toComment(fn, filename) {
+  return parse({
+    file: filename,
+    source: fn instanceof Function ? '(' + fn.toString() + ')' : fn
+  })[0];
+}
+
+function evaluate(fn) {
+  return toComment(fn, 'input.js');
+}
+
+test('github', function (t) {
+  t.end();
+});