Support arc bookmark in Mercurial

Summary:
Branch in Mercurial means something else.
Hopefully users wouldn't be too confused.

Test Plan:
  $ arc help
  $ arc help branch
  $ arc help feature
  $ arc feature
  $ arc bookmark
  $ arc branch
  # In hg repo:
  $ arc feature
  $ arc feature new
  $ arc feature new

Reviewers: epriestley

Reviewed By: epriestley

CC: aran, Korvin

Maniphest Tasks: T2332

Differential Revision: https://secure.phabricator.com/D4753

src/__phutil_library_map__.php

@@ -21,6 +21,7 @@ phutil_register_library_map(array(
     'ArcanistBaseUnitTestEngine' => 'unit/engine/ArcanistBaseUnitTestEngine.php',
     'ArcanistBaseWorkflow' => 'workflow/ArcanistBaseWorkflow.php',
     'ArcanistBaseXHPASTLinter' => 'lint/linter/ArcanistBaseXHPASTLinter.php',
+    'ArcanistBookmarkWorkflow' => 'workflow/ArcanistBookmarkWorkflow.php',
     'ArcanistBranchWorkflow' => 'workflow/ArcanistBranchWorkflow.php',
     'ArcanistBrowseWorkflow' => 'workflow/ArcanistBrowseWorkflow.php',
     'ArcanistBundle' => 'parser/ArcanistBundle.php',
@@ -55,6 +56,7 @@ phutil_register_library_map(array(
     'ArcanistDownloadWorkflow' => 'workflow/ArcanistDownloadWorkflow.php',
     'ArcanistEventType' => 'events/constant/ArcanistEventType.php',
     'ArcanistExportWorkflow' => 'workflow/ArcanistExportWorkflow.php',
+    'ArcanistFeatureWorkflow' => 'workflow/ArcanistFeatureWorkflow.php',
     'ArcanistFilenameLinter' => 'lint/linter/ArcanistFilenameLinter.php',
     'ArcanistFlagWorkflow' => 'workflow/ArcanistFlagWorkflow.php',
     'ArcanistFlake8Linter' => 'lint/linter/ArcanistFlake8Linter.php',
@@ -175,7 +177,8 @@ phutil_register_library_map(array(
     'ArcanistBaseCommitParserTestCase' => 'ArcanistTestCase',
     'ArcanistBaseWorkflow' => 'Phobject',
     'ArcanistBaseXHPASTLinter' => 'ArcanistLinter',
-    'ArcanistBranchWorkflow' => 'ArcanistBaseWorkflow',
+    'ArcanistBookmarkWorkflow' => 'ArcanistFeatureWorkflow',
+    'ArcanistBranchWorkflow' => 'ArcanistFeatureWorkflow',
     'ArcanistBrowseWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistBundleTestCase' => 'ArcanistTestCase',
     'ArcanistCallConduitWorkflow' => 'ArcanistBaseWorkflow',
@@ -198,6 +201,7 @@ phutil_register_library_map(array(
     'ArcanistDownloadWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistEventType' => 'PhutilEventType',
     'ArcanistExportWorkflow' => 'ArcanistBaseWorkflow',
+    'ArcanistFeatureWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistFilenameLinter' => 'ArcanistLinter',
     'ArcanistFlagWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistFlake8Linter' => 'ArcanistLinter',

src/repository/api/ArcanistMercurialAPI.php

@@ -453,6 +453,26 @@ final class ArcanistMercurialAPI extends ArcanistRepositoryAPI {
     return true;
   }
 
+  public function getAllBranches() {
+    list($branch_info) = $this->execxLocal('bookmarks');
+    $matches = null;
+    preg_match_all(
+      '/^\s*(\*?)\s*(.+)\s(\S+)$/m',
+      $branch_info,
+      $matches,
+      PREG_SET_ORDER);
+
+    $return = array();
+    foreach ($matches as $match) {
+      list(, $current, $name) = $match;
+      $return[] = array(
+        'current' => (bool)$current,
+        'name'    => rtrim($name),
+      );
+    }
+    return $return;
+  }
+
   public function hasLocalCommit($commit) {
     try {
       $this->getCanonicalRevisionName($commit);

src/workflow/ArcanistBookmarkWorkflow.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * Alias for arc feature
+ *
+ * @group workflow
+ */
+final class ArcanistBookmarkWorkflow extends ArcanistFeatureWorkflow {
+
+  public function getWorkflowName() {
+    return 'bookmark';
+  }
+
+  public function getCommandSynopses() {
+    return phutil_console_format(<<<EOTEXT
+      **bookmark** [__options__]
+      **bookmark** __name__ [__start__]
+EOTEXT
+      );
+  }
+
+  public function getCommandHelp() {
+    return phutil_console_format(<<<EOTEXT
+          Supports: hg
+          Alias for arc feature.
+EOTEXT
+      );
+  }
+
+  public function run() {
+    $repository_api = $this->getRepositoryAPI();
+    if (!($repository_api instanceof ArcanistMercurialAPI)) {
+      throw new ArcanistUsageException(
+        'arc bookmark is only supported under Mercurial.');
+    }
+    return parent::run();
+  }
+
+}

src/workflow/ArcanistBranchWorkflow.php

@@ -1,13 +1,11 @@
 <?php
 
 /**
- * Displays user's git branches
+ * Alias for arc feature
  *
  * @group workflow
  */
-final class ArcanistBranchWorkflow extends ArcanistBaseWorkflow {
+final class ArcanistBranchWorkflow extends ArcanistFeatureWorkflow {
-
-  private $branches;
 
   public function getWorkflowName() {
     return 'branch';
@@ -24,285 +22,18 @@ EOTEXT
   public function getCommandHelp() {
     return phutil_console_format(<<<EOTEXT
           Supports: git
-          A wrapper on 'git branch'. It pulls data from Differential and
+          Alias for arc feature.
-          displays the revision status next to the branch name.
-
-          By default, branches are sorted chronologically. You can sort them
-          by status instead with __--by-status__.
-
-          By default, branches that are "Closed" or "Abandoned" are not
-          displayed. You can show them with __--view-all__.
-
-          With __name__, it creates or checks out a branch. If the branch
-          __name__ doesn't exist and is in format D123 then the branch of
-          revision D123 is checked out.
 EOTEXT
       );
   }
 
-  public function requiresConduit() {
-    return true;
-  }
-
-  public function requiresRepositoryAPI() {
-    return true;
-  }
-
-  public function requiresAuthentication() {
-    return true;
-  }
-
-
-  public function getArguments() {
-    return array(
-      'view-all' => array(
-        'help' => 'Include closed and abandoned revisions',
-      ),
-      'by-status' => array(
-        'help' => 'Sort branches by status instead of time.',
-      ),
-      '*' => 'names',
-    );
-  }
-
   public function run() {
     $repository_api = $this->getRepositoryAPI();
     if (!($repository_api instanceof ArcanistGitAPI)) {
       throw new ArcanistUsageException(
-        'arc branch is only supported under git.');
+        'arc branch is only supported under Git.');
-    }
-
-    $names = $this->getArgument('names');
-    if ($names) {
-      if (count($names) > 2) {
-        throw new ArcanistUsageException("Specify only one branch.");
-      }
-      return $this->checkoutBranch($names);
-    }
-
-    $branches = $repository_api->getAllBranches();
-    if (!$branches) {
-      throw new ArcanistUsageException('No branches in this working copy.');
-    }
-
-    $branches = $this->loadCommitInfo($branches);
-
-    $revisions = $this->loadRevisions($branches);
-
-    $this->printBranches($branches, $revisions);
-
-    return 0;
-  }
-
-  private function checkoutBranch(array $names) {
-    $api = $this->getRepositoryAPI();
-
-    list($err, $stdout, $stderr) = $api->execManualLocal(
-      'checkout %s',
-      reset($names));
-
-    if ($err) {
-      $match = null;
-      if (preg_match('/^D(\d+)$/', reset($names), $match)) {
-        try {
-          $diff = $this->getConduit()->callMethodSynchronous(
-            'differential.getdiff',
-            array(
-              'revision_id' => $match[1],
-            ));
-
-          if ($diff['branch'] != '') {
-            $names[0] = $diff['branch'];
-            list($err, $stdout, $stderr) = $api->execManualLocal(
-              'checkout %s',
-              reset($names));
-          }
-        } catch (ConduitException $ex) {
-        }
-      }
-    }
-
-    if ($err) {
-      list($err, $stdout, $stderr) = $api->execManualLocal(
-        'checkout -b %Ls',
-        $names);
-    }
-
-    echo $stdout;
-    fprintf(STDERR, $stderr);
-    return $err;
-  }
-
-  private function loadCommitInfo(array $branches) {
-    $repository_api = $this->getRepositoryAPI();
-
-    $futures = array();
-    foreach ($branches as $branch) {
-      // NOTE: "-s" is an option deep in git's diff argument parser that doesn't
-      // seem to have much documentation and has no long form. It suppresses any
-      // diff output.
-      $futures[$branch['name']] = $repository_api->execFutureLocal(
-        'show -s --format=%C %s --',
-        '%H%x01%ct%x01%T%x01%s%x01%b',
-        $branch['name']);
-    }
-
-    $branches = ipull($branches, null, 'name');
-
-    foreach (Futures($futures)->limit(16) as $name => $future) {
-      list($info) = $future->resolvex();
-      list($hash, $epoch, $tree, $desc, $text) = explode("\1", trim($info), 5);
-
-      $branch = $branches[$name];
-      $branch['hash'] = $hash;
-      $branch['desc'] = $desc;
-
-      try {
-        $text = $desc."\n".$text;
-        $message = ArcanistDifferentialCommitMessage::newFromRawCorpus($text);
-        $id = $message->getRevisionID();
-
-        $branch += array(
-          'epoch'       => (int)$epoch,
-          'tree'        => $tree,
-          'revisionID'  => $id,
-        );
-      } catch (ArcanistUsageException $ex) {
-        // In case of invalid commit message which fails the parsing,
-        // do nothing.
-      }
-
-      $branches[$name] = $branch;
-    }
-
-    return $branches;
-  }
-
-  private function loadRevisions(array $branches) {
-    $ids = array();
-    $hashes = array();
-
-    foreach ($branches as $branch) {
-      if ($branch['revisionID']) {
-        $ids[] = $branch['revisionID'];
-      }
-      $hashes[] = array('gtcm', $branch['hash']);
-      $hashes[] = array('gttr', $branch['tree']);
-    }
-
-    $calls = array();
-
-    if ($ids) {
-      $calls[] = $this->getConduit()->callMethod(
-        'differential.query',
-        array(
-          'ids' => $ids,
-        ));
-    }
-
-    if ($hashes) {
-      $calls[] = $this->getConduit()->callMethod(
-        'differential.query',
-        array(
-          'commitHashes' => $hashes,
-        ));
-    }
-
-    $results = array();
-    foreach (Futures($calls) as $call) {
-      $results[] = $call->resolve();
-    }
-
-    return array_mergev($results);
-  }
-
-  private function printBranches(array $branches, array $revisions) {
-    $revisions = ipull($revisions, null, 'id');
-
-    static $color_map = array(
-      'Closed'          => 'cyan',
-      'Needs Review'    => 'magenta',
-      'Needs Revision'  => 'red',
-      'Accepted'        => 'green',
-      'No Revision'     => 'blue',
-      'Abandoned'       => 'default',
-    );
-
-    static $ssort_map = array(
-      'Closed'          => 1,
-      'No Revision'     => 2,
-      'Needs Review'    => 3,
-      'Needs Revision'  => 4,
-      'Accepted'        => 5,
-    );
-
-    $out = array();
-    foreach ($branches as $branch) {
-      $revision = idx($revisions, idx($branch, 'revisionID'));
-
-      // If we haven't identified a revision by ID, try to identify it by hash.
-      if (!$revision) {
-        foreach ($revisions as $rev) {
-          $hashes = idx($rev, 'hashes', array());
-          foreach ($hashes as $hash) {
-            if (($hash[0] == 'gtcm' && $hash[1] == $branch['hash']) ||
-                ($hash[0] == 'gttr' && $hash[1] == $branch['tree'])) {
-              $revision = $rev;
-              break;
-            }
-          }
-        }
-      }
-
-      if ($revision) {
-        $desc = 'D'.$revision['id'].': '.$revision['title'];
-        $status = $revision['statusName'];
-      } else {
-        $desc = $branch['desc'];
-        $status = 'No Revision';
-      }
-
-      if (!$this->getArgument('view-all') && !$branch['current']) {
-        if ($status == 'Closed' || $status == 'Abandoned') {
-          continue;
-        }
-      }
-
-      $epoch = $branch['epoch'];
-
-      $color = idx($color_map, $status, 'default');
-      $ssort = sprintf('%d%012d', idx($ssort_map, $status, 0), $epoch);
-
-      $out[] = array(
-        'name'      => $branch['name'],
-        'current'   => $branch['current'],
-        'status'    => $status,
-        'desc'      => $desc,
-        'color'     => $color,
-        'esort'     => $epoch,
-        'ssort'     => $ssort,
-      );
-    }
-
-    $len_name = max(array_map('strlen', ipull($out, 'name'))) + 2;
-    $len_status = max(array_map('strlen', ipull($out, 'status'))) + 2;
-
-    if ($this->getArgument('by-status')) {
-      $out = isort($out, 'ssort');
-    } else {
-      $out = isort($out, 'esort');
-    }
-
-    $console = PhutilConsole::getConsole();
-    foreach ($out as $line) {
-      $color = $line['color'];
-      $console->writeOut(
-        "%s **%s** <fg:{$color}>%s</fg> %s\n",
-        $line['current'] ? '* ' : '  ',
-        str_pad($line['name'], $len_name),
-        str_pad($line['status'], $len_status),
-        $line['desc']);
     }
+    return parent::run();
   }
 
 }

src/workflow/ArcanistFeatureWorkflow.php

@@ -0,0 +1,337 @@
+<?php
+
+/**
+ * Displays user's Git branches or Mercurial bookmarks
+ *
+ * @group workflow
+ * @concrete-extensible
+ */
+class ArcanistFeatureWorkflow extends ArcanistBaseWorkflow {
+
+  private $branches;
+
+  public function getWorkflowName() {
+    return 'feature';
+  }
+
+  public function getCommandSynopses() {
+    return phutil_console_format(<<<EOTEXT
+      **feature** [__options__]
+      **feature** __name__ [__start__]
+EOTEXT
+      );
+  }
+
+  public function getCommandHelp() {
+    return phutil_console_format(<<<EOTEXT
+          Supports: git, hg
+          A wrapper on 'git branch' or 'hg bookmark'. It pulls data from
+          Differential and displays the revision status next to the branch name.
+
+          By default, branches are sorted chronologically. You can sort them
+          by status instead with __--by-status__.
+
+          By default, branches that are "Closed" or "Abandoned" are not
+          displayed. You can show them with __--view-all__.
+
+          With __name__, it creates or checks out a branch. If the branch
+          __name__ doesn't exist and is in format D123 then the branch of
+          revision D123 is checked out.
+EOTEXT
+      );
+  }
+
+  public function requiresConduit() {
+    return true;
+  }
+
+  public function requiresRepositoryAPI() {
+    return true;
+  }
+
+  public function requiresAuthentication() {
+    return true;
+  }
+
+
+  public function getArguments() {
+    return array(
+      'view-all' => array(
+        'help' => 'Include closed and abandoned revisions.',
+      ),
+      'by-status' => array(
+        'help' => 'Sort branches by status instead of time.',
+      ),
+      '*' => 'names',
+    );
+  }
+
+  public function run() {
+    $repository_api = $this->getRepositoryAPI();
+    if (!($repository_api instanceof ArcanistGitAPI) &&
+        !($repository_api instanceof ArcanistMercurialAPI)) {
+      throw new ArcanistUsageException(
+        'arc feature is only supported under Git and Mercurial.');
+    }
+
+    $names = $this->getArgument('names');
+    if ($names) {
+      if (count($names) > 2) {
+        throw new ArcanistUsageException("Specify only one branch.");
+      }
+      return $this->checkoutBranch($names);
+    }
+
+    $branches = $repository_api->getAllBranches();
+    if (!$branches) {
+      throw new ArcanistUsageException('No branches in this working copy.');
+    }
+
+    $branches = $this->loadCommitInfo($branches);
+
+    $revisions = $this->loadRevisions($branches);
+
+    $this->printBranches($branches, $revisions);
+
+    return 0;
+  }
+
+  private function checkoutBranch(array $names) {
+    $api = $this->getRepositoryAPI();
+
+    if ($api instanceof ArcanistMercurialAPI) {
+      $command = 'update %s';
+    } else {
+      $command = 'checkout %s';
+    }
+
+    list($err, $stdout, $stderr) = $api->execManualLocal(
+      $command,
+      reset($names));
+
+    if ($err) {
+      $match = null;
+      if (preg_match('/^D(\d+)$/', reset($names), $match)) {
+        try {
+          $diff = $this->getConduit()->callMethodSynchronous(
+            'differential.getdiff',
+            array(
+              'revision_id' => $match[1],
+            ));
+
+          if ($diff['branch'] != '') {
+            $names[0] = $diff['branch'];
+            list($err, $stdout, $stderr) = $api->execManualLocal(
+              $command,
+              reset($names));
+          }
+        } catch (ConduitException $ex) {
+        }
+      }
+    }
+
+    if ($err) {
+      if ($api instanceof ArcanistMercurialAPI) {
+        $rev = '';
+        if (isset($names[1])) {
+          $rev = csprintf('-r %s', hgsprintf($names[1]));
+        }
+        $exec = $api->execManualLocal(
+          'update %C %s',
+          $rev,
+          $names[0]);
+
+      } else {
+        $exec = $api->execManualLocal(
+          'checkout -b %Ls',
+          $names);
+      }
+
+      list($err, $stdout, $stderr) = $exec;
+    }
+
+    echo $stdout;
+    fprintf(STDERR, $stderr);
+    return $err;
+  }
+
+  private function loadCommitInfo(array $branches) {
+    $repository_api = $this->getRepositoryAPI();
+
+    $futures = array();
+    foreach ($branches as $branch) {
+      if ($repository_api instanceof ArcanistMercurialAPI) {
+        $futures[$branch['name']] = $repository_api->execFutureLocal(
+          "log -l 1 --template '%C' -r %s",
+          "{node}\1{date|hgdate}\1{p1node}\1{desc|firstline}\1{desc}",
+          hgsprintf($branch['name']));
+
+      } else {
+        // NOTE: "-s" is an option deep in git's diff argument parser that
+        // doesn't seem to have much documentation and has no long form. It
+        // suppresses any diff output.
+        $futures[$branch['name']] = $repository_api->execFutureLocal(
+          'show -s --format=%C %s --',
+          '%H%x01%ct%x01%T%x01%s%x01%s%n%n%b',
+          $branch['name']);
+      }
+    }
+
+    $branches = ipull($branches, null, 'name');
+
+    foreach (Futures($futures)->limit(16) as $name => $future) {
+      list($info) = $future->resolvex();
+      list($hash, $epoch, $tree, $desc, $text) = explode("\1", trim($info), 5);
+
+      $branch = $branches[$name];
+      $branch['hash'] = $hash;
+      $branch['desc'] = $desc;
+
+      try {
+        $message = ArcanistDifferentialCommitMessage::newFromRawCorpus($text);
+        $id = $message->getRevisionID();
+
+        $branch += array(
+          'epoch'       => (int)$epoch,
+          'tree'        => $tree,
+          'revisionID'  => $id,
+        );
+      } catch (ArcanistUsageException $ex) {
+        // In case of invalid commit message which fails the parsing,
+        // do nothing.
+      }
+
+      $branches[$name] = $branch;
+    }
+
+    return $branches;
+  }
+
+  private function loadRevisions(array $branches) {
+    $ids = array();
+    $hashes = array();
+
+    foreach ($branches as $branch) {
+      if ($branch['revisionID']) {
+        $ids[] = $branch['revisionID'];
+      }
+      $hashes[] = array('gtcm', $branch['hash']);
+      $hashes[] = array('gttr', $branch['tree']);
+    }
+
+    $calls = array();
+
+    if ($ids) {
+      $calls[] = $this->getConduit()->callMethod(
+        'differential.query',
+        array(
+          'ids' => $ids,
+        ));
+    }
+
+    if ($hashes) {
+      $calls[] = $this->getConduit()->callMethod(
+        'differential.query',
+        array(
+          'commitHashes' => $hashes,
+        ));
+    }
+
+    $results = array();
+    foreach (Futures($calls) as $call) {
+      $results[] = $call->resolve();
+    }
+
+    return array_mergev($results);
+  }
+
+  private function printBranches(array $branches, array $revisions) {
+    $revisions = ipull($revisions, null, 'id');
+
+    static $color_map = array(
+      'Closed'          => 'cyan',
+      'Needs Review'    => 'magenta',
+      'Needs Revision'  => 'red',
+      'Accepted'        => 'green',
+      'No Revision'     => 'blue',
+      'Abandoned'       => 'default',
+    );
+
+    static $ssort_map = array(
+      'Closed'          => 1,
+      'No Revision'     => 2,
+      'Needs Review'    => 3,
+      'Needs Revision'  => 4,
+      'Accepted'        => 5,
+    );
+
+    $out = array();
+    foreach ($branches as $branch) {
+      $revision = idx($revisions, idx($branch, 'revisionID'));
+
+      // If we haven't identified a revision by ID, try to identify it by hash.
+      if (!$revision) {
+        foreach ($revisions as $rev) {
+          $hashes = idx($rev, 'hashes', array());
+          foreach ($hashes as $hash) {
+            if (($hash[0] == 'gtcm' && $hash[1] == $branch['hash']) ||
+                ($hash[0] == 'gttr' && $hash[1] == $branch['tree'])) {
+              $revision = $rev;
+              break;
+            }
+          }
+        }
+      }
+
+      if ($revision) {
+        $desc = 'D'.$revision['id'].': '.$revision['title'];
+        $status = $revision['statusName'];
+      } else {
+        $desc = $branch['desc'];
+        $status = 'No Revision';
+      }
+
+      if (!$this->getArgument('view-all') && !$branch['current']) {
+        if ($status == 'Closed' || $status == 'Abandoned') {
+          continue;
+        }
+      }
+
+      $epoch = $branch['epoch'];
+
+      $color = idx($color_map, $status, 'default');
+      $ssort = sprintf('%d%012d', idx($ssort_map, $status, 0), $epoch);
+
+      $out[] = array(
+        'name'      => $branch['name'],
+        'current'   => $branch['current'],
+        'status'    => $status,
+        'desc'      => $desc,
+        'color'     => $color,
+        'esort'     => $epoch,
+        'ssort'     => $ssort,
+      );
+    }
+
+    $len_name = max(array_map('strlen', ipull($out, 'name'))) + 2;
+    $len_status = max(array_map('strlen', ipull($out, 'status'))) + 2;
+
+    if ($this->getArgument('by-status')) {
+      $out = isort($out, 'ssort');
+    } else {
+      $out = isort($out, 'esort');
+    }
+
+    $console = PhutilConsole::getConsole();
+    foreach ($out as $line) {
+      $color = $line['color'];
+      $console->writeOut(
+        "%s **%s** <fg:{$color}>%s</fg> %s\n",
+        $line['current'] ? '* ' : '  ',
+        str_pad($line['name'], $len_name),
+        str_pad($line['status'], $len_status),
+        $line['desc']);
+    }
+  }
+
+}