class RuboCop::Cop::Layout::SpaceBeforeBlockBraces

Checks that block braces have or don't have a space before the opening brace depending on configuration.

@example

# bad
foo.map{ |a|
  a.bar.to_s
}

# good
foo.map { |a|
  a.bar.to_s
}

Constants

DETECTED_MSG
MISSING_MSG

Public Class Methods

autocorrect_incompatible_with() click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 25
def self.autocorrect_incompatible_with
  [Style::SymbolProc]
end

Public Instance Methods

on_block(node) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 29
def on_block(node)
  return if node.keywords?

  left_brace = node.loc.begin
  space_plus_brace = range_with_surrounding_space(left_brace)
  used_style =
    space_plus_brace.source.start_with?('{') ? :no_space : :space

  if empty_braces?(node.loc)
    check_empty(left_brace, space_plus_brace, used_style)
  else
    check_non_empty(left_brace, space_plus_brace, used_style)
  end
end

Private Instance Methods

autocorrect(range) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 92
def autocorrect(range)
  lambda do |corrector|
    case range.source
    when /\s/ then corrector.remove(range)
    else           corrector.insert_before(range, ' ')
    end
  end
end
check_empty(left_brace, space_plus_brace, used_style) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 46
def check_empty(left_brace, space_plus_brace, used_style)
  return if style_for_empty_braces == used_style

  config_to_allow_offenses['EnforcedStyleForEmptyBraces'] =
    used_style.to_s

  if style_for_empty_braces == :space
    add_offense(left_brace, location: left_brace, message: MISSING_MSG)
  else
    space = range_between(space_plus_brace.begin_pos,
                          left_brace.begin_pos)
    add_offense(space, location: space, message: DETECTED_MSG)
  end
end
check_non_empty(left_brace, space_plus_brace, used_style) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 61
def check_non_empty(left_brace, space_plus_brace, used_style)
  case used_style
  when style  then correct_style_detected
  when :space then space_detected(left_brace, space_plus_brace)
  else             space_missing(left_brace)
  end
end
empty_braces?(loc) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 101
def empty_braces?(loc)
  loc.begin.end_pos == loc.end.begin_pos
end
space_detected(left_brace, space_plus_brace) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 75
def space_detected(left_brace, space_plus_brace)
  space = range_between(space_plus_brace.begin_pos,
                        left_brace.begin_pos)
  add_offense(space, location: space, message: DETECTED_MSG) do
    opposite_style_detected
  end
end
space_missing(left_brace) click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 69
def space_missing(left_brace)
  add_offense(left_brace, location: left_brace, message: MISSING_MSG) do
    opposite_style_detected
  end
end
style_for_empty_braces() click to toggle source
# File lib/rubocop/cop/layout/space_before_block_braces.rb, line 83
def style_for_empty_braces
  case cop_config['EnforcedStyleForEmptyBraces']
  when 'space'    then :space
  when 'no_space' then :no_space
  when nil then style
  else raise 'Unknown EnforcedStyleForEmptyBraces selected!'
  end
end