IndentationWidth auto-correct breaks block comments

[andreaseger]

So I currently starting to use rubocop on a huge and quite old codebase(>4k files) and as usually thats when bugs starting to appear.
This one is about the IndentationWidth auto-correct code. Have a look at this minimal example:

Before:

module Foo
class Bar
=begin
This is a nice long
comment
which spans a few lines
=end
  def baz
    do_something
  end
end
end

Then I run this command on the file rubocop --only IndentationWidth --auto-correct block_comment_rubocop_example.rb
After the file looks like this and is obviously broken.

module Foo
  class Bar
  =begin
  This is a nice long
  comment
  which spans a few lines
  =end
    def baz
      do_something
    end
  end
end

> rubocop -V
0.22.0 (using Parser 2.1.9, running on ruby 2.1.2 x86_64-linux)

(I don't want to discuss the use of block comments, as mentioned old and huge codebase)

[bbatsov]

I haven't seen those in a while. :-) @jonas054 Would you, please, handle this? I'm also thinking we should add auto-correct support to our block comments cop to convert them to regular comments.

[andreaseger]

Found a similar issue with heredoc

Before:

module Foo
module Bar
  SOMETHING = <<GOO
text
more text
foo
GOO
  def baz
    do_something
  end
end
end

After rubocop --only IndentationWidth --auto-correct heredoc_rubocop_bug.rb

module Foo
  module Bar
    SOMETHING = <<GOO
  text
  more text
  foo
  GOO
    def baz
      do_something
    end
  end
end

Tell me if I should create a separate issue for this one. For me this seems to be the same core issue.

[andreaseger]

Another one related to heredoc, this time AlignArray introduced the problems - I still think its the same issue as all these cops use the AutocorrectAlignment module.

Before

var = [
       { :type => 'something',
         :sql => <<EOF
Select something
from atable
EOF
       },
      { :type => 'something',
        :sql => <<EOF
Select something
from atable
EOF
      }
]

After rubocop --only AlignArray --auto-correct heredoc_rubocop_bug2.rb

var = [
       { :type => 'something',
         :sql => <<EOF
Select something
from atable
EOF
       },
       { :type => 'something',
         :sql => <<EOF
 Select something
 from atable
 EOF
       }
]

[andreaseger]

thanks for the quick fix for the block comment issue. shall I open a new issue for the two heredoc issues I listed here?

[bbatsov]

Yes. Probably @jonas054 missed those. —
Sent from Mailbox

On Thu, May 29, 2014 at 1:06 PM, Eger Andreas notifications@github.com
wrote:

thanks for the quick fix for the block comment issue. shall I open a new issue for the two heredoc issues I listed here?

Reply to this email directly or view it on GitHub:
#1117 (comment)