<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[164487] trunk/Tools</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/164487">164487</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2014-02-21 11:17:28 -0800 (Fri, 21 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Web Inspector: update check-webkit-style to flag single quotes in WebInspectorUI projects
https://bugs.webkit.org/show_bug.cgi?id=128422
Patch by Diego Pino García <dpino@igalia.com> on 2014-02-21
Reviewed by Joseph Pecoraro.
* Scripts/webkitpy/style/checkers/js.py:
(JSChecker.__init__):
(JSChecker.check):
(SingleQuoteChecker):
(SingleQuoteChecker.__init__):
(SingleQuoteChecker.check):
* Scripts/webkitpy/style/checkers/js_unittest.py:
(JSTestCase.assertError.error_for_test):
(JSTestCase.assertError):
(JSTestCase.test_no_error):
(JSTestCase.test_error):</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptswebkitpystylecheckersjspy">trunk/Tools/Scripts/webkitpy/style/checkers/js.py</a></li>
<li><a href="#trunkToolsScriptswebkitpystylecheckersjs_unittestpy">trunk/Tools/Scripts/webkitpy/style/checkers/js_unittest.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (164486 => 164487)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2014-02-21 19:14:17 UTC (rev 164486)
+++ trunk/Tools/ChangeLog 2014-02-21 19:17:28 UTC (rev 164487)
</span><span class="lines">@@ -1 +1,20 @@
</span><ins>+2014-02-21 Diego Pino García <dpino@igalia.com>
+
+ Web Inspector: update check-webkit-style to flag single quotes in WebInspectorUI projects
+ https://bugs.webkit.org/show_bug.cgi?id=128422
+
+ Reviewed by Joseph Pecoraro.
+
+ * Scripts/webkitpy/style/checkers/js.py:
+ (JSChecker.__init__):
+ (JSChecker.check):
+ (SingleQuoteChecker):
+ (SingleQuoteChecker.__init__):
+ (SingleQuoteChecker.check):
+ * Scripts/webkitpy/style/checkers/js_unittest.py:
+ (JSTestCase.assertError.error_for_test):
+ (JSTestCase.assertError):
+ (JSTestCase.test_no_error):
+ (JSTestCase.test_error):
+
</ins><span class="cx"> == Rolled over to ChangeLog-2014-02-20 ==
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckersjspy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/js.py (164486 => 164487)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/js.py 2014-02-21 19:14:17 UTC (rev 164486)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/js.py 2014-02-21 19:17:28 UTC (rev 164487)
</span><span class="lines">@@ -1,4 +1,5 @@
</span><span class="cx"> # Copyright (C) 2013 University of Washington. All rights reserved.
</span><ins>+# Copyright (C) 2014 Igalia S.L.
</ins><span class="cx"> #
</span><span class="cx"> # Redistribution and use in source and binary forms, with or without
</span><span class="cx"> # modification, are permitted provided that the following conditions are
</span><span class="lines">@@ -23,11 +24,15 @@
</span><span class="cx"> # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
</span><span class="cx"> # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</span><span class="cx">
</span><del>-"""Supports checking WebKit style in JavaScript files"""
</del><ins>+"""
+Supports checking WebKit style in JavaScript files.
</ins><span class="cx">
</span><ins>+This checker is only used to check WebInspector JavaScript files.
+"""
+
</ins><span class="cx"> from common import TabChecker
</span><ins>+import re
</ins><span class="cx">
</span><del>-
</del><span class="cx"> class JSChecker(object):
</span><span class="cx"> """Processes JavaScript lines for checking style."""
</span><span class="cx">
</span><span class="lines">@@ -37,6 +42,50 @@
</span><span class="cx"> def __init__(self, file_path, handle_style_error):
</span><span class="cx"> self._handle_style_error = handle_style_error
</span><span class="cx"> self._tab_checker = TabChecker(file_path, handle_style_error)
</span><ins>+ self._single_quote_checker = SingleQuoteChecker(file_path, handle_style_error)
</ins><span class="cx">
</span><span class="cx"> def check(self, lines):
</span><span class="cx"> self._tab_checker.check(lines)
</span><ins>+ self._single_quote_checker.check(lines)
+
+
+class SingleQuoteChecker(object):
+ """Checks there are not single quotes in source."""
+
+ def __init__(self, file_path, handle_style_error):
+ self._file_path = file_path
+ self._handle_style_error = handle_style_error
+
+ def check(self, lines):
+ in_multiline_comment = False
+ line_number = 0
+ for line in lines:
+ line = line.strip()
+ line_number = line_number + 1
+
+ if (line.endswith("*/")):
+ in_multiline_comment = False
+ continue
+
+ if (line.startswith("/*") or line.startswith("*")):
+ in_multiline_comment = True
+ continue
+
+ # Remove "double quoted" strings.
+ line = re.sub(r'"(?:[^"\\]|\\.)*"', '""', line)
+
+ # Remove single line comment if any.
+ single_line_comment_pos = line.find('//')
+ if (single_line_comment_pos != -1):
+ line = line[:single_line_comment_pos]
+
+ # The whole line was a single line comment, so continue.
+ if (len(line) == 0):
+ continue
+
+ # Remove regexes.
+ line = re.sub('/.+?/', '//', line)
+
+ single_quote_pos = line.find("'")
+ if (single_quote_pos != -1):
+ self._handle_style_error(line_number, "js/syntax", 5, "Line contains single-quote character.")
</ins></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckersjs_unittestpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/js_unittest.py (164486 => 164487)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/js_unittest.py 2014-02-21 19:14:17 UTC (rev 164486)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/js_unittest.py 2014-02-21 19:17:28 UTC (rev 164487)
</span><span class="lines">@@ -56,18 +56,27 @@
</span><span class="cx"> def error_for_test(line_number, category, confidence, message):
</span><span class="cx"> """Checks if the expected error occurs."""
</span><span class="cx"> self.assertEqual(expected_line_number, line_number)
</span><del>- self.assertEqual('whitespace/tab', category)
</del><ins>+ self.assertTrue(category in ['whitespace/tab', 'js/syntax'])
</ins><span class="cx"> self.had_error = True
</span><span class="cx">
</span><span class="cx"> checker = JSChecker('', error_for_test)
</span><span class="cx"> checker.check(lines)
</span><del>- self.assertTrue(self.had_error, '%s should have an error [whitespace/tab].' % lines)
</del><ins>+ self.assertTrue(self.had_error, '%s should have an error [whitespace/tab] or [js/syntax].' % lines)
</ins><span class="cx">
</span><span class="cx"> def test_no_error(self):
</span><span class="cx"> """Tests for no error cases."""
</span><span class="cx"> self.assertNoError([''])
</span><span class="cx"> self.assertNoError(['abc def', 'ggg'])
</span><ins>+ # Single-quotes within string are OK.
+ self.assertNoError(['var foo = "''"'])
+ # Single-quotes within regular expression are OK.
+ self.assertNoError(["var regex = /[a-z']/"])
</ins><span class="cx">
</span><span class="cx"> def test_error(self):
</span><span class="cx"> """Tests for error cases."""
</span><span class="cx"> self.assertError(['\tvar foo = window;\n'], 1)
</span><ins>+ # Single-quotes are not OK.
+ self.assertError(["var foo = 'Hello world!;'\n"], 1)
+ self.assertError(["foo(\"a'b\", 'c');"], 1)
+ self.assertError(["foo(\"a/'b\", '/c');"], 1)
+ self.assertError(["foo(/'/, 'c');"], 1)
</ins></span></pre>
</div>
</div>
</body>
</html>