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`.'.freeze
SCOPE_METHODS =
%i[
  all eager_load includes joins left_joins left_outer_joins not preload
  references unscoped where
].freeze
IGNORED_METHODS =
%i[order limit select].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



35
36
37
# File 'lib/rubocop/cop/rails/find_each.rb', line 35

def autocorrect(node)
  ->(corrector) { corrector.replace(node.loc.selector, 'find_each') }
end

#on_send(node) ⇒ Object



24
25
26
27
28
29
30
31
32
33
# File 'lib/rubocop/cop/rails/find_each.rb', line 24

def on_send(node)
  return unless node.receiver &&
                node.receiver.send_type? &&
                node.method?(:each)

  return unless SCOPE_METHODS.include?(node.receiver.method_name)
  return if method_chain(node).any? { |m| ignored_by_find_each?(m) }

  add_offense(node, location: :selector)
end