From 5ab15b51a3e8304d1cf89fb0c2745d8d2e9a4286 Mon Sep 17 00:00:00 2001
From: Bob Trahan <bob.trahan@gmail.com>
Date: Fri, 27 Sep 2013 12:05:58 -0700
Subject: [PATCH] Herald - tighten up rule display

Summary: we were bad at displaying phid-based values nicely. Now we are good at it.

Test Plan: made a herald rule where if the author was a or b, the task should be assigned to c and have projects x, y, z added to it. this displayed nicely.

Reviewers: epriestley

Reviewed By: epriestley

CC: Korvin, aran

Differential Revision: https://secure.phabricator.com/D7158
---
 .../herald/adapter/HeraldAdapter.php          | 103 ++++++++++++++----
 .../controller/HeraldRuleViewController.php   |   4 +-
 2 files changed, 86 insertions(+), 21 deletions(-)

diff --git a/src/applications/herald/adapter/HeraldAdapter.php b/src/applications/herald/adapter/HeraldAdapter.php
index eb11aedd02..ff1cd4eea0 100644
--- a/src/applications/herald/adapter/HeraldAdapter.php
+++ b/src/applications/herald/adapter/HeraldAdapter.php
@@ -710,7 +710,9 @@ abstract class HeraldAdapter {
   }
 
 
-  public function renderRuleAsText(HeraldRule $rule) {
+  public function renderRuleAsText(HeraldRule $rule, array $handles) {
+    assert_instances_of($handles, 'PhabricatorObjectHandle');
+
     $out = array();
 
     if ($rule->getMustMatchAll()) {
@@ -721,7 +723,7 @@ abstract class HeraldAdapter {
 
     $out[] = null;
     foreach ($rule->getConditions() as $condition) {
-      $out[] = "    ".$this->renderConditionAsText($condition);
+      $out[] = $this->renderConditionAsText($condition, $handles);
     }
     $out[] = null;
 
@@ -733,52 +735,115 @@ abstract class HeraldAdapter {
 
     $out[] = null;
     foreach ($rule->getActions() as $action) {
-      $out[] = "    ".$this->renderActionAsText($action);
+      $out[] = $this->renderActionAsText($action, $handles);
     }
 
-    return implode("\n", $out);
+    return phutil_implode_html("\n", $out);
   }
 
-  private function renderConditionAsText(HeraldCondition $condition) {
+  private function renderConditionAsText(
+    HeraldCondition $condition,
+    array $handles) {
     $field_type = $condition->getFieldName();
     $field_name = idx($this->getFieldNameMap(), $field_type);
 
     $condition_type = $condition->getFieldCondition();
     $condition_name = idx($this->getConditionNameMap(), $condition_type);
 
-    $value = $this->renderConditionValueAsText($condition);
+    $value = $this->renderConditionValueAsText($condition, $handles);
 
-    return "{$field_name} {$condition_name} {$value}";
+    return hsprintf('    %s %s %s', $field_name, $condition_name, $value);
   }
 
-  private function renderActionAsText(HeraldAction $action) {
+  private function renderActionAsText(
+    HeraldAction $action,
+    array $handles) {
     $rule_global = HeraldRuleTypeConfig::RULE_TYPE_GLOBAL;
 
     $action_type = $action->getAction();
     $action_name = idx($this->getActionNameMap($rule_global), $action_type);
 
-    $target = $this->renderActionTargetAsText($action);
+    $target = $this->renderActionTargetAsText($action, $handles);
 
-    return "{$action_name} {$target}";
+    return hsprintf('    %s %s', $action_name, $target);
   }
 
-  private function renderConditionValueAsText(HeraldCondition $condition) {
-    // TODO: This produces sketchy results for many conditions.
+  private function renderConditionValueAsText(
+    HeraldCondition $condition,
+    array $handles) {
+
     $value = $condition->getValue();
-    if (is_array($value)) {
-      $value = implode(', ', $value);
+    if (!is_array($value)) {
+      $value = array($value);
     }
+    foreach ($value as $index => $val) {
+      $handle = idx($handles, $val);
+      if ($handle) {
+        $value[$index] = $handle->renderLink();
+      }
+    }
+    $value = phutil_implode_html(', ', $value);
     return $value;
   }
 
-  private function renderActionTargetAsText(HeraldAction $action) {
-    // TODO: This produces sketchy results for Flags and PHIDs.
+  private function renderActionTargetAsText(
+    HeraldAction $action,
+    array $handles) {
+
     $target = $action->getTarget();
-    if (is_array($target)) {
-      $target = implode(', ', $target);
+    if (!is_array($target)) {
+      $target = array($target);
+    }
+    foreach ($target as $index => $val) {
+      $handle = idx($handles, $val);
+      if ($handle) {
+        $target[$index] = $handle->renderLink();
+      }
+    }
+    $target = phutil_implode_html(', ', $target);
+    return $target;
+  }
+
+  /**
+   * Given a @{class:HeraldRule}, this function extracts all the phids that
+   * we'll want to load as handles later.
+   *
+   * This function performs a somewhat hacky approach to figuring out what
+   * is and is not a phid - try to get the phid type and if the type is
+   * *not* unknown assume its a valid phid.
+   *
+   * Don't try this at home. Use more strongly typed data at home.
+   *
+   * Think of the children.
+   */
+  public static function getHandlePHIDs(HeraldRule $rule) {
+    $phids = array($rule->getAuthorPHID());
+    foreach ($rule->getConditions() as $condition) {
+      $value = $condition->getValue();
+      if (!is_array($value)) {
+        $value = array($value);
+      }
+      foreach ($value as $val) {
+        if (phid_get_type($val) !=
+            PhabricatorPHIDConstants::PHID_TYPE_UNKNOWN) {
+          $phids[] = $val;
+        }
+      }
     }
 
-    return $target;
+    foreach ($rule->getActions() as $action) {
+      $target = $action->getTarget();
+      if (!is_array($target)) {
+        $target = array($target);
+      }
+      foreach ($target as $val) {
+        if (phid_get_type($val) !=
+            PhabricatorPHIDConstants::PHID_TYPE_UNKNOWN) {
+          $phids[] = $val;
+        }
+      }
+    }
+    return $phids;
   }
 
 }
diff --git a/src/applications/herald/controller/HeraldRuleViewController.php b/src/applications/herald/controller/HeraldRuleViewController.php
index 59523b80d6..53ed9ee44c 100644
--- a/src/applications/herald/controller/HeraldRuleViewController.php
+++ b/src/applications/herald/controller/HeraldRuleViewController.php
@@ -73,7 +73,7 @@ final class HeraldRuleViewController extends HeraldController {
   private function buildPropertyView(HeraldRule $rule) {
     $viewer = $this->getRequest()->getUser();
 
-    $this->loadHandles(array($rule->getAuthorPHID()));
+    $this->loadHandles(HeraldAdapter::getHandlePHIDs($rule));
 
     $view = id(new PhabricatorPropertyListView())
       ->setUser($viewer)
@@ -104,7 +104,7 @@ final class HeraldRuleViewController extends HeraldController {
           array(
             'style' => 'white-space: pre-wrap;',
           ),
-          $adapter->renderRuleAsText($rule)));
+          $adapter->renderRuleAsText($rule, $this->getLoadedHandles())));
     }
 
     return $view;