Class: RuboCop::Cop::Rails::FindEach

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/rails/find_each.rb

Overview

This cop is used to identify usages of all.each and change them to use all.find_each instead.

Examples:

# bad
User.all.each

# good
User.all.find_each

Constant Summary collapse

MSG = 
'Use `find_each` instead of `each`.'
SCOPE_METHODS = 
[:all, :where]

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

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 



31
32
33
34
35
 
# File 'lib/rubocop/cop/rails/find_each.rb', line 31

def autocorrect(node)
  each_loc = node.loc.selector

  ->(corrector) { corrector.replace(each_loc, 'find_each') }
end

#on_send(node) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rubocop/cop/rails/find_each.rb', line 20

def on_send(node)
  receiver, second_method, _selector = *node
  return unless second_method == :each
  return if receiver.nil?

  _model, first_method = *receiver
  return unless SCOPE_METHODS.include?(first_method)

  add_offense(node, node.loc.selector, MSG)
end