From ae78ea38e66cf307c97e58944413e47b512a6aa4 Mon Sep 17 00:00:00 2001
From: mgummelt <mgummelt@fb.com>
Date: Wed, 29 Jun 2011 12:05:19 -0700
Subject: [PATCH] added commit message field class

Summary:
commit message fields were previously stored as name/value
pairs in an associative array.  this resulted in ad hoc code to modify
the structure/rendering of these fields in commit messages.  this diff
introduces a new DifferentialCommitMessageField class.

Test Plan:
ran "arc amend" to ensure the commit message still looked good

Reviewed By: epriestley
Reviewers: epriestley
CC: aran, dpepper, epriestley
Differential Revision: 554
---
 src/__phutil_library_map__.php                |  1 +
 .../DifferentialCommitMessageData.php         | 97 ++++++++++---------
 .../DifferentialCommitMessageField.php        | 49 ++++++++++
 .../data/commitmessage/__init__.php           |  1 +
 4 files changed, 103 insertions(+), 45 deletions(-)
 create mode 100644 src/applications/differential/data/commitmessage/DifferentialCommitMessageField.php

diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index 1344689d0c..2a2d5ad172 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -139,6 +139,7 @@ phutil_register_library_map(array(
     'DifferentialCommentSaveController' => 'applications/differential/controller/commentsave',
     'DifferentialCommitMessage' => 'applications/differential/parser/commitmessage',
     'DifferentialCommitMessageData' => 'applications/differential/data/commitmessage',
+    'DifferentialCommitMessageField' => 'applications/differential/data/commitmessage',
     'DifferentialCommitMessageParserException' => 'applications/differential/parser/commitmessage/exception',
     'DifferentialController' => 'applications/differential/controller/base',
     'DifferentialDAO' => 'applications/differential/storage/base',
diff --git a/src/applications/differential/data/commitmessage/DifferentialCommitMessageData.php b/src/applications/differential/data/commitmessage/DifferentialCommitMessageData.php
index 9e1084ebc2..d2ac1c7316 100644
--- a/src/applications/differential/data/commitmessage/DifferentialCommitMessageData.php
+++ b/src/applications/differential/data/commitmessage/DifferentialCommitMessageData.php
@@ -19,7 +19,7 @@
 class DifferentialCommitMessageData {
 
   protected $revision;
-  protected $dict = array();
+  protected $fields = array();
   protected $mode;
   protected $comments;
 
@@ -66,12 +66,14 @@ class DifferentialCommitMessageData {
   public function prepare() {
     $revision = $this->revision;
 
-    $dict = array();
+    $fields = array();
     if ($revision->getSummary()) {
-      $dict['Summary'] = $revision->getSummary();
+      $fields[] =
+        new DifferentialCommitMessageField('Summary', $revision->getSummary());
     }
 
-    $dict['Test Plan'] = $revision->getTestPlan();
+    $fields[] =
+      new DifferentialCommitMessageField('Test Plan', $revision->getTestPlan());
 
     $reviewer = null;
     $commenters = array();
@@ -95,7 +97,9 @@ class DifferentialCommitMessageData {
 
     if ($this->mode == self::MODE_AMEND) {
       if ($reviewer) {
-        $dict['Reviewed By'] = $handles[$reviewer]->getName();
+        $fields[] =
+          new DifferentialCommitMessageField('Reviewed By',
+                                             $handles[$reviewer]->getName());
       }
     }
 
@@ -105,79 +109,82 @@ class DifferentialCommitMessageData {
         $reviewer_names[] = $handles[$uid]->getName();
       }
       $reviewer_names = implode(', ', $reviewer_names);
-      $dict['Reviewers'] = $reviewer_names;
+      $fields[] = new DifferentialCommitMessageField('Reviewers',
+                                                     $reviewer_names);
     }
 
     $user_handles = array_select_keys($handles, $commenters);
     if ($user_handles) {
-      $dict['Commenters'] = implode(
-        ', ',
-        mpull($user_handles, 'getName'));
+      $commenters = implode(', ', mpull($user_handles, 'getName'));
+      $fields[] = new DifferentialCommitMessageField('Commenters', $commenters);
     }
 
     $cc_handles = array_select_keys($handles, $ccphids);
     if ($cc_handles) {
-      $dict['CC'] = implode(
-        ', ',
-        mpull($cc_handles, 'getName'));
+      $cc = implode(', ', mpull($cc_handles, 'getName'));
+      $fields[] = new DifferentialCommitMessageField('CC', $cc);
     }
 
     if ($revision->getRevertPlan()) {
-      $dict['Revert Plan'] = $revision->getRevertPlan();
+      $fields[] =
+        new DifferentialCommitMessageField('Revert Plan',
+                                           $revision->getRevertPlan());
     }
 
     if ($revision->getBlameRevision()) {
-      $dict['Blame Revision'] = $revision->getBlameRevision();
+      $fields[] =
+        new DifferentialCommitMessageField('Blame Revision',
+                                           $revision->getBlameRevision());
     }
 
     if ($this->mode == self::MODE_EDIT) {
       // In edit mode, include blank fields.
-      $dict += array(
-        'Summary'         => '',
-        'Reviewers'       => '',
-        'CC'              => '',
-        'Revert Plan'     => '',
-        'Blame Revision'  => '',
+      $fields += array(
+        new DifferentialCommitMessageField('Summary', ''),
+        new DifferentialCommitMessageField('Reviewers', ''),
+        new DifferentialCommitMessageField('CC', ''),
+        new DifferentialCommitMessageField('Revert Plan', ''),
+        new DifferentialCommitMessageField('Blame Revision', ''),
       );
     }
 
-    $dict['Title'] = $revision->getTitle();
+    $fields[] =
+      new DifferentialCommitMessageField('Title', $revision->getTitle());
 
-    $dict['Differential Revision'] = $revision->getID();
+    $fields[] = new DifferentialCommitMessageField('Differential Revision',
+                                                   $revision->getID());
 
-    $this->dict = $dict;
+    $this->fields = $fields;
   }
 
-  public function overwriteFieldValue($field, $value) {
-    $this->dict[$field] = $value;
+  public function overwriteFieldValue($name, $value) {
+    $field = $this->getField($name);
+    if ($field) {
+      $field->setValue($value);
+    }
     return $this;
   }
 
-  public function getCommitMessage() {
+  private function getField($name) {
+    foreach ($this->fields as $field) {
+      if ($field->getName() == $name) {
+        return $field;
+      }
+    }
+    return null;
+  }
 
-    $revision = $this->revision;
-    $dict = $this->dict;
+  public function getCommitMessage() {
+    $fields = $this->fields;
 
     $message = array();
-    $message[] = $dict['Title']."\n";
-    unset($dict['Title']);
 
-    $one_line = array(
-      'Differential Revision' => true,
-      'Reviewed By'           => true,
-      'Revert'                => true,
-      'Blame Rev'             => true,
-      'Commenters'            => true,
-      'CC'                    => true,
-      'Reviewers'             => true,
-    );
+    $title = $this->getField('Title');
+    $message[] = $title->getValue() . "\n";
 
-    foreach ($dict as $key => $value) {
-      $value = trim($value);
-      if (isset($one_line[$key])) {
-        $message[] = "{$key}: {$value}";
-      } else {
-        $message[] = "{$key}:\n{$value}\n";
+    foreach ($fields as $field) {
+      if ($field->getName() != 'Title') {
+        $message[] = $field->render();
       }
     }
 
diff --git a/src/applications/differential/data/commitmessage/DifferentialCommitMessageField.php b/src/applications/differential/data/commitmessage/DifferentialCommitMessageField.php
new file mode 100644
index 0000000000..b70d5ec03a
--- /dev/null
+++ b/src/applications/differential/data/commitmessage/DifferentialCommitMessageField.php
@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * Copyright 2011 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class DifferentialCommitMessageField {
+
+  // true if the field should be displayed on a single line
+  protected $oneLine;
+  protected $value;
+
+  public function __construct($name, $value) {
+    $this->name = $name;
+    $this->value = $value;
+  }
+
+  public function getName() {
+    return $this->name;
+  }
+
+  public function getValue() {
+    return $this->value;
+  }
+
+  public function setValue($value) {
+    $this->value = trim($value);
+  }
+
+  public function render() {
+    $str = "{$this->name}:\n{$this->value}\n";
+    if (!strpos($this->value, "\n")) {
+      $str = "{$this->name}: {$this->value}";
+    }
+    return $str;
+  }
+}
diff --git a/src/applications/differential/data/commitmessage/__init__.php b/src/applications/differential/data/commitmessage/__init__.php
index c5b785e2be..c091db077e 100644
--- a/src/applications/differential/data/commitmessage/__init__.php
+++ b/src/applications/differential/data/commitmessage/__init__.php
@@ -14,3 +14,4 @@ phutil_require_module('phutil', 'utils');
 
 
 phutil_require_source('DifferentialCommitMessageData.php');
+phutil_require_source('DifferentialCommitMessageField.php');