Autocorrect for Layout/IndentHeredoc mangles Heredoc

[movermeyer]

When Layout/IndentHeredoc detects a violation, its autocorrect can mess with Heredocs.

Example file (foo.rb):

module Foo
  class Bar < Baz
    class << self
      def generate_comment(_data)
        <<~MARKDOWN
        **This is a comment**

        This is a sentence about the comment.

        - [ ] Task 1
        - [ ] Task 2:
          - Sub-task 1
          - Sub-task 2
          - Sub-task 3

        Another sentence about the comment.
        MARKDOWN
      end
    end
  end
end

Note that contents of the Heredoc is not at the correct indentation.

Now run the autocorrect: rubocop -x foo.rb

Result:

module Foo
  class Bar < Baz
    class << self
      def generate_comment(_data)
        <<~MARKDOWN
          **This is a comment**
           This is a sentence about the comment.
           - [ ] Task 1
          - [ ] Task 2:
            - Sub-task 1
            - Sub-task 2
            - Sub-task 3
           Another sentence about the comment.
        MARKDOWN
      end
    end
  end
end

Expected:

module Foo
  class Bar < Status
    class << self
      def generate_comment(_data)
        <<~MARKDOWN
          **This is a comment**

          This is a sentence about the comment.

          - [ ] Task 1
          - [ ] Task 2:
            - Sub-task 1
            - Sub-task 2
            - Sub-task 3

          Another sentence about the comment.
        MARKDOWN
      end
    end
  end
end

---

Expected behavior

I expected the contents of the Heredoc to be unchanged, except for the additional 2 spaces added to each line.
Empty lines would still exist and be empty (admittedly, I'm not sure how empty lines should work in general).

Actual behavior

Empty lines were removed, and some of the lines got 3 spaces, not 2 (See Task 1).

Steps to reproduce the problem

rubocop -x foo.rb on the file above.

RuboCop version

rubocop -V
0.61.1 (using Parser 2.5.3.0, running on ruby 2.5.3 x86_64-darwin18)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contribution and understanding!

[stale]

This issues been automatically closed due to lack of activity. Feel free to re-open it if you ever come back to it.