Allow goto-ing a sha1 hash (#93)

A partial sha1 hash may now be provided to `stg goto`. The sha1 must
unambiguously map to a patch within the current branch.

Signed-off-by: Peter Grayson <[email protected]>

Author: jpgrayson

stgit/commands/common.py

@@ -136,17 +136,6 @@ def print_current_patch(stack):
         out.info('No patches applied')
 
 
-def get_patch_from_list(part_name, patch_list):
-    candidates = [full for full in patch_list if part_name in full]
-    if len(candidates) >= 2:
-        out.info('Possible patches:\n  %s' % '\n  '.join(candidates))
-        raise CmdException('Ambiguous patch name "%s"' % part_name)
-    elif len(candidates) == 1:
-        return candidates[0]
-    else:
-        return None
-
-
 def parse_patches(patch_args, patch_list, boundary=0, ordered=False):
     """Parse patch_args list for patch names in patch_list.
 

stgit/commands/goto.py

@@ -1,10 +1,9 @@
+import re
+
 from stgit import argparse
-from stgit.commands.common import (
-    CmdException,
-    DirectoryHasRepository,
-    get_patch_from_list,
-)
+from stgit.commands.common import CmdException, DirectoryHasRepository
 from stgit.lib import transaction
+from stgit.out import out
 
 __copyright__ = """
 Copyright (C) 2006, Catalin Marinas <[email protected]>
@@ -38,26 +37,35 @@
 def func(parser, options, args):
     if len(args) != 1:
         parser.error('incorrect number of arguments')
-    patch = args[0]
+    name = args[0]
 
     stack = directory.repository.current_stack
     iw = stack.repository.default_iw
     clean_iw = (not options.keep and iw) or None
     trans = transaction.StackTransaction(stack, 'goto', check_clean_iw=clean_iw)
 
-    if patch not in trans.all_patches:
-        candidate = get_patch_from_list(patch, trans.all_patches)
-        if candidate is None:
-            raise CmdException('Patch "%s" does not exist' % patch)
-        patch = candidate
+    if name not in trans.all_patches:
+        candidates = [pn for pn in trans.all_patches if name in pn]
+        if len(candidates) == 1:
+            name = candidates[0]
+        elif len(candidates) > 1:
+            out.info('Possible patches:\n  %s' % '\n  '.join(candidates))
+            raise CmdException('Ambiguous patch name "%s"' % name)
+        elif re.match('[0-9A-Fa-f]{4,40}$', name):
+            sha1 = name
+            name = stack.patches.name_from_sha1(sha1)
+            if not name:
+                raise CmdException('No patch associated with %s' % sha1)
+        else:
+            raise CmdException('Patch "%s" does not exist' % name)
 
-    if patch in trans.applied:
-        to_pop = set(trans.applied[trans.applied.index(patch) + 1 :])
+    if name in trans.applied:
+        to_pop = set(trans.applied[trans.applied.index(name) + 1 :])
         popped_extra = trans.pop_patches(lambda pn: pn in to_pop)
         assert not popped_extra
-    elif patch in trans.unapplied:
+    elif name in trans.unapplied:
         try:
-            to_push = trans.unapplied[: trans.unapplied.index(patch) + 1]
+            to_push = trans.unapplied[: trans.unapplied.index(name) + 1]
             if options.merged:
                 merged = set(trans.check_merged(to_push))
             else:

stgit/lib/stack.py

@@ -151,6 +151,17 @@ def exists(self, name):
     def get(self, name):
         return self._patches[name]
 
+    def name_from_sha1(self, partial_sha1):
+        patch_ref_prefix = _patches_ref_prefix(self._stack.name)
+        for ref in self._stack.repository.refs:
+            if ref.startswith(patch_ref_prefix):
+                patch_name = ref[len(patch_ref_prefix) :]
+                patch = self.get(patch_name)
+                if patch.commit.sha1.startswith(partial_sha1.lower()):
+                    return patch_name
+        else:
+            return None
+
     def is_name_valid(self, name):
         if '/' in name:
             # TODO slashes in patch names could be made to be okay

t/t1700-goto.sh

@@ -38,6 +38,14 @@ test_expect_success 'Goto a patch' '
     test "$(echo $(stg series --unapplied --noprefix))" = "p4 p5"
 '
 
+test_expect_success 'Goto by partial sha1' '
+    stg goto "$(echo $(stg id p5) | test_copy_bytes 10)" &&
+    test "$(echo $(stg series --applied --noprefix))" = "p1 p2 p3 p4 p5" &&
+    stg goto "$(echo $(stg id p3))" &&
+    test "$(echo $(stg series --applied --noprefix))" = "p1 p2 p3" &&
+    test "$(echo $(stg series --unapplied --noprefix))" = "p4 p5"
+'
+
 test_expect_success 'Refuse to go to a hidden patch' '
     stg new h0 -m "hidden patch" &&
     stg hide h0 &&