Rules: Add the 'comments-indentation' rule

yamllint/rules/common.py

@@ -14,6 +14,8 @@
 # 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 yaml
+
 from yamllint.errors import LintProblem
 
 
@@ -39,3 +41,53 @@ def spaces_before(token, prev, next, min=-1, max=-1,
         elif min != - 1 and spaces < min:
             return LintProblem(token.start_mark.line + 1,
                                token.start_mark.column + 1, min_desc)
+
+
+class Comment(object):
+    def __init__(self, line, column, buffer, pointer):
+        self.line = line
+        self.column = column
+        self.buffer = buffer
+        self.pointer = pointer
+
+    def __repr__(self):
+        end = self.buffer.find('\n', self.pointer)
+        if end == -1:
+            end = self.buffer.find('\0', self.pointer)
+        if end != -1:
+            return self.buffer[self.pointer:end]
+        return self.buffer[self.pointer:]
+
+    def __eq__(self, other):
+        return (self.line == other.line and
+                self.column == other.column and
+                str(self) == str(other))
+
+
+def get_comments_between_tokens(token1, token2, skip_first_line=False):
+    if token2 is None:
+        buf = token1.end_mark.buffer[token1.end_mark.pointer:]
+    elif (token1.end_mark.line == token2.start_mark.line and
+          not isinstance(token1, yaml.StreamStartToken) and
+          not isinstance(token2, yaml.StreamEndToken)):
+        return
+    else:
+        buf = token1.end_mark.buffer[token1.end_mark.pointer:
+                                     token2.start_mark.pointer]
+
+    line_no = token1.end_mark.line + 1
+    column_no = token1.end_mark.column + 1
+    pointer = token1.end_mark.pointer
+
+    for line in buf.split('\n'):
+        if skip_first_line:
+            skip_first_line = False
+        else:
+            pos = line.find('#')
+            if pos != -1:
+                yield Comment(line_no, column_no + pos,
+                              token1.end_mark.buffer, pointer + pos)
+
+        pointer += len(line) + 1
+        line_no += 1
+        column_no = 1