Plumb style-checker filter up to command options and make land-cowboy use it.
[WebKit-https.git] / Tools / Scripts / webkitpy / style / checkers / changelog.py
1 #!/usr/bin/env python
2 #
3 # Copyright (C) 2011 Patrick Gansterer <paroga@paroga.com>
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 # 1.  Redistributions of source code must retain the above copyright
9 #     notice, this list of conditions and the following disclaimer.
10 # 2.  Redistributions in binary form must reproduce the above copyright
11 #     notice, this list of conditions and the following disclaimer in the
12 #     documentation and/or other materials provided with the distribution.
13 #
14 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25
26 """Checks WebKit style for ChangeLog files."""
27
28 import re
29 from common import TabChecker
30 from webkitpy.common.checkout.changelog import parse_bug_id_from_changelog
31
32
33 class ChangeLogChecker(object):
34     """Processes text lines for checking style."""
35
36     categories = set(['changelog/bugnumber', 'changelog/filechangedescriptionwhitespace'])
37
38     def __init__(self, file_path, handle_style_error, should_line_be_checked):
39         self.file_path = file_path
40         self.handle_style_error = handle_style_error
41         self.should_line_be_checked = should_line_be_checked
42         self._tab_checker = TabChecker(file_path, handle_style_error)
43
44     def check_entry(self, first_line_checked, entry_lines):
45         if not entry_lines:
46             return
47         for line in entry_lines:
48             if parse_bug_id_from_changelog(line):
49                 break
50             if re.search("Unreviewed", line, re.IGNORECASE):
51                 break
52             if re.search("build", line, re.IGNORECASE) and re.search("fix", line, re.IGNORECASE):
53                 break
54         else:
55             self.handle_style_error(first_line_checked,
56                                     "changelog/bugnumber", 5,
57                                     "ChangeLog entry has no bug number")
58         # check file change descriptions for style violations
59         line_no = first_line_checked - 1
60         for line in entry_lines:
61             line_no = line_no + 1
62             # filter file change descriptions
63             if not re.match('\s*\*\s', line):
64                 continue
65             if re.search(':\s*$', line) or re.search(':\s', line):
66                 continue
67             self.handle_style_error(line_no,
68                                     "changelog/filechangedescriptionwhitespace", 5,
69                                     "Need whitespace between colon and description")
70
71
72     def check(self, lines):
73         self._tab_checker.check(lines)
74         first_line_checked = 0
75         entry_lines = []
76
77         for line_index, line in enumerate(lines):
78             if not self.should_line_be_checked(line_index + 1):
79                 # If we transitioned from finding changed lines to
80                 # unchanged lines, then we are done.
81                 if first_line_checked:
82                     break
83                 continue
84             if not first_line_checked:
85                 first_line_checked = line_index + 1
86             entry_lines.append(line)
87
88         self.check_entry(first_line_checked, entry_lines)