Home | History | Annotate | Download | only in common 
      1 # Copyright (c) 2010 Google Inc. All rights reserved.
      2 #
      3 # Redistribution and use in source and binary forms, with or without
      4 # modification, are permitted provided that the following conditions are
      5 # met:
      6 #
      7 #     * Redistributions of source code must retain the above copyright
      8 # notice, this list of conditions and the following disclaimer.
      9 #     * Redistributions in binary form must reproduce the above
     10 # copyright notice, this list of conditions and the following disclaimer
     11 # in the documentation and/or other materials provided with the
     12 # distribution.
     13 #     * Neither the name of Google Inc. nor the names of its
     14 # contributors may be used to endorse or promote products derived from
     15 # this software without specific prior written permission.
     16 #
     17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28 
     29 import os
     30 import tempfile
     31 
     32 
     33 class PrettyPatch(object):
     34     # FIXME: PrettyPatch should not require checkout_root.
     35     def __init__(self, executive, checkout_root):
     36         self._executive = executive
     37         self._checkout_root = checkout_root
     38 
     39     def pretty_diff_file(self, diff):
     40         # Diffs can contain multiple text files of different encodings
     41         # so we always deal with them as byte arrays, not unicode strings.
     42         assert(isinstance(diff, str))
     43         pretty_diff = self.pretty_diff(diff)
     44         diff_file = tempfile.NamedTemporaryFile(suffix=".html")
     45         diff_file.write(pretty_diff)
     46         diff_file.flush()
     47         return diff_file
     48 
     49     def pretty_diff(self, diff):
     50         # pretify.rb will hang forever if given no input.
     51         # Avoid the hang by returning an empty string.
     52         if not diff:
     53             return ""
     54 
     55         pretty_patch_path = os.path.join(self._checkout_root,
     56                                          "Websites", "bugs.webkit.org",
     57                                          "PrettyPatch")
     58         prettify_path = os.path.join(pretty_patch_path, "prettify.rb")
     59         args = [
     60             "ruby",
     61             "-I",
     62             pretty_patch_path,
     63             prettify_path,
     64         ]
     65         # PrettyPatch does not modify the encoding of the diff output
     66         # so we can't expect it to be utf-8.
     67         return self._executive.run_command(args, input=diff, decode_output=False)
     68