Rules: Add the 'comments-indentation' rule

2016-01-14 18:08:55 +01:00
parent e81b73c111
commit 233a70adb3
8 changed files with 315 additions and 107 deletions
--- a/tests/rules/test_common.py
+++ b/tests/rules/test_common.py
@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2016 Adrien Vergé
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import unittest
+
+import yaml
+
+from yamllint.rules.common import Comment, get_comments_between_tokens
+
+
+class CommonTestCase(unittest.TestCase):
+    def check_comments(self, buffer, *expected):
+        yaml_loader = yaml.BaseLoader(buffer)
+
+        comments = []
+
+        next = yaml_loader.peek_token()
+        while next is not None:
+            curr = yaml_loader.get_token()
+            next = yaml_loader.peek_token()
+            for comment in get_comments_between_tokens(curr, next):
+                comments.append(comment)
+
+        self.assertEqual(comments, list(expected))
+
+    def test_get_comments_between_tokens(self):
+        self.check_comments('# comment\n',
+                            Comment(1, 1, '# comment', 0))
+        self.check_comments('---\n'
+                            '# comment\n'
+                            '...\n',
+                            Comment(2, 1, '# comment', 0))
+        self.check_comments('---\n'
+                            '# no newline char',
+                            Comment(2, 1, '# no newline char', 0))
+        self.check_comments('# just comment',
+                            Comment(1, 1, '# just comment', 0))
+        self.check_comments('\n'
+                            '   # indented comment\n',
+                            Comment(2, 4, '# indented comment', 0))
+        self.check_comments('\n'
+                            '# trailing spaces    \n',
+                            Comment(2, 1, '# trailing spaces    ', 0))
+        self.check_comments('# comment one\n'
+                            '\n'
+                            'key: val  # key=val\n'
+                            '\n'
+                            '# this is\n'
+                            '# a block     \n'
+                            '# comment\n'
+                            '\n'
+                            'other:\n'
+                            '  - foo  # equals\n'
+                            '         # bar\n',
+                            Comment(1, 1, '# comment one', 0),
+                            Comment(3, 11, '# key=val', 0),
+                            Comment(5, 1, '# this is', 0),
+                            Comment(6, 1, '# a block     ', 0),
+                            Comment(7, 1, '# comment', 0),
+                            Comment(10, 10, '# equals', 0),
+                            Comment(11, 10, '# bar', 0))