refactor parsing of change descriptions, fix TBR=

presubmit_support.py

 #!/usr/bin/python
 # Copyright (c) 2010 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Enables directory-specific presubmit checks to run at upload and/or commit.
 """
 
 __version__ = '1.4'
 
@@ skipping 794 matching lines @@
 
 
 class GitChange(Change):
   _AFFECTED_FILES = GitAffectedFile
 
   def __init__(self, *args, **kwargs):
     Change.__init__(self, *args, **kwargs)
     self.scm = 'git'
 
 
+class ChangeDescription(object):

[M-A Ruel, 2011/03/22 17:24:16]

It's a slightly odd location for this class but it's fine.

+  """Contains a parsed form of the change description."""
+  MAX_SUBJECT_LENGTH = 100
+
+  def __init__(self, subject=None, description=None, reviewers=None, tbr=False,
+               editor=None):
+    self.subject = (subject or '').strip()
+    self.description = (description or '').strip()
+    self.reviewers = reviewers or []
+    self.tbr = tbr
+    self.editor = editor or gclient_utils.UserEdit
+
+    if self.description:
+      if not self.description.startswith(self.subject):
+        self.description = self.subject + '\n\n' + self.description
+    elif self.subject:
+      self.description = self.subject
+    self.Parse(self.EditableDescription())
+
+  def EditableDescription(self):
+    text = self.description.strip()
+    if text:
+      text += '\n'
+
+    tbr_present = False
+    r_present = False
+    bug_present = False
+    test_present = False
+    for l in text.splitlines():
+      l = l.strip()
+      r_present = r_present or l.startswith('R=')
+      tbr_present = tbr_present or l.startswith('TBR=')
+
+    if text and not (r_present or tbr_present):
+      text += '\n'
+
+    if not tbr_present and not r_present:
+      if self.tbr:
+        text += 'TBR=' + ','.join(self.reviewers) + '\n'
+      else:
+        text += 'R=' + ','.join(self.reviewers) + '\n'
+    if not bug_present:
+      text += 'BUG=\n'
+    if not test_present:
+      text += 'TEST=\n'
+
+    return text
+
+  def UserEdit(self):
+    """Allows the user to update the description.
+
+    Uses the editor callback passed to the constructor."""
+    self.Parse(self.editor(self.EditableDescription()))
+
+  def Parse(self, text):
+    """Parse the text returned from UserEdit() and update our state."""
+    parsed_lines = []
+    reviewers_regexp = re.compile('\s*(TBR|R)=(.+)')
+    reviewers = []
+    subject = ''
+    tbr = False
+    for l in text.splitlines():
+      l = l.strip()
+
+      # Throw away empty BUG=, TEST=, and R= lines. We leave in TBR= lines
+      # to indicate that this change was meant to be "unreviewed".
+      if l in ('BUG=', 'TEST=', 'R='):
+        continue
+
+      if not subject:
+        subject = l
+      matched_reviewers = reviewers_regexp.match(l)
+      if matched_reviewers:
+        tbr = (matched_reviewers.group(1) == 'TBR')
+        reviewers.extend(matched_reviewers.group(2).split(','))
+      parsed_lines.append(l)
+
+    if len(subject) > self.MAX_SUBJECT_LENGTH:
+      subject = subject[:self.MAX_SUBJECT_LENGTH - 3] + '...'
+
+    self.description = '\n'.join(parsed_lines).strip()
+    self.subject = subject
+    self.reviewers = reviewers
+    self.tbr = tbr
+
+  def IsEmpty(self):
+    return not self.description
+
+
+
 def ListRelevantPresubmitFiles(files, root):
   """Finds all presubmit files that apply to a given set of source files.
 
   If inherit-review-settings-ok is present right under root, looks for
   PRESUBMIT.py in directories enclosing root.
 
   Args:
     files: An iterable container containing file paths.
     root: Path where to stop searching.
 
@@ skipping 361 matching lines @@
                               options.verbose,
                               sys.stdout,
                               sys.stdin,
                               options.default_presubmit,
                               options.may_prompt)
   return not results.should_continue()
 
 
 if __name__ == '__main__':
   sys.exit(Main(None))