fix skip comments when aligning variables (#58)

Author: bhirsz

robotidy/transformers/AlignVariablesSection.py

@@ -35,7 +35,7 @@ class AlignVariablesSection(ModelTransformer):
     def visit_VariableSection(self, node):  # noqa
         statements = []
         for child in node.body:
-            if child.type == 'EOL':
+            if child.type in (Token.EOL, Token.COMMENT):
                 statements.append(child)
             else:
                 statements.append(list(self.tokens_by_lines(child)))

robotidy/version.py

@@ -1 +1 @@
-__version__ = '1.1.0'
+__version__ = '1.1.1'

tests/atest/transformers/AlignVariablesSection/expected/long_comment.robot

@@ -0,0 +1,12 @@
+*** Variables ***
+# some comment that is longer than usual and can go and go and ends     here
+
+${VARIABLE 1}                           10                                  # comment
+@{LIST}                                 a                                   b               c       d
+${LONGER_NAME_THAT_GOES_AND_GOES}       longer value that goes and goes
+
+&{MULTILINE}                            a=b
+...                                     b=c
+...                                     d=1
+${invalid}
+${invalid_more}

tests/atest/transformers/AlignVariablesSection/source/long_comment.robot

@@ -0,0 +1,12 @@
+*** Variables ***
+# some comment that is longer than usual and can go and go and ends     here
+
+${VARIABLE 1}  10  # comment
+@{LIST}  a  b  c  d
+${LONGER_NAME_THAT_GOES_AND_GOES}    longer value that goes and goes
+
+           &{MULTILINE}  a=b
+...  b=c
+...         d=1
+ ${invalid}
+  ${invalid_more}

tests/atest/transformers/test_transformers.py

@@ -296,3 +296,6 @@ def test_align_variables(self):
 
     def test_align_with_optional_equal_signs(self):
         run_tidy_and_compare(self.TRANSFORMER_NAME, sources=['optional_equal_sign.robot'])
+
+    def test_align_with_long_comment(self):
+        run_tidy_and_compare(self.TRANSFORMER_NAME, sources=['long_comment.robot'])