[Fix #837] Fix incorrect autocorrection of Rails/ActionOrder about comments

[r7kamura]

About

This change fixes the following Issue by extending the Parser::Source::Range used for replacement to include comment lines.

• Fix Rails/ActionOrder leaves comments behind in autocorrecting #837

Background

I encountered a problem with Rails/ActionOrder Cop autocorrection where comments were not corrected properly.

Before

class FooController < ApplicationController
  # show
  def show; end

  # index
  def index; end
end

Expected

class FooController < ApplicationController
  # index
  def index; end

  # show
  def show; end
end

Actual

class FooController < ApplicationController
  # show
  def index; end

  # index
  def show; end
end

When creating this Pull Request, I confirmed that a similar issue had already been reported, so I decided to tie it.

---

Before submitting the PR make sure the following are checked:

• The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
• Wrote good commit messages.
• Commit message starts with [Fix #issue-number] (if the related issue exists).
• Feature branch is up-to-date with master (if not - rebase it).
• Squashed related commits together.
• Added tests.
• Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
• Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
• If this is a new cop, consider making a corresponding update to the Rails Style Guide.

[r7kamura]

It would be nice to have RangeHelp module of the rubocop gem provide such a #range_with_comments feature in the future, since this kind of process seems a common pattern.

In fact, a similar process is already implemented in Style/AccessModifierDeclaration.

• https://github.com/rubocop/rubocop/blob/b2cf00281e3d13c80e1f6a2f69faf78842072bfa/lib/rubocop/cop/style/access_modifier_declarations.rb#L204-L230

[koic]

Thanks!