Class: RuboCop::Cop::Sidekiq::ConsistentJobSuffix

Inherits:
Base
  • Object
show all
Includes:
ClassNameHelper
Defined in:
lib/rubocop/cop/sidekiq/consistent_job_suffix.rb

Overview

Enforces consistent job class name suffix (Job or Worker).

Examples:

EnforcedSuffix: Job (default)

# bad
class ProcessPaymentWorker
  include Sidekiq::Job
end

# good
class ProcessPaymentJob
  include Sidekiq::Job
end

Constant Summary collapse

MSG = 
'Use `%<suffix>s` suffix for Sidekiq job class names.'

Instance Method Summary collapse

Methods included from Sidekiq::Language

#active_job_class?, #perform_call?, #sidekiq_include?, #sidekiq_options_call?

Instance Method Details

#on_class(node) ⇒ Object 



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

def on_class(node)
  return unless sidekiq_job_class?(node)

  class_name = class_name(node)
  return unless class_name

  suffix = enforced_suffix
  return if class_name.end_with?(suffix)

  add_offense(node.loc.keyword, message: format(MSG, suffix: suffix))
end