Make Arcanist workflow names explicit

Summary:
Currently, adding a new workflow requires you to override ArcanistConfiguration, which is messy. Instead, just load everything that extends ArcanistBaseWorkflow.

Remove all the rules tying workflow names to class names through arcane incantations.

This has a very small performance cost in that we need to load every Workflow class every time now, but we don't hit __init__ and such anymore and it was pretty negligible on my machine (98ms vs 104ms or something).

Test Plan: Ran "arc help", "arc which", "arc diff", etc.

Reviewers: edward, vrana, btrahan

Reviewed By: edward

CC: aran, zeeg

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

src/configuration/ArcanistConfiguration.php

@@ -45,53 +45,29 @@ class ArcanistConfiguration {
       $command = 'help';
     }
 
-    if ($command == 'base') {
-      return null;
-    }
-
-    $workflow_class = 'Arcanist'.ucfirst($command).'Workflow';
-    $workflow_class = preg_replace_callback(
-      '/-([a-z])/',
-      array(
-        'ArcanistConfiguration',
-        'replaceClassnameHyphens',
-      ),
-      $workflow_class);
-
-    $symbols = id(new PhutilSymbolLoader())
-      ->setType('class')
-      ->setName($workflow_class)
-      ->setLibrary('arcanist')
-      ->selectAndLoadSymbols();
-
-    if (!$symbols) {
-      return null;
-    }
-
-    return newv($workflow_class, array());
+    return idx($this->buildAllWorkflows(), $command);
   }
 
   public function buildAllWorkflows() {
     $symbols = id(new PhutilSymbolLoader())
       ->setType('class')
       ->setAncestorClass('ArcanistBaseWorkflow')
-      ->setLibrary('arcanist')
       ->selectAndLoadSymbols();
 
     $workflows = array();
     foreach ($symbols as $symbol) {
       $class = $symbol['name'];
-      $name = preg_replace('/^Arcanist(\w+)Workflow$/', '\1', $class);
-      $name[0] = strtolower($name[0]);
-      $name = preg_replace_callback(
-        '/[A-Z]/',
-        array(
-          'ArcanistConfiguration',
-          'replaceClassnameUppers',
-        ),
-        $name);
-      $name = strtolower($name);
-      $workflows[$name] = newv($class, array());
+      $workflow = newv($class, array());
+      $name = $workflow->getWorkflowName();
+
+      if (isset($workflows[$name])) {
+        $other = get_class($workflows[$name]);
+        throw new Exception(
+          "Workflows {$class} and {$other} both implement workflows named ".
+          "{$name}.");
+      }
+
+      $workflows[$workflow->getWorkflowName()] = $workflow;
     }
 
     return $workflows;
@@ -114,12 +90,4 @@ class ArcanistConfiguration {
     return array();
   }
 
-  public static function replaceClassnameHyphens($m) {
-    return strtoupper($m[1]);
-  }
-
-  public static function replaceClassnameUppers($m) {
-    return '-'.strtolower($m[0]);
-  }
-
 }

src/workflow/ArcanistAliasWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistAliasWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'alias';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **alias**

src/workflow/ArcanistAmendWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistAmendWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'amend';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **amend** [--revision __revision_id__] [--show]

src/workflow/ArcanistAnoidWorkflow.php

@@ -21,6 +21,10 @@
  */
 final class ArcanistAnoidWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'anoid';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **anoid**

src/workflow/ArcanistBaseWorkflow.php

@@ -83,6 +83,14 @@ abstract class ArcanistBaseWorkflow {
 
   abstract public function run();
 
+  /**
+   * Return the command used to invoke this workflow from the command like,
+   * e.g. "help" for @{class:ArcanistHelpWorkflow}.
+   *
+   * @return string   The command a user types to invoke this workflow.
+   */
+  abstract public function getWorkflowName();
+
 
 /* -(  Conduit  )------------------------------------------------------------ */
 

src/workflow/ArcanistBranchWorkflow.php

@@ -25,6 +25,10 @@ final class ArcanistBranchWorkflow extends ArcanistBaseWorkflow {
 
   private $branches;
 
+  public function getWorkflowName() {
+    return 'branch';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **branch** [__options__]

src/workflow/ArcanistCallConduitWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistCallConduitWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'call-conduit';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **call-conduit** __method__

src/workflow/ArcanistCloseRevisionWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistCloseRevisionWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'close-revision';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **close-revision** [__options__] __revision__

src/workflow/ArcanistCloseWorkflow.php

@@ -33,6 +33,11 @@ final class ArcanistCloseWorkflow extends ArcanistBaseWorkflow {
     "open"      => 0
     );
 
+
+  public function getWorkflowName() {
+    return 'close';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **close** __task_id__ [__options__]

src/workflow/ArcanistCommitWorkflow.php

@@ -25,6 +25,10 @@ final class ArcanistCommitWorkflow extends ArcanistBaseWorkflow {
 
   private $revisionID;
 
+  public function getWorkflowName() {
+    return 'commit';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **commit** [--revision __revision_id__] [--show]

src/workflow/ArcanistCoverWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistCoverWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'cover';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **cover** [--rev __revision__] [__path__ ...]

src/workflow/ArcanistDiffWorkflow.php

@@ -41,6 +41,10 @@ final class ArcanistDiffWorkflow extends ArcanistBaseWorkflow {
   private $diffPropertyFutures = array();
   private $commitMessageFromRevision;
 
+  public function getWorkflowName() {
+    return 'diff';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **diff** [__paths__] (svn)

src/workflow/ArcanistDownloadWorkflow.php

@@ -27,6 +27,10 @@ final class ArcanistDownloadWorkflow extends ArcanistBaseWorkflow {
   private $saveAs;
   private $show;
 
+  public function getWorkflowName() {
+    return 'download';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **download** __file__ [--as __name__] [--show]

src/workflow/ArcanistExportWorkflow.php

@@ -35,6 +35,10 @@ final class ArcanistExportWorkflow extends ArcanistBaseWorkflow {
   private $sourceID;
   private $format;
 
+  public function getWorkflowName() {
+    return 'export';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **export** [__paths__] __format__ (svn)

src/workflow/ArcanistFlagWorkflow.php

@@ -43,6 +43,10 @@ final class ArcanistFlagWorkflow extends ArcanistBaseWorkflow {
     'checkered' => 7, 'c' => 7,   7 => 7,
   );
 
+  public function getWorkflowName() {
+    return 'flag';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **flag** [__object__ ...]

src/workflow/ArcanistGetConfigWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistGetConfigWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'get-config';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **get-config** -- [__name__ ...]

src/workflow/ArcanistGitHookPreReceiveWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistGitHookPreReceiveWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'git-hook-pre-receive';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **git-hook-pre-receive**

src/workflow/ArcanistHelpWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistHelpWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'help';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **help** [__command__]

src/workflow/ArcanistInlinesWorkflow.php

@@ -21,6 +21,10 @@
  */
 final class ArcanistInlinesWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'inlines';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **inlines** [--revision __revision_id__]

src/workflow/ArcanistInstallCertificateWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistInstallCertificateWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'install-certificate';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **install-certificate** [uri]

src/workflow/ArcanistLandWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistLandWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'land';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **land** [__options__] [__branch__] [--onto __master__]

src/workflow/ArcanistLiberateWorkflow.php

@@ -29,6 +29,10 @@
  */
 final class ArcanistLiberateWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'liberate';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **liberate** [__path__]

src/workflow/ArcanistLintWorkflow.php

@@ -36,6 +36,10 @@ class ArcanistLintWorkflow extends ArcanistBaseWorkflow {
   private $engine;
   private $postponedLinters;
 
+  public function getWorkflowName() {
+    return 'lint';
+  }
+
   public function setShouldAmendChanges($should_amend) {
     $this->shouldAmendChanges = $should_amend;
     return $this;

src/workflow/ArcanistListWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistListWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'list';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **list**

src/workflow/ArcanistMarkCommittedWorkflow.php

@@ -21,6 +21,10 @@
  */
 final class ArcanistMarkCommittedWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'mark-committed';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **mark-committed** (DEPRECATED)

src/workflow/ArcanistPasteWorkflow.php

@@ -28,6 +28,10 @@ final class ArcanistPasteWorkflow extends ArcanistBaseWorkflow {
   private $title;
   private $json;
 
+  public function getWorkflowName() {
+    return 'paste';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **paste** [--title __title__] [--lang __language__] [--json]

src/workflow/ArcanistPatchWorkflow.php

@@ -31,6 +31,10 @@ final class ArcanistPatchWorkflow extends ArcanistBaseWorkflow {
   private $source;
   private $sourceParam;
 
+  public function getWorkflowName() {
+    return 'patch';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **patch** __D12345__

src/workflow/ArcanistSetConfigWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistSetConfigWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'set-config';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **set-config** [__options__] -- __name__ __value__

src/workflow/ArcanistShellCompleteWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistShellCompleteWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'shell-complete';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **shell-complete** __--current__ __N__ -- [__argv__]

src/workflow/ArcanistSvnHookPreCommitWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistSvnHookPreCommitWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'svn-hook-pre-commit';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **svn-hook-pre-commit** __repository__ __transaction__

src/workflow/ArcanistTasksWorkflow.php

@@ -25,6 +25,10 @@ final class ArcanistTasksWorkflow extends ArcanistBaseWorkflow {
 
   private $tasks;
 
+  public function getWorkflowName() {
+    return 'tasks';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **tasks** [__options__]

src/workflow/ArcanistTodoWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistTodoWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'todo';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **todo** __summary__ [__options__]

src/workflow/ArcanistUnitWorkflow.php

@@ -33,6 +33,10 @@ final class ArcanistUnitWorkflow extends ArcanistBaseWorkflow {
   private $testResults;
   private $engine;
 
+  public function getWorkflowName() {
+    return 'unit';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **unit** [__options__] [__paths__]

src/workflow/ArcanistUpgradeWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistUpgradeWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'upgrade';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **upgrade**

src/workflow/ArcanistUploadWorkflow.php

@@ -26,6 +26,10 @@ final class ArcanistUploadWorkflow extends ArcanistBaseWorkflow {
   private $paths;
   private $json;
 
+  public function getWorkflowName() {
+    return 'upload';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **upload** __file__ [__file__ ...] [--json]

src/workflow/ArcanistWhichWorkflow.php

@@ -23,6 +23,10 @@
  */
 final class ArcanistWhichWorkflow extends ArcanistBaseWorkflow {
 
+  public function getWorkflowName() {
+    return 'which';
+  }
+
   public function getCommandSynopses() {
     return phutil_console_format(<<<EOTEXT
       **which** (svn)