2011-08-14 23:28:08 +02:00
|
|
|
<?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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
final class DifferentialSummaryFieldSpecification
|
|
|
|
extends DifferentialFieldSpecification {
|
|
|
|
|
2011-08-16 22:05:12 +02:00
|
|
|
private $summary = '';
|
2011-08-14 23:28:08 +02:00
|
|
|
|
|
|
|
public function shouldAppearOnEdit() {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
Drive commit message rendering from field specifications
Summary:
When rendering commit messages, drive all the logic through field specification
classes instead of the hard-coded DifferentialCommitMessageData class. This
removes DifferentialCommitMessageData and support classes.
Note that this effectively reverts D546, and will cause a minor break for
Facebook (Task IDs will no longer render in commit messages generated by "arc
amend", and will not be editable via "arc diff --edit"). This can be resolved by
implementing the feature as a custom field. While I've been able to preserve the
task ID functionality elsewhere, I felt this implementation was too complex to
reasonably leave hooks for, and the break is pretty minor.
Test Plan:
- Made numerous calls to differential.getcommitmessage across many diffs in
various states, with and without 'edit' and with and without various field
overrides.
- General behavior seems correct (messages look accurate, and have the
expected information). Special fields like "Reviewed By" and "git-svn-id" seem
to work correctly.
- Edit behavior seems correct (edit mode shows all editable fields, hides
fields like "Reviewed By").
- Field overwrite behavior seems correct (overwritable fields show the correct
values when overwritten, ignore provided values otherwise).
Reviewed By: jungejason
Reviewers: jungejason, tuomaspelkonen, aran
CC: aran, jungejason
Differential Revision: 814
2011-08-16 06:06:58 +02:00
|
|
|
protected function didSetRevision() {
|
|
|
|
$this->summary = $this->getRevision()->getSummary();
|
|
|
|
}
|
|
|
|
|
2011-08-14 23:28:08 +02:00
|
|
|
public function setValueFromRequest(AphrontRequest $request) {
|
|
|
|
$this->summary = $request->getStr('summary');
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function renderEditControl() {
|
|
|
|
return id(new AphrontFormTextAreaControl())
|
|
|
|
->setLabel('Summary')
|
|
|
|
->setName('summary')
|
|
|
|
->setValue($this->summary);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function willWriteRevision(DifferentialRevisionEditor $editor) {
|
|
|
|
$this->getRevision()->setSummary($this->summary);
|
|
|
|
}
|
|
|
|
|
2011-08-15 03:52:09 +02:00
|
|
|
public function shouldAppearOnCommitMessage() {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getCommitMessageKey() {
|
|
|
|
return 'summary';
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setValueFromParsedCommitMessage($value) {
|
2011-08-16 22:05:12 +02:00
|
|
|
$this->summary = (string)$value;
|
2011-08-15 03:52:09 +02:00
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
Drive commit message rendering from field specifications
Summary:
When rendering commit messages, drive all the logic through field specification
classes instead of the hard-coded DifferentialCommitMessageData class. This
removes DifferentialCommitMessageData and support classes.
Note that this effectively reverts D546, and will cause a minor break for
Facebook (Task IDs will no longer render in commit messages generated by "arc
amend", and will not be editable via "arc diff --edit"). This can be resolved by
implementing the feature as a custom field. While I've been able to preserve the
task ID functionality elsewhere, I felt this implementation was too complex to
reasonably leave hooks for, and the break is pretty minor.
Test Plan:
- Made numerous calls to differential.getcommitmessage across many diffs in
various states, with and without 'edit' and with and without various field
overrides.
- General behavior seems correct (messages look accurate, and have the
expected information). Special fields like "Reviewed By" and "git-svn-id" seem
to work correctly.
- Edit behavior seems correct (edit mode shows all editable fields, hides
fields like "Reviewed By").
- Field overwrite behavior seems correct (overwritable fields show the correct
values when overwritten, ignore provided values otherwise).
Reviewed By: jungejason
Reviewers: jungejason, tuomaspelkonen, aran
CC: aran, jungejason
Differential Revision: 814
2011-08-16 06:06:58 +02:00
|
|
|
public function shouldOverwriteWhenCommitMessageIsEdited() {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function renderLabelForCommitMessage() {
|
|
|
|
return 'Summary';
|
|
|
|
}
|
|
|
|
|
|
|
|
public function renderValueForCommitMessage($is_edit) {
|
|
|
|
return $this->summary;
|
|
|
|
}
|
|
|
|
|
2011-08-14 23:28:08 +02:00
|
|
|
}
|