Implement annotated tag support.

Author: rwjblue

index.js

@@ -2,6 +2,7 @@
 
 var fs   = require('fs');
 var path = require('path');
+var zlib = require('zlib');
 
 var GIT_DIR = '.git';
 
@@ -43,19 +44,39 @@ function findPackedTag(gitPath, sha) {
   }
 }
 
+function commitForTag(gitPath, tag) {
+  var tagPath = path.join(gitPath, 'refs', 'tags', tag);
+  var taggedObject = fs.readFileSync(tagPath, { encoding: 'utf8' }).trim();
+  var objectPath = path.join(gitPath, 'objects', taggedObject.slice(0, 2), taggedObject.slice(2));
+  var objectContents = zlib.inflateSync(fs.readFileSync(objectPath)).toString();
+
+  // 'tag 172\u0000object c1ee41c325d54f410b133e0018c7a6b1316f6cda\ntype commit\ntag awesome-tag\ntagger Robert Jackson <[email protected]> 1429100021 -0400\n\nI am making an annotated tag.\n'
+  if (objectContents.slice(0,3) === 'tag') {
+    var sections = objectContents.split(/\0|\n/);
+    var sha = sections[1].slice(7);
+
+    return sha;
+  } else {
+    // this will return the tag for lightweight tags
+    return taggedObject;
+  }
+}
+
 function findTag(gitPath, sha) {
   var tag = findPackedTag(gitPath, sha);
   if (tag) { return tag; }
 
   var tagsPath = path.join(gitPath, 'refs', 'tags');
-  if (!fs.existsSync(tagsPath)) { return; }
+  if (!fs.existsSync(tagsPath)) { return false; }
 
   var tags = fs.readdirSync(tagsPath);
 
   for (var i = 0, l = tags.length; i < l; i++) {
-    var tagPath = path.join(tagsPath, tags[i]);
-    if (fs.readFileSync(tagPath, { encoding: 'utf8' }).indexOf(sha) > -1) {
-      return tags[i];
+    tag = tags[i];
+    var commitAtTag = commitForTag(gitPath, tags[i]);
+
+    if (commitAtTag === sha) {
+      return tag;
     }
   }
 }
@@ -97,11 +118,16 @@ module.exports = function(gitPath) {
       }
     }
   } catch (e) {
-    // eat it
+    if (!module.exports._suppressErrors) {
+      throw e; // helps with testing and scenarios where we do not expect errors
+    } else {
+      // eat the error
+    }
   }
 
   return result;
 };
 
+module.exports._suppressErrors = true;
 module.exports._findRepo     = findRepo;
 module.exports._changeGitDir = changeGitDir;

tests/fixtures/tagged-annotated/dot-git/COMMIT_EDITMSG

@@ -0,0 +1,16 @@
+Initial commit.
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch master
+#
+# Initial commit
+#
+# Changes to be committed:
+#	new file:   README
+#
+# ------------------------ >8 ------------------------
+# Do not touch the line above.
+# Everything below will be removed.
+diff --git a/README b/README
+new file mode 100644
+index 0000000..e69de29

tests/fixtures/tagged-annotated/dot-git/HEAD

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

tests/fixtures/tagged-annotated/dot-git/config

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

tests/fixtures/tagged-annotated/dot-git/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

tests/fixtures/tagged-annotated/dot-git/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/commit-msg" &&
+	exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
+:

tests/fixtures/tagged-annotated/dot-git/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

tests/fixtures/tagged-annotated/dot-git/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git update-server-info

tests/fixtures/tagged-annotated/dot-git/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+	exec "$GIT_DIR/hooks/pre-commit" ${1+"$@"}
+:

tests/fixtures/tagged-annotated/dot-git/hooks/pre-commit.sample

@@ -0,0 +1,49 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --