Class: RuboCop::Cop::Style::NumberedParametersLimit

Inherits:
Base
  • Object
show all
Extended by:
TargetRubyVersion, ExcludeLimit
Defined in:
lib/rubocop/cop/style/numbered_parameters_limit.rb

Overview

Detects use of an excessive amount of numbered parameters in a single block. Having too many numbered parameters can make code too cryptic and hard to read.

The cop defaults to registering an offense if there is more than 1 numbered parameter but this maximum can be configured by setting ‘Max`.

Examples:

Max: 1 (default)

# bad
use_multiple_numbered_parameters { _1.call(_2, _3, _4) }

# good
array.each { use_array_element_as_numbered_parameter(_1) }
hash.each { use_only_hash_value_as_numbered_parameter(_2) }

Constant Summary collapse

DEFAULT_MAX_VALUE = 
1
MSG = 
'Avoid using more than %<max>i numbered %<parameter>s; %<count>i detected.'
NUMBERED_PARAMETER_PATTERN = 
/\A_[1-9]\z/.freeze

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

maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

Methods included from ExcludeLimit

exclude_limit

Methods inherited from Base

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

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #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 



32
33
34
35
36
37
38
39
 
# File 'lib/rubocop/cop/style/numbered_parameters_limit.rb', line 32

def on_numblock(node)
  param_count = numbered_parameter_nodes(node).uniq.count
  return if param_count <= max_count

  parameter = max_count > 1 ? 'parameters' : 'parameter'
  message = format(MSG, max: max_count, parameter: parameter, count: param_count)
  add_offense(node, message: message) { self.max = param_count }
end