class RuboCop::Cop::Layout::InitialIndentation

This cop checks for indentation of the first non-blank non-comment line in a file.

@example

# bad
   class A
     def foo; end
   end

# good
class A
  def foo; end
end

Constants

MSG

Public Instance Methods

autocorrect(range) click to toggle source
# File lib/rubocop/cop/layout/initial_indentation.rb, line 31
def autocorrect(range)
  ->(corrector) { corrector.remove(range) }
end
investigate(_processed_source) click to toggle source
# File lib/rubocop/cop/layout/initial_indentation.rb, line 25
def investigate(_processed_source)
  space_before(first_token) do |space|
    add_offense(space, location: first_token.pos)
  end
end

Private Instance Methods

first_token() click to toggle source
# File lib/rubocop/cop/layout/initial_indentation.rb, line 37
def first_token
  processed_source.find_token { |t| !t.text.start_with?('#') }
end
space_before(token) { |range_between(begin_pos, begin_pos)| ... } click to toggle source
# File lib/rubocop/cop/layout/initial_indentation.rb, line 41
def space_before(token)
  return unless token
  return if token.column.zero?

  space_range =
    range_with_surrounding_space(range: token.pos,
                                 side: :left,
                                 newlines: false)
  # If the file starts with a byte order mark (BOM), the column can be
  # non-zero, but then we find out here if there's no space to the left
  # of the first token.
  return if space_range == token.pos

  yield range_between(space_range.begin_pos, token.begin_pos)
end