Class: RuboCop::Cop::Style::SingleLineBlockParams

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/single_line_block_params.rb

Overview

This cop checks whether the block parameters of a single-line method accepting a block match the names specified via configuration.

For instance one can configure `reduce`(`inject`) to use |a, e| as parameters.

Configuration option: Methods Should be set to use this cop. Array of hashes, where each key is the method name and value - array of argument names.

Examples:

Methods: [%w[a b]]

# bad
foo.reduce { |c, d| c + d }
foo.reduce { |_, _d| 1 }

# good
foo.reduce { |a, b| a + b }
foo.reduce { |a, _b| a }
foo.reduce { |a, (id, _)| a + id }
foo.reduce { true }

# good
foo.reduce do |c, d|
  c + d
end

Constant Summary collapse

MSG =
'Name `%<method>s` block params `|%<params>s|`.'

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 AutoCorrector

support_autocorrect?

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_block(node) ⇒ Object


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/rubocop/cop/style/single_line_block_params.rb', line 36

def on_block(node)
  return unless node.single_line?

  return unless eligible_method?(node)
  return unless eligible_arguments?(node)

  method_name = node.send_node.method_name
  return if args_match?(method_name, node.arguments)

  preferred_block_arguments = build_preferred_arguments_map(node, target_args(method_name))
  joined_block_arguments = preferred_block_arguments.values.join(', ')

  message = format(MSG, method: method_name, params: joined_block_arguments)

  add_offense(node.arguments, message: message) do |corrector|
    autocorrect(corrector, node, preferred_block_arguments, joined_block_arguments)
  end
end