|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module RuboCop |
| 4 | + module Cop |
| 5 | + module RSpecRails |
| 6 | + # Prefer `have_enqueued_job` over `receive(:perform_later)`. |
| 7 | + # |
| 8 | + # The `have_enqueued_job` matcher is preferred for testing ActiveJob |
| 9 | + # enqueuing. It is more explicit and provides better clarity than |
| 10 | + # using `receive(:perform_later)`. |
| 11 | + # |
| 12 | + # @example |
| 13 | + # # bad |
| 14 | + # expect(MyJob).to receive(:perform_later) |
| 15 | + # do_something |
| 16 | + # |
| 17 | + # # bad |
| 18 | + # allow(MyJob).to receive(:perform_later) |
| 19 | + # do_something |
| 20 | + # expect(MyJob).to have_received(:perform_later) |
| 21 | + # |
| 22 | + # # bad |
| 23 | + # expect(MyJob).to receive(:perform_later).with(user, order) |
| 24 | + # |
| 25 | + # # good |
| 26 | + # expect { do_something }.to have_enqueued_job(MyJob) |
| 27 | + # |
| 28 | + # # good |
| 29 | + # expect { do_something }.to have_enqueued_job(MyJob).with(user, order) |
| 30 | + # |
| 31 | + # # good |
| 32 | + # expect { do_something } |
| 33 | + # .to have_enqueued_job(MyJob) |
| 34 | + # .on_queue('mailers') |
| 35 | + # .at(Date.tomorrow.noon) |
| 36 | + # |
| 37 | + class ReceivePerformLater < ::RuboCop::Cop::Base |
| 38 | + MSG = 'Prefer `expect { ... }.to have_enqueued_job(%<job_class>s)` ' \ |
| 39 | + 'over `%<receiver>s(%<job_class>s).%<to>s ' \ |
| 40 | + '%<matcher>s(:perform_later)`.' |
| 41 | + |
| 42 | + RESTRICT_ON_SEND = %i[receive have_received].to_set |
| 43 | + RUNNERS = %i[to to_not not_to].freeze |
| 44 | + |
| 45 | + # @!method receive_perform_later?(node) |
| 46 | + def_node_matcher :receive_perform_later?, <<~PATTERN |
| 47 | + (send nil? {:receive :have_received} |
| 48 | + (sym :perform_later)) |
| 49 | + PATTERN |
| 50 | + |
| 51 | + # @!method expect_or_allow?(node) |
| 52 | + def_node_matcher :expect_or_allow?, <<~PATTERN |
| 53 | + (send nil? {:expect :allow} const_type?) |
| 54 | + PATTERN |
| 55 | + |
| 56 | + def on_send(node) |
| 57 | + return unless receive_perform_later?(node) |
| 58 | + return unless (runner_node = find_runner_node(node)) |
| 59 | + |
| 60 | + expect_node = runner_node.receiver |
| 61 | + return unless expect_or_allow?(expect_node) |
| 62 | + return if allow_receive_combination?(expect_node, node) |
| 63 | + |
| 64 | + job_class = expect_node.first_argument |
| 65 | + offense_node = find_offense_range(runner_node) |
| 66 | + add_offense(offense_node, |
| 67 | + message: offense_message(expect_node, job_class, |
| 68 | + runner_node, node)) |
| 69 | + end |
| 70 | + |
| 71 | + private |
| 72 | + |
| 73 | + def allow_receive_combination?(expect_node, matcher_node) |
| 74 | + expect_node.method?(:allow) && matcher_node.method?(:receive) |
| 75 | + end |
| 76 | + |
| 77 | + def offense_message(expect_node, job_class, runner_node, matcher_node) |
| 78 | + format(MSG, |
| 79 | + receiver: expect_node.method_name, |
| 80 | + job_class: job_class.source, |
| 81 | + to: runner_node.method_name, |
| 82 | + matcher: matcher_node.method_name) |
| 83 | + end |
| 84 | + |
| 85 | + def find_runner_node(node) |
| 86 | + node.each_ancestor(:send).find { |ancestor| runner?(ancestor) } |
| 87 | + end |
| 88 | + |
| 89 | + def find_offense_range(runner_node) |
| 90 | + current = runner_node |
| 91 | + current = current.parent while chained_send?(current) |
| 92 | + current |
| 93 | + end |
| 94 | + |
| 95 | + def chained_send?(node) |
| 96 | + node.parent&.send_type? && node.parent.receiver == node |
| 97 | + end |
| 98 | + |
| 99 | + def runner?(node) |
| 100 | + RUNNERS.include?(node.method_name) |
| 101 | + end |
| 102 | + end |
| 103 | + end |
| 104 | + end |
| 105 | +end |
0 commit comments