Class: RuboCop::Cop::Style::NumberedParameters

Inherits:
Base
  • Object
show all
Extended by:
TargetRubyVersion
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/numbered_parameters.rb

Overview

This cop checks for numbered parameters.

It can either restrict the use of numbered parameters to single-lined blocks, or disallow completely numbered parameters.

Examples:

EnforcedStyle: allow_single_line (default)

# bad
collection.each do
  puts _1
end

# good
collection.each { puts _1 }

EnforcedStyle: disallow

# bad
collection.each { puts _1 }

# good
collection.each { |item| puts item }

Constant Summary collapse

MSG_DISALLOW =
'Avoid using numbered parameters.'
MSG_MULTI_LINE =
'Avoid using numbered parameters for multi-line blocks.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from TargetRubyVersion

minimum_target_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_numblock(node) ⇒ Object


36
37
38
39
40
41
42
# File 'lib/rubocop/cop/style/numbered_parameters.rb', line 36

def on_numblock(node)
  if style == :disallow
    add_offense(node, message: MSG_DISALLOW)
  elsif node.multiline?
    add_offense(node, message: MSG_MULTI_LINE)
  end
end