Class: RuboCop::Cop::Style::HashEachMethods

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
AllowedReceivers, Lint::UnusedArgument
Defined in:
lib/rubocop/cop/style/hash_each_methods.rb

Overview

Checks for uses of each_key and each_value Hash methods.

Note
 If you have an array of two-element arrays, you can put parentheses around the block arguments to indicate that you’re not working with a hash, and suppress RuboCop offenses.

Examples:

# bad
hash.keys.each { |k| p k }
hash.values.each { |v| p v }

# good
hash.each_key { |k| p k }
hash.each_value { |v| p v }

AllowedReceivers: ['execute']

# good
execute(sql).keys.each { |v| p v }
execute(sql).values.each { |v| p v }

Cop Safety Information:

  • This cop is unsafe because it cannot be guaranteed that the receiver is a Hash. The AllowedReceivers configuration can mitigate, but not fully resolve, this safety issue.

Constant Summary collapse

MSG = 
'Use `%<prefer>s` instead of `%<current>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 included from Lint::UnusedArgument

#after_leaving_scope

Methods included from AllowedReceivers

#allowed_receiver?, #allowed_receivers, #receiver_name

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, 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, #inspect, 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?, #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

#kv_each(node) ⇒ Object 



38
39
40
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 38

def_node_matcher :kv_each, <<~PATTERN
  ({block numblock} $(send (send _ ${:keys :values}) :each) ...)
PATTERN

#kv_each_with_block_pass(node) ⇒ Object 



43
44
45
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 43

def_node_matcher :kv_each_with_block_pass, <<~PATTERN
  (send $(send _ ${:keys :values}) :each (block_pass (sym _)))
PATTERN

#on_block(node) ⇒ Object Also known as: on_numblock 



47
48
49
50
51
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 47

def on_block(node)
  kv_each(node) do |target, method|
    register_kv_offense(target, method)
  end
end

#on_block_pass(node) ⇒ Object 



55
56
57
58
59
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 55

def on_block_pass(node)
  kv_each_with_block_pass(node.parent) do |target, method|
    register_kv_with_block_pass_offense(node, target, method)
  end
end