Home | History | Annotate | Download | only in scm 
      1 # Copyright (c) 2009, 2010, 2011 Google Inc. All rights reserved.
      2 # Copyright (c) 2009 Apple Inc. All rights reserved.
      3 #
      4 # Redistribution and use in source and binary forms, with or without
      5 # modification, are permitted provided that the following conditions are
      6 # met:
      7 #
      8 #     * Redistributions of source code must retain the above copyright
      9 # notice, this list of conditions and the following disclaimer.
     10 #     * Redistributions in binary form must reproduce the above
     11 # copyright notice, this list of conditions and the following disclaimer
     12 # in the documentation and/or other materials provided with the
     13 # distribution.
     14 #     * Neither the name of Google Inc. nor the names of its
     15 # contributors may be used to endorse or promote products derived from
     16 # this software without specific prior written permission.
     17 #
     18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29 
     30 import re
     31 
     32 
     33 def _first_non_empty_line_after_index(lines, index=0):
     34     first_non_empty_line = index
     35     for line in lines[index:]:
     36         if re.match("^\s*$", line):
     37             first_non_empty_line += 1
     38         else:
     39             break
     40     return first_non_empty_line
     41 
     42 
     43 class CommitMessage:
     44     def __init__(self, message):
     45         self.message_lines = message[_first_non_empty_line_after_index(message, 0):]
     46 
     47     def body(self, lstrip=False):
     48         lines = self.message_lines[_first_non_empty_line_after_index(self.message_lines, 1):]
     49         if lstrip:
     50             lines = [line.lstrip() for line in lines]
     51         return "\n".join(lines) + "\n"
     52 
     53     def description(self, lstrip=False, strip_url=False):
     54         line = self.message_lines[0]
     55         if lstrip:
     56             line = line.lstrip()
     57         if strip_url:
     58             line = re.sub("^(\s*)<.+> ", "\1", line)
     59         return line
     60 
     61     def message(self):
     62         return "\n".join(self.message_lines) + "\n"
     63