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.each { |k, unused_value| p k }

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

# bad
hash.values.each { |v| p v }
hash.each { |unused_key, v| p v }

# good
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`.'
UNUSED_BLOCK_ARG_MSG = 
"#{MSG.chop} and remove the unused `%<unused_code>s` block argument."
ARRAY_CONVERTER_METHODS = 
%i[assoc chunk flatten rassoc sort sort_by to_a].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 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, #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?, #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 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

#check_unused_block_args(node, key, value) ⇒ Object

rubocop:disable Metrics/AbcSize



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 79

def check_unused_block_args(node, key, value)
  return if node.body.nil?

  value_unused = unused_block_arg_exist?(node, value)
  key_unused = unused_block_arg_exist?(node, key)
  return if value_unused && key_unused

  if value_unused
    message = message('each_key', node.method_name, value.source)
    unused_range = key.source_range.end.join(value.source_range.end)

    register_each_args_offense(node, message, 'each_key', unused_range)
  elsif key_unused
    message = message('each_value', node.method_name, key.source)
    unused_range = key.source_range.begin.join(value.source_range.begin)

    register_each_args_offense(node, message, 'each_value', unused_range)
  end
end

#each_arguments(node) ⇒ Object 



51
52
53
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 51

def_node_matcher :each_arguments, <<~PATTERN
  (block (call _ :each)(args $_key $_value) ...)
PATTERN

#hash_mutated?(node, receiver) ⇒ Object 



61
62
63
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 61

def_node_matcher :hash_mutated?, <<~PATTERN
  `(send %1 :[]= ...)
PATTERN

#kv_each(node) ⇒ Object 



46
47
48
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 46

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

#kv_each_with_block_pass(node) ⇒ Object 



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

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

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



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 65

def on_block(node)
  return unless handleable?(node)

  kv_each(node) do |target, method|
    register_kv_offense(target, method) and return
  end

  return unless (key, value = each_arguments(node))

  check_unused_block_args(node, key, value)
end

#on_block_pass(node) ⇒ Object

rubocop:enable Metrics/AbcSize



100
101
102
103
104
 
# File 'lib/rubocop/cop/style/hash_each_methods.rb', line 100

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