Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/tools/tests/test_pretty_print.py

495 lines
9.4 KiB
Python
Raw Normal View History

tools: Create HTML pretty printer. In This commit we extend the work being done by @showell in PR#1778 to develop a tool to pretty print html and our handlebar templates in order to enforce our style convention of 4 Space indentation in templates. This commit introduces following changes: * Fix Py3 Compatibility. * Add ability to prettify in cases when html tags are not the starting of a line and addition of test cases for it. * Add ability to lint handlebar tags and add test cases for it. * Add {{else}} as special case of indent. * Add test cases in general to testing new tool. @showell Helped me throughout and reviewed this commit. Fixes #1778
2017-02-15 05:39:42 +01:00
import unittest
from tools.lib.pretty_print import pretty_print_html
# Note that GOOD_HTML isn't necessarily beautiful HTML. Apart
# from adjusting indentation, we mostly leave things alone to
# respect whatever line-wrapping styles were in place before.
BAD_HTML = """
<!-- test -->
<!DOCTYPE html>
<html>
<!-- test -->
<head>
<title>Test</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="style.css" />
</head>
<body>
<div><p>Hello<br />world!</p></div>
<p>Goodbye<!-- test -->world!</p>
<table>
<tr>
<td>5</td>
</tr>
</table>
<pre>
print 'hello world'
</pre>
<div class = "foo"
id = "bar"
role = "whatever">{{ bla }}</div>
</body>
</html>
<!-- test -->
"""
GOOD_HTML = """
<!-- test -->
<!DOCTYPE html>
<html>
<!-- test -->
<head>
<title>Test</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="style.css" />
</head>
<body>
<div><p>Hello<br />world!</p></div>
<p>Goodbye<!-- test -->world!</p>
<table>
<tr>
<td>5</td>
</tr>
</table>
Enhance template parser for comments, Fix deep nesting in Jinja2. In this commit we add the ability of recognizing comments in handlebar and Jinja2 templates to the template parser. This fixes issue of template parser picking up code tags which are commented out in files. Also we fix the problem of too much deep nesting in the Jinja2 logic statement. Now only nested Jinja2 logic statements will get a deeper indentation level.With this another fix was introduced relating with the tags before a nested handlebar or django tag getting wrong indent. We also fix the issue with wrong offsets with closing tags in cases if they were not matching indent level of the starting tag intially. Also we also start to ignore any tags occuring in between 'pre' tags for deeper indent levels. As well we start to filter out django non block tags from getting deeper indent level.
2017-02-23 18:12:52 +01:00
<pre>
print 'hello world'
</pre>
tools: Create HTML pretty printer. In This commit we extend the work being done by @showell in PR#1778 to develop a tool to pretty print html and our handlebar templates in order to enforce our style convention of 4 Space indentation in templates. This commit introduces following changes: * Fix Py3 Compatibility. * Add ability to prettify in cases when html tags are not the starting of a line and addition of test cases for it. * Add ability to lint handlebar tags and add test cases for it. * Add {{else}} as special case of indent. * Add test cases in general to testing new tool. @showell Helped me throughout and reviewed this commit. Fixes #1778
2017-02-15 05:39:42 +01:00
<div class = "foo"
linter: Enforce 2 space indents on tags spread over multiple lines. We make some specific cases of tags use 2 space indents. The case description: * A tag with opening tag spread over multiple lines and closing tag on the same line as of the closing angle bracket of the opening tag. * A tag with opening tag spread over multiple lines and closing tag not on the same line as of the closing angle bracket of the opening tag. Example: Case 1: Not linted: <button type="button" class="btn btn-primary btn-small">{{t "Yes" }}</button> After linting: <button type="button" class="btn btn-primary btn-small">{{t "Yes" }}</button> Case 2: Before linting: <div class = "foo" id = "bar" role = "whatever"> {{ bla }} </div> After linting: <div class = "foo" id = "bar" role = "whatever"> {{ bla }} </div>
2018-04-05 08:38:46 +02:00
id = "bar"
role = "whatever">{{ bla }}</div>
tools: Create HTML pretty printer. In This commit we extend the work being done by @showell in PR#1778 to develop a tool to pretty print html and our handlebar templates in order to enforce our style convention of 4 Space indentation in templates. This commit introduces following changes: * Fix Py3 Compatibility. * Add ability to prettify in cases when html tags are not the starting of a line and addition of test cases for it. * Add ability to lint handlebar tags and add test cases for it. * Add {{else}} as special case of indent. * Add test cases in general to testing new tool. @showell Helped me throughout and reviewed this commit. Fixes #1778
2017-02-15 05:39:42 +01:00
</body>
</html>
<!-- test -->
"""
BAD_HTML1 = """
<html>
<body>
foobarfoobarfoo<b>bar</b>
</body>
</html>
"""
GOOD_HTML1 = """
<html>
<body>
foobarfoobarfoo<b>bar</b>
</body>
</html>
"""
BAD_HTML2 = """
<html>
<body>
{{# foobar area}}
foobarfoobarfoo<b>bar</b>
{{/ foobar area}}
</body>
</html>
"""
GOOD_HTML2 = """
<html>
<body>
{{# foobar area}}
foobarfoobarfoo<b>bar</b>
{{/ foobar area}}
</body>
</html>
"""
BAD_HTML3 = """
<html>
<body>
{{# foobar area}}
foobarfoobar<blockquote>
<p>
FOOBAR
</p>
</blockquote>
{{/ foobar area}}
</body>
</html>
"""
GOOD_HTML3 = """
<html>
<body>
{{# foobar area}}
foobarfoobar<blockquote>
<p>
FOOBAR
</p>
</blockquote>
{{/ foobar area}}
</body>
</html>
"""
BAD_HTML4 = """
<div>
foo
<p>hello</p>
bar
</div>
"""
GOOD_HTML4 = """
<div>
foo
<p>hello</p>
bar
</div>
"""
BAD_HTML5 = """
<div>
foo
{{#if foobar}}
hello
{{else}}
bye
{{/if}}
bar
</div>
"""
GOOD_HTML5 = """
<div>
foo
{{#if foobar}}
hello
{{else}}
bye
{{/if}}
bar
</div>
"""
BAD_HTML6 = """
<div>
<p> <strong> <span class = "whatever">foobar </span> </strong></p>
</div>
"""
GOOD_HTML6 = """
<div>
<p> <strong> <span class = "whatever">foobar </span> </strong></p>
</div>
"""
Add Django and html singleton tags support to pretty print. In this commit we are modifying pretty print tool to support Django and html singleton tags. For Addition of html singleton tags template parser was modified to emit psudeo html singleton end tags to accompany html singleton tags and token class was updated to have line_span field.
2017-02-16 20:25:53 +01:00
BAD_HTML7 = """
<div class="foobar">
<input type="foobar" name="temp" value="{{dyn_name}}"
{{#unless invite_only}}checked="checked"{{/unless}} /> {{dyn_name}}
icons: Remove base class from comments and test templates.
2018-10-15 16:25:18 +02:00
{{#if invite_only}}<i class="fa fa-lock"></i>{{/if}}
Add Django and html singleton tags support to pretty print. In this commit we are modifying pretty print tool to support Django and html singleton tags. For Addition of html singleton tags template parser was modified to emit psudeo html singleton end tags to accompany html singleton tags and token class was updated to have line_span field.
2017-02-16 20:25:53 +01:00
</div>
"""
GOOD_HTML7 = """
<div class="foobar">
<input type="foobar" name="temp" value="{{dyn_name}}"
linter: Make html singleton tags use 2 space indentation.
2018-04-03 10:07:23 +02:00
{{#unless invite_only}}checked="checked"{{/unless}} /> {{dyn_name}}
icons: Remove base class from comments and test templates.
2018-10-15 16:25:18 +02:00
{{#if invite_only}}<i class="fa fa-lock"></i>{{/if}}
Add Django and html singleton tags support to pretty print. In this commit we are modifying pretty print tool to support Django and html singleton tags. For Addition of html singleton tags template parser was modified to emit psudeo html singleton end tags to accompany html singleton tags and token class was updated to have line_span field.
2017-02-16 20:25:53 +01:00
</div>
"""
BAD_HTML8 = """
{{#each test}}
{{#with this}}
{{#if foobar}}
<div class="anything">{{{test}}}</div>
{{/if}}
{{#if foobar2}}
templates: Use upstream Handlebars partials syntax. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-11 04:05:28 +02:00
{{> teststuff}}
Add Django and html singleton tags support to pretty print. In this commit we are modifying pretty print tool to support Django and html singleton tags. For Addition of html singleton tags template parser was modified to emit psudeo html singleton end tags to accompany html singleton tags and token class was updated to have line_span field.
2017-02-16 20:25:53 +01:00
{{/if}}
{{/with}}
{{/each}}
"""
GOOD_HTML8 = """
{{#each test}}
{{#with this}}
{{#if foobar}}
<div class="anything">{{{test}}}</div>
{{/if}}
{{#if foobar2}}
templates: Use upstream Handlebars partials syntax. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-11 04:05:28 +02:00
{{> teststuff}}
Add Django and html singleton tags support to pretty print. In this commit we are modifying pretty print tool to support Django and html singleton tags. For Addition of html singleton tags template parser was modified to emit psudeo html singleton end tags to accompany html singleton tags and token class was updated to have line_span field.
2017-02-16 20:25:53 +01:00
{{/if}}
{{/with}}
{{/each}}
"""
Enhance template parser for comments, Fix deep nesting in Jinja2. In this commit we add the ability of recognizing comments in handlebar and Jinja2 templates to the template parser. This fixes issue of template parser picking up code tags which are commented out in files. Also we fix the problem of too much deep nesting in the Jinja2 logic statement. Now only nested Jinja2 logic statements will get a deeper indentation level.With this another fix was introduced relating with the tags before a nested handlebar or django tag getting wrong indent. We also fix the issue with wrong offsets with closing tags in cases if they were not matching indent level of the starting tag intially. Also we also start to ignore any tags occuring in between 'pre' tags for deeper indent levels. As well we start to filter out django non block tags from getting deeper indent level.
2017-02-23 18:12:52 +01:00
BAD_HTML9 = """
<form id="foobar" class="whatever">
{{! <div class="anothertest"> }}
<input value="test" />
<button type="button"><i class="test"></i></button>
<button type="button"><i class="test"></i></button>
{{! </div> }}
<div class="test"></div>
</form>
"""
GOOD_HTML9 = """
<form id="foobar" class="whatever">
{{! <div class="anothertest"> }}
<input value="test" />
<button type="button"><i class="test"></i></button>
<button type="button"><i class="test"></i></button>
{{! </div> }}
<div class="test"></div>
</form>
"""
BAD_HTML10 = """
{% block portico_content %}
<div class="test">
<i class='test'></i> foobar
</div>
<div class="test1">
{% for row in data %}
<div class="test2">
{% for group in (row[0:2], row[2:4]) %}
<div class="test2">
</div>
{% endfor %}
</div>
{% endfor %}
</div>
{% endblock %}
"""
GOOD_HTML10 = """
{% block portico_content %}
<div class="test">
<i class='test'></i> foobar
</div>
<div class="test1">
{% for row in data %}
<div class="test2">
{% for group in (row[0:2], row[2:4]) %}
<div class="test2">
</div>
{% endfor %}
</div>
{% endfor %}
</div>
{% endblock %}
"""
BAD_HTML11 = """
<div class="test1">
<div class="test2">
foobar
<div class="test2">
</div>
</div>
</div>
"""
GOOD_HTML11 = """
<div class="test1">
<div class="test2">
foobar
<div class="test2">
</div>
</div>
</div>
"""
BAD_HTML12 = """
<div class="test1">
<pre>
<div class="test2">
foobar
<div class="test2">
</div>
</div>
</pre>
</div>
"""
GOOD_HTML12 = """
<div class="test1">
<pre>
<div class="test2">
foobar
<div class="test2">
</div>
</div>
</pre>
</div>
"""
BAD_HTML13 = """
<div>
{{#if this.code}}
<div>&nbsp:{{this.name}}:</div>
{{else}}
{{#if this.is_realm_emoji}}
<img src="{{this.url}}" class="emoji" />
{{else}}
<div/>
{{/if}}
{{/if}}
<div>{{this.count}}</div>
</div>
"""
GOOD_HTML13 = """
<div>
{{#if this.code}}
<div>&nbsp:{{this.name}}:</div>
{{else}}
{{#if this.is_realm_emoji}}
<img src="{{this.url}}" class="emoji" />
{{else}}
<div/>
{{/if}}
{{/if}}
<div>{{this.count}}</div>
</div>
"""
linter: Fix bug resulting in <pre> being indented cyclically.
2017-06-13 07:14:48 +02:00
BAD_HTML14 = """
<div>
{{#if this.code}}
<pre>Here goes some cool code.</pre>
{{else}}
<div>
content of first div
<div>
content of second div.
</div>
</div>
{{/if}}
</div>
"""
GOOD_HTML14 = """
<div>
{{#if this.code}}
<pre>Here goes some cool code.</pre>
{{else}}
<div>
content of first div
<div>
content of second div.
</div>
</div>
{{/if}}
</div>
"""
linter: Make html singleton tags use 2 space indentation.
2018-04-03 10:07:23 +02:00
BAD_HTML15 = """
<div>
<img alt=":thumbs_up:"
class="emoji"
src="/path/to/png"
title=":thumbs_up:"/>
<img alt=":thumbs_up:"
class="emoji"
src="/path/to/png"
title=":thumbs_up:"/>
<img alt=":thumbs_up:"
title=":thumbs_up:"/>
</div>
"""
GOOD_HTML15 = """
<div>
<img alt=":thumbs_up:"
class="emoji"
src="/path/to/png"
title=":thumbs_up:"/>
<img alt=":thumbs_up:"
class="emoji"
src="/path/to/png"
title=":thumbs_up:"/>
<img alt=":thumbs_up:"
title=":thumbs_up:"/>
</div>
"""
linter: Make multiline handlebar singleton tags use 2 space indentation.
2018-04-03 10:09:00 +02:00
BAD_HTML16 = """
<div>
templates: Use upstream Handlebars partials syntax. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-11 04:05:28 +02:00
{{> settings_checkbox
setting_name="realm_name_in_notifications"
is_checked=page_params.realm_name_in_notifications
label=settings_label.realm_name_in_notifications}}
linter: Make multiline handlebar singleton tags use 2 space indentation.
2018-04-03 10:09:00 +02:00
</div>
"""
GOOD_HTML16 = """
<div>
templates: Use upstream Handlebars partials syntax. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-11 04:05:28 +02:00
{{> settings_checkbox
setting_name="realm_name_in_notifications"
is_checked=page_params.realm_name_in_notifications
label=settings_label.realm_name_in_notifications}}
linter: Make multiline handlebar singleton tags use 2 space indentation.
2018-04-03 10:09:00 +02:00
</div>
"""
linter: Enforce 2 space indents on tags spread over multiple lines. We make some specific cases of tags use 2 space indents. The case description: * A tag with opening tag spread over multiple lines and closing tag on the same line as of the closing angle bracket of the opening tag. * A tag with opening tag spread over multiple lines and closing tag not on the same line as of the closing angle bracket of the opening tag. Example: Case 1: Not linted: <button type="button" class="btn btn-primary btn-small">{{t "Yes" }}</button> After linting: <button type="button" class="btn btn-primary btn-small">{{t "Yes" }}</button> Case 2: Before linting: <div class = "foo" id = "bar" role = "whatever"> {{ bla }} </div> After linting: <div class = "foo" id = "bar" role = "whatever"> {{ bla }} </div>
2018-04-05 08:38:46 +02:00
BAD_HTML17 = """
<div>
<button type="button"
class="btn btn-primary btn-small">{{t "Yes" }}</button>
<button type="button"
id="confirm_btn"
class="btn btn-primary btn-small">{{t "Yes" }}</button>
<div class = "foo"
id = "bar"
role = "whatever">
{{ bla }}
</div>
</div>
"""
GOOD_HTML17 = """
<div>
<button type="button"
class="btn btn-primary btn-small">{{t "Yes" }}</button>
<button type="button"
id="confirm_btn"
class="btn btn-primary btn-small">{{t "Yes" }}</button>
<div class = "foo"
id = "bar"
role = "whatever">
{{ bla }}
</div>
</div>
"""
tools: Create HTML pretty printer. In This commit we extend the work being done by @showell in PR#1778 to develop a tool to pretty print html and our handlebar templates in order to enforce our style convention of 4 Space indentation in templates. This commit introduces following changes: * Fix Py3 Compatibility. * Add ability to prettify in cases when html tags are not the starting of a line and addition of test cases for it. * Add ability to lint handlebar tags and add test cases for it. * Add {{else}} as special case of indent. * Add test cases in general to testing new tool. @showell Helped me throughout and reviewed this commit. Fixes #1778
2017-02-15 05:39:42 +01:00
class TestPrettyPrinter(unittest.TestCase):
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def compare(self, a: str, b: str) -> None:
tools: Create HTML pretty printer. In This commit we extend the work being done by @showell in PR#1778 to develop a tool to pretty print html and our handlebar templates in order to enforce our style convention of 4 Space indentation in templates. This commit introduces following changes: * Fix Py3 Compatibility. * Add ability to prettify in cases when html tags are not the starting of a line and addition of test cases for it. * Add ability to lint handlebar tags and add test cases for it. * Add {{else}} as special case of indent. * Add test cases in general to testing new tool. @showell Helped me throughout and reviewed this commit. Fixes #1778
2017-02-15 05:39:42 +01:00
self.assertEqual(a.split('\n'), b.split('\n'))
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def test_pretty_print(self) -> None:
tools: Create HTML pretty printer. In This commit we extend the work being done by @showell in PR#1778 to develop a tool to pretty print html and our handlebar templates in order to enforce our style convention of 4 Space indentation in templates. This commit introduces following changes: * Fix Py3 Compatibility. * Add ability to prettify in cases when html tags are not the starting of a line and addition of test cases for it. * Add ability to lint handlebar tags and add test cases for it. * Add {{else}} as special case of indent. * Add test cases in general to testing new tool. @showell Helped me throughout and reviewed this commit. Fixes #1778
2017-02-15 05:39:42 +01:00
self.compare(pretty_print_html(GOOD_HTML), GOOD_HTML)
self.compare(pretty_print_html(BAD_HTML), GOOD_HTML)
self.compare(pretty_print_html(BAD_HTML1), GOOD_HTML1)
self.compare(pretty_print_html(BAD_HTML2), GOOD_HTML2)
self.compare(pretty_print_html(BAD_HTML3), GOOD_HTML3)
self.compare(pretty_print_html(BAD_HTML4), GOOD_HTML4)
self.compare(pretty_print_html(BAD_HTML5), GOOD_HTML5)
self.compare(pretty_print_html(BAD_HTML6), GOOD_HTML6)
Add Django and html singleton tags support to pretty print. In this commit we are modifying pretty print tool to support Django and html singleton tags. For Addition of html singleton tags template parser was modified to emit psudeo html singleton end tags to accompany html singleton tags and token class was updated to have line_span field.
2017-02-16 20:25:53 +01:00
self.compare(pretty_print_html(BAD_HTML7), GOOD_HTML7)
self.compare(pretty_print_html(BAD_HTML8), GOOD_HTML8)
Enhance template parser for comments, Fix deep nesting in Jinja2. In this commit we add the ability of recognizing comments in handlebar and Jinja2 templates to the template parser. This fixes issue of template parser picking up code tags which are commented out in files. Also we fix the problem of too much deep nesting in the Jinja2 logic statement. Now only nested Jinja2 logic statements will get a deeper indentation level.With this another fix was introduced relating with the tags before a nested handlebar or django tag getting wrong indent. We also fix the issue with wrong offsets with closing tags in cases if they were not matching indent level of the starting tag intially. Also we also start to ignore any tags occuring in between 'pre' tags for deeper indent levels. As well we start to filter out django non block tags from getting deeper indent level.
2017-02-23 18:12:52 +01:00
self.compare(pretty_print_html(BAD_HTML9), GOOD_HTML9)
self.compare(pretty_print_html(BAD_HTML10), GOOD_HTML10)
self.compare(pretty_print_html(BAD_HTML11), GOOD_HTML11)
self.compare(pretty_print_html(BAD_HTML12), GOOD_HTML12)
self.compare(pretty_print_html(BAD_HTML13), GOOD_HTML13)
linter: Fix bug resulting in <pre> being indented cyclically.
2017-06-13 07:14:48 +02:00
self.compare(pretty_print_html(BAD_HTML14), GOOD_HTML14)
linter: Make html singleton tags use 2 space indentation.
2018-04-03 10:07:23 +02:00
self.compare(pretty_print_html(BAD_HTML15), GOOD_HTML15)
linter: Make multiline handlebar singleton tags use 2 space indentation.
2018-04-03 10:09:00 +02:00
self.compare(pretty_print_html(BAD_HTML16), GOOD_HTML16)
linter: Enforce 2 space indents on tags spread over multiple lines. We make some specific cases of tags use 2 space indents. The case description: * A tag with opening tag spread over multiple lines and closing tag on the same line as of the closing angle bracket of the opening tag. * A tag with opening tag spread over multiple lines and closing tag not on the same line as of the closing angle bracket of the opening tag. Example: Case 1: Not linted: <button type="button" class="btn btn-primary btn-small">{{t "Yes" }}</button> After linting: <button type="button" class="btn btn-primary btn-small">{{t "Yes" }}</button> Case 2: Before linting: <div class = "foo" id = "bar" role = "whatever"> {{ bla }} </div> After linting: <div class = "foo" id = "bar" role = "whatever"> {{ bla }} </div>
2018-04-05 08:38:46 +02:00
self.compare(pretty_print_html(BAD_HTML17), GOOD_HTML17)