class RuboCop::Cop::Style::ItBlockParameter

Checks for blocks with one argument where ‘it` block parameter can be used.

It provides four ‘EnforcedStyle` options:

  1. ‘allow_single_line` (default) … Always uses the `it` block parameter in a single line.

  2. ‘only_numbered_parameters` … Detects only numbered block parameters.

  3. ‘always` … Always uses the `it` block parameter.

  4. ‘disallow` … Disallows the `it` block parameter.

A single numbered parameter is detected when ‘allow_single_line`, `only_numbered_parameters`, or `always`.

@example EnforcedStyle: allow_single_line (default)

# bad
block do
  do_something(it)
end
block { do_something(_1) }

# good
block { do_something(it) }
block { |named_param| do_something(named_param) }

@example EnforcedStyle: only_numbered_parameters

# bad
block { do_something(_1) }

# good
block { do_something(it) }
block { |named_param| do_something(named_param) }

@example EnforcedStyle: always

# bad
block { do_something(_1) }
block { |named_param| do_something(named_param) }

# good
block { do_something(it) }

@example EnforcedStyle: disallow

# bad
block { do_something(it) }

# good
block { do_something(_1) }
block { |named_param| do_something(named_param) }