Sha256: 4d9c1821c8db27ba66c8f9638970e30350e1241ca35c9918bd4d502f97a77480
Contents?: true
Size: 1.89 KB
Versions: 6
Compression:
Stored size: 1.89 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# Identifies usages of `all.each` and
# change them to use `all.find_each` instead.
#
# @example
# # bad
# User.all.each
#
# # good
# User.all.find_each
#
# @example AllowedMethods: ['order']
# # good
# User.order(:foo).each
#
# @example AllowedPattern: ['order']
# # good
# User.order(:foo).each
class FindEach < Base
include ActiveRecordHelper
include AllowedMethods
include AllowedPattern
extend AutoCorrector
MSG = 'Use `find_each` instead of `each`.'
RESTRICT_ON_SEND = %i[each].freeze
SCOPE_METHODS = %i[
all eager_load includes joins left_joins left_outer_joins not preload
references unscoped where
].freeze
def on_send(node)
return unless node.receiver&.send_type?
return unless SCOPE_METHODS.include?(node.receiver.method_name)
return if node.receiver.receiver.nil? && !inherit_active_record_base?(node)
return if ignored?(node)
range = node.loc.selector
add_offense(range) do |corrector|
corrector.replace(range, 'find_each')
end
end
private
def ignored?(node)
return true if active_model_error_where?(node.receiver)
method_chain = node.each_node(:send).map(&:method_name)
method_chain.any? { |method_name| allowed_method?(method_name) || matches_allowed_pattern?(method_name) }
end
def active_model_error_where?(node)
node.method?(:where) && active_model_error?(node.receiver)
end
def active_model_error?(node)
return false if node.nil?
node.send_type? && node.method?(:errors)
end
end
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems