class RuboCop::Cop::Layout::SpaceAroundBlockParameters

Checks the spacing inside and after block parameters pipes.

@example

# EnforcedStyleInsidePipes: no_space (default)

# bad
{}.each { | x,  y |puts x }
->( x,  y ) { puts x }

# good
{}.each { |x, y| puts x }
->(x, y) { puts x }

@example

# EnforcedStyleInsidePipes: space

# bad
{}.each { |x,  y| puts x }
->(x,  y) { puts x }

# good
{}.each { | x, y | puts x }
->( x, y ) { puts x }

Public Instance Methods

on_block(node) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 34
def on_block(node)
  return unless node.arguments?

  args = node.arguments

  opening_pipe = args.loc.begin
  closing_pipe = args.loc.end
  return if opening_pipe.nil? || closing_pipe.nil?

  check_inside_pipes(args.children, opening_pipe, closing_pipe)

  if node.body
    check_space(closing_pipe.end_pos, node.body.source_range.begin_pos,
                closing_pipe, 'after closing `|`')
  end

  check_each_arg(args)
end

Private Instance Methods

autocorrect(range) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 127
def autocorrect(range)
  lambda do |corrector|
    case range.source
    when /^\s+$/ then corrector.remove(range)
    else              corrector.insert_after(range, ' ')
    end
  end
end
check_closing_pipe_space(args, closing_pipe) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 91
def check_closing_pipe_space(args, closing_pipe)
  last         = args.last.source_range
  last_end_pos = last_end_pos_inside_pipes(last.end_pos)

  check_space(last_end_pos, closing_pipe.begin_pos, last,
              'after last block parameter')
  check_no_space(last_end_pos + 1, closing_pipe.begin_pos,
                 'Extra space after last')
end
check_each_arg(args) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 105
def check_each_arg(args)
  args.children.butfirst.each do |arg|
    expr = arg.source_range
    check_no_space(range_with_surrounding_space(expr, :left).begin_pos,
                   expr.begin_pos - 1, 'Extra space before')
  end
end
check_inside_pipes(args, opening_pipe, closing_pipe) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 59
def check_inside_pipes(args, opening_pipe, closing_pipe)
  if style == :no_space
    check_no_space_style_inside_pipes(args, opening_pipe, closing_pipe)
  elsif style == :space
    check_space_style_inside_pipes(args, opening_pipe, closing_pipe)
  end
end
check_no_space(space_begin_pos, space_end_pos, msg) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 119
def check_no_space(space_begin_pos, space_end_pos, msg)
  return if space_begin_pos >= space_end_pos

  range = range_between(space_begin_pos, space_end_pos)
  add_offense(range, location: range,
                     message: "#{msg} block parameter detected.")
end
check_no_space_style_inside_pipes(args, opening_pipe, closing_pipe) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 67
def check_no_space_style_inside_pipes(args, opening_pipe, closing_pipe)
  first = args.first.source_range
  last = args.last.source_range

  check_no_space(opening_pipe.end_pos, first.begin_pos,
                 'Space before first')
  check_no_space(last_end_pos_inside_pipes(last.end_pos),
                 closing_pipe.begin_pos, 'Space after last')
end
check_opening_pipe_space(args, opening_pipe) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 82
def check_opening_pipe_space(args, opening_pipe)
  first = args.first.source_range

  check_space(opening_pipe.end_pos, first.begin_pos, first,
              'before first block parameter')
  check_no_space(opening_pipe.end_pos, first.begin_pos - 1,
                 'Extra space before first')
end
check_space(space_begin_pos, space_end_pos, range, msg) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 113
def check_space(space_begin_pos, space_end_pos, range, msg)
  return if space_begin_pos != space_end_pos

  add_offense(range, location: range, message: "Space #{msg} missing.")
end
check_space_style_inside_pipes(args, opening_pipe, closing_pipe) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 77
def check_space_style_inside_pipes(args, opening_pipe, closing_pipe)
  check_opening_pipe_space(args, opening_pipe)
  check_closing_pipe_space(args, closing_pipe)
end
last_end_pos_inside_pipes(pos) click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 101
def last_end_pos_inside_pipes(pos)
  processed_source.buffer.source[pos] == ',' ? pos + 1 : pos
end
style_parameter_name() click to toggle source
# File lib/rubocop/cop/layout/space_around_block_parameters.rb, line 55
def style_parameter_name
  'EnforcedStyleInsidePipes'
end