From 3cad04cd51fb2453e33044a0eb2923dd389c2d20 Mon Sep 17 00:00:00 2001
From: Douwe Maan <douwe@selenight.nl>
Date: Tue, 12 Dec 2017 17:21:00 +0100
Subject: Add rubocops to ensure Sidekiq workers include ApplicationWorker and
 don't manually set their queue

---
 rubocop/cop/include_sidekiq_worker.rb | 29 +++++++++++++++++++++++++++++
 rubocop/cop/sidekiq_options_queue.rb  | 27 +++++++++++++++++++++++++++
 rubocop/rubocop.rb                    |  2 ++
 3 files changed, 58 insertions(+)
 create mode 100644 rubocop/cop/include_sidekiq_worker.rb
 create mode 100644 rubocop/cop/sidekiq_options_queue.rb

(limited to 'rubocop')

diff --git a/rubocop/cop/include_sidekiq_worker.rb b/rubocop/cop/include_sidekiq_worker.rb
new file mode 100644
index 00000000000..4a6332286a2
--- /dev/null
+++ b/rubocop/cop/include_sidekiq_worker.rb
@@ -0,0 +1,29 @@
+require_relative '../spec_helpers'
+
+module RuboCop
+  module Cop
+    # Cop that makes sure workers include `ApplicationWorker`, not `Sidekiq::Worker`.
+    class IncludeSidekiqWorker < RuboCop::Cop::Cop
+      include SpecHelpers
+
+      MSG = 'Include `ApplicationWorker`, not `Sidekiq::Worker`.'.freeze
+
+      def_node_matcher :includes_sidekiq_worker?, <<~PATTERN
+        (send nil :include (const (const nil :Sidekiq) :Worker))
+      PATTERN
+
+      def on_send(node)
+        return if in_spec?(node)
+        return unless includes_sidekiq_worker?(node)
+
+        add_offense(node.arguments.first, :expression)
+      end
+
+      def autocorrect(node)
+        lambda do |corrector|
+          corrector.replace(node.source_range, 'ApplicationWorker')
+        end
+      end
+    end
+  end
+end
diff --git a/rubocop/cop/sidekiq_options_queue.rb b/rubocop/cop/sidekiq_options_queue.rb
new file mode 100644
index 00000000000..43b35ba0214
--- /dev/null
+++ b/rubocop/cop/sidekiq_options_queue.rb
@@ -0,0 +1,27 @@
+require_relative '../spec_helpers'
+
+module RuboCop
+  module Cop
+    # Cop that prevents manually setting a queue in Sidekiq workers.
+    class SidekiqOptionsQueue < RuboCop::Cop::Cop
+      include SpecHelpers
+
+      MSG = 'Do not manually set a queue; `ApplicationWorker` sets one automatically.'.freeze
+
+      def_node_matcher :sidekiq_options?, <<~PATTERN
+        (send nil :sidekiq_options $...)
+      PATTERN
+
+      def on_send(node)
+        return if in_spec?(node)
+        return unless sidekiq_options?(node)
+
+        node.arguments.first.each_node(:pair) do |pair|
+          key_name = pair.key.children[0]
+
+          add_offense(pair, :expression) if key_name == :queue
+        end
+      end
+    end
+  end
+end
diff --git a/rubocop/rubocop.rb b/rubocop/rubocop.rb
index eb52be3d731..3e3b4c8349a 100644
--- a/rubocop/rubocop.rb
+++ b/rubocop/rubocop.rb
@@ -3,10 +3,12 @@ require_relative 'cop/active_record_serialize'
 require_relative 'cop/custom_error_class'
 require_relative 'cop/gem_fetcher'
 require_relative 'cop/in_batches'
+require_relative 'cop/include_sidekiq_worker'
 require_relative 'cop/line_break_after_guard_clauses'
 require_relative 'cop/polymorphic_associations'
 require_relative 'cop/project_path_helper'
 require_relative 'cop/redirect_with_status'
+require_relative 'cop/sidekiq_options_queue'
 require_relative 'cop/migration/add_column'
 require_relative 'cop/migration/add_concurrent_foreign_key'
 require_relative 'cop/migration/add_concurrent_index'
-- 
cgit v1.2.3