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

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

Overview

This cop 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 }

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 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

#kv_each(node) ⇒ Object


32
33
34
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 32

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

#on_block(node) ⇒ Object


36
37
38
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 36

def on_block(node)
  register_kv_offense(node)
end