module RuboCop::Cop::SurroundingSpace

Common functionality for checking and correcting surrounding whitespace.

Constants

NO_SPACE_COMMAND
SINGLE_SPACE_REGEXP
SPACE_COMMAND

Private Instance Methods

empty_brackets?(left_bracket_token, right_bracket_token) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 110
def empty_brackets?(left_bracket_token, right_bracket_token)
  left_index = processed_source.tokens.index(left_bracket_token)
  right_index = processed_source.tokens.index(right_bracket_token)
  right_index && left_index == right_index - 1
end
empty_offense(node, range, message, command) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 104
def empty_offense(node, range, message, command)
  add_offense(range, message: format(message, command: command)) do |corrector|
    autocorrect(corrector, node)
  end
end
empty_offenses(node, left, right, message) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 94
def empty_offenses(node, left, right, message)
  range = range_between(left.begin_pos, right.end_pos)
  if offending_empty_space?(empty_config, left, right)
    empty_offense(node, range, message, 'Use one')
  end
  return unless offending_empty_no_space?(empty_config, left, right)

  empty_offense(node, range, message, 'Do not use')
end
extra_space?(token, side) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 68
def extra_space?(token, side)
  return false unless token

  if side == :left
    SINGLE_SPACE_REGEXP.match?(String(token.space_after?))
  else
    SINGLE_SPACE_REGEXP.match?(String(token.space_before?))
  end
end
no_space_between?(left_bracket_token, right_bracket_token) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 128
def no_space_between?(left_bracket_token, right_bracket_token)
  left_bracket_token.end_pos == right_bracket_token.begin_pos
end
no_space_offenses(node, left_token, right_token, message, start_ok: false, end_ok: false) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 38
def no_space_offenses(node, # rubocop:disable Metrics/ParameterLists
                      left_token,
                      right_token,
                      message,
                      start_ok: false,
                      end_ok: false)
  if extra_space?(left_token, :left) && !start_ok
    space_offense(node, left_token, :right, message, NO_SPACE_COMMAND)
  end
  return if (!extra_space?(right_token, :right) || end_ok) ||
            (autocorrect_with_disable_uncorrectable? && !start_ok)

  space_offense(node, right_token, :left, message, NO_SPACE_COMMAND)
end
offending_empty_no_space?(config, left_token, right_token) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 120
def offending_empty_no_space?(config, left_token, right_token)
  config == 'no_space' && !no_space_between?(left_token, right_token)
end
offending_empty_space?(config, left_token, right_token) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 116
def offending_empty_space?(config, left_token, right_token)
  config == 'space' && !space_between?(left_token, right_token)
end
on_new_investigation() click to toggle source
Calls superclass method
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 33
def on_new_investigation
  @token_table = nil
  super
end
reposition(src, pos, step, include_newlines: false) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 78
def reposition(src, pos, step, include_newlines: false)
  offset = step == -1 ? -1 : 0
  pos += step while SINGLE_SPACE_REGEXP.match?(src[pos + offset]) ||
                    (include_newlines && src[pos + offset] == "\n")
  pos.negative? ? 0 : pos
end
side_space_range(range:, side:, include_newlines: false) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 16
def side_space_range(range:, side:, include_newlines: false)
  buffer = processed_source.buffer
  src = buffer.source

  begin_pos = range.begin_pos
  end_pos = range.end_pos
  if side == :left
    end_pos = begin_pos
    begin_pos = reposition(src, begin_pos, -1, include_newlines: include_newlines)
  end
  if side == :right
    begin_pos = end_pos
    end_pos = reposition(src, end_pos, 1, include_newlines: include_newlines)
  end
  Parser::Source::Range.new(buffer, begin_pos, end_pos)
end
space_between?(left_bracket_token, right_bracket_token) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 124
def space_between?(left_bracket_token, right_bracket_token)
  left_bracket_token.end_pos + 1 == right_bracket_token.begin_pos
end
space_offense(node, token, side, message, command) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 85
def space_offense(node, token, side, message, command)
  range = side_space_range(range: token.pos, side: side)
  add_offense(range, message: format(message, command: command)) do |corrector|
    autocorrect(corrector, node) unless ignored_node?(node)

    ignore_node(node)
  end
end
space_offenses(node, left_token, right_token, message, start_ok: false, end_ok: false) click to toggle source
# File lib/rubocop/cop/mixin/surrounding_space.rb, line 53
def space_offenses(node, # rubocop:disable Metrics/ParameterLists
                   left_token,
                   right_token,
                   message,
                   start_ok: false,
                   end_ok: false)
  unless extra_space?(left_token, :left) || start_ok
    space_offense(node, left_token, :none, message, SPACE_COMMAND)
  end
  return if (extra_space?(right_token, :right) || end_ok) ||
            (autocorrect_with_disable_uncorrectable? && !start_ok)

  space_offense(node, right_token, :none, message, SPACE_COMMAND)
end