Class: SidekiqUniqueJobs::Deprecation

Inherits:
Object
  • Object
show all
Defined in:
lib/sidekiq_unique_jobs/deprecation.rb

Overview

Class Deprecation provides logging of deprecations

Author:

Class Method Summary collapse

Class Method Details

.muted ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/sidekiq_unique_jobs/deprecation.rb', line 10

def self.muted
  orig_val = Thread.current[:uniquejobs_mute_deprecations]
  Thread.current[:uniquejobs_mute_deprecations] = true
  yield
ensure
  Thread.current[:uniquejobs_mute_deprecations] = orig_val
end

.muted? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/sidekiq_unique_jobs/deprecation.rb', line 18

def self.muted?
  Thread.current[:uniquejobs_mute_deprecations] == true
end

.warn(msg) ⇒ Object 



22
23
24
25
26
 
# File 'lib/sidekiq_unique_jobs/deprecation.rb', line 22

def self.warn(msg)
  return if SidekiqUniqueJobs::Deprecation.muted?

  warn "DEPRECATION WARNING: #{msg}"
end

.warn_with_backtrace(msg) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/sidekiq_unique_jobs/deprecation.rb', line 28

def self.warn_with_backtrace(msg)
  return if SidekiqUniqueJobs::Deprecation.muted?

  trace = "\n\nCALLED FROM:\n#{caller.join("\n")}"
  warn(msg + trace)
end