Merge pull request #13 from alisdair/git-and-version-commit-key-generators

Add git-tag-commit and version-commit key generators

Author: Aaron Chambers

README.md

@@ -54,6 +54,7 @@ For detailed information on how configuration of plugins works, please refer to
 The type of [Key Generator](#key-generators) to be used.
 
 *Default:* `'file-hash'`
+*Alternatives:* `'git-tag-commit'`, `'version-commit'`
 
 ## Key Generators
 
@@ -83,6 +84,24 @@ The list of built project files. This option should be relative to `distDir` and
 
 *Default:* `context.distFiles`
 
+### Git Tag Commit generator
+
+Creates a key based on the most recent git tag and the currently checked-out commit. The tag is the tag identifier, followed by a `+` symbol, followed by the first 8 characters of the commit hash.
+
+For example, if your most recent git tag is `v2.0.3`, and the current commit is `0993043d49f9e0[...]`, this generator will return a revision of `v2.0.3+0993043d`.
+
+### Version Commit generator
+
+Similar to the Git Tag Commit generator, but uses the `package.json` version string instead of the git tag. The JSON file containing the version string can be configured with the `versionFile` option.
+
+#### Configuration Options
+
+##### versionFile
+
+The file containing your project's version number. Must be a JSON file with a top-level `version` key. Only used by the `version-commit` key generator.
+
+*Default:* `package.json`
+
 ## Prerequisites
 
 The following properties are expected to be present on the deployment `context` object:

index.js

@@ -20,6 +20,7 @@ module.exports = {
         distFiles: function(context) {
           return context.distFiles;
         },
+        versionFile: 'package.json',
       },
       didBuild: function(context) {
         var self = this;

lib/key-generators/git-tag-commit.js

@@ -0,0 +1,23 @@
+var CoreObject  = require('core-object');
+var gitRepoInfo = require('git-repo-info');
+var Promise     = require('ember-cli/lib/ext/promise');
+
+module.exports = CoreObject.extend({
+  generate: function() {
+    var path = gitRepoInfo._findRepo();
+
+    if (path === null) {
+      return Promise.reject('Could not find git repository');
+    }
+
+    var info = gitRepoInfo(path);
+    var tag = info.tag;
+    var sha = info.sha.slice(0, 8);
+
+    if (!info.tag || !sha) {
+      return Promise.reject('Could not build revision with tag `' + tag + '` and commit hash `' + sha + '`');
+    }
+
+    return Promise.resolve(info.tag + '+' + sha);
+  }
+});

lib/key-generators/index.js

@@ -1,3 +1,5 @@
 module.exports = {
-  "file-hash": require('./file-hash')
+  "file-hash": require('./file-hash'),
+  "git-tag-commit": require('./git-tag-commit'),
+  "version-commit": require('./version-commit')
 };

lib/key-generators/version-commit.js

@@ -0,0 +1,37 @@
+var CoreObject  = require('core-object');
+var gitRepoInfo = require('git-repo-info');
+var fs          = require('fs');
+var Promise     = require('ember-cli/lib/ext/promise');
+
+var denodeify   = require('rsvp').denodeify;
+var readFile    = denodeify(fs.readFile);
+
+module.exports = CoreObject.extend({
+  init: function(options) {
+    this._plugin = options.plugin;
+  },
+
+  generate: function() {
+    var versionFile = this._plugin.readConfig('versionFile');
+
+    var path = gitRepoInfo._findRepo();
+
+    if (path === null) {
+      return Promise.reject('Could not find git repository');
+    }
+
+    var info = gitRepoInfo(path);
+    var sha = info.sha.slice(0, 8);
+
+    return readFile(versionFile)
+      .then(function(contents) {
+        var json = JSON.parse(contents);
+
+        if (!json.version || !sha) {
+          return Promise.reject('Could not build revision with version `' + json.version + '` and commit hash `' + sha + '`');
+        }
+
+        return json.version + '+' + sha;
+      });
+  }
+});

package.json

@@ -46,8 +46,9 @@
   "dependencies": {
     "chalk": "^1.0.0",
     "core-object": "^1.1.0",
-    "ember-cli-deploy-plugin": "0.1.3",
     "ember-cli-babel": "^5.0.0",
+    "ember-cli-deploy-plugin": "0.1.3",
+    "git-repo-info": "^1.1.2",
     "minimatch": "^2.0.4",
     "rsvp": "^3.0.18"
   },

tests/fixtures/not-a-repo/package.json

@@ -0,0 +1,3 @@
+{
+  "version": "3.2.1"
+}

tests/fixtures/repo/dotgit/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

tests/fixtures/repo/dotgit/config

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+	precomposeunicode = true

tests/fixtures/repo/dotgit/index

@@ -0,0 +1,2 @@
+x
��A
+1@Q�=E��4�L����"Ӧ�Z��������������7H��g�0N�GN�샥A�'&&t9~�Gmp^��X��E�Mp�_;��ֶ��~\���ak�Z��.2��Ԯ����OB�

tests/fixtures/repo/dotgit/objects/41/d41f081b45ad50935c08b1203220737d9739b4

@@ -0,0 +1 @@
+41d41f081b45ad50935c08b1203220737d9739b4

tests/fixtures/repo/dotgit/objects/77/06f9e51d51a2f357b2c2078cdd04e4acf48f93

@@ -0,0 +1 @@
+41d41f081b45ad50935c08b1203220737d9739b4

tests/fixtures/repo/dotgit/objects/a5/10e8069cc7eaa8b8262a9c071a702fbd52dbea

@@ -0,0 +1,3 @@
+{
+  "version": "3.2.1"
+}

tests/fixtures/repo/dotgit/objects/d4/6bba1991f218165a93efe79024e16da2a213fc

@@ -0,0 +1,3 @@
+{
+  "version": "1.2.3"
+}

tests/fixtures/repo/dotgit/refs/heads/master

@@ -0,0 +1 @@
+ref: refs/heads/master

tests/fixtures/repo/dotgit/refs/tags/2.3.4

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+	precomposeunicode = true

tests/fixtures/repo/package.json

@@ -0,0 +1,2 @@
+x
��A
+1@Q�=E��$i;RQp��C������Z�/8���_���V�H��K�X8e�<E�,4+�M�2�b�D�KJN���:�{e�7���j�k��ym���G��G��	��w>ʟ��>m�,�z�n�BM

tests/fixtures/repo/version.json

@@ -0,0 +1 @@
+9138ef996f3c7680aedcba68b0371d828b6dbb0b

tests/fixtures/tagless-repo/dotgit/HEAD

@@ -0,0 +1,3 @@
+{
+  "version": "3.2.1"
+}

tests/fixtures/tagless-repo/dotgit/config

@@ -77,7 +77,7 @@ describe('the index', function() {
         return previous;
       }, []);
 
-      assert.equal(messages.length, 4);
+      assert.equal(messages.length, 5);
     });
 
     it('adds default config to the config object', function() {

tests/fixtures/tagless-repo/dotgit/index

@@ -0,0 +1,57 @@
+'use strict';
+
+var assert = require('ember-cli/tests/helpers/assert');
+var gitRepoInfo = require('git-repo-info');
+
+describe('the git-tag-commit key generator', function() {
+  var KeyGenerator;
+  var cwd;
+
+  before(function() {
+    KeyGenerator = require('../../../../lib/key-generators/git-tag-commit');
+    gitRepoInfo._changeGitDir('dotgit');
+  });
+
+  beforeEach(function() {
+    cwd = process.cwd();
+  });
+
+  afterEach(function() {
+    process.chdir(cwd);
+  });
+
+  describe('#generate', function() {
+    it('concatenates the git tag and the git commit hash', function() {
+      process.chdir('tests/fixtures/repo');
+
+      var subject = new KeyGenerator();
+
+      return assert.isFulfilled(subject.generate())
+        .then(function(revision) {
+          assert.equal(revision, '2.3.4+41d41f08');
+        });
+    });
+
+    it('rejects if no repository found', function() {
+      process.chdir('tests/fixtures/not-a-repo');
+
+      var subject = new KeyGenerator();
+
+      return assert.isRejected(subject.generate())
+        .then(function(error) {
+          assert.equal(error, 'Could not find git repository');
+        });
+    });
+
+    it('rejects if no git tag found', function() {
+      process.chdir('tests/fixtures/tagless-repo');
+
+      var subject = new KeyGenerator();
+
+      return assert.isRejected(subject.generate())
+        .then(function(error) {
+          assert.equal(error, 'Could not build revision with tag `null` and commit hash `9138ef99`');
+        });
+    });
+  });
+});

tests/fixtures/tagless-repo/dotgit/objects/5e/29d0ad64c0132a1fc27416a0af2c05511c3e99

@@ -0,0 +1,101 @@
+'use strict';
+
+var assert = require('ember-cli/tests/helpers/assert');
+var gitRepoInfo = require('git-repo-info');
+
+describe('the version-commit key generator', function() {
+  var KeyGenerator;
+  var cwd;
+
+  before(function() {
+    KeyGenerator = require('../../../../lib/key-generators/version-commit');
+    gitRepoInfo._changeGitDir('dotgit');
+  });
+
+  beforeEach(function() {
+    cwd = process.cwd();
+  });
+
+  afterEach(function() {
+    process.chdir(cwd);
+  });
+
+  describe('#generate', function() {
+    it('concatenates the package version and the git commit hash', function() {
+      process.chdir('tests/fixtures/repo');
+
+      var plugin = {
+        stubConfig: {
+          versionFile: 'package.json'
+        },
+        readConfig: function(key) { return this.stubConfig[key]; }
+      };
+
+      var subject = new KeyGenerator({
+        plugin: plugin
+      });
+
+      return assert.isFulfilled(subject.generate())
+        .then(function(revision) {
+          assert.equal(revision, '3.2.1+41d41f08');
+        });
+    });
+
+    it('rejects if no repository found', function() {
+      process.chdir('tests/fixtures/not-a-repo');
+
+      var plugin = {
+        stubConfig: {
+          versionFile: 'package.json'
+        },
+        readConfig: function(key) { return this.stubConfig[key]; }
+      };
+
+      var subject = new KeyGenerator({
+        plugin: plugin
+      });
+
+      return assert.isRejected(subject.generate())
+        .then(function(error) {
+          assert.equal(error, 'Could not find git repository');
+        });
+    });
+
+    it('has version source file option', function() {
+      process.chdir('tests/fixtures/repo');
+
+      var plugin = {
+        stubConfig: {
+          versionFile: 'version.json'
+        },
+        readConfig: function(key) { return this.stubConfig[key]; }
+      };
+
+      var subject = new KeyGenerator({
+        plugin: plugin
+      });
+
+      return assert.isFulfilled(subject.generate())
+        .then(function(revision) {
+          assert.equal(revision, '1.2.3+41d41f08');
+        });
+    });
+
+    it('rejects when the version source file doesn\'t exist', function() {
+      process.chdir('tests/fixtures/repo');
+
+      var plugin = {
+        stubConfig: {
+          versionFile: 'tests/fixtures/missing-version.json'
+        },
+        readConfig: function(key) { return this.stubConfig[key]; }
+      };
+
+      var subject = new KeyGenerator({
+        plugin: plugin
+      });
+
+      return assert.isRejected(subject.generate());
+    });
+  });
+});