rubocop/cop/sidekiq_options_queue.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# frozen_string_literal: true

module RuboCop
  module Cop
    # Cop that prevents manually setting a queue in Sidekiq workers.
    class SidekiqOptionsQueue < RuboCop::Cop::Cop
      MSG = 'Do not manually set a queue; `ApplicationWorker` sets one automatically.'

      def_node_matcher :sidekiq_options?, <<~PATTERN
        (send nil? :sidekiq_options $...)
      PATTERN

      def on_send(node)
        return unless sidekiq_options?(node)

        node.arguments.first.each_node(:pair) do |pair|
          key_name = pair.key.children[0]

          add_offense(pair, location: :expression) if key_name == :queue
        end
      end
    end
  end
end