Class: RuboCop::Cop::Performance::HashEachMethods

Inherits:
Cop
  • Object
show all
Includes:
Lint::UnusedArgument
Defined in:
lib/rubocop/cop/performance/hash_each.rb

Overview

This cop checks for uses of ‘each_key` & `each_value` Hash methods.

Examples:

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

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

Constant Summary collapse

MSG = 
'Use `%s` instead of `%s`.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from Lint::UnusedArgument

#after_leaving_scope, #join_force?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rubocop/cop/performance/hash_each.rb', line 52

def autocorrect(node)
  receiver, _second_method = *node
  caller, first_method = *receiver
  lambda do |corrector|
    if first_method == :hash
      method = @args.values.first ? :key : :value
      new_source = receiver.source + ".each_#{method}"
      corrector.replace(node.loc.expression, new_source)
      correct_args(node, corrector)
    else
      new_source = caller.source + ".each_#{first_method[0..-2]}"
      corrector.replace(node.loc.expression, new_source)
    end
  end
end

#check_argument(variable) ⇒ Object 



47
48
49
50
 
# File 'lib/rubocop/cop/performance/hash_each.rb', line 47

def check_argument(variable)
  return unless variable.block_argument?
  (@args ||= {})[variable.name] = variable.used?
end

#on_block(node) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/performance/hash_each.rb', line 32

def on_block(node)
  plain_each(node) do |target, k, v|
    return if @args[k] && @args[v]
    used = @args[k] ? :key : :value
    add_offense(target, range(target), format(message,
                                              "each_#{used}",
                                              :each))
  end
  kv_each(node) do |target, method|
    add_offense(target, range(target), format(message,
                                              "each_#{method[0..-2]}",
                                              "#{method}.each"))
  end
end