Home | History | Annotate | Download | only in style 
      1 # Copyright (C) 2010 Google Inc. All rights reserved.
      2 # Copyright (C) 2010 Chris Jerdonek (chris.jerdonek (at] gmail.com)
      3 # Copyright (C) 2010 ProFUSION embedded systems
      4 #
      5 # Redistribution and use in source and binary forms, with or without
      6 # modification, are permitted provided that the following conditions are
      7 # met:
      8 #
      9 #     * Redistributions of source code must retain the above copyright
     10 # notice, this list of conditions and the following disclaimer.
     11 #     * Redistributions in binary form must reproduce the above
     12 # copyright notice, this list of conditions and the following disclaimer
     13 # in the documentation and/or other materials provided with the
     14 # distribution.
     15 #     * Neither the name of Google Inc. nor the names of its
     16 # contributors may be used to endorse or promote products derived from
     17 # this software without specific prior written permission.
     18 #
     19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30 
     31 import logging
     32 import re
     33 
     34 from webkitpy.common.checkout.diff_parser import DiffParser
     35 from webkitpy.common.system.executive import Executive
     36 from webkitpy.common.system.filesystem import FileSystem
     37 from webkitpy.common.checkout.scm.detection import SCMDetector
     38 
     39 
     40 _log = logging.getLogger(__name__)
     41 
     42 
     43 class PatchReader(object):
     44     """Supports checking style in patches."""
     45 
     46     def __init__(self, text_file_reader):
     47         """Create a PatchReader instance.
     48 
     49         Args:
     50           text_file_reader: A TextFileReader instance.
     51 
     52         """
     53         self._text_file_reader = text_file_reader
     54 
     55     def check(self, patch_string, fs=None):
     56         """Check style in the given patch."""
     57         fs = fs or FileSystem()
     58         patch_files = DiffParser(patch_string.splitlines()).files
     59 
     60         # If the user uses git, checking subversion config file only once is enough.
     61         call_only_once = True
     62 
     63         for path, diff_file in patch_files.iteritems():
     64             line_numbers = diff_file.added_or_modified_line_numbers()
     65             _log.debug('Found %s new or modified lines in: %s' % (len(line_numbers), path))
     66 
     67             if not line_numbers:
     68                 match = re.search("\s*png$", path)
     69                 if match and fs.exists(path):
     70                     if call_only_once:
     71                         self._text_file_reader.process_file(file_path=path, line_numbers=None)
     72                         cwd = FileSystem().getcwd()
     73                         detection = SCMDetector(fs, Executive()).detect_scm_system(cwd)
     74                         if detection.display_name() == "git":
     75                             call_only_once = False
     76                     continue
     77                 # Don't check files which contain only deleted lines
     78                 # as they can never add style errors. However, mark them as
     79                 # processed so that we count up number of such files.
     80                 self._text_file_reader.count_delete_only_file()
     81                 continue
     82 
     83             self._text_file_reader.process_file(file_path=path, line_numbers=line_numbers)
     84